@propulsionworks/cloudformation 0.1.33 → 0.1.35
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/out/exports/resources.generated/aws-appstream-fleet.d.ts +1 -5
- package/out/exports/resources.generated/aws-appstream-imagebuilder.d.ts +2 -6
- package/out/exports/resources.generated/aws-appstream-stack.d.ts +3 -3
- package/out/exports/resources.generated/aws-aps-anomalydetector.d.ts +34 -12
- package/out/exports/resources.generated/aws-aps-scraper.d.ts +48 -0
- package/out/exports/resources.generated/aws-backup-logicallyairgappedbackupvault.d.ts +4 -0
- package/out/exports/resources.generated/aws-backup-restoretestingselection.d.ts +2 -0
- package/out/exports/resources.generated/aws-batch-computeenvironment.d.ts +6 -6
- package/out/exports/resources.generated/aws-batch-jobdefinition.d.ts +3 -0
- package/out/exports/resources.generated/aws-bedrock-automatedreasoningpolicy.d.ts +15 -0
- package/out/exports/resources.generated/aws-bedrockagentcore-browsercustom.d.ts +16 -0
- package/out/exports/resources.generated/aws-bedrockagentcore-gatewaytarget.d.ts +18 -1
- package/out/exports/resources.generated/aws-bedrockagentcore-runtime.d.ts +109 -0
- package/out/exports/resources.generated/aws-bedrockagentcore-workloadidentity.d.ts +61 -0
- package/out/exports/resources.generated/aws-cassandra-keyspace.d.ts +1 -1
- package/out/exports/resources.generated/aws-cleanrooms-collaboration.d.ts +9 -0
- package/out/exports/resources.generated/aws-cleanrooms-configuredtable.d.ts +15 -1
- package/out/exports/resources.generated/aws-cleanrooms-privacybudgettemplate.d.ts +30 -3
- package/out/exports/resources.generated/aws-cloudfront-anycastiplist.d.ts +1 -0
- package/out/exports/resources.generated/aws-cloudfront-distribution.d.ts +1 -0
- package/out/exports/resources.generated/aws-cloudfront-vpcorigin.d.ts +1 -0
- package/out/exports/resources.generated/aws-config-configurationrecorder.d.ts +1 -1
- package/out/exports/resources.generated/aws-connect-evaluationform.d.ts +35 -12
- package/out/exports/resources.generated/aws-connect-securityprofile.d.ts +52 -0
- package/out/exports/resources.generated/aws-connectcampaignsv2-campaign.d.ts +4 -4
- package/out/exports/resources.generated/aws-controltower-landingzone.d.ts +5 -0
- package/out/exports/resources.generated/aws-datazone-connection.d.ts +32 -0
- package/out/exports/resources.generated/aws-dsql-cluster.d.ts +10 -0
- package/out/exports/resources.generated/aws-ec2-ec2fleet.d.ts +2 -2
- package/out/exports/resources.generated/aws-ec2-flowlog.d.ts +1 -1
- package/out/exports/resources.generated/aws-ec2-ipamscope.d.ts +25 -0
- package/out/exports/resources.generated/aws-ec2-spotfleet.d.ts +2 -2
- package/out/exports/resources.generated/aws-ec2-transitgateway.d.ts +8 -0
- package/out/exports/resources.generated/aws-ec2-volume.d.ts +542 -0
- package/out/exports/resources.generated/aws-ecs-capacityprovider.d.ts +1 -1
- package/out/exports/resources.generated/aws-ecs-cluster.d.ts +5 -5
- package/out/exports/resources.generated/aws-ecs-clustercapacityproviderassociations.d.ts +5 -5
- package/out/exports/resources.generated/aws-ecs-service.d.ts +42 -5
- package/out/exports/resources.generated/aws-ecs-taskdefinition.d.ts +4 -4
- package/out/exports/resources.generated/aws-ecs-taskset.d.ts +5 -5
- package/out/exports/resources.generated/aws-elasticloadbalancingv2-listener.d.ts +38 -0
- package/out/exports/resources.generated/aws-elasticloadbalancingv2-listenerrule.d.ts +38 -0
- package/out/exports/resources.generated/aws-elasticloadbalancingv2-targetgroup.d.ts +5 -0
- package/out/exports/resources.generated/aws-gamelift-build.d.ts +1 -1
- package/out/exports/resources.generated/aws-glue-integrationresourceproperty.d.ts +74 -0
- package/out/exports/resources.generated/aws-imagebuilder-containerrecipe.d.ts +21 -1
- package/out/exports/resources.generated/aws-imagebuilder-imagerecipe.d.ts +21 -1
- package/out/exports/resources.generated/aws-kendra-datasource.d.ts +19 -19
- package/out/exports/resources.generated/aws-kinesis-stream.d.ts +12 -0
- package/out/exports/resources.generated/aws-kms-key.d.ts +4 -1
- package/out/exports/resources.generated/aws-lambda-eventsourcemapping.d.ts +22 -2
- package/out/exports/resources.generated/aws-lambda-permission.d.ts +1 -1
- package/out/exports/resources.generated/aws-location-apikey.d.ts +39 -0
- package/out/exports/resources.generated/aws-macie-session.d.ts +1 -1
- package/out/exports/resources.generated/aws-mediaconnect-flow.d.ts +55 -0
- package/out/exports/resources.generated/aws-mediaconnect-flowoutput.d.ts +56 -1
- package/out/exports/resources.generated/aws-mediaconnect-routerinput.d.ts +484 -0
- package/out/exports/resources.generated/aws-mediaconnect-routernetworkinterface.d.ts +135 -0
- package/out/exports/resources.generated/aws-mediaconnect-routeroutput.d.ts +432 -0
- package/out/exports/resources.generated/aws-networkfirewall-firewall.d.ts +1 -0
- package/out/exports/resources.generated/aws-networkfirewall-firewallpolicy.d.ts +1 -0
- package/out/exports/resources.generated/aws-omics-annotationstore.d.ts +2 -2
- package/out/exports/resources.generated/aws-opensearchserverless-collection.d.ts +5 -0
- package/out/exports/resources.generated/aws-organizations-policy.d.ts +1 -1
- package/out/exports/resources.generated/aws-qbusiness-application.d.ts +3 -3
- package/out/exports/resources.generated/aws-quicksight-analysis.d.ts +1 -1
- package/out/exports/resources.generated/aws-quicksight-dashboard.d.ts +1 -1
- package/out/exports/resources.generated/aws-quicksight-dataset.d.ts +1166 -27
- package/out/exports/resources.generated/aws-quicksight-datasource.d.ts +1 -1
- package/out/exports/resources.generated/aws-quicksight-template.d.ts +1 -1
- package/out/exports/resources.generated/aws-refactorspaces-application.d.ts +2 -2
- package/out/exports/resources.generated/aws-refactorspaces-environment.d.ts +2 -2
- package/out/exports/resources.generated/aws-refactorspaces-service.d.ts +2 -2
- package/out/exports/resources.generated/aws-rekognition-project.d.ts +6 -1
- package/out/exports/resources.generated/aws-route53resolver-firewallrulegroup.d.ts +1 -1
- package/out/exports/resources.generated/aws-rtbfabric-inboundexternallink.d.ts +124 -0
- package/out/exports/resources.generated/aws-rtbfabric-link.d.ts +49 -4
- package/out/exports/resources.generated/aws-rtbfabric-requestergateway.d.ts +7 -5
- package/out/exports/resources.generated/aws-rtbfabric-respondergateway.d.ts +29 -5
- package/out/exports/resources.generated/aws-s3tables-table.d.ts +6 -1
- package/out/exports/resources.generated/aws-s3tables-tablebucket.d.ts +6 -1
- package/out/exports/resources.generated/aws-s3vectors-index.d.ts +68 -11
- package/out/exports/resources.generated/aws-s3vectors-vectorbucket.d.ts +74 -8
- package/out/exports/resources.generated/aws-s3vectors-vectorbucketpolicy.d.ts +64 -6
- package/out/exports/resources.generated/aws-securityhub-automationrule.d.ts +19 -19
- package/out/exports/resources.generated/aws-securityhub-automationrulev2.d.ts +6 -6
- package/out/exports/resources.generated/aws-securityhub-configurationpolicy.d.ts +8 -8
- package/out/exports/resources.generated/aws-securityhub-delegatedadmin.d.ts +2 -2
- package/out/exports/resources.generated/aws-securityhub-findingaggregator.d.ts +2 -2
- package/out/exports/resources.generated/aws-securityhub-hub.d.ts +2 -2
- package/out/exports/resources.generated/aws-securityhub-insight.d.ts +17 -17
- package/out/exports/resources.generated/aws-securityhub-organizationconfiguration.d.ts +2 -2
- package/out/exports/resources.generated/aws-securityhub-policyassociation.d.ts +3 -3
- package/out/exports/resources.generated/aws-securityhub-productsubscription.d.ts +2 -2
- package/out/exports/resources.generated/aws-securityhub-securitycontrol.d.ts +0 -0
- package/out/exports/resources.generated/aws-securityhub-standard.d.ts +3 -3
- package/out/exports/resources.generated/aws-servicecatalog-cloudformationproduct.d.ts +22 -1
- package/out/exports/resources.generated/aws-servicecatalog-portfolioprincipalassociation.d.ts +5 -13
- package/out/exports/resources.generated/aws-ses-multiregionendpoint.d.ts +48 -0
- package/out/exports/resources.generated/aws-wafv2-webacl.d.ts +32 -0
- package/out/exports/resources.generated/aws-workspacesthinclient-environment.d.ts +2 -2
- package/out/exports/resources.generated/aws-workspacesweb-browsersettings.d.ts +26 -1
- package/out/exports/resources.generated/dev-fsx-storagevirtualmachine.d.ts +29 -0
- package/package.json +1 -1
|
@@ -1,54 +1,65 @@
|
|
|
1
1
|
import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* Creates a responder gateway.
|
|
4
|
+
*
|
|
5
|
+
* > A domain name or managed endpoint is required.
|
|
4
6
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-respondergateway.html}
|
|
5
7
|
*/
|
|
6
8
|
export type RTBFabricResponderGateway = ResourceDefinitionWithAttributes<"AWS::RTBFabric::ResponderGateway", RTBFabricResponderGatewayProps, RTBFabricResponderGatewayAttribs>;
|
|
7
9
|
/**
|
|
8
|
-
*
|
|
10
|
+
* Creates a responder gateway.
|
|
11
|
+
*
|
|
12
|
+
* > A domain name or managed endpoint is required.
|
|
9
13
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-respondergateway.html}
|
|
10
14
|
*/
|
|
11
15
|
export type RTBFabricResponderGatewayProps = {
|
|
12
16
|
/**
|
|
17
|
+
* An optional description for the responder gateway.
|
|
13
18
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-respondergateway.html#cfn-rtbfabric-respondergateway-description}
|
|
14
19
|
*/
|
|
15
20
|
Description?: string | undefined;
|
|
16
21
|
/**
|
|
22
|
+
* The domain name for the responder gateway.
|
|
17
23
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-respondergateway.html#cfn-rtbfabric-respondergateway-domainname}
|
|
18
24
|
*/
|
|
19
25
|
DomainName?: string | undefined;
|
|
20
26
|
/**
|
|
27
|
+
* The configuration for the managed endpoint.
|
|
21
28
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-respondergateway.html#cfn-rtbfabric-respondergateway-managedendpointconfiguration}
|
|
22
29
|
*/
|
|
23
30
|
ManagedEndpointConfiguration?: ManagedEndpointConfiguration | undefined;
|
|
24
31
|
/**
|
|
32
|
+
* The networking port to use.
|
|
25
33
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-respondergateway.html#cfn-rtbfabric-respondergateway-port}
|
|
26
34
|
*/
|
|
27
35
|
Port: number;
|
|
28
36
|
/**
|
|
37
|
+
* The networking protocol to use.
|
|
29
38
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-respondergateway.html#cfn-rtbfabric-respondergateway-protocol}
|
|
30
39
|
*/
|
|
31
40
|
Protocol: Protocol;
|
|
32
41
|
/**
|
|
33
|
-
* The
|
|
42
|
+
* The unique identifiers of the security groups.
|
|
34
43
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-respondergateway.html#cfn-rtbfabric-respondergateway-securitygroupids}
|
|
35
44
|
*/
|
|
36
45
|
SecurityGroupIds: string[];
|
|
37
46
|
/**
|
|
38
|
-
* The
|
|
47
|
+
* The unique identifiers of the subnets.
|
|
39
48
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-respondergateway.html#cfn-rtbfabric-respondergateway-subnetids}
|
|
40
49
|
*/
|
|
41
50
|
SubnetIds: string[];
|
|
42
51
|
/**
|
|
43
|
-
*
|
|
52
|
+
* A map of the key-value pairs of the tag or tags to assign to the resource.
|
|
44
53
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-respondergateway.html#cfn-rtbfabric-respondergateway-tags}
|
|
45
54
|
*/
|
|
46
55
|
Tags?: Tag[] | undefined;
|
|
47
56
|
/**
|
|
57
|
+
* The configuration of the trust store.
|
|
48
58
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-respondergateway.html#cfn-rtbfabric-respondergateway-truststoreconfiguration}
|
|
49
59
|
*/
|
|
50
60
|
TrustStoreConfiguration?: TrustStoreConfiguration | undefined;
|
|
51
61
|
/**
|
|
62
|
+
* The unique identifier of the Virtual Private Cloud (VPC).
|
|
52
63
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-respondergateway.html#cfn-rtbfabric-respondergateway-vpcid}
|
|
53
64
|
*/
|
|
54
65
|
VpcId: string;
|
|
@@ -79,29 +90,35 @@ export type RTBFabricResponderGatewayAttribs = {
|
|
|
79
90
|
UpdatedTimestamp: string;
|
|
80
91
|
};
|
|
81
92
|
/**
|
|
93
|
+
* Describes the configuration of an auto scaling group.
|
|
82
94
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-autoscalinggroupsconfiguration.html}
|
|
83
95
|
*/
|
|
84
96
|
export type AutoScalingGroupsConfiguration = {
|
|
85
97
|
/**
|
|
98
|
+
* The names of the auto scaling group.
|
|
86
99
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-autoscalinggroupsconfiguration.html#cfn-rtbfabric-respondergateway-autoscalinggroupsconfiguration-autoscalinggroupnamelist}
|
|
87
100
|
*/
|
|
88
101
|
AutoScalingGroupNameList: string[];
|
|
89
102
|
/**
|
|
103
|
+
* The role ARN of the auto scaling group.
|
|
90
104
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-autoscalinggroupsconfiguration.html#cfn-rtbfabric-respondergateway-autoscalinggroupsconfiguration-rolearn}
|
|
91
105
|
*/
|
|
92
106
|
RoleArn: string;
|
|
93
107
|
};
|
|
94
108
|
/**
|
|
109
|
+
* Describes the configuration of an Amazon Elastic Kubernetes Service endpoint.
|
|
95
110
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-eksendpointsconfiguration.html}
|
|
96
111
|
*/
|
|
97
112
|
export type EksEndpointsConfiguration = {
|
|
98
113
|
/**
|
|
114
|
+
* The CA certificate chain of the cluster API server.
|
|
99
115
|
* @minLength 1
|
|
100
116
|
* @maxLength 2097152
|
|
101
117
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-eksendpointsconfiguration.html#cfn-rtbfabric-respondergateway-eksendpointsconfiguration-clusterapiservercacertificatechain}
|
|
102
118
|
*/
|
|
103
119
|
ClusterApiServerCaCertificateChain: string;
|
|
104
120
|
/**
|
|
121
|
+
* The URI of the cluster API server endpoint.
|
|
105
122
|
* @minLength 0
|
|
106
123
|
* @maxLength 255
|
|
107
124
|
* @pattern ^(https|http)://(?:[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?)(?:\.(?:[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?))+$
|
|
@@ -109,26 +126,31 @@ export type EksEndpointsConfiguration = {
|
|
|
109
126
|
*/
|
|
110
127
|
ClusterApiServerEndpointUri: string;
|
|
111
128
|
/**
|
|
129
|
+
* The name of the cluster.
|
|
112
130
|
* @pattern ^[A-Za-z0-9][A-Za-z0-9-]{0,61}[A-Za-z0-9]$
|
|
113
131
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-eksendpointsconfiguration.html#cfn-rtbfabric-respondergateway-eksendpointsconfiguration-clustername}
|
|
114
132
|
*/
|
|
115
133
|
ClusterName: string;
|
|
116
134
|
/**
|
|
135
|
+
* The name of the endpoint resource.
|
|
117
136
|
* @pattern ^[A-Za-z0-9][A-Za-z0-9-]{0,61}[A-Za-z0-9]$
|
|
118
137
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-eksendpointsconfiguration.html#cfn-rtbfabric-respondergateway-eksendpointsconfiguration-endpointsresourcename}
|
|
119
138
|
*/
|
|
120
139
|
EndpointsResourceName: string;
|
|
121
140
|
/**
|
|
141
|
+
* The namespace of the endpoint resource.
|
|
122
142
|
* @pattern ^[A-Za-z0-9][A-Za-z0-9-]{0,61}[A-Za-z0-9]$
|
|
123
143
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-eksendpointsconfiguration.html#cfn-rtbfabric-respondergateway-eksendpointsconfiguration-endpointsresourcenamespace}
|
|
124
144
|
*/
|
|
125
145
|
EndpointsResourceNamespace: string;
|
|
126
146
|
/**
|
|
147
|
+
* The role ARN for the cluster.
|
|
127
148
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-eksendpointsconfiguration.html#cfn-rtbfabric-respondergateway-eksendpointsconfiguration-rolearn}
|
|
128
149
|
*/
|
|
129
150
|
RoleArn: string;
|
|
130
151
|
};
|
|
131
152
|
/**
|
|
153
|
+
* Describes the configuration of a managed endpoint.
|
|
132
154
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-managedendpointconfiguration.html}
|
|
133
155
|
*/
|
|
134
156
|
export type ManagedEndpointConfiguration = {
|
|
@@ -145,10 +167,12 @@ export type Protocol = "HTTP" | "HTTPS";
|
|
|
145
167
|
*/
|
|
146
168
|
export type ResponderGatewayStatus = "PENDING_CREATION" | "ACTIVE" | "PENDING_DELETION" | "DELETED" | "ERROR" | "PENDING_UPDATE" | "ISOLATED" | "PENDING_ISOLATION" | "PENDING_RESTORATION";
|
|
147
169
|
/**
|
|
170
|
+
* Describes the configuration of a trust store.
|
|
148
171
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-truststoreconfiguration.html}
|
|
149
172
|
*/
|
|
150
173
|
export type TrustStoreConfiguration = {
|
|
151
174
|
/**
|
|
175
|
+
* The certificate authority certificate.
|
|
152
176
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-truststoreconfiguration.html#cfn-rtbfabric-respondergateway-truststoreconfiguration-certificateauthoritycertificates}
|
|
153
177
|
*/
|
|
154
178
|
CertificateAuthorityCertificates: string[];
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { ResourceDefinitionWithAttributes } from "../main.ts";
|
|
1
|
+
import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
|
|
2
2
|
/**
|
|
3
3
|
* Creates a new table associated with the given namespace in a table bucket. For more information, see [Creating an Amazon S3 table](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-create.html) in the *Amazon Simple Storage Service User Guide* .
|
|
4
4
|
*
|
|
@@ -64,6 +64,11 @@ export type S3TablesTableProps = {
|
|
|
64
64
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-tablename}
|
|
65
65
|
*/
|
|
66
66
|
TableName: string;
|
|
67
|
+
/**
|
|
68
|
+
* User tags (key-value pairs) to associate with the table.
|
|
69
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-tags}
|
|
70
|
+
*/
|
|
71
|
+
Tags?: Tag[] | undefined;
|
|
67
72
|
/**
|
|
68
73
|
* Indicates that you don't want to specify a schema for the table. This property is mutually exclusive to `IcebergMetadata` , and its only possible value is `Yes` .
|
|
69
74
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-withoutmetadata}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { ResourceDefinitionWithAttributes } from "../main.ts";
|
|
1
|
+
import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
|
|
2
2
|
/**
|
|
3
3
|
* Creates a table bucket. For more information, see [Creating a table bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-buckets-create.html) in the *Amazon Simple Storage Service User Guide* .
|
|
4
4
|
*
|
|
@@ -33,6 +33,11 @@ export type S3TablesTableBucketProps = {
|
|
|
33
33
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablebucket.html#cfn-s3tables-tablebucket-tablebucketname}
|
|
34
34
|
*/
|
|
35
35
|
TableBucketName: string;
|
|
36
|
+
/**
|
|
37
|
+
* User tags (key-value pairs) to associate with the table bucket.
|
|
38
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablebucket.html#cfn-s3tables-tablebucket-tags}
|
|
39
|
+
*/
|
|
40
|
+
Tags?: Tag[] | undefined;
|
|
36
41
|
/**
|
|
37
42
|
* The unreferenced file removal settings for your table bucket. Unreferenced file removal identifies and deletes all objects that are not referenced by any table snapshots. For more information, see the [*Amazon S3 User Guide*](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-table-buckets-maintenance.html) .
|
|
38
43
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablebucket.html#cfn-s3tables-tablebucket-unreferencedfileremoval}
|
|
@@ -1,31 +1,82 @@
|
|
|
1
1
|
import type { ResourceDefinitionWithAttributes } from "../main.ts";
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* The `AWS::S3Vectors::Index` resource defines a vector index within an Amazon S3 vector bucket. For more information, see [Creating a vector index in a vector bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-vectors-create-index.html) in the *Amazon Simple Storage Service User Guide* .
|
|
4
|
+
*
|
|
5
|
+
* You must specify either `VectorBucketName` or `VectorBucketArn` to identify the bucket that contains the index.
|
|
6
|
+
*
|
|
7
|
+
* To control how AWS CloudFormation handles the vector index when the stack is deleted, you can set a deletion policy for your index. You can choose to *retain* the index or to *delete* the index. For more information, see [DeletionPolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) .
|
|
8
|
+
*
|
|
9
|
+
* - **Permissions** - The required permissions for CloudFormation to use are based on the operations that are performed on the stack.
|
|
10
|
+
*
|
|
11
|
+
* - Create
|
|
12
|
+
*
|
|
13
|
+
* - s3vectors:CreateIndex
|
|
14
|
+
* - s3vectors:GetIndex
|
|
15
|
+
* - Read
|
|
16
|
+
*
|
|
17
|
+
* - s3vectors:GetIndex
|
|
18
|
+
* - Delete
|
|
19
|
+
*
|
|
20
|
+
* - s3vectors:DeleteIndex
|
|
21
|
+
* - s3vectors:GetIndex
|
|
22
|
+
* - List
|
|
23
|
+
*
|
|
24
|
+
* - s3vectors:ListIndexes
|
|
4
25
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-index.html}
|
|
5
26
|
*/
|
|
6
27
|
export type S3VectorsIndex = ResourceDefinitionWithAttributes<"AWS::S3Vectors::Index", S3VectorsIndexProps, S3VectorsIndexAttribs>;
|
|
7
28
|
/**
|
|
8
|
-
*
|
|
29
|
+
* The `AWS::S3Vectors::Index` resource defines a vector index within an Amazon S3 vector bucket. For more information, see [Creating a vector index in a vector bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-vectors-create-index.html) in the *Amazon Simple Storage Service User Guide* .
|
|
30
|
+
*
|
|
31
|
+
* You must specify either `VectorBucketName` or `VectorBucketArn` to identify the bucket that contains the index.
|
|
32
|
+
*
|
|
33
|
+
* To control how AWS CloudFormation handles the vector index when the stack is deleted, you can set a deletion policy for your index. You can choose to *retain* the index or to *delete* the index. For more information, see [DeletionPolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) .
|
|
34
|
+
*
|
|
35
|
+
* - **Permissions** - The required permissions for CloudFormation to use are based on the operations that are performed on the stack.
|
|
36
|
+
*
|
|
37
|
+
* - Create
|
|
38
|
+
*
|
|
39
|
+
* - s3vectors:CreateIndex
|
|
40
|
+
* - s3vectors:GetIndex
|
|
41
|
+
* - Read
|
|
42
|
+
*
|
|
43
|
+
* - s3vectors:GetIndex
|
|
44
|
+
* - Delete
|
|
45
|
+
*
|
|
46
|
+
* - s3vectors:DeleteIndex
|
|
47
|
+
* - s3vectors:GetIndex
|
|
48
|
+
* - List
|
|
49
|
+
*
|
|
50
|
+
* - s3vectors:ListIndexes
|
|
9
51
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-index.html}
|
|
10
52
|
*/
|
|
11
53
|
export type S3VectorsIndexProps = {
|
|
12
54
|
/**
|
|
13
|
-
* The data type of the vectors to be inserted into the vector index.
|
|
55
|
+
* The data type of the vectors to be inserted into the vector index. Currently, only `float32` is supported, which represents 32-bit floating-point numbers.
|
|
14
56
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-index.html#cfn-s3vectors-index-datatype}
|
|
15
57
|
*/
|
|
16
58
|
DataType: DataType;
|
|
17
59
|
/**
|
|
18
|
-
* The dimensions of the vectors to be inserted into the vector index.
|
|
60
|
+
* The dimensions of the vectors to be inserted into the vector index. This value must be between 1 and 4096, inclusive. All vectors stored in the index must have the same number of dimensions.
|
|
61
|
+
*
|
|
62
|
+
* The dimension value affects the storage requirements and search performance. Higher dimensions require more storage space and may impact search latency.
|
|
19
63
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-index.html#cfn-s3vectors-index-dimension}
|
|
20
64
|
*/
|
|
21
65
|
Dimension: number;
|
|
22
66
|
/**
|
|
23
|
-
* The distance metric to be used for similarity search.
|
|
67
|
+
* The distance metric to be used for similarity search. Valid values are:
|
|
68
|
+
*
|
|
69
|
+
* - `cosine` - Measures the cosine of the angle between two vectors.
|
|
70
|
+
* - `euclidean` - Measures the straight-line distance between two points in multi-dimensional space. Lower values indicate greater similarity.
|
|
24
71
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-index.html#cfn-s3vectors-index-distancemetric}
|
|
25
72
|
*/
|
|
26
73
|
DistanceMetric: DistanceMetric;
|
|
27
74
|
/**
|
|
28
|
-
* The name of the vector index to create.
|
|
75
|
+
* The name of the vector index to create. The index name must be between 3 and 63 characters long and can contain only lowercase letters, numbers, hyphens (-), and dots (.). The index name must be unique within the vector bucket.
|
|
76
|
+
*
|
|
77
|
+
* If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the index name.
|
|
78
|
+
*
|
|
79
|
+
* > If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.
|
|
29
80
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-index.html#cfn-s3vectors-index-indexname}
|
|
30
81
|
*/
|
|
31
82
|
IndexName?: string | undefined;
|
|
@@ -35,7 +86,7 @@ export type S3VectorsIndexProps = {
|
|
|
35
86
|
*/
|
|
36
87
|
MetadataConfiguration?: MetadataConfiguration | undefined;
|
|
37
88
|
/**
|
|
38
|
-
* The Amazon Resource Name (ARN) of the vector bucket.
|
|
89
|
+
* The Amazon Resource Name (ARN) of the vector bucket that contains the vector index.
|
|
39
90
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-index.html#cfn-s3vectors-index-vectorbucketarn}
|
|
40
91
|
*/
|
|
41
92
|
VectorBucketArn?: string | undefined;
|
|
@@ -50,12 +101,16 @@ export type S3VectorsIndexProps = {
|
|
|
50
101
|
*/
|
|
51
102
|
export type S3VectorsIndexAttribs = {
|
|
52
103
|
/**
|
|
53
|
-
*
|
|
104
|
+
* Returns the date and time when the vector index was created.
|
|
105
|
+
*
|
|
106
|
+
* Example: `2024-12-21T10:30:00Z`
|
|
54
107
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-index.html#cfn-s3vectors-index-creationtime}
|
|
55
108
|
*/
|
|
56
109
|
CreationTime: string;
|
|
57
110
|
/**
|
|
58
|
-
*
|
|
111
|
+
* Returns the Amazon Resource Name (ARN) of the specified index.
|
|
112
|
+
*
|
|
113
|
+
* Example: `arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket/index/my-index`
|
|
59
114
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-index.html#cfn-s3vectors-index-indexarn}
|
|
60
115
|
*/
|
|
61
116
|
IndexArn: string;
|
|
@@ -71,12 +126,14 @@ export type DataType = "float32";
|
|
|
71
126
|
*/
|
|
72
127
|
export type DistanceMetric = "cosine" | "euclidean";
|
|
73
128
|
/**
|
|
74
|
-
* The metadata configuration for the vector index.
|
|
129
|
+
* The metadata configuration for the vector index. This configuration allows you to specify which metadata keys should be treated as non-filterable.
|
|
75
130
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3vectors-index-metadataconfiguration.html}
|
|
76
131
|
*/
|
|
77
132
|
export type MetadataConfiguration = {
|
|
78
133
|
/**
|
|
79
|
-
* Non-filterable metadata keys allow you to enrich vectors with additional context during storage and retrieval. Unlike default metadata keys, these keys
|
|
134
|
+
* Non-filterable metadata keys allow you to enrich vectors with additional context during storage and retrieval. Unlike default metadata keys, these keys can't be used as query filters. Non-filterable metadata keys can be retrieved but can't be searched, queried, or filtered. You can access non-filterable metadata keys of your vectors after finding the vectors.
|
|
135
|
+
*
|
|
136
|
+
* You can specify 1 to 10 non-filterable metadata keys. Each key must be 1 to 63 characters long.
|
|
80
137
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3vectors-index-metadataconfiguration.html#cfn-s3vectors-index-metadataconfiguration-nonfilterablemetadatakeys}
|
|
81
138
|
*/
|
|
82
139
|
NonFilterableMetadataKeys?: string[] | undefined;
|
|
@@ -1,11 +1,65 @@
|
|
|
1
1
|
import type { ResourceDefinitionWithAttributes } from "../main.ts";
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* Defines an Amazon S3 vector bucket in the same AWS Region where you create the AWS CloudFormation stack.
|
|
4
|
+
*
|
|
5
|
+
* Vector buckets are specialized storage containers designed for storing and managing vector data used in machine learning and AI applications. They provide optimized storage and retrieval capabilities for high-dimensional vector data.
|
|
6
|
+
*
|
|
7
|
+
* To control how AWS CloudFormation handles the bucket when the stack is deleted, you can set a deletion policy for your bucket. You can choose to *retain* the bucket or to *delete* the bucket. For more information, see [DeletionPolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) .
|
|
8
|
+
*
|
|
9
|
+
* > You can only delete empty vector buckets. Deletion fails for buckets that have contents.
|
|
10
|
+
*
|
|
11
|
+
* - **Permissions** - The required permissions for CloudFormation to use are based on the operations that are performed on the stack.
|
|
12
|
+
*
|
|
13
|
+
* - Create
|
|
14
|
+
*
|
|
15
|
+
* - s3vectors:CreateVectorBucket
|
|
16
|
+
* - s3vectors:GetVectorBucket
|
|
17
|
+
* - kms:GenerateDataKey (if using KMS encryption)
|
|
18
|
+
* - Read
|
|
19
|
+
*
|
|
20
|
+
* - s3vectors:GetVectorBucket
|
|
21
|
+
* - kms:GenerateDataKey (if using KMS encryption)
|
|
22
|
+
* - Delete
|
|
23
|
+
*
|
|
24
|
+
* - s3vectors:DeleteVectorBucket
|
|
25
|
+
* - s3vectors:GetVectorBucket
|
|
26
|
+
* - kms:GenerateDataKey (if using KMS encryption)
|
|
27
|
+
* - List
|
|
28
|
+
*
|
|
29
|
+
* - s3vectors:ListVectorBuckets
|
|
30
|
+
* - kms:GenerateDataKey (if using KMS encryption)
|
|
4
31
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-vectorbucket.html}
|
|
5
32
|
*/
|
|
6
33
|
export type S3VectorsVectorBucket = ResourceDefinitionWithAttributes<"AWS::S3Vectors::VectorBucket", S3VectorsVectorBucketProps, S3VectorsVectorBucketAttribs>;
|
|
7
34
|
/**
|
|
8
|
-
*
|
|
35
|
+
* Defines an Amazon S3 vector bucket in the same AWS Region where you create the AWS CloudFormation stack.
|
|
36
|
+
*
|
|
37
|
+
* Vector buckets are specialized storage containers designed for storing and managing vector data used in machine learning and AI applications. They provide optimized storage and retrieval capabilities for high-dimensional vector data.
|
|
38
|
+
*
|
|
39
|
+
* To control how AWS CloudFormation handles the bucket when the stack is deleted, you can set a deletion policy for your bucket. You can choose to *retain* the bucket or to *delete* the bucket. For more information, see [DeletionPolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) .
|
|
40
|
+
*
|
|
41
|
+
* > You can only delete empty vector buckets. Deletion fails for buckets that have contents.
|
|
42
|
+
*
|
|
43
|
+
* - **Permissions** - The required permissions for CloudFormation to use are based on the operations that are performed on the stack.
|
|
44
|
+
*
|
|
45
|
+
* - Create
|
|
46
|
+
*
|
|
47
|
+
* - s3vectors:CreateVectorBucket
|
|
48
|
+
* - s3vectors:GetVectorBucket
|
|
49
|
+
* - kms:GenerateDataKey (if using KMS encryption)
|
|
50
|
+
* - Read
|
|
51
|
+
*
|
|
52
|
+
* - s3vectors:GetVectorBucket
|
|
53
|
+
* - kms:GenerateDataKey (if using KMS encryption)
|
|
54
|
+
* - Delete
|
|
55
|
+
*
|
|
56
|
+
* - s3vectors:DeleteVectorBucket
|
|
57
|
+
* - s3vectors:GetVectorBucket
|
|
58
|
+
* - kms:GenerateDataKey (if using KMS encryption)
|
|
59
|
+
* - List
|
|
60
|
+
*
|
|
61
|
+
* - s3vectors:ListVectorBuckets
|
|
62
|
+
* - kms:GenerateDataKey (if using KMS encryption)
|
|
9
63
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-vectorbucket.html}
|
|
10
64
|
*/
|
|
11
65
|
export type S3VectorsVectorBucketProps = {
|
|
@@ -15,7 +69,11 @@ export type S3VectorsVectorBucketProps = {
|
|
|
15
69
|
*/
|
|
16
70
|
EncryptionConfiguration?: EncryptionConfiguration | undefined;
|
|
17
71
|
/**
|
|
18
|
-
*
|
|
72
|
+
* A name for the vector bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). The bucket name must be unique in the same AWS account for each AWS Region. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name.
|
|
73
|
+
*
|
|
74
|
+
* The bucket name must be between 3 and 63 characters long and must not contain uppercase characters or underscores.
|
|
75
|
+
*
|
|
76
|
+
* > If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.
|
|
19
77
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-vectorbucket.html#cfn-s3vectors-vectorbucket-vectorbucketname}
|
|
20
78
|
*/
|
|
21
79
|
VectorBucketName?: string | undefined;
|
|
@@ -25,23 +83,31 @@ export type S3VectorsVectorBucketProps = {
|
|
|
25
83
|
*/
|
|
26
84
|
export type S3VectorsVectorBucketAttribs = {
|
|
27
85
|
/**
|
|
28
|
-
*
|
|
86
|
+
* Returns the date and time when the vector bucket was created.
|
|
87
|
+
*
|
|
88
|
+
* Example: `2024-12-21T10:30:00Z`
|
|
29
89
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-vectorbucket.html#cfn-s3vectors-vectorbucket-creationtime}
|
|
30
90
|
*/
|
|
31
91
|
CreationTime: string;
|
|
32
92
|
/**
|
|
33
|
-
*
|
|
93
|
+
* Returns the Amazon Resource Name (ARN) of the specified vector bucket.
|
|
94
|
+
*
|
|
95
|
+
* Example: `arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket`
|
|
34
96
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-vectorbucket.html#cfn-s3vectors-vectorbucket-vectorbucketarn}
|
|
35
97
|
*/
|
|
36
98
|
VectorBucketArn: string;
|
|
37
99
|
};
|
|
38
100
|
/**
|
|
39
|
-
*
|
|
101
|
+
* Specifies the encryption configuration for the vector bucket. By default, all new vectors in Amazon S3 vector buckets use server-side encryption with Amazon S3 managed keys (SSE-S3), specifically AES256.
|
|
40
102
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3vectors-vectorbucket-encryptionconfiguration.html}
|
|
41
103
|
*/
|
|
42
104
|
export type EncryptionConfiguration = {
|
|
43
105
|
/**
|
|
44
|
-
* AWS Key Management Service (KMS) customer managed key
|
|
106
|
+
* AWS Key Management Service (KMS) customer managed key ARN to use for the encryption configuration. This parameter is required if and only if `SseType` is set to `aws:kms` .
|
|
107
|
+
*
|
|
108
|
+
* You must specify the full ARN of the KMS key. Key IDs or key aliases aren't supported.
|
|
109
|
+
*
|
|
110
|
+
* > Amazon S3 Vectors only supports symmetric encryption KMS keys. For more information, see [Asymmetric keys in AWS KMS](https://docs.aws.amazon.com//kms/latest/developerguide/symmetric-asymmetric.html) in the *AWS Key Management Service Developer Guide* .
|
|
45
111
|
* @minLength 1
|
|
46
112
|
* @maxLength 2048
|
|
47
113
|
* @pattern ^(arn:aws[-a-z0-9]*:kms:[-a-z0-9]*:[0-9]{12}:key/.+)$
|
|
@@ -49,7 +115,7 @@ export type EncryptionConfiguration = {
|
|
|
49
115
|
*/
|
|
50
116
|
KmsKeyArn?: string | undefined;
|
|
51
117
|
/**
|
|
52
|
-
* The server-side encryption type to use for the encryption configuration of the vector bucket.
|
|
118
|
+
* The server-side encryption type to use for the encryption configuration of the vector bucket. Valid values are `AES256` for Amazon S3 managed keys and `aws:kms` for AWS KMS keys.
|
|
53
119
|
* @default "AES256"
|
|
54
120
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3vectors-vectorbucket-encryptionconfiguration.html#cfn-s3vectors-vectorbucket-encryptionconfiguration-ssetype}
|
|
55
121
|
*/
|
|
@@ -1,40 +1,98 @@
|
|
|
1
1
|
import type { ResourceDefinition } from "../main.ts";
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* The `AWS::S3Vectors::VectorBucketPolicy` resource defines an Amazon S3 vector bucket policy to control access to an Amazon S3 vector bucket.
|
|
4
|
+
*
|
|
5
|
+
* Vector bucket policies are written in JSON and allow you to grant or deny permissions across all (or a subset of) objects within a vector bucket.
|
|
6
|
+
*
|
|
7
|
+
* You must specify either `VectorBucketName` or `VectorBucketArn` to identify the target bucket.
|
|
8
|
+
*
|
|
9
|
+
* To control how AWS CloudFormation handles the vector bucket policy when the stack is deleted, you can set a deletion policy for your policy. You can choose to *retain* the policy or to *delete* the policy. For more information, see [DeletionPolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) .
|
|
10
|
+
*
|
|
11
|
+
* - **Permissions** - The required permissions for CloudFormation to use are based on the operations that are performed on the stack.
|
|
12
|
+
*
|
|
13
|
+
* - Create
|
|
14
|
+
*
|
|
15
|
+
* - s3vectors:GetVectorBucketPolicy
|
|
16
|
+
* - s3vectors:PutVectorBucketPolicy
|
|
17
|
+
* - Read
|
|
18
|
+
*
|
|
19
|
+
* - s3vectors:GetVectorBucketPolicy
|
|
20
|
+
* - Update
|
|
21
|
+
*
|
|
22
|
+
* - s3vectors:GetVectorBucketPolicy
|
|
23
|
+
* - s3vectors:PutVectorBucketPolicy
|
|
24
|
+
* - Delete
|
|
25
|
+
*
|
|
26
|
+
* - s3vectors:GetVectorBucketPolicy
|
|
27
|
+
* - s3vectors:DeleteVectorBucketPolicy
|
|
28
|
+
* - List
|
|
29
|
+
*
|
|
30
|
+
* - s3vectors:GetVectorBucketPolicy
|
|
31
|
+
* - s3vectors:ListVectorBuckets
|
|
4
32
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-vectorbucketpolicy.html}
|
|
5
33
|
*/
|
|
6
34
|
export type S3VectorsVectorBucketPolicy = ResourceDefinition<"AWS::S3Vectors::VectorBucketPolicy", S3VectorsVectorBucketPolicyProps>;
|
|
7
35
|
/**
|
|
8
|
-
*
|
|
36
|
+
* The `AWS::S3Vectors::VectorBucketPolicy` resource defines an Amazon S3 vector bucket policy to control access to an Amazon S3 vector bucket.
|
|
37
|
+
*
|
|
38
|
+
* Vector bucket policies are written in JSON and allow you to grant or deny permissions across all (or a subset of) objects within a vector bucket.
|
|
39
|
+
*
|
|
40
|
+
* You must specify either `VectorBucketName` or `VectorBucketArn` to identify the target bucket.
|
|
41
|
+
*
|
|
42
|
+
* To control how AWS CloudFormation handles the vector bucket policy when the stack is deleted, you can set a deletion policy for your policy. You can choose to *retain* the policy or to *delete* the policy. For more information, see [DeletionPolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) .
|
|
43
|
+
*
|
|
44
|
+
* - **Permissions** - The required permissions for CloudFormation to use are based on the operations that are performed on the stack.
|
|
45
|
+
*
|
|
46
|
+
* - Create
|
|
47
|
+
*
|
|
48
|
+
* - s3vectors:GetVectorBucketPolicy
|
|
49
|
+
* - s3vectors:PutVectorBucketPolicy
|
|
50
|
+
* - Read
|
|
51
|
+
*
|
|
52
|
+
* - s3vectors:GetVectorBucketPolicy
|
|
53
|
+
* - Update
|
|
54
|
+
*
|
|
55
|
+
* - s3vectors:GetVectorBucketPolicy
|
|
56
|
+
* - s3vectors:PutVectorBucketPolicy
|
|
57
|
+
* - Delete
|
|
58
|
+
*
|
|
59
|
+
* - s3vectors:GetVectorBucketPolicy
|
|
60
|
+
* - s3vectors:DeleteVectorBucketPolicy
|
|
61
|
+
* - List
|
|
62
|
+
*
|
|
63
|
+
* - s3vectors:GetVectorBucketPolicy
|
|
64
|
+
* - s3vectors:ListVectorBuckets
|
|
9
65
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-vectorbucketpolicy.html}
|
|
10
66
|
*/
|
|
11
67
|
export type S3VectorsVectorBucketPolicyProps = {
|
|
12
68
|
/**
|
|
69
|
+
* A policy document containing permissions to add to the specified vector bucket. In IAM , you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM .
|
|
13
70
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-vectorbucketpolicy.html#cfn-s3vectors-vectorbucketpolicy-policy}
|
|
14
71
|
*/
|
|
15
72
|
Policy: Policy;
|
|
16
73
|
/**
|
|
17
|
-
* The Amazon Resource Name (ARN) of the vector bucket.
|
|
74
|
+
* The Amazon Resource Name (ARN) of the S3 vector bucket to which the policy applies.
|
|
18
75
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-vectorbucketpolicy.html#cfn-s3vectors-vectorbucketpolicy-vectorbucketarn}
|
|
19
76
|
*/
|
|
20
77
|
VectorBucketArn?: string | undefined;
|
|
21
78
|
/**
|
|
22
|
-
* The name of the vector bucket
|
|
79
|
+
* The name of the S3 vector bucket to which the policy applies.
|
|
23
80
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-vectorbucketpolicy.html#cfn-s3vectors-vectorbucketpolicy-vectorbucketname}
|
|
24
81
|
*/
|
|
25
82
|
VectorBucketName: string;
|
|
26
83
|
} | {
|
|
27
84
|
/**
|
|
85
|
+
* A policy document containing permissions to add to the specified vector bucket. In IAM , you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM .
|
|
28
86
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-vectorbucketpolicy.html#cfn-s3vectors-vectorbucketpolicy-policy}
|
|
29
87
|
*/
|
|
30
88
|
Policy: Policy;
|
|
31
89
|
/**
|
|
32
|
-
* The Amazon Resource Name (ARN) of the vector bucket.
|
|
90
|
+
* The Amazon Resource Name (ARN) of the S3 vector bucket to which the policy applies.
|
|
33
91
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-vectorbucketpolicy.html#cfn-s3vectors-vectorbucketpolicy-vectorbucketarn}
|
|
34
92
|
*/
|
|
35
93
|
VectorBucketArn: string;
|
|
36
94
|
/**
|
|
37
|
-
* The name of the vector bucket
|
|
95
|
+
* The name of the S3 vector bucket to which the policy applies.
|
|
38
96
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-vectorbucketpolicy.html#cfn-s3vectors-vectorbucketpolicy-vectorbucketname}
|
|
39
97
|
*/
|
|
40
98
|
VectorBucketName?: string | undefined;
|