@horietakehiro/aws-cdk-utul 0.10.2 → 0.11.3
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/lib/stack-manager.d.ts +41 -0
- package/lib/stack-manager.js +132 -0
- package/lib/types/cfn-resource-types/aws-amazonmq-configuration.d.ts +35 -5
- package/lib/types/cfn-resource-types/aws-amazonmq-configuration.js +1 -1
- package/lib/types/cfn-resource-types/aws-apigateway-vpclink.d.ts +0 -9
- package/lib/types/cfn-resource-types/aws-apigateway-vpclink.js +1 -1
- package/lib/types/cfn-resource-types/aws-apigatewayv2-domainname.d.ts +2 -2
- package/lib/types/cfn-resource-types/aws-apigatewayv2-domainname.js +1 -1
- package/lib/types/cfn-resource-types/aws-appconfig-deploymentstrategy.d.ts +56 -8
- package/lib/types/cfn-resource-types/aws-appconfig-deploymentstrategy.js +1 -1
- package/lib/types/cfn-resource-types/aws-appsync-datasource.d.ts +151 -31
- package/lib/types/cfn-resource-types/aws-appsync-datasource.js +1 -1
- package/lib/types/cfn-resource-types/aws-appsync-graphqlapi.d.ts +225 -36
- package/lib/types/cfn-resource-types/aws-appsync-graphqlapi.js +1 -1
- package/lib/types/cfn-resource-types/aws-autoscaling-autoscalinggroup.d.ts +6 -1
- package/lib/types/cfn-resource-types/aws-autoscaling-autoscalinggroup.js +1 -1
- package/lib/types/cfn-resource-types/aws-b2bi-capability.d.ts +2 -0
- package/lib/types/cfn-resource-types/aws-b2bi-capability.js +1 -1
- package/lib/types/cfn-resource-types/aws-b2bi-partnership.d.ts +37 -1
- package/lib/types/cfn-resource-types/aws-b2bi-partnership.js +1 -1
- package/lib/types/cfn-resource-types/aws-b2bi-transformer.d.ts +41 -4
- package/lib/types/cfn-resource-types/aws-b2bi-transformer.js +1 -1
- package/lib/types/cfn-resource-types/aws-backup-logicallyairgappedbackupvault.d.ts +28 -0
- package/lib/types/cfn-resource-types/aws-backup-logicallyairgappedbackupvault.js +3 -0
- package/lib/types/cfn-resource-types/aws-bedrock-agent.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-bedrock-agent.js +1 -1
- package/lib/types/cfn-resource-types/aws-bedrock-flow.d.ts +17 -6
- package/lib/types/cfn-resource-types/aws-bedrock-flow.js +1 -1
- package/lib/types/cfn-resource-types/aws-bedrock-flowversion.d.ts +17 -6
- package/lib/types/cfn-resource-types/aws-bedrock-flowversion.js +1 -1
- package/lib/types/cfn-resource-types/aws-bedrock-prompt.d.ts +3 -7
- package/lib/types/cfn-resource-types/aws-bedrock-prompt.js +1 -1
- package/lib/types/cfn-resource-types/aws-bedrock-promptversion.d.ts +4 -8
- package/lib/types/cfn-resource-types/aws-bedrock-promptversion.js +1 -1
- package/lib/types/cfn-resource-types/aws-cloudformation-customresource.d.ts +2 -1
- package/lib/types/cfn-resource-types/aws-cloudformation-customresource.js +1 -1
- package/lib/types/cfn-resource-types/aws-codepipeline-pipeline.d.ts +23 -2
- package/lib/types/cfn-resource-types/aws-codepipeline-pipeline.js +1 -1
- package/lib/types/cfn-resource-types/aws-cognito-userpool.d.ts +2 -0
- package/lib/types/cfn-resource-types/aws-cognito-userpool.js +1 -1
- package/lib/types/cfn-resource-types/aws-cognito-userpoolidentityprovider.d.ts +15 -8
- package/lib/types/cfn-resource-types/aws-cognito-userpoolidentityprovider.js +1 -1
- package/lib/types/cfn-resource-types/aws-connect-contactflow.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-connect-contactflow.js +1 -1
- package/lib/types/cfn-resource-types/aws-connect-hoursofoperation.d.ts +18 -18
- package/lib/types/cfn-resource-types/aws-connect-hoursofoperation.js +1 -1
- package/lib/types/cfn-resource-types/aws-datasync-task.d.ts +96 -96
- package/lib/types/cfn-resource-types/aws-datasync-task.js +1 -1
- package/lib/types/cfn-resource-types/aws-dms-datamigration.d.ts +90 -0
- package/lib/types/cfn-resource-types/aws-dms-datamigration.js +3 -0
- package/lib/types/cfn-resource-types/aws-dms-replicationinstance.d.ts +1 -0
- package/lib/types/cfn-resource-types/aws-dms-replicationinstance.js +1 -1
- package/lib/types/cfn-resource-types/aws-ec2-capacityreservation.d.ts +1 -0
- package/lib/types/cfn-resource-types/aws-ec2-capacityreservation.js +1 -1
- package/lib/types/cfn-resource-types/aws-ec2-eip.d.ts +2 -0
- package/lib/types/cfn-resource-types/aws-ec2-eip.js +1 -1
- package/lib/types/cfn-resource-types/aws-ec2-natgateway.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-ec2-natgateway.js +1 -1
- package/lib/types/cfn-resource-types/aws-ec2-transitgateway.d.ts +6 -5
- package/lib/types/cfn-resource-types/aws-ec2-transitgateway.js +1 -1
- package/lib/types/cfn-resource-types/aws-ec2-transitgatewayattachment.d.ts +4 -0
- package/lib/types/cfn-resource-types/aws-ec2-transitgatewayattachment.js +1 -1
- package/lib/types/cfn-resource-types/aws-ec2-transitgatewayvpcattachment.d.ts +14 -10
- package/lib/types/cfn-resource-types/aws-ec2-transitgatewayvpcattachment.js +1 -1
- package/lib/types/cfn-resource-types/aws-ec2-vpc.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-ec2-vpc.js +1 -1
- package/lib/types/cfn-resource-types/aws-ec2-vpcendpoint.d.ts +2 -1
- package/lib/types/cfn-resource-types/aws-ec2-vpcendpoint.js +1 -1
- package/lib/types/cfn-resource-types/aws-ec2-vpcendpointconnectionnotification.d.ts +8 -8
- package/lib/types/cfn-resource-types/aws-ec2-vpcendpointconnectionnotification.js +1 -1
- package/lib/types/cfn-resource-types/aws-ec2-vpnconnection.d.ts +213 -3
- package/lib/types/cfn-resource-types/aws-ec2-vpnconnection.js +1 -1
- package/lib/types/cfn-resource-types/aws-ecs-capacityprovider.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-ecs-capacityprovider.js +1 -1
- package/lib/types/cfn-resource-types/aws-ecs-service.d.ts +10 -1
- package/lib/types/cfn-resource-types/aws-ecs-service.js +1 -1
- package/lib/types/cfn-resource-types/aws-ecs-taskset.d.ts +57 -51
- package/lib/types/cfn-resource-types/aws-ecs-taskset.js +1 -1
- package/lib/types/cfn-resource-types/aws-eks-cluster.d.ts +11 -1
- package/lib/types/cfn-resource-types/aws-eks-cluster.js +1 -1
- package/lib/types/cfn-resource-types/aws-elasticache-globalreplicationgroup.d.ts +4 -0
- package/lib/types/cfn-resource-types/aws-elasticache-globalreplicationgroup.js +1 -1
- package/lib/types/cfn-resource-types/aws-elasticloadbalancingv2-listener.d.ts +79 -63
- package/lib/types/cfn-resource-types/aws-elasticloadbalancingv2-listener.js +1 -1
- package/lib/types/cfn-resource-types/aws-elasticloadbalancingv2-listenerrule.d.ts +65 -63
- package/lib/types/cfn-resource-types/aws-elasticloadbalancingv2-listenerrule.js +1 -1
- package/lib/types/cfn-resource-types/aws-emr-cluster.d.ts +35 -14
- package/lib/types/cfn-resource-types/aws-emr-cluster.js +1 -1
- package/lib/types/cfn-resource-types/aws-emr-instancefleetconfig.d.ts +21 -0
- package/lib/types/cfn-resource-types/aws-emr-instancefleetconfig.js +1 -1
- package/lib/types/cfn-resource-types/aws-fis-experimenttemplate.d.ts +81 -81
- package/lib/types/cfn-resource-types/aws-fis-experimenttemplate.js +1 -1
- package/lib/types/cfn-resource-types/aws-gamelift-containergroupdefinition.d.ts +19 -0
- package/lib/types/cfn-resource-types/aws-gamelift-containergroupdefinition.js +1 -1
- package/lib/types/cfn-resource-types/aws-glue-crawler.d.ts +179 -1
- package/lib/types/cfn-resource-types/aws-glue-crawler.js +1 -1
- package/lib/types/cfn-resource-types/aws-glue-job.d.ts +96 -6
- package/lib/types/cfn-resource-types/aws-glue-job.js +1 -1
- package/lib/types/cfn-resource-types/aws-glue-schema.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-glue-schema.js +1 -1
- package/lib/types/cfn-resource-types/aws-glue-usageprofile.d.ts +64 -0
- package/lib/types/cfn-resource-types/aws-glue-usageprofile.js +3 -0
- package/lib/types/cfn-resource-types/aws-iam-policy.d.ts +4 -1
- package/lib/types/cfn-resource-types/aws-iam-policy.js +1 -1
- package/lib/types/cfn-resource-types/aws-iam-role.d.ts +3 -2
- package/lib/types/cfn-resource-types/aws-iam-role.js +1 -1
- package/lib/types/cfn-resource-types/aws-imagebuilder-component.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-imagebuilder-component.js +1 -1
- package/lib/types/cfn-resource-types/aws-imagebuilder-infrastructureconfiguration.d.ts +22 -0
- package/lib/types/cfn-resource-types/aws-imagebuilder-infrastructureconfiguration.js +1 -1
- package/lib/types/cfn-resource-types/aws-iot-domainconfiguration.d.ts +6 -0
- package/lib/types/cfn-resource-types/aws-iot-domainconfiguration.js +1 -1
- package/lib/types/cfn-resource-types/aws-iotevents-alarmmodel.d.ts +195 -79
- package/lib/types/cfn-resource-types/aws-iotevents-alarmmodel.js +1 -1
- package/lib/types/cfn-resource-types/aws-iotevents-detectormodel.d.ts +177 -85
- package/lib/types/cfn-resource-types/aws-iotevents-detectormodel.js +1 -1
- package/lib/types/cfn-resource-types/aws-iotevents-input.d.ts +9 -11
- package/lib/types/cfn-resource-types/aws-iotevents-input.js +1 -1
- package/lib/types/cfn-resource-types/aws-ivs-encoderconfiguration.d.ts +2 -2
- package/lib/types/cfn-resource-types/aws-ivs-encoderconfiguration.js +1 -1
- package/lib/types/cfn-resource-types/aws-kinesis-resourcepolicy.d.ts +17 -0
- package/lib/types/cfn-resource-types/aws-kinesis-resourcepolicy.js +3 -0
- package/lib/types/cfn-resource-types/aws-lakeformation-principalpermissions.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-lakeformation-principalpermissions.js +1 -1
- package/lib/types/cfn-resource-types/aws-lakeformation-tag.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-lakeformation-tag.js +1 -1
- package/lib/types/cfn-resource-types/aws-lambda-eventsourcemapping.d.ts +115 -108
- package/lib/types/cfn-resource-types/aws-lambda-eventsourcemapping.js +1 -1
- package/lib/types/cfn-resource-types/aws-medialive-channel.d.ts +2 -0
- package/lib/types/cfn-resource-types/aws-medialive-channel.js +1 -1
- package/lib/types/cfn-resource-types/aws-memorydb-cluster.d.ts +4 -0
- package/lib/types/cfn-resource-types/aws-memorydb-cluster.js +1 -1
- package/lib/types/cfn-resource-types/aws-networkfirewall-firewallpolicy.d.ts +3 -0
- package/lib/types/cfn-resource-types/aws-networkfirewall-firewallpolicy.js +1 -1
- package/lib/types/cfn-resource-types/aws-organizations-policy.d.ts +2 -2
- package/lib/types/cfn-resource-types/aws-organizations-policy.js +1 -1
- package/lib/types/cfn-resource-types/aws-qbusiness-webexperience.d.ts +6 -0
- package/lib/types/cfn-resource-types/aws-qbusiness-webexperience.js +1 -1
- package/lib/types/cfn-resource-types/aws-quicksight-analysis.d.ts +13 -0
- package/lib/types/cfn-resource-types/aws-quicksight-analysis.js +1 -1
- package/lib/types/cfn-resource-types/aws-quicksight-dashboard.d.ts +13 -0
- package/lib/types/cfn-resource-types/aws-quicksight-dashboard.js +1 -1
- package/lib/types/cfn-resource-types/aws-quicksight-dataset.d.ts +2 -2
- package/lib/types/cfn-resource-types/aws-quicksight-dataset.js +1 -1
- package/lib/types/cfn-resource-types/aws-quicksight-datasource.d.ts +247 -242
- package/lib/types/cfn-resource-types/aws-quicksight-datasource.js +1 -1
- package/lib/types/cfn-resource-types/aws-quicksight-folder.d.ts +79 -0
- package/lib/types/cfn-resource-types/aws-quicksight-folder.js +3 -0
- package/lib/types/cfn-resource-types/aws-quicksight-template.d.ts +8 -0
- package/lib/types/cfn-resource-types/aws-quicksight-template.js +1 -1
- package/lib/types/cfn-resource-types/aws-rds-dbcluster.d.ts +366 -366
- package/lib/types/cfn-resource-types/aws-rds-dbcluster.js +1 -1
- package/lib/types/cfn-resource-types/aws-rds-dbinstance.d.ts +1 -4
- package/lib/types/cfn-resource-types/aws-rds-dbinstance.js +1 -1
- package/lib/types/cfn-resource-types/aws-rds-globalcluster.d.ts +19 -0
- package/lib/types/cfn-resource-types/aws-rds-globalcluster.js +1 -1
- package/lib/types/cfn-resource-types/aws-redshift-integration.d.ts +61 -0
- package/lib/types/cfn-resource-types/aws-redshift-integration.js +3 -0
- package/lib/types/cfn-resource-types/aws-refactorspaces-environment.d.ts +2 -2
- package/lib/types/cfn-resource-types/aws-refactorspaces-environment.js +1 -1
- package/lib/types/cfn-resource-types/aws-route53profiles-profileassociation.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-route53profiles-profileassociation.js +1 -1
- package/lib/types/cfn-resource-types/aws-route53resolver-resolverrule.d.ts +4 -4
- package/lib/types/cfn-resource-types/aws-route53resolver-resolverrule.js +1 -1
- package/lib/types/cfn-resource-types/aws-s3-bucket.d.ts +599 -591
- package/lib/types/cfn-resource-types/aws-s3-bucket.js +1 -1
- package/lib/types/cfn-resource-types/aws-s3express-directorybucket.d.ts +34 -3
- package/lib/types/cfn-resource-types/aws-s3express-directorybucket.js +1 -1
- package/lib/types/cfn-resource-types/aws-sagemaker-domain.d.ts +8 -0
- package/lib/types/cfn-resource-types/aws-sagemaker-domain.js +1 -1
- package/lib/types/cfn-resource-types/aws-sagemaker-endpoint.d.ts +137 -20
- package/lib/types/cfn-resource-types/aws-sagemaker-endpoint.js +1 -1
- package/lib/types/cfn-resource-types/aws-secretsmanager-secret.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-secretsmanager-secret.js +1 -1
- package/lib/types/cfn-resource-types/aws-securityhub-automationrule.d.ts +4 -4
- package/lib/types/cfn-resource-types/aws-securityhub-automationrule.js +1 -1
- package/lib/types/cfn-resource-types/aws-securityhub-findingaggregator.d.ts +2 -2
- package/lib/types/cfn-resource-types/aws-securityhub-findingaggregator.js +1 -1
- package/lib/types/cfn-resource-types/aws-ses-mailmanagerruleset.d.ts +4 -1
- package/lib/types/cfn-resource-types/aws-ses-mailmanagerruleset.js +1 -1
- package/lib/types/cfn-resource-types/aws-sns-topic.d.ts +2 -6
- package/lib/types/cfn-resource-types/aws-sns-topic.js +1 -1
- package/lib/types/cfn-resource-types/aws-sqs-queue.d.ts +12 -12
- package/lib/types/cfn-resource-types/aws-sqs-queue.js +1 -1
- package/lib/types/cfn-resource-types/aws-sqs-queuepolicy.d.ts +1 -3
- package/lib/types/cfn-resource-types/aws-sqs-queuepolicy.js +1 -1
- package/lib/types/cfn-resource-types/aws-ssmquicksetup-configurationmanager.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-ssmquicksetup-configurationmanager.js +1 -1
- package/lib/types/cfn-resource-types/aws-transfer-server.d.ts +70 -36
- package/lib/types/cfn-resource-types/aws-transfer-server.js +1 -1
- package/lib/types/cfn-resource-types/aws-wisdom-aiprompt.d.ts +34 -0
- package/lib/types/cfn-resource-types/aws-wisdom-aiprompt.js +3 -0
- package/lib/types/cfn-resource-types/aws-wisdom-knowledgebase.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-wisdom-knowledgebase.js +1 -1
- package/lib/types/cfn-resource-types/aws-workspacesweb-identityprovider.d.ts +9 -0
- package/lib/types/cfn-resource-types/aws-workspacesweb-identityprovider.js +1 -1
- package/lib/types/cfn-resource-types.d.ts +14 -0
- package/lib/types/cfn-resource-types.js +40 -26
- package/package.json +11 -7
|
@@ -15,12 +15,7 @@ export type TargetObjectKeyFormat = ({
|
|
|
15
15
|
* You can only delete empty buckets. Deletion fails for buckets that have contents.
|
|
16
16
|
*/
|
|
17
17
|
export interface _AWS_S3_BUCKET {
|
|
18
|
-
|
|
19
|
-
* Specifies the inventory configuration for an Amazon S3 bucket. For more information, see [GET Bucket inventory](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html) in the *Amazon S3 API Reference*.
|
|
20
|
-
*/
|
|
21
|
-
InventoryConfigurations?: InventoryConfiguration[];
|
|
22
|
-
WebsiteConfiguration?: WebsiteConfiguration;
|
|
23
|
-
DualStackDomainName?: string;
|
|
18
|
+
AccelerateConfiguration?: AccelerateConfiguration;
|
|
24
19
|
/**
|
|
25
20
|
* This is a legacy property, and it is not recommended for most use cases. A majority of modern use cases in Amazon S3 no longer require the use of ACLs, and we recommend that you keep ACLs disabled. For more information, see [Controlling object ownership](https://docs.aws.amazon.com//AmazonS3/latest/userguide/about-object-ownership.html) in the *Amazon S3 User Guide*.
|
|
26
21
|
* A canned access control list (ACL) that grants predefined permissions to the bucket. For more information about canned ACLs, see [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) in the *Amazon S3 User Guide*.
|
|
@@ -32,355 +27,481 @@ export interface _AWS_S3_BUCKET {
|
|
|
32
27
|
* Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.
|
|
33
28
|
*/
|
|
34
29
|
AnalyticsConfigurations?: AnalyticsConfiguration[];
|
|
35
|
-
|
|
36
|
-
PublicAccessBlockConfiguration?: PublicAccessBlockConfiguration;
|
|
30
|
+
BucketEncryption?: BucketEncryption;
|
|
37
31
|
/**
|
|
38
32
|
* A name for the bucket. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name. The bucket name must contain only lowercase letters, numbers, periods (.), and dashes (-) and must follow [Amazon S3 bucket restrictions and limitations](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html). For more information, see [Rules for naming Amazon S3 buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html#bucketnamingrules) in the *Amazon S3 User Guide*.
|
|
39
33
|
* 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.
|
|
40
34
|
*/
|
|
41
35
|
BucketName?: string;
|
|
42
|
-
|
|
43
|
-
|
|
36
|
+
CorsConfiguration?: CorsConfiguration;
|
|
37
|
+
/**
|
|
38
|
+
* Defines how Amazon S3 handles Intelligent-Tiering storage.
|
|
39
|
+
*/
|
|
40
|
+
IntelligentTieringConfigurations?: IntelligentTieringConfiguration[];
|
|
41
|
+
/**
|
|
42
|
+
* Specifies the inventory configuration for an Amazon S3 bucket. For more information, see [GET Bucket inventory](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html) in the *Amazon S3 API Reference*.
|
|
43
|
+
*/
|
|
44
|
+
InventoryConfigurations?: InventoryConfiguration[];
|
|
45
|
+
LifecycleConfiguration?: LifecycleConfiguration;
|
|
46
|
+
LoggingConfiguration?: LoggingConfiguration;
|
|
47
|
+
/**
|
|
48
|
+
* Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see [PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html).
|
|
49
|
+
*/
|
|
50
|
+
MetricsConfigurations?: MetricsConfiguration[];
|
|
51
|
+
NotificationConfiguration?: NotificationConfiguration;
|
|
44
52
|
ObjectLockConfiguration?: ObjectLockConfiguration;
|
|
45
53
|
/**
|
|
46
54
|
* Indicates whether this bucket has an Object Lock configuration enabled. Enable ``ObjectLockEnabled`` when you apply ``ObjectLockConfiguration`` to a bucket.
|
|
47
55
|
*/
|
|
48
56
|
ObjectLockEnabled?: boolean;
|
|
49
|
-
|
|
57
|
+
OwnershipControls?: OwnershipControls;
|
|
58
|
+
PublicAccessBlockConfiguration?: PublicAccessBlockConfiguration;
|
|
50
59
|
ReplicationConfiguration?: ReplicationConfiguration;
|
|
51
60
|
/**
|
|
52
61
|
* An arbitrary set of tags (key-value pairs) for this S3 bucket.
|
|
53
62
|
*/
|
|
54
63
|
Tags?: Tag[];
|
|
64
|
+
VersioningConfiguration?: VersioningConfiguration;
|
|
65
|
+
WebsiteConfiguration?: WebsiteConfiguration;
|
|
66
|
+
Arn?: string;
|
|
55
67
|
DomainName?: string;
|
|
56
|
-
|
|
68
|
+
DualStackDomainName?: string;
|
|
69
|
+
RegionalDomainName?: string;
|
|
57
70
|
WebsiteURL?: string;
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
*/
|
|
64
|
-
MetricsConfigurations?: MetricsConfiguration[];
|
|
71
|
+
}
|
|
72
|
+
/**
|
|
73
|
+
* Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see [Amazon S3 Transfer Acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) in the *Amazon S3 User Guide*.
|
|
74
|
+
*/
|
|
75
|
+
export interface AccelerateConfiguration {
|
|
65
76
|
/**
|
|
66
|
-
*
|
|
77
|
+
* Specifies the transfer acceleration status of the bucket.
|
|
67
78
|
*/
|
|
68
|
-
|
|
69
|
-
CorsConfiguration?: CorsConfiguration;
|
|
70
|
-
Arn?: string;
|
|
79
|
+
AccelerationStatus: ("Enabled" | "Suspended");
|
|
71
80
|
}
|
|
72
81
|
/**
|
|
73
|
-
* Specifies the
|
|
82
|
+
* Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.
|
|
74
83
|
*/
|
|
75
|
-
export interface
|
|
76
|
-
Destination: Destination;
|
|
84
|
+
export interface AnalyticsConfiguration {
|
|
77
85
|
/**
|
|
78
|
-
*
|
|
86
|
+
* The tags to use when evaluating an analytics filter.
|
|
87
|
+
* The analytics only includes objects that meet the filter's criteria. If no filter is specified, all of the contents of the bucket are included in the analysis.
|
|
79
88
|
*/
|
|
80
|
-
|
|
89
|
+
TagFilters?: TagFilter[];
|
|
90
|
+
StorageClassAnalysis: StorageClassAnalysis;
|
|
81
91
|
/**
|
|
82
|
-
*
|
|
92
|
+
* The ID that identifies the analytics configuration.
|
|
83
93
|
*/
|
|
84
|
-
|
|
94
|
+
Id: string;
|
|
85
95
|
/**
|
|
86
|
-
*
|
|
96
|
+
* The prefix that an object must have to be included in the analytics results.
|
|
87
97
|
*/
|
|
88
|
-
|
|
98
|
+
Prefix?: string;
|
|
99
|
+
}
|
|
100
|
+
/**
|
|
101
|
+
* Specifies tags to use to identify a subset of objects for an Amazon S3 bucket.
|
|
102
|
+
*/
|
|
103
|
+
export interface TagFilter {
|
|
89
104
|
/**
|
|
90
|
-
* The
|
|
105
|
+
* The tag value.
|
|
91
106
|
*/
|
|
92
|
-
|
|
107
|
+
Value: string;
|
|
93
108
|
/**
|
|
94
|
-
*
|
|
109
|
+
* The tag key.
|
|
95
110
|
*/
|
|
96
|
-
|
|
111
|
+
Key: string;
|
|
112
|
+
}
|
|
113
|
+
/**
|
|
114
|
+
* Contains data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes.
|
|
115
|
+
*/
|
|
116
|
+
export interface StorageClassAnalysis {
|
|
117
|
+
DataExport?: DataExport;
|
|
118
|
+
}
|
|
119
|
+
/**
|
|
120
|
+
* Specifies how data related to the storage class analysis for an Amazon S3 bucket should be exported.
|
|
121
|
+
*/
|
|
122
|
+
export interface DataExport {
|
|
123
|
+
Destination: Destination;
|
|
97
124
|
/**
|
|
98
|
-
*
|
|
125
|
+
* The version of the output schema to use when exporting data. Must be ``V_1``.
|
|
99
126
|
*/
|
|
100
|
-
|
|
127
|
+
OutputSchemaVersion: "V_1";
|
|
101
128
|
}
|
|
102
129
|
/**
|
|
103
|
-
*
|
|
130
|
+
* The place to store the data for an analysis.
|
|
104
131
|
*/
|
|
105
132
|
export interface Destination {
|
|
106
133
|
/**
|
|
107
134
|
* The Amazon Resource Name (ARN) of the bucket to which data is exported.
|
|
108
135
|
*/
|
|
109
136
|
BucketArn: string;
|
|
110
|
-
/**
|
|
111
|
-
* Specifies the file format used when exporting data to Amazon S3.
|
|
112
|
-
* *Allowed values*: ``CSV`` | ``ORC`` | ``Parquet``
|
|
113
|
-
*/
|
|
114
|
-
Format: ("CSV" | "ORC" | "Parquet");
|
|
115
137
|
/**
|
|
116
138
|
* The account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data.
|
|
117
139
|
* Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes.
|
|
118
140
|
*/
|
|
119
141
|
BucketAccountId?: string;
|
|
142
|
+
/**
|
|
143
|
+
* Specifies the file format used when exporting data to Amazon S3.
|
|
144
|
+
* *Allowed values*: ``CSV`` | ``ORC`` | ``Parquet``
|
|
145
|
+
*/
|
|
146
|
+
Format: ("CSV" | "ORC" | "Parquet");
|
|
120
147
|
/**
|
|
121
148
|
* The prefix to use when exporting data. The prefix is prepended to all results.
|
|
122
149
|
*/
|
|
123
150
|
Prefix?: string;
|
|
124
151
|
}
|
|
125
152
|
/**
|
|
126
|
-
*
|
|
153
|
+
* Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3), AWS KMS-managed keys (SSE-KMS), or dual-layer server-side encryption with KMS-managed keys (DSSE-KMS). For information about the Amazon S3 default encryption feature, see [Amazon S3 Default Encryption for S3 Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) in the *Amazon S3 User Guide*.
|
|
127
154
|
*/
|
|
128
|
-
export interface
|
|
129
|
-
/**
|
|
130
|
-
* The name of the index document for the website.
|
|
131
|
-
*/
|
|
132
|
-
IndexDocument?: string;
|
|
133
|
-
RedirectAllRequestsTo?: RedirectAllRequestsTo;
|
|
155
|
+
export interface BucketEncryption {
|
|
134
156
|
/**
|
|
135
|
-
*
|
|
157
|
+
* Specifies the default server-side-encryption configuration.
|
|
136
158
|
*/
|
|
137
|
-
|
|
159
|
+
ServerSideEncryptionConfiguration: ServerSideEncryptionRule[];
|
|
160
|
+
}
|
|
161
|
+
/**
|
|
162
|
+
* Specifies the default server-side encryption configuration.
|
|
163
|
+
* + *General purpose buckets* - If you're specifying a customer managed KMS key, we recommend using a fully qualified KMS key ARN. If you use a KMS key alias instead, then KMS resolves the key within the requester’s account. This behavior can result in data that's encrypted with a KMS key that belongs to the requester, and not the bucket owner.
|
|
164
|
+
* + *Directory buckets* - When you specify an [customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) for encryption in your directory bucket, only use the key ID or key ARN. The key alias format of the KMS key isn't supported.
|
|
165
|
+
*/
|
|
166
|
+
export interface ServerSideEncryptionRule {
|
|
138
167
|
/**
|
|
139
|
-
*
|
|
168
|
+
* Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Setting the ``BucketKeyEnabled`` element to ``true`` causes Amazon S3 to use an S3 Bucket Key. By default, S3 Bucket Key is not enabled.
|
|
169
|
+
* For more information, see [Amazon S3 Bucket Keys](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) in the *Amazon S3 User Guide*.
|
|
140
170
|
*/
|
|
141
|
-
|
|
171
|
+
BucketKeyEnabled?: boolean;
|
|
172
|
+
ServerSideEncryptionByDefault?: ServerSideEncryptionByDefault;
|
|
142
173
|
}
|
|
143
174
|
/**
|
|
144
|
-
*
|
|
145
|
-
* If you specify this property, you can't specify any other property.
|
|
175
|
+
* Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied.
|
|
146
176
|
*/
|
|
147
|
-
export interface
|
|
177
|
+
export interface ServerSideEncryptionByDefault {
|
|
148
178
|
/**
|
|
149
|
-
*
|
|
179
|
+
* AWS Key Management Service (KMS) customer managed key ID to use for the default encryption.
|
|
180
|
+
* + *General purpose buckets* - This parameter is allowed if and only if ``SSEAlgorithm`` is set to ``aws:kms`` or ``aws:kms:dsse``.
|
|
181
|
+
* + *Directory buckets* - This parameter is allowed if and only if ``SSEAlgorithm`` is set to ``aws:kms``.
|
|
182
|
+
*
|
|
183
|
+
* You can specify the key ID, key alias, or the Amazon Resource Name (ARN) of the KMS key.
|
|
184
|
+
* + Key ID: ``1234abcd-12ab-34cd-56ef-1234567890ab``
|
|
185
|
+
* + Key ARN: ``arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab``
|
|
186
|
+
* + Key Alias: ``alias/alias-name``
|
|
187
|
+
*
|
|
188
|
+
* If you are using encryption with cross-account or AWS service operations, you must use a fully qualified KMS key ARN. For more information, see [Using encryption for cross-account operations](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html#bucket-encryption-update-bucket-policy).
|
|
189
|
+
* + *General purpose buckets* - If you're specifying a customer managed KMS key, we recommend using a fully qualified KMS key ARN. If you use a KMS key alias instead, then KMS resolves the key within the requester’s account. This behavior can result in data that's encrypted with a KMS key that belongs to the requester, and not the bucket owner. Also, if you use a key ID, you can run into a LogDestination undeliverable error when creating a VPC flow log.
|
|
190
|
+
* + *Directory buckets* - When you specify an [customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) for encryption in your directory bucket, only use the key ID or key ARN. The key alias format of the KMS key isn't supported.
|
|
191
|
+
*
|
|
192
|
+
* Amazon S3 only supports symmetric encryption KMS keys. For more information, see [Asymmetric keys in KMS](https://docs.aws.amazon.com//kms/latest/developerguide/symmetric-asymmetric.html) in the *Key Management Service Developer Guide*.
|
|
150
193
|
*/
|
|
151
|
-
|
|
194
|
+
KMSMasterKeyID?: string;
|
|
152
195
|
/**
|
|
153
|
-
*
|
|
196
|
+
* Server-side encryption algorithm to use for the default encryption.
|
|
197
|
+
* For directory buckets, there are only two supported values for server-side encryption: ``AES256`` and ``aws:kms``.
|
|
154
198
|
*/
|
|
155
|
-
|
|
199
|
+
SSEAlgorithm: ("aws:kms" | "AES256" | "aws:kms:dsse");
|
|
156
200
|
}
|
|
157
201
|
/**
|
|
158
|
-
*
|
|
202
|
+
* Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see [Enabling Cross-Origin Resource Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the *Amazon S3 User Guide*.
|
|
159
203
|
*/
|
|
160
|
-
export interface
|
|
161
|
-
|
|
162
|
-
|
|
204
|
+
export interface CorsConfiguration {
|
|
205
|
+
/**
|
|
206
|
+
* A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the configuration.
|
|
207
|
+
*/
|
|
208
|
+
CorsRules: CorsRule[];
|
|
163
209
|
}
|
|
164
210
|
/**
|
|
165
|
-
*
|
|
211
|
+
* Specifies a cross-origin access rule for an Amazon S3 bucket.
|
|
166
212
|
*/
|
|
167
|
-
export interface
|
|
213
|
+
export interface CorsRule {
|
|
168
214
|
/**
|
|
169
|
-
*
|
|
170
|
-
* Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).
|
|
215
|
+
* Headers that are specified in the ``Access-Control-Request-Headers`` header. These headers are allowed in a preflight OPTIONS request. In response to any preflight OPTIONS request, Amazon S3 returns any requested headers that are allowed.
|
|
171
216
|
*/
|
|
172
|
-
|
|
217
|
+
AllowedHeaders?: string[];
|
|
173
218
|
/**
|
|
174
|
-
*
|
|
219
|
+
* An HTTP method that you allow the origin to run.
|
|
220
|
+
* *Allowed values*: ``GET`` | ``PUT`` | ``HEAD`` | ``POST`` | ``DELETE``
|
|
175
221
|
*/
|
|
176
|
-
|
|
222
|
+
AllowedMethods: ("GET" | "PUT" | "HEAD" | "POST" | "DELETE")[];
|
|
177
223
|
/**
|
|
178
|
-
*
|
|
224
|
+
* One or more origins you want customers to be able to access the bucket from.
|
|
179
225
|
*/
|
|
180
|
-
|
|
226
|
+
AllowedOrigins: string[];
|
|
181
227
|
/**
|
|
182
|
-
*
|
|
228
|
+
* One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript ``XMLHttpRequest`` object).
|
|
183
229
|
*/
|
|
184
|
-
|
|
230
|
+
ExposedHeaders?: string[];
|
|
185
231
|
/**
|
|
186
|
-
*
|
|
187
|
-
* Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).
|
|
232
|
+
* A unique identifier for this rule. The value must be no more than 255 characters.
|
|
188
233
|
*/
|
|
189
|
-
|
|
234
|
+
Id?: string;
|
|
235
|
+
/**
|
|
236
|
+
* The time in seconds that your browser is to cache the preflight response for the specified resource.
|
|
237
|
+
*/
|
|
238
|
+
MaxAge?: number;
|
|
190
239
|
}
|
|
191
240
|
/**
|
|
192
|
-
*
|
|
241
|
+
* Specifies the S3 Intelligent-Tiering configuration for an Amazon S3 bucket.
|
|
242
|
+
* For information about the S3 Intelligent-Tiering storage class, see [Storage class for automatically optimizing frequently and infrequently accessed objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access).
|
|
193
243
|
*/
|
|
194
|
-
export interface
|
|
244
|
+
export interface IntelligentTieringConfiguration {
|
|
195
245
|
/**
|
|
196
|
-
* The
|
|
197
|
-
* Required when the parent element ``Condition`` is specified and sibling ``HttpErrorCodeReturnedEquals`` is not specified. If both conditions are specified, both must be true for the redirect to be applied.
|
|
246
|
+
* The ID used to identify the S3 Intelligent-Tiering configuration.
|
|
198
247
|
*/
|
|
199
|
-
|
|
248
|
+
Id: string;
|
|
200
249
|
/**
|
|
201
|
-
*
|
|
202
|
-
* Required when parent element ``Condition`` is specified and sibling ``KeyPrefixEquals`` is not specified. If both are specified, then both must be true for the redirect to be applied.
|
|
250
|
+
* An object key name prefix that identifies the subset of objects to which the rule applies.
|
|
203
251
|
*/
|
|
204
|
-
|
|
205
|
-
}
|
|
206
|
-
/**
|
|
207
|
-
* Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.
|
|
208
|
-
*/
|
|
209
|
-
export interface AnalyticsConfiguration {
|
|
210
|
-
StorageClassAnalysis: StorageClassAnalysis;
|
|
252
|
+
Prefix?: string;
|
|
211
253
|
/**
|
|
212
|
-
*
|
|
213
|
-
* The analytics only includes objects that meet the filter's criteria. If no filter is specified, all of the contents of the bucket are included in the analysis.
|
|
254
|
+
* Specifies the status of the configuration.
|
|
214
255
|
*/
|
|
215
|
-
|
|
256
|
+
Status: ("Disabled" | "Enabled");
|
|
216
257
|
/**
|
|
217
|
-
*
|
|
258
|
+
* A container for a key-value pair.
|
|
218
259
|
*/
|
|
219
|
-
|
|
260
|
+
TagFilters?: TagFilter[];
|
|
220
261
|
/**
|
|
221
|
-
*
|
|
262
|
+
* Specifies a list of S3 Intelligent-Tiering storage class tiers in the configuration. At least one tier must be defined in the list. At most, you can specify two tiers in the list, one for each available AccessTier: ``ARCHIVE_ACCESS`` and ``DEEP_ARCHIVE_ACCESS``.
|
|
263
|
+
* You only need Intelligent Tiering Configuration enabled on a bucket if you want to automatically move objects stored in the Intelligent-Tiering storage class to Archive Access or Deep Archive Access tiers.
|
|
222
264
|
*/
|
|
223
|
-
|
|
265
|
+
Tierings: Tiering[];
|
|
224
266
|
}
|
|
225
267
|
/**
|
|
226
|
-
*
|
|
268
|
+
* The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead.
|
|
227
269
|
*/
|
|
228
|
-
export interface
|
|
229
|
-
|
|
270
|
+
export interface Tiering {
|
|
271
|
+
/**
|
|
272
|
+
* S3 Intelligent-Tiering access tier. See [Storage class for automatically optimizing frequently and infrequently accessed objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access) for a list of access tiers in the S3 Intelligent-Tiering storage class.
|
|
273
|
+
*/
|
|
274
|
+
AccessTier: ("ARCHIVE_ACCESS" | "DEEP_ARCHIVE_ACCESS");
|
|
275
|
+
/**
|
|
276
|
+
* The number of consecutive days of no access after which an object will be eligible to be transitioned to the corresponding tier. The minimum number of days specified for Archive Access tier must be at least 90 days and Deep Archive Access tier must be at least 180 days. The maximum can be up to 2 years (730 days).
|
|
277
|
+
*/
|
|
278
|
+
Days: number;
|
|
230
279
|
}
|
|
231
280
|
/**
|
|
232
|
-
* Specifies
|
|
281
|
+
* Specifies the inventory configuration for an Amazon S3 bucket. For more information, see [GET Bucket inventory](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html) in the *Amazon S3 API Reference*.
|
|
233
282
|
*/
|
|
234
|
-
export interface
|
|
283
|
+
export interface InventoryConfiguration {
|
|
235
284
|
Destination: Destination1;
|
|
236
285
|
/**
|
|
237
|
-
*
|
|
286
|
+
* Specifies whether the inventory is enabled or disabled. If set to ``True``, an inventory list is generated. If set to ``False``, no inventory list is generated.
|
|
238
287
|
*/
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
288
|
+
Enabled: boolean;
|
|
289
|
+
/**
|
|
290
|
+
* The ID used to identify the inventory configuration.
|
|
291
|
+
*/
|
|
292
|
+
Id: string;
|
|
293
|
+
/**
|
|
294
|
+
* Object versions to include in the inventory list. If set to ``All``, the list includes all the object versions, which adds the version-related fields ``VersionId``, ``IsLatest``, and ``DeleteMarker`` to the list. If set to ``Current``, the list does not contain these version-related fields.
|
|
295
|
+
*/
|
|
296
|
+
IncludedObjectVersions: ("All" | "Current");
|
|
297
|
+
/**
|
|
298
|
+
* Contains the optional fields that are included in the inventory results.
|
|
299
|
+
*/
|
|
300
|
+
OptionalFields?: ("Size" | "LastModifiedDate" | "StorageClass" | "ETag" | "IsMultipartUploaded" | "ReplicationStatus" | "EncryptionStatus" | "ObjectLockRetainUntilDate" | "ObjectLockMode" | "ObjectLockLegalHoldStatus" | "IntelligentTieringAccessTier" | "BucketKeyStatus" | "ChecksumAlgorithm" | "ObjectAccessControlList" | "ObjectOwner")[];
|
|
301
|
+
/**
|
|
302
|
+
* Specifies the inventory filter prefix.
|
|
303
|
+
*/
|
|
304
|
+
Prefix?: string;
|
|
305
|
+
/**
|
|
306
|
+
* Specifies the schedule for generating inventory results.
|
|
307
|
+
*/
|
|
308
|
+
ScheduleFrequency: ("Daily" | "Weekly");
|
|
309
|
+
}
|
|
310
|
+
/**
|
|
311
|
+
* Contains information about where to publish the inventory results.
|
|
243
312
|
*/
|
|
244
313
|
export interface Destination1 {
|
|
245
314
|
/**
|
|
246
315
|
* The Amazon Resource Name (ARN) of the bucket to which data is exported.
|
|
247
316
|
*/
|
|
248
317
|
BucketArn: string;
|
|
249
|
-
/**
|
|
250
|
-
* Specifies the file format used when exporting data to Amazon S3.
|
|
251
|
-
* *Allowed values*: ``CSV`` | ``ORC`` | ``Parquet``
|
|
252
|
-
*/
|
|
253
|
-
Format: ("CSV" | "ORC" | "Parquet");
|
|
254
318
|
/**
|
|
255
319
|
* The account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data.
|
|
256
320
|
* Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes.
|
|
257
321
|
*/
|
|
258
322
|
BucketAccountId?: string;
|
|
323
|
+
/**
|
|
324
|
+
* Specifies the file format used when exporting data to Amazon S3.
|
|
325
|
+
* *Allowed values*: ``CSV`` | ``ORC`` | ``Parquet``
|
|
326
|
+
*/
|
|
327
|
+
Format: ("CSV" | "ORC" | "Parquet");
|
|
259
328
|
/**
|
|
260
329
|
* The prefix to use when exporting data. The prefix is prepended to all results.
|
|
261
330
|
*/
|
|
262
331
|
Prefix?: string;
|
|
263
332
|
}
|
|
264
333
|
/**
|
|
265
|
-
* Specifies
|
|
334
|
+
* Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in the *Amazon S3 User Guide*.
|
|
266
335
|
*/
|
|
267
|
-
export interface
|
|
268
|
-
/**
|
|
269
|
-
* The tag value.
|
|
270
|
-
*/
|
|
271
|
-
Value: string;
|
|
336
|
+
export interface LifecycleConfiguration {
|
|
272
337
|
/**
|
|
273
|
-
*
|
|
338
|
+
* A lifecycle rule for individual objects in an Amazon S3 bucket.
|
|
274
339
|
*/
|
|
275
|
-
|
|
340
|
+
Rules: Rule[];
|
|
341
|
+
TransitionDefaultMinimumObjectSize?: ("varies_by_storage_class" | "all_storage_classes_128K");
|
|
276
342
|
}
|
|
277
343
|
/**
|
|
278
|
-
*
|
|
344
|
+
* Specifies lifecycle rules for an Amazon S3 bucket. For more information, see [Put Bucket Lifecycle Configuration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.html) in the *Amazon S3 API Reference*.
|
|
345
|
+
* You must specify at least one of the following properties: ``AbortIncompleteMultipartUpload``, ``ExpirationDate``, ``ExpirationInDays``, ``NoncurrentVersionExpirationInDays``, ``NoncurrentVersionTransition``, ``NoncurrentVersionTransitions``, ``Transition``, or ``Transitions``.
|
|
279
346
|
*/
|
|
280
|
-
export interface
|
|
347
|
+
export interface Rule {
|
|
348
|
+
AbortIncompleteMultipartUpload?: AbortIncompleteMultipartUpload;
|
|
281
349
|
/**
|
|
282
|
-
*
|
|
350
|
+
* Indicates when objects are deleted from Amazon S3 and Amazon S3 Glacier. The date value must be in ISO 8601 format. The time is always midnight UTC. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time.
|
|
283
351
|
*/
|
|
284
|
-
|
|
285
|
-
}
|
|
286
|
-
/**
|
|
287
|
-
* Configuration that defines how Amazon S3 handles public access.
|
|
288
|
-
*/
|
|
289
|
-
export interface PublicAccessBlockConfiguration {
|
|
352
|
+
ExpirationDate?: string;
|
|
290
353
|
/**
|
|
291
|
-
*
|
|
292
|
-
* Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.
|
|
354
|
+
* Indicates the number of days after creation when objects are deleted from Amazon S3 and Amazon S3 Glacier. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time.
|
|
293
355
|
*/
|
|
294
|
-
|
|
356
|
+
ExpirationInDays?: number;
|
|
295
357
|
/**
|
|
296
|
-
*
|
|
297
|
-
* Enabling this setting doesn't affect existing bucket policies.
|
|
358
|
+
* Indicates whether Amazon S3 will remove a delete marker without any noncurrent versions. If set to true, the delete marker will be removed if there are no noncurrent versions. This cannot be specified with ``ExpirationInDays``, ``ExpirationDate``, or ``TagFilters``.
|
|
298
359
|
*/
|
|
299
|
-
|
|
360
|
+
ExpiredObjectDeleteMarker?: boolean;
|
|
300
361
|
/**
|
|
301
|
-
*
|
|
302
|
-
* + PUT Bucket ACL and PUT Object ACL calls fail if the specified ACL is public.
|
|
303
|
-
* + PUT Object calls fail if the request includes a public ACL.
|
|
304
|
-
* + PUT Bucket calls fail if the request includes a public ACL.
|
|
305
|
-
*
|
|
306
|
-
* Enabling this setting doesn't affect existing policies or ACLs.
|
|
362
|
+
* Unique identifier for the rule. The value can't be longer than 255 characters.
|
|
307
363
|
*/
|
|
308
|
-
|
|
364
|
+
Id?: string;
|
|
309
365
|
/**
|
|
310
|
-
*
|
|
311
|
-
* Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.
|
|
366
|
+
* (Deprecated.) For buckets with versioning enabled (or suspended), specifies the time, in days, between when a new version of the object is uploaded to the bucket and when old versions of the object expire. When object versions expire, Amazon S3 permanently deletes them. If you specify a transition and expiration time, the expiration time must be later than the transition time.
|
|
312
367
|
*/
|
|
313
|
-
|
|
368
|
+
NoncurrentVersionExpirationInDays?: number;
|
|
369
|
+
NoncurrentVersionExpiration?: NoncurrentVersionExpiration;
|
|
370
|
+
NoncurrentVersionTransition?: NoncurrentVersionTransition;
|
|
371
|
+
/**
|
|
372
|
+
* For buckets with versioning enabled (or suspended), one or more transition rules that specify when non-current objects transition to a specified storage class. If you specify a transition and expiration time, the expiration time must be later than the transition time. If you specify this property, don't specify the ``NoncurrentVersionTransition`` property.
|
|
373
|
+
*/
|
|
374
|
+
NoncurrentVersionTransitions?: NoncurrentVersionTransition1[];
|
|
375
|
+
/**
|
|
376
|
+
* Object key prefix that identifies one or more objects to which this rule applies.
|
|
377
|
+
* Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).
|
|
378
|
+
*/
|
|
379
|
+
Prefix?: string;
|
|
380
|
+
/**
|
|
381
|
+
* If ``Enabled``, the rule is currently being applied. If ``Disabled``, the rule is not currently being applied.
|
|
382
|
+
*/
|
|
383
|
+
Status: ("Enabled" | "Disabled");
|
|
384
|
+
/**
|
|
385
|
+
* Tags to use to identify a subset of objects to which the lifecycle rule applies.
|
|
386
|
+
*/
|
|
387
|
+
TagFilters?: TagFilter[];
|
|
388
|
+
/**
|
|
389
|
+
* Specifies the minimum object size in bytes for this rule to apply to. Objects must be larger than this value in bytes. For more information about size based rules, see [Lifecycle configuration using size-based rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-configuration-examples.html#lc-size-rules) in the *Amazon S3 User Guide*.
|
|
390
|
+
*/
|
|
391
|
+
ObjectSizeGreaterThan?: string;
|
|
392
|
+
/**
|
|
393
|
+
* Specifies the maximum object size in bytes for this rule to apply to. Objects must be smaller than this value in bytes. For more information about sized based rules, see [Lifecycle configuration using size-based rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-configuration-examples.html#lc-size-rules) in the *Amazon S3 User Guide*.
|
|
394
|
+
*/
|
|
395
|
+
ObjectSizeLessThan?: string;
|
|
396
|
+
Transition?: Transition;
|
|
397
|
+
/**
|
|
398
|
+
* One or more transition rules that specify when an object transitions to a specified storage class. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. If you specify this property, don't specify the ``Transition`` property.
|
|
399
|
+
*/
|
|
400
|
+
Transitions?: Transition1[];
|
|
314
401
|
}
|
|
315
402
|
/**
|
|
316
|
-
*
|
|
403
|
+
* Specifies a lifecycle rule that stops incomplete multipart uploads to an Amazon S3 bucket.
|
|
317
404
|
*/
|
|
318
|
-
export interface
|
|
405
|
+
export interface AbortIncompleteMultipartUpload {
|
|
319
406
|
/**
|
|
320
|
-
* Specifies the
|
|
407
|
+
* Specifies the number of days after which Amazon S3 stops an incomplete multipart upload.
|
|
321
408
|
*/
|
|
322
|
-
|
|
409
|
+
DaysAfterInitiation: number;
|
|
323
410
|
}
|
|
324
411
|
/**
|
|
325
|
-
* Specifies
|
|
326
|
-
* S3 Object Ownership is an Amazon S3 bucket-level setting that you can use to disable access control lists (ACLs) and take ownership of every object in your bucket, simplifying access management for data stored in Amazon S3. For more information, see [Controlling ownership of objects and disabling ACLs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) in the *Amazon S3 User Guide*.
|
|
412
|
+
* Specifies when noncurrent object versions expire. Upon expiration, S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that S3 delete noncurrent object versions at a specific period in the object's lifetime.
|
|
327
413
|
*/
|
|
328
|
-
export interface
|
|
414
|
+
export interface NoncurrentVersionExpiration {
|
|
329
415
|
/**
|
|
330
|
-
* Specifies an object
|
|
416
|
+
* Specifies the number of days an object is noncurrent before S3 can perform the associated action. For information about the noncurrent days calculations, see [How Amazon S3 Calculates When an Object Became Noncurrent](https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations) in the *Amazon S3 User Guide*.
|
|
331
417
|
*/
|
|
332
|
-
|
|
418
|
+
NoncurrentDays: number;
|
|
419
|
+
/**
|
|
420
|
+
* Specifies how many noncurrent versions S3 will retain. If there are this many more recent noncurrent versions, S3 will take the associated action. For more information about noncurrent versions, see [Lifecycle configuration elements](https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html) in the *Amazon S3 User Guide*.
|
|
421
|
+
*/
|
|
422
|
+
NewerNoncurrentVersions?: number;
|
|
333
423
|
}
|
|
334
424
|
/**
|
|
335
|
-
*
|
|
336
|
-
* Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see [Locking Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html).
|
|
337
|
-
* + The ``DefaultRetention`` settings require both a mode and a period.
|
|
338
|
-
* + The ``DefaultRetention`` period can be either ``Days`` or ``Years`` but you must select one. You cannot specify ``Days`` and ``Years`` at the same time.
|
|
339
|
-
* + You can enable Object Lock for new or existing buckets. For more information, see [Configuring Object Lock](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-configure.html).
|
|
425
|
+
* (Deprecated.) For buckets with versioning enabled (or suspended), specifies when non-current objects transition to a specified storage class. If you specify a transition and expiration time, the expiration time must be later than the transition time. If you specify this property, don't specify the ``NoncurrentVersionTransitions`` property.
|
|
340
426
|
*/
|
|
341
|
-
export interface
|
|
427
|
+
export interface NoncurrentVersionTransition {
|
|
342
428
|
/**
|
|
343
|
-
*
|
|
429
|
+
* The class of storage used to store the object.
|
|
344
430
|
*/
|
|
345
|
-
|
|
346
|
-
|
|
431
|
+
StorageClass: ("DEEP_ARCHIVE" | "GLACIER" | "Glacier" | "GLACIER_IR" | "INTELLIGENT_TIERING" | "ONEZONE_IA" | "STANDARD_IA");
|
|
432
|
+
/**
|
|
433
|
+
* Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see [How Amazon S3 Calculates How Long an Object Has Been Noncurrent](https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations) in the *Amazon S3 User Guide*.
|
|
434
|
+
*/
|
|
435
|
+
TransitionInDays: number;
|
|
436
|
+
/**
|
|
437
|
+
* Specifies how many noncurrent versions S3 will retain. If there are this many more recent noncurrent versions, S3 will take the associated action. For more information about noncurrent versions, see [Lifecycle configuration elements](https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html) in the *Amazon S3 User Guide*.
|
|
438
|
+
*/
|
|
439
|
+
NewerNoncurrentVersions?: number;
|
|
347
440
|
}
|
|
348
441
|
/**
|
|
349
|
-
*
|
|
442
|
+
* Container for the transition rule that describes when noncurrent objects transition to the ``STANDARD_IA``, ``ONEZONE_IA``, ``INTELLIGENT_TIERING``, ``GLACIER_IR``, ``GLACIER``, or ``DEEP_ARCHIVE`` storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the ``STANDARD_IA``, ``ONEZONE_IA``, ``INTELLIGENT_TIERING``, ``GLACIER_IR``, ``GLACIER``, or ``DEEP_ARCHIVE`` storage class at a specific period in the object's lifetime. If you specify this property, don't specify the ``NoncurrentVersionTransitions`` property.
|
|
350
443
|
*/
|
|
351
|
-
export interface
|
|
352
|
-
|
|
444
|
+
export interface NoncurrentVersionTransition1 {
|
|
445
|
+
/**
|
|
446
|
+
* The class of storage used to store the object.
|
|
447
|
+
*/
|
|
448
|
+
StorageClass: ("DEEP_ARCHIVE" | "GLACIER" | "Glacier" | "GLACIER_IR" | "INTELLIGENT_TIERING" | "ONEZONE_IA" | "STANDARD_IA");
|
|
449
|
+
/**
|
|
450
|
+
* Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see [How Amazon S3 Calculates How Long an Object Has Been Noncurrent](https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations) in the *Amazon S3 User Guide*.
|
|
451
|
+
*/
|
|
452
|
+
TransitionInDays: number;
|
|
453
|
+
/**
|
|
454
|
+
* Specifies how many noncurrent versions S3 will retain. If there are this many more recent noncurrent versions, S3 will take the associated action. For more information about noncurrent versions, see [Lifecycle configuration elements](https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html) in the *Amazon S3 User Guide*.
|
|
455
|
+
*/
|
|
456
|
+
NewerNoncurrentVersions?: number;
|
|
353
457
|
}
|
|
354
458
|
/**
|
|
355
|
-
*
|
|
459
|
+
* (Deprecated.) Specifies when an object transitions to a specified storage class. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. If you specify this property, don't specify the ``Transitions`` property.
|
|
356
460
|
*/
|
|
357
|
-
export interface
|
|
461
|
+
export interface Transition {
|
|
358
462
|
/**
|
|
359
|
-
* The
|
|
463
|
+
* The storage class to which you want the object to transition.
|
|
360
464
|
*/
|
|
361
|
-
|
|
465
|
+
StorageClass: ("DEEP_ARCHIVE" | "GLACIER" | "Glacier" | "GLACIER_IR" | "INTELLIGENT_TIERING" | "ONEZONE_IA" | "STANDARD_IA");
|
|
362
466
|
/**
|
|
363
|
-
*
|
|
467
|
+
* Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC.
|
|
364
468
|
*/
|
|
365
|
-
|
|
469
|
+
TransitionDate?: string;
|
|
366
470
|
/**
|
|
367
|
-
*
|
|
471
|
+
* Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer.
|
|
368
472
|
*/
|
|
369
|
-
|
|
473
|
+
TransitionInDays?: number;
|
|
370
474
|
}
|
|
371
475
|
/**
|
|
372
|
-
*
|
|
476
|
+
* Specifies when an object transitions to a specified storage class. For more information about Amazon S3 lifecycle configuration rules, see [Transitioning Objects Using Amazon S3 Lifecycle](https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-transition-general-considerations.html) in the *Amazon S3 User Guide*.
|
|
373
477
|
*/
|
|
374
|
-
export interface
|
|
375
|
-
TargetObjectKeyFormat?: TargetObjectKeyFormat;
|
|
478
|
+
export interface Transition1 {
|
|
376
479
|
/**
|
|
377
|
-
*
|
|
480
|
+
* The storage class to which you want the object to transition.
|
|
378
481
|
*/
|
|
379
|
-
|
|
482
|
+
StorageClass: ("DEEP_ARCHIVE" | "GLACIER" | "Glacier" | "GLACIER_IR" | "INTELLIGENT_TIERING" | "ONEZONE_IA" | "STANDARD_IA");
|
|
483
|
+
/**
|
|
484
|
+
* Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC.
|
|
485
|
+
*/
|
|
486
|
+
TransitionDate?: string;
|
|
487
|
+
/**
|
|
488
|
+
* Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer.
|
|
489
|
+
*/
|
|
490
|
+
TransitionInDays?: number;
|
|
491
|
+
}
|
|
492
|
+
/**
|
|
493
|
+
* Settings that define where logs are stored.
|
|
494
|
+
*/
|
|
495
|
+
export interface LoggingConfiguration {
|
|
380
496
|
/**
|
|
381
497
|
* The name of the bucket where Amazon S3 should store server access log files. You can store log files in any bucket that you own. By default, logs are stored in the bucket where the ``LoggingConfiguration`` property is defined.
|
|
382
498
|
*/
|
|
383
499
|
DestinationBucketName?: string;
|
|
500
|
+
/**
|
|
501
|
+
* A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a single bucket, you can use a prefix to distinguish which log files came from which bucket.
|
|
502
|
+
*/
|
|
503
|
+
LogFilePrefix?: string;
|
|
504
|
+
TargetObjectKeyFormat?: TargetObjectKeyFormat;
|
|
384
505
|
}
|
|
385
506
|
/**
|
|
386
507
|
* Amazon S3 keys for log objects are partitioned in the following format:
|
|
@@ -396,526 +517,432 @@ export interface PartitionedPrefix {
|
|
|
396
517
|
PartitionDateSource?: ("EventTime" | "DeliveryTime");
|
|
397
518
|
}
|
|
398
519
|
/**
|
|
399
|
-
*
|
|
400
|
-
* Amazon S3 can store replicated objects in a single destination bucket or multiple destination buckets. The destination bucket or buckets must already exist.
|
|
520
|
+
* Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For examples, see [AWS::S3::Bucket](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#aws-properties-s3-bucket--examples). For more information, see [PUT Bucket metrics](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html) in the *Amazon S3 API Reference*.
|
|
401
521
|
*/
|
|
402
|
-
export interface
|
|
522
|
+
export interface MetricsConfiguration {
|
|
403
523
|
/**
|
|
404
|
-
* The
|
|
524
|
+
* The access point that was used while performing operations on the object. The metrics configuration only includes objects that meet the filter's criteria.
|
|
405
525
|
*/
|
|
406
|
-
|
|
526
|
+
AccessPointArn?: string;
|
|
407
527
|
/**
|
|
408
|
-
*
|
|
528
|
+
* The ID used to identify the metrics configuration. This can be any value you choose that helps you identify your metrics configuration.
|
|
409
529
|
*/
|
|
410
|
-
|
|
530
|
+
Id: string;
|
|
531
|
+
/**
|
|
532
|
+
* The prefix that an object must have to be included in the metrics results.
|
|
533
|
+
*/
|
|
534
|
+
Prefix?: string;
|
|
535
|
+
/**
|
|
536
|
+
* Specifies a list of tag filters to use as a metrics configuration filter. The metrics configuration includes only objects that meet the filter's criteria.
|
|
537
|
+
*/
|
|
538
|
+
TagFilters?: TagFilter[];
|
|
411
539
|
}
|
|
412
540
|
/**
|
|
413
|
-
*
|
|
541
|
+
* Configuration that defines how Amazon S3 handles bucket notifications.
|
|
414
542
|
*/
|
|
415
|
-
export interface
|
|
543
|
+
export interface NotificationConfiguration {
|
|
544
|
+
EventBridgeConfiguration?: EventBridgeConfiguration;
|
|
416
545
|
/**
|
|
417
|
-
*
|
|
546
|
+
* Describes the LAMlong functions to invoke and the events for which to invoke them.
|
|
418
547
|
*/
|
|
419
|
-
|
|
420
|
-
Destination: ReplicationDestination;
|
|
421
|
-
Filter?: ReplicationRuleFilter;
|
|
548
|
+
LambdaConfigurations?: LambdaConfiguration[];
|
|
422
549
|
/**
|
|
423
|
-
* The
|
|
424
|
-
* For more information, see [Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) in the *Amazon S3 User Guide*.
|
|
550
|
+
* The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages.
|
|
425
551
|
*/
|
|
426
|
-
|
|
427
|
-
SourceSelectionCriteria?: SourceSelectionCriteria;
|
|
552
|
+
QueueConfigurations?: QueueConfiguration[];
|
|
428
553
|
/**
|
|
429
|
-
*
|
|
554
|
+
* The topic to which notifications are sent and the events for which notifications are generated.
|
|
430
555
|
*/
|
|
431
|
-
|
|
432
|
-
/**
|
|
433
|
-
* An object key name prefix that identifies the object or objects to which the rule applies. The maximum prefix length is 1,024 characters. To include all objects in a bucket, specify an empty string. To filter using a V1 replication configuration, add the ``Prefix`` directly as a child element of the ``Rule`` element.
|
|
434
|
-
* Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).
|
|
435
|
-
*/
|
|
436
|
-
Prefix?: string;
|
|
437
|
-
DeleteMarkerReplication?: DeleteMarkerReplication;
|
|
556
|
+
TopicConfigurations?: TopicConfiguration[];
|
|
438
557
|
}
|
|
439
558
|
/**
|
|
440
|
-
*
|
|
559
|
+
* Enables delivery of events to Amazon EventBridge.
|
|
441
560
|
*/
|
|
442
|
-
export interface
|
|
443
|
-
AccessControlTranslation?: AccessControlTranslation;
|
|
444
|
-
/**
|
|
445
|
-
* Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to change replica ownership to the AWS-account that owns the destination bucket by specifying the ``AccessControlTranslation`` property, this is the account ID of the destination bucket owner. For more information, see [Cross-Region Replication Additional Configuration: Change Replica Owner](https://docs.aws.amazon.com/AmazonS3/latest/dev/crr-change-owner.html) in the *Amazon S3 User Guide*.
|
|
446
|
-
* If you specify the ``AccessControlTranslation`` property, the ``Account`` property is required.
|
|
447
|
-
*/
|
|
448
|
-
Account?: string;
|
|
449
|
-
Metrics?: Metrics;
|
|
450
|
-
/**
|
|
451
|
-
* The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the results.
|
|
452
|
-
*/
|
|
453
|
-
Bucket: string;
|
|
454
|
-
EncryptionConfiguration?: EncryptionConfiguration;
|
|
561
|
+
export interface EventBridgeConfiguration {
|
|
455
562
|
/**
|
|
456
|
-
*
|
|
457
|
-
* For valid values, see the ``StorageClass`` element of the [PUT Bucket replication](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html) action in the *Amazon S3 API Reference*.
|
|
563
|
+
* Enables delivery of events to Amazon EventBridge.
|
|
458
564
|
*/
|
|
459
|
-
|
|
460
|
-
ReplicationTime?: ReplicationTime;
|
|
565
|
+
EventBridgeEnabled: (boolean & string);
|
|
461
566
|
}
|
|
462
567
|
/**
|
|
463
|
-
*
|
|
568
|
+
* Describes the LAMlong functions to invoke and the events for which to invoke them.
|
|
464
569
|
*/
|
|
465
|
-
export interface
|
|
570
|
+
export interface LambdaConfiguration {
|
|
466
571
|
/**
|
|
467
|
-
*
|
|
572
|
+
* The Amazon S3 bucket event for which to invoke the LAMlong function. For more information, see [Supported Event Types](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*.
|
|
468
573
|
*/
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
/**
|
|
472
|
-
* A container specifying replication metrics-related settings enabling replication metrics and events.
|
|
473
|
-
*/
|
|
474
|
-
export interface Metrics {
|
|
574
|
+
Event: string;
|
|
575
|
+
Filter?: NotificationFilter;
|
|
475
576
|
/**
|
|
476
|
-
*
|
|
577
|
+
* The Amazon Resource Name (ARN) of the LAMlong function that Amazon S3 invokes when the specified event type occurs.
|
|
477
578
|
*/
|
|
478
|
-
|
|
479
|
-
EventThreshold?: ReplicationTimeValue;
|
|
579
|
+
Function: string;
|
|
480
580
|
}
|
|
481
581
|
/**
|
|
482
|
-
*
|
|
582
|
+
* The filtering rules that determine which objects invoke the AWS Lambda function. For example, you can create a filter so that only image files with a ``.jpg`` extension invoke the function when they are added to the Amazon S3 bucket.
|
|
483
583
|
*/
|
|
484
|
-
export interface
|
|
485
|
-
|
|
486
|
-
* Contains an integer specifying time in minutes.
|
|
487
|
-
* Valid value: 15
|
|
488
|
-
*/
|
|
489
|
-
Minutes: number;
|
|
584
|
+
export interface NotificationFilter {
|
|
585
|
+
S3Key: S3KeyFilter;
|
|
490
586
|
}
|
|
491
587
|
/**
|
|
492
|
-
*
|
|
588
|
+
* A container for object key name prefix and suffix filtering rules.
|
|
493
589
|
*/
|
|
494
|
-
export interface
|
|
590
|
+
export interface S3KeyFilter {
|
|
495
591
|
/**
|
|
496
|
-
*
|
|
592
|
+
* A list of containers for the key-value pair that defines the criteria for the filter rule.
|
|
497
593
|
*/
|
|
498
|
-
|
|
594
|
+
Rules: FilterRule[];
|
|
499
595
|
}
|
|
500
596
|
/**
|
|
501
|
-
*
|
|
597
|
+
* Specifies the Amazon S3 object key name to filter on. An object key name is the name assigned to an object in your Amazon S3 bucket. You specify whether to filter on the suffix or prefix of the object key name. A prefix is a specific string of characters at the beginning of an object key name, which you can use to organize objects. For example, you can start the key names of related objects with a prefix, such as ``2023-`` or ``engineering/``. Then, you can use ``FilterRule`` to find objects in a bucket with key names that have the same prefix. A suffix is similar to a prefix, but it is at the end of the object key name instead of at the beginning.
|
|
502
598
|
*/
|
|
503
|
-
export interface
|
|
599
|
+
export interface FilterRule {
|
|
504
600
|
/**
|
|
505
|
-
*
|
|
601
|
+
* The object key name prefix or suffix identifying one or more objects to which the filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, see [Configuring Event Notifications](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*.
|
|
506
602
|
*/
|
|
507
|
-
|
|
508
|
-
Time: ReplicationTimeValue1;
|
|
509
|
-
}
|
|
510
|
-
/**
|
|
511
|
-
* A container specifying the time by which replication should be complete for all objects and operations on objects.
|
|
512
|
-
*/
|
|
513
|
-
export interface ReplicationTimeValue1 {
|
|
603
|
+
Name: string;
|
|
514
604
|
/**
|
|
515
|
-
*
|
|
516
|
-
* Valid value: 15
|
|
605
|
+
* The value that the filter searches for in object key names.
|
|
517
606
|
*/
|
|
518
|
-
|
|
607
|
+
Value: string;
|
|
519
608
|
}
|
|
520
609
|
/**
|
|
521
|
-
*
|
|
522
|
-
* V1 replication configuration only supports filtering by key prefix. To filter using a V1 replication configuration, add the ``Prefix`` directly as a child element of the ``Rule`` element.
|
|
610
|
+
* Specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events.
|
|
523
611
|
*/
|
|
524
|
-
export interface
|
|
525
|
-
And?: ReplicationRuleAndOperator;
|
|
526
|
-
TagFilter?: TagFilter1;
|
|
612
|
+
export interface QueueConfiguration {
|
|
527
613
|
/**
|
|
528
|
-
*
|
|
529
|
-
* Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).
|
|
614
|
+
* The Amazon S3 bucket event about which you want to publish messages to Amazon SQS. For more information, see [Supported Event Types](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*.
|
|
530
615
|
*/
|
|
531
|
-
|
|
616
|
+
Event: string;
|
|
617
|
+
Filter?: NotificationFilter1;
|
|
618
|
+
/**
|
|
619
|
+
* The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type. FIFO queues are not allowed when enabling an SQS queue as the event notification destination.
|
|
620
|
+
*/
|
|
621
|
+
Queue: string;
|
|
532
622
|
}
|
|
533
623
|
/**
|
|
534
|
-
*
|
|
535
|
-
* + If you specify both a ``Prefix`` and a ``TagFilter``, wrap these filters in an ``And`` tag.
|
|
536
|
-
* + If you specify a filter based on multiple tags, wrap the ``TagFilter`` elements in an ``And`` tag.
|
|
624
|
+
* The filtering rules that determine which objects trigger notifications. For example, you can create a filter so that Amazon S3 sends notifications only when image files with a ``.jpg`` extension are added to the bucket. For more information, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*.
|
|
537
625
|
*/
|
|
538
|
-
export interface
|
|
539
|
-
|
|
540
|
-
* An array of tags containing key and value pairs.
|
|
541
|
-
*/
|
|
542
|
-
TagFilters?: TagFilter[];
|
|
543
|
-
/**
|
|
544
|
-
* An object key name prefix that identifies the subset of objects to which the rule applies.
|
|
545
|
-
*/
|
|
546
|
-
Prefix?: string;
|
|
626
|
+
export interface NotificationFilter1 {
|
|
627
|
+
S3Key: S3KeyFilter;
|
|
547
628
|
}
|
|
548
629
|
/**
|
|
549
|
-
*
|
|
630
|
+
* A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service (Amazon SNS) topic when Amazon S3 detects specified events.
|
|
550
631
|
*/
|
|
551
|
-
export interface
|
|
632
|
+
export interface TopicConfiguration {
|
|
552
633
|
/**
|
|
553
|
-
* The
|
|
634
|
+
* The Amazon S3 bucket event about which to send notifications. For more information, see [Supported Event Types](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*.
|
|
554
635
|
*/
|
|
555
|
-
|
|
636
|
+
Event: string;
|
|
637
|
+
Filter?: NotificationFilter2;
|
|
556
638
|
/**
|
|
557
|
-
* The
|
|
639
|
+
* The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 publishes a message when it detects events of the specified type.
|
|
558
640
|
*/
|
|
559
|
-
|
|
641
|
+
Topic: string;
|
|
560
642
|
}
|
|
561
643
|
/**
|
|
562
|
-
*
|
|
644
|
+
* The filtering rules that determine for which objects to send notifications. For example, you can create a filter so that Amazon S3 sends notifications only when image files with a ``.jpg`` extension are added to the bucket.
|
|
563
645
|
*/
|
|
564
|
-
export interface
|
|
565
|
-
|
|
566
|
-
SseKmsEncryptedObjects?: SseKmsEncryptedObjects;
|
|
646
|
+
export interface NotificationFilter2 {
|
|
647
|
+
S3Key: S3KeyFilter;
|
|
567
648
|
}
|
|
568
649
|
/**
|
|
569
|
-
*
|
|
650
|
+
* This operation is not supported by directory buckets.
|
|
651
|
+
* Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see [Locking Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html).
|
|
652
|
+
* + The ``DefaultRetention`` settings require both a mode and a period.
|
|
653
|
+
* + The ``DefaultRetention`` period can be either ``Days`` or ``Years`` but you must select one. You cannot specify ``Days`` and ``Years`` at the same time.
|
|
654
|
+
* + You can enable Object Lock for new or existing buckets. For more information, see [Configuring Object Lock](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-configure.html).
|
|
570
655
|
*/
|
|
571
|
-
export interface
|
|
656
|
+
export interface ObjectLockConfiguration {
|
|
572
657
|
/**
|
|
573
|
-
*
|
|
574
|
-
* *Allowed values*: ``Enabled`` | ``Disabled``
|
|
658
|
+
* Indicates whether this bucket has an Object Lock configuration enabled. Enable ``ObjectLockEnabled`` when you apply ``ObjectLockConfiguration`` to a bucket.
|
|
575
659
|
*/
|
|
576
|
-
|
|
660
|
+
ObjectLockEnabled?: "Enabled";
|
|
661
|
+
Rule?: ObjectLockRule;
|
|
577
662
|
}
|
|
578
663
|
/**
|
|
579
|
-
*
|
|
664
|
+
* Specifies the Object Lock rule for the specified object. Enable this rule when you apply ``ObjectLockConfiguration`` to a bucket. If Object Lock is turned on, bucket settings require both ``Mode`` and a period of either ``Days`` or ``Years``. You cannot specify ``Days`` and ``Years`` at the same time. For more information, see [ObjectLockRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockrule.html) and [DefaultRetention](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html).
|
|
580
665
|
*/
|
|
581
|
-
export interface
|
|
582
|
-
|
|
583
|
-
* Specifies whether Amazon S3 replicates objects created with server-side encryption using an AWS KMS key stored in AWS Key Management Service.
|
|
584
|
-
*/
|
|
585
|
-
Status: ("Disabled" | "Enabled");
|
|
666
|
+
export interface ObjectLockRule {
|
|
667
|
+
DefaultRetention?: DefaultRetention;
|
|
586
668
|
}
|
|
587
669
|
/**
|
|
588
|
-
*
|
|
589
|
-
* For more information about delete marker replication, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/delete-marker-replication.html).
|
|
590
|
-
* If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see [Backward Compatibility](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations).
|
|
670
|
+
* The default Object Lock retention mode and period that you want to apply to new objects placed in the specified bucket. If Object Lock is turned on, bucket settings require both ``Mode`` and a period of either ``Days`` or ``Years``. You cannot specify ``Days`` and ``Years`` at the same time. For more information about allowable values for mode and period, see [DefaultRetention](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html).
|
|
591
671
|
*/
|
|
592
|
-
export interface
|
|
672
|
+
export interface DefaultRetention {
|
|
593
673
|
/**
|
|
594
|
-
*
|
|
674
|
+
* The number of years that you want to specify for the default retention period. If Object Lock is turned on, you must specify ``Mode`` and specify either ``Days`` or ``Years``.
|
|
595
675
|
*/
|
|
596
|
-
|
|
597
|
-
}
|
|
598
|
-
/**
|
|
599
|
-
* A container of a key value name pair.
|
|
600
|
-
*/
|
|
601
|
-
export interface Tag {
|
|
676
|
+
Years?: number;
|
|
602
677
|
/**
|
|
603
|
-
*
|
|
678
|
+
* The number of days that you want to specify for the default retention period. If Object Lock is turned on, you must specify ``Mode`` and specify either ``Days`` or ``Years``.
|
|
604
679
|
*/
|
|
605
|
-
|
|
680
|
+
Days?: number;
|
|
606
681
|
/**
|
|
607
|
-
*
|
|
682
|
+
* The default Object Lock retention mode you want to apply to new objects placed in the specified bucket. If Object Lock is turned on, you must specify ``Mode`` and specify either ``Days`` or ``Years``.
|
|
608
683
|
*/
|
|
609
|
-
|
|
684
|
+
Mode?: ("COMPLIANCE" | "GOVERNANCE");
|
|
610
685
|
}
|
|
611
686
|
/**
|
|
612
|
-
*
|
|
687
|
+
* Configuration that defines how Amazon S3 handles Object Ownership rules.
|
|
613
688
|
*/
|
|
614
|
-
export interface
|
|
689
|
+
export interface OwnershipControls {
|
|
615
690
|
/**
|
|
616
|
-
* Specifies the
|
|
691
|
+
* Specifies the container element for Object Ownership rules.
|
|
617
692
|
*/
|
|
618
|
-
|
|
693
|
+
Rules: OwnershipControlsRule[];
|
|
619
694
|
}
|
|
620
695
|
/**
|
|
621
|
-
* Specifies
|
|
622
|
-
*
|
|
696
|
+
* Specifies an Object Ownership rule.
|
|
697
|
+
* S3 Object Ownership is an Amazon S3 bucket-level setting that you can use to disable access control lists (ACLs) and take ownership of every object in your bucket, simplifying access management for data stored in Amazon S3. For more information, see [Controlling ownership of objects and disabling ACLs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) in the *Amazon S3 User Guide*.
|
|
623
698
|
*/
|
|
624
|
-
export interface
|
|
699
|
+
export interface OwnershipControlsRule {
|
|
625
700
|
/**
|
|
626
|
-
* Specifies
|
|
627
|
-
* For more information, see [Amazon S3 Bucket Keys](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) in the *Amazon S3 User Guide*.
|
|
701
|
+
* Specifies an object ownership rule.
|
|
628
702
|
*/
|
|
629
|
-
|
|
630
|
-
ServerSideEncryptionByDefault?: ServerSideEncryptionByDefault;
|
|
703
|
+
ObjectOwnership?: ("ObjectWriter" | "BucketOwnerPreferred" | "BucketOwnerEnforced");
|
|
631
704
|
}
|
|
632
705
|
/**
|
|
633
|
-
*
|
|
706
|
+
* Configuration that defines how Amazon S3 handles public access.
|
|
634
707
|
*/
|
|
635
|
-
export interface
|
|
636
|
-
/**
|
|
637
|
-
* Server-side encryption algorithm to use for the default encryption.
|
|
638
|
-
*/
|
|
639
|
-
SSEAlgorithm: ("aws:kms" | "AES256" | "aws:kms:dsse");
|
|
708
|
+
export interface PublicAccessBlockConfiguration {
|
|
640
709
|
/**
|
|
641
|
-
*
|
|
642
|
-
*
|
|
643
|
-
* +
|
|
644
|
-
* +
|
|
645
|
-
* + Key Alias: ``alias/alias-name``
|
|
710
|
+
* Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects in this bucket. Setting this element to ``TRUE`` causes the following behavior:
|
|
711
|
+
* + PUT Bucket ACL and PUT Object ACL calls fail if the specified ACL is public.
|
|
712
|
+
* + PUT Object calls fail if the request includes a public ACL.
|
|
713
|
+
* + PUT Bucket calls fail if the request includes a public ACL.
|
|
646
714
|
*
|
|
647
|
-
*
|
|
648
|
-
* If you are using encryption with cross-account or AWS service operations you must use a fully qualified KMS key ARN. For more information, see [Using encryption for cross-account operations](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html#bucket-encryption-update-bucket-policy).
|
|
649
|
-
* Amazon S3 only supports symmetric encryption KMS keys. For more information, see [Asymmetric keys in KMS](https://docs.aws.amazon.com//kms/latest/developerguide/symmetric-asymmetric.html) in the *Key Management Service Developer Guide*.
|
|
650
|
-
*/
|
|
651
|
-
KMSMasterKeyID?: string;
|
|
652
|
-
}
|
|
653
|
-
/**
|
|
654
|
-
* Configuration that defines how Amazon S3 handles bucket notifications.
|
|
655
|
-
*/
|
|
656
|
-
export interface NotificationConfiguration {
|
|
657
|
-
/**
|
|
658
|
-
* The topic to which notifications are sent and the events for which notifications are generated.
|
|
659
|
-
*/
|
|
660
|
-
TopicConfigurations?: TopicConfiguration[];
|
|
661
|
-
/**
|
|
662
|
-
* The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages.
|
|
663
|
-
*/
|
|
664
|
-
QueueConfigurations?: QueueConfiguration[];
|
|
665
|
-
/**
|
|
666
|
-
* Describes the LAMlong functions to invoke and the events for which to invoke them.
|
|
715
|
+
* Enabling this setting doesn't affect existing policies or ACLs.
|
|
667
716
|
*/
|
|
668
|
-
|
|
669
|
-
EventBridgeConfiguration?: EventBridgeConfiguration;
|
|
670
|
-
}
|
|
671
|
-
/**
|
|
672
|
-
* A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service (Amazon SNS) topic when Amazon S3 detects specified events.
|
|
673
|
-
*/
|
|
674
|
-
export interface TopicConfiguration {
|
|
675
|
-
Filter?: NotificationFilter;
|
|
717
|
+
BlockPublicAcls?: boolean;
|
|
676
718
|
/**
|
|
677
|
-
*
|
|
719
|
+
* Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting this element to ``TRUE`` causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access.
|
|
720
|
+
* Enabling this setting doesn't affect existing bucket policies.
|
|
678
721
|
*/
|
|
679
|
-
|
|
722
|
+
BlockPublicPolicy?: boolean;
|
|
680
723
|
/**
|
|
681
|
-
*
|
|
724
|
+
* Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Setting this element to ``TRUE`` causes Amazon S3 to ignore all public ACLs on this bucket and objects in this bucket.
|
|
725
|
+
* Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.
|
|
682
726
|
*/
|
|
683
|
-
|
|
684
|
-
}
|
|
685
|
-
/**
|
|
686
|
-
* The filtering rules that determine for which objects to send notifications. For example, you can create a filter so that Amazon S3 sends notifications only when image files with a ``.jpg`` extension are added to the bucket.
|
|
687
|
-
*/
|
|
688
|
-
export interface NotificationFilter {
|
|
689
|
-
S3Key: S3KeyFilter;
|
|
690
|
-
}
|
|
691
|
-
/**
|
|
692
|
-
* A container for object key name prefix and suffix filtering rules.
|
|
693
|
-
*/
|
|
694
|
-
export interface S3KeyFilter {
|
|
727
|
+
IgnorePublicAcls?: boolean;
|
|
695
728
|
/**
|
|
696
|
-
*
|
|
729
|
+
* Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to ``TRUE`` restricts access to this bucket to only AWS-service principals and authorized users within this account if the bucket has a public policy.
|
|
730
|
+
* Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.
|
|
697
731
|
*/
|
|
698
|
-
|
|
732
|
+
RestrictPublicBuckets?: boolean;
|
|
699
733
|
}
|
|
700
734
|
/**
|
|
701
|
-
*
|
|
735
|
+
* Configuration for replicating objects in an S3 bucket. To enable replication, you must also enable versioning by using the ``VersioningConfiguration`` property.
|
|
736
|
+
* Amazon S3 can store replicated objects in a single destination bucket or multiple destination buckets. The destination bucket or buckets must already exist.
|
|
702
737
|
*/
|
|
703
|
-
export interface
|
|
738
|
+
export interface ReplicationConfiguration {
|
|
704
739
|
/**
|
|
705
|
-
* The
|
|
740
|
+
* The Amazon Resource Name (ARN) of the IAMlong (IAM) role that Amazon S3 assumes when replicating objects. For more information, see [How to Set Up Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-how-setup.html) in the *Amazon S3 User Guide*.
|
|
706
741
|
*/
|
|
707
|
-
|
|
742
|
+
Role: string;
|
|
708
743
|
/**
|
|
709
|
-
*
|
|
744
|
+
* A container for one or more replication rules. A replication configuration must have at least one rule and can contain a maximum of 1,000 rules.
|
|
710
745
|
*/
|
|
711
|
-
|
|
746
|
+
Rules: ReplicationRule[];
|
|
712
747
|
}
|
|
713
748
|
/**
|
|
714
|
-
* Specifies
|
|
749
|
+
* Specifies which Amazon S3 objects to replicate and where to store the replicas.
|
|
715
750
|
*/
|
|
716
|
-
export interface
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
|
|
720
|
-
*/
|
|
721
|
-
Event: string;
|
|
751
|
+
export interface ReplicationRule {
|
|
752
|
+
DeleteMarkerReplication?: DeleteMarkerReplication;
|
|
753
|
+
Destination: ReplicationDestination;
|
|
754
|
+
Filter?: ReplicationRuleFilter;
|
|
722
755
|
/**
|
|
723
|
-
*
|
|
756
|
+
* A unique identifier for the rule. The maximum value is 255 characters. If you don't specify a value, AWS CloudFormation generates a random ID. When using a V2 replication configuration this property is capitalized as "ID".
|
|
724
757
|
*/
|
|
725
|
-
|
|
726
|
-
}
|
|
727
|
-
/**
|
|
728
|
-
* The filtering rules that determine which objects trigger notifications. For example, you can create a filter so that Amazon S3 sends notifications only when image files with a ``.jpg`` extension are added to the bucket. For more information, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*.
|
|
729
|
-
*/
|
|
730
|
-
export interface NotificationFilter1 {
|
|
731
|
-
S3Key: S3KeyFilter;
|
|
732
|
-
}
|
|
733
|
-
/**
|
|
734
|
-
* Describes the LAMlong functions to invoke and the events for which to invoke them.
|
|
735
|
-
*/
|
|
736
|
-
export interface LambdaConfiguration {
|
|
758
|
+
Id?: string;
|
|
737
759
|
/**
|
|
738
|
-
*
|
|
760
|
+
* An object key name prefix that identifies the object or objects to which the rule applies. The maximum prefix length is 1,024 characters. To include all objects in a bucket, specify an empty string. To filter using a V1 replication configuration, add the ``Prefix`` directly as a child element of the ``Rule`` element.
|
|
761
|
+
* Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).
|
|
739
762
|
*/
|
|
740
|
-
|
|
741
|
-
Filter?: NotificationFilter2;
|
|
763
|
+
Prefix?: string;
|
|
742
764
|
/**
|
|
743
|
-
* The Amazon S3
|
|
765
|
+
* The priority indicates which rule has precedence whenever two or more replication rules conflict. Amazon S3 will attempt to replicate objects according to all replication rules. However, if there are two or more rules with the same destination bucket, then objects will be replicated according to the rule with the highest priority. The higher the number, the higher the priority.
|
|
766
|
+
* For more information, see [Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) in the *Amazon S3 User Guide*.
|
|
744
767
|
*/
|
|
745
|
-
|
|
746
|
-
|
|
747
|
-
/**
|
|
748
|
-
* The filtering rules that determine which objects invoke the AWS Lambda function. For example, you can create a filter so that only image files with a ``.jpg`` extension invoke the function when they are added to the Amazon S3 bucket.
|
|
749
|
-
*/
|
|
750
|
-
export interface NotificationFilter2 {
|
|
751
|
-
S3Key: S3KeyFilter;
|
|
752
|
-
}
|
|
753
|
-
/**
|
|
754
|
-
* Enables delivery of events to Amazon EventBridge.
|
|
755
|
-
*/
|
|
756
|
-
export interface EventBridgeConfiguration {
|
|
768
|
+
Priority?: number;
|
|
769
|
+
SourceSelectionCriteria?: SourceSelectionCriteria;
|
|
757
770
|
/**
|
|
758
|
-
*
|
|
771
|
+
* Specifies whether the rule is enabled.
|
|
759
772
|
*/
|
|
760
|
-
|
|
773
|
+
Status: ("Disabled" | "Enabled");
|
|
761
774
|
}
|
|
762
775
|
/**
|
|
763
|
-
* Specifies
|
|
776
|
+
* Specifies whether Amazon S3 replicates delete markers. If you specify a ``Filter`` in your replication configuration, you must also include a ``DeleteMarkerReplication`` element. If your ``Filter`` includes a ``Tag`` element, the ``DeleteMarkerReplication`` ``Status`` must be set to Disabled, because Amazon S3 does not support replicating delete markers for tag-based rules. For an example configuration, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-config-min-rule-config).
|
|
777
|
+
* For more information about delete marker replication, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/delete-marker-replication.html).
|
|
778
|
+
* If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see [Backward Compatibility](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations).
|
|
764
779
|
*/
|
|
765
|
-
export interface
|
|
780
|
+
export interface DeleteMarkerReplication {
|
|
766
781
|
/**
|
|
767
|
-
*
|
|
782
|
+
* Indicates whether to replicate delete markers. Disabled by default.
|
|
768
783
|
*/
|
|
769
|
-
|
|
784
|
+
Status?: ("Disabled" | "Enabled");
|
|
770
785
|
}
|
|
771
786
|
/**
|
|
772
|
-
*
|
|
773
|
-
* You must specify at least one of the following properties: ``AbortIncompleteMultipartUpload``, ``ExpirationDate``, ``ExpirationInDays``, ``NoncurrentVersionExpirationInDays``, ``NoncurrentVersionTransition``, ``NoncurrentVersionTransitions``, ``Transition``, or ``Transitions``.
|
|
787
|
+
* A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC).
|
|
774
788
|
*/
|
|
775
|
-
export interface
|
|
776
|
-
|
|
777
|
-
* If ``Enabled``, the rule is currently being applied. If ``Disabled``, the rule is not currently being applied.
|
|
778
|
-
*/
|
|
779
|
-
Status: ("Enabled" | "Disabled");
|
|
780
|
-
/**
|
|
781
|
-
* Indicates whether Amazon S3 will remove a delete marker without any noncurrent versions. If set to true, the delete marker will be removed if there are no noncurrent versions. This cannot be specified with ``ExpirationInDays``, ``ExpirationDate``, or ``TagFilters``.
|
|
782
|
-
*/
|
|
783
|
-
ExpiredObjectDeleteMarker?: boolean;
|
|
784
|
-
/**
|
|
785
|
-
* (Deprecated.) For buckets with versioning enabled (or suspended), specifies the time, in days, between when a new version of the object is uploaded to the bucket and when old versions of the object expire. When object versions expire, Amazon S3 permanently deletes them. If you specify a transition and expiration time, the expiration time must be later than the transition time.
|
|
786
|
-
*/
|
|
787
|
-
NoncurrentVersionExpirationInDays?: number;
|
|
788
|
-
/**
|
|
789
|
-
* One or more transition rules that specify when an object transitions to a specified storage class. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. If you specify this property, don't specify the ``Transition`` property.
|
|
790
|
-
*/
|
|
791
|
-
Transitions?: Transition[];
|
|
792
|
-
/**
|
|
793
|
-
* Specifies the minimum object size in bytes for this rule to apply to. Objects must be larger than this value in bytes. For more information about size based rules, see [Lifecycle configuration using size-based rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-configuration-examples.html#lc-size-rules) in the *Amazon S3 User Guide*.
|
|
794
|
-
*/
|
|
795
|
-
ObjectSizeGreaterThan?: string;
|
|
796
|
-
/**
|
|
797
|
-
* Tags to use to identify a subset of objects to which the lifecycle rule applies.
|
|
798
|
-
*/
|
|
799
|
-
TagFilters?: TagFilter[];
|
|
800
|
-
/**
|
|
801
|
-
* For buckets with versioning enabled (or suspended), one or more transition rules that specify when non-current objects transition to a specified storage class. If you specify a transition and expiration time, the expiration time must be later than the transition time. If you specify this property, don't specify the ``NoncurrentVersionTransition`` property.
|
|
802
|
-
*/
|
|
803
|
-
NoncurrentVersionTransitions?: NoncurrentVersionTransition[];
|
|
804
|
-
/**
|
|
805
|
-
* Object key prefix that identifies one or more objects to which this rule applies.
|
|
806
|
-
* Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).
|
|
807
|
-
*/
|
|
808
|
-
Prefix?: string;
|
|
809
|
-
/**
|
|
810
|
-
* Specifies the maximum object size in bytes for this rule to apply to. Objects must be smaller than this value in bytes. For more information about sized based rules, see [Lifecycle configuration using size-based rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-configuration-examples.html#lc-size-rules) in the *Amazon S3 User Guide*.
|
|
811
|
-
*/
|
|
812
|
-
ObjectSizeLessThan?: string;
|
|
813
|
-
NoncurrentVersionTransition?: NoncurrentVersionTransition1;
|
|
789
|
+
export interface ReplicationDestination {
|
|
790
|
+
AccessControlTranslation?: AccessControlTranslation;
|
|
814
791
|
/**
|
|
815
|
-
*
|
|
792
|
+
* Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to change replica ownership to the AWS-account that owns the destination bucket by specifying the ``AccessControlTranslation`` property, this is the account ID of the destination bucket owner. For more information, see [Cross-Region Replication Additional Configuration: Change Replica Owner](https://docs.aws.amazon.com/AmazonS3/latest/dev/crr-change-owner.html) in the *Amazon S3 User Guide*.
|
|
793
|
+
* If you specify the ``AccessControlTranslation`` property, the ``Account`` property is required.
|
|
816
794
|
*/
|
|
817
|
-
|
|
818
|
-
NoncurrentVersionExpiration?: NoncurrentVersionExpiration;
|
|
795
|
+
Account?: string;
|
|
819
796
|
/**
|
|
820
|
-
*
|
|
797
|
+
* The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the results.
|
|
821
798
|
*/
|
|
822
|
-
|
|
823
|
-
|
|
799
|
+
Bucket: string;
|
|
800
|
+
EncryptionConfiguration?: EncryptionConfiguration;
|
|
801
|
+
Metrics?: Metrics;
|
|
802
|
+
ReplicationTime?: ReplicationTime;
|
|
824
803
|
/**
|
|
825
|
-
*
|
|
804
|
+
* The storage class to use when replicating objects, such as S3 Standard or reduced redundancy. By default, Amazon S3 uses the storage class of the source object to create the object replica.
|
|
805
|
+
* For valid values, see the ``StorageClass`` element of the [PUT Bucket replication](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html) action in the *Amazon S3 API Reference*.
|
|
826
806
|
*/
|
|
827
|
-
|
|
828
|
-
AbortIncompleteMultipartUpload?: AbortIncompleteMultipartUpload;
|
|
807
|
+
StorageClass?: ("DEEP_ARCHIVE" | "GLACIER" | "GLACIER_IR" | "INTELLIGENT_TIERING" | "ONEZONE_IA" | "REDUCED_REDUNDANCY" | "STANDARD" | "STANDARD_IA");
|
|
829
808
|
}
|
|
830
809
|
/**
|
|
831
|
-
*
|
|
810
|
+
* Specify this only in a cross-account scenario (where source and destination bucket owners are not the same), and you want to change replica ownership to the AWS-account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same AWS-account that owns the source object.
|
|
832
811
|
*/
|
|
833
|
-
export interface
|
|
812
|
+
export interface AccessControlTranslation {
|
|
834
813
|
/**
|
|
835
|
-
*
|
|
814
|
+
* Specifies the replica ownership. For default and valid values, see [PUT bucket replication](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html) in the *Amazon S3 API Reference*.
|
|
836
815
|
*/
|
|
837
|
-
|
|
816
|
+
Owner: "Destination";
|
|
817
|
+
}
|
|
818
|
+
/**
|
|
819
|
+
* Specifies encryption-related information.
|
|
820
|
+
*/
|
|
821
|
+
export interface EncryptionConfiguration {
|
|
838
822
|
/**
|
|
839
|
-
*
|
|
823
|
+
* Specifies the ID (Key ARN or Alias ARN) of the customer managed AWS KMS key stored in AWS Key Management Service (KMS) for the destination bucket. Amazon S3 uses this key to encrypt replica objects. Amazon S3 only supports symmetric encryption KMS keys. For more information, see [Asymmetric keys in KMS](https://docs.aws.amazon.com//kms/latest/developerguide/symmetric-asymmetric.html) in the *Key Management Service Developer Guide*.
|
|
840
824
|
*/
|
|
841
|
-
|
|
825
|
+
ReplicaKmsKeyID: string;
|
|
826
|
+
}
|
|
827
|
+
/**
|
|
828
|
+
* A container specifying replication metrics-related settings enabling replication metrics and events.
|
|
829
|
+
*/
|
|
830
|
+
export interface Metrics {
|
|
831
|
+
EventThreshold?: ReplicationTimeValue;
|
|
842
832
|
/**
|
|
843
|
-
*
|
|
833
|
+
* Specifies whether the replication metrics are enabled.
|
|
844
834
|
*/
|
|
845
|
-
|
|
835
|
+
Status: ("Disabled" | "Enabled");
|
|
846
836
|
}
|
|
847
837
|
/**
|
|
848
|
-
*
|
|
838
|
+
* A container specifying the time threshold for emitting the ``s3:Replication:OperationMissedThreshold`` event.
|
|
849
839
|
*/
|
|
850
|
-
export interface
|
|
840
|
+
export interface ReplicationTimeValue {
|
|
851
841
|
/**
|
|
852
|
-
*
|
|
842
|
+
* Contains an integer specifying time in minutes.
|
|
843
|
+
* Valid value: 15
|
|
853
844
|
*/
|
|
854
|
-
|
|
845
|
+
Minutes: number;
|
|
846
|
+
}
|
|
847
|
+
/**
|
|
848
|
+
* A container specifying S3 Replication Time Control (S3 RTC), including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated. Must be specified together with a ``Metrics`` block.
|
|
849
|
+
*/
|
|
850
|
+
export interface ReplicationTime {
|
|
855
851
|
/**
|
|
856
|
-
* Specifies the
|
|
852
|
+
* Specifies whether the replication time is enabled.
|
|
857
853
|
*/
|
|
858
|
-
|
|
854
|
+
Status: ("Disabled" | "Enabled");
|
|
855
|
+
Time: ReplicationTimeValue1;
|
|
856
|
+
}
|
|
857
|
+
/**
|
|
858
|
+
* A container specifying the time by which replication should be complete for all objects and operations on objects.
|
|
859
|
+
*/
|
|
860
|
+
export interface ReplicationTimeValue1 {
|
|
859
861
|
/**
|
|
860
|
-
*
|
|
862
|
+
* Contains an integer specifying time in minutes.
|
|
863
|
+
* Valid value: 15
|
|
861
864
|
*/
|
|
862
|
-
|
|
865
|
+
Minutes: number;
|
|
863
866
|
}
|
|
864
867
|
/**
|
|
865
|
-
*
|
|
868
|
+
* A filter that identifies the subset of objects to which the replication rule applies. A ``Filter`` must specify exactly one ``Prefix``, ``TagFilter``, or an ``And`` child element. The use of the filter field indicates that this is a V2 replication configuration. This field isn't supported in a V1 replication configuration.
|
|
869
|
+
* V1 replication configuration only supports filtering by key prefix. To filter using a V1 replication configuration, add the ``Prefix`` directly as a child element of the ``Rule`` element.
|
|
866
870
|
*/
|
|
867
|
-
export interface
|
|
871
|
+
export interface ReplicationRuleFilter {
|
|
872
|
+
And?: ReplicationRuleAndOperator;
|
|
868
873
|
/**
|
|
869
|
-
*
|
|
874
|
+
* An object key name prefix that identifies the subset of objects to which the rule applies.
|
|
875
|
+
* Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).
|
|
870
876
|
*/
|
|
871
|
-
|
|
877
|
+
Prefix?: string;
|
|
878
|
+
TagFilter?: TagFilter1;
|
|
879
|
+
}
|
|
880
|
+
/**
|
|
881
|
+
* A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter. For example:
|
|
882
|
+
* + If you specify both a ``Prefix`` and a ``TagFilter``, wrap these filters in an ``And`` tag.
|
|
883
|
+
* + If you specify a filter based on multiple tags, wrap the ``TagFilter`` elements in an ``And`` tag.
|
|
884
|
+
*/
|
|
885
|
+
export interface ReplicationRuleAndOperator {
|
|
872
886
|
/**
|
|
873
|
-
*
|
|
887
|
+
* An object key name prefix that identifies the subset of objects to which the rule applies.
|
|
874
888
|
*/
|
|
875
|
-
|
|
889
|
+
Prefix?: string;
|
|
876
890
|
/**
|
|
877
|
-
*
|
|
891
|
+
* An array of tags containing key and value pairs.
|
|
878
892
|
*/
|
|
879
|
-
|
|
893
|
+
TagFilters?: TagFilter[];
|
|
880
894
|
}
|
|
881
895
|
/**
|
|
882
|
-
* Specifies
|
|
896
|
+
* Specifies tags to use to identify a subset of objects for an Amazon S3 bucket.
|
|
883
897
|
*/
|
|
884
|
-
export interface
|
|
898
|
+
export interface TagFilter1 {
|
|
885
899
|
/**
|
|
886
|
-
*
|
|
900
|
+
* The tag value.
|
|
887
901
|
*/
|
|
888
|
-
|
|
902
|
+
Value: string;
|
|
889
903
|
/**
|
|
890
|
-
*
|
|
904
|
+
* The tag key.
|
|
891
905
|
*/
|
|
892
|
-
|
|
906
|
+
Key: string;
|
|
893
907
|
}
|
|
894
908
|
/**
|
|
895
|
-
*
|
|
909
|
+
* A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects.
|
|
896
910
|
*/
|
|
897
|
-
export interface
|
|
898
|
-
|
|
899
|
-
|
|
900
|
-
|
|
901
|
-
|
|
911
|
+
export interface SourceSelectionCriteria {
|
|
912
|
+
ReplicaModifications?: ReplicaModifications;
|
|
913
|
+
SseKmsEncryptedObjects?: SseKmsEncryptedObjects;
|
|
914
|
+
}
|
|
915
|
+
/**
|
|
916
|
+
* A filter that you can specify for selection for modifications on replicas.
|
|
917
|
+
*/
|
|
918
|
+
export interface ReplicaModifications {
|
|
902
919
|
/**
|
|
903
|
-
*
|
|
920
|
+
* Specifies whether Amazon S3 replicates modifications on replicas.
|
|
921
|
+
* *Allowed values*: ``Enabled`` | ``Disabled``
|
|
904
922
|
*/
|
|
905
|
-
|
|
923
|
+
Status: ("Enabled" | "Disabled");
|
|
924
|
+
}
|
|
925
|
+
/**
|
|
926
|
+
* A container for filter information for the selection of Amazon S3 objects encrypted with AWS KMS.
|
|
927
|
+
*/
|
|
928
|
+
export interface SseKmsEncryptedObjects {
|
|
906
929
|
/**
|
|
907
|
-
*
|
|
930
|
+
* Specifies whether Amazon S3 replicates objects created with server-side encryption using an AWS KMS key stored in AWS Key Management Service.
|
|
908
931
|
*/
|
|
909
|
-
|
|
932
|
+
Status: ("Disabled" | "Enabled");
|
|
910
933
|
}
|
|
911
934
|
/**
|
|
912
|
-
*
|
|
935
|
+
* A container of a key value name pair.
|
|
913
936
|
*/
|
|
914
|
-
export interface
|
|
937
|
+
export interface Tag {
|
|
915
938
|
/**
|
|
916
|
-
*
|
|
939
|
+
* Name of the object key.
|
|
917
940
|
*/
|
|
918
|
-
|
|
941
|
+
Key: string;
|
|
942
|
+
/**
|
|
943
|
+
* Value of the tag.
|
|
944
|
+
*/
|
|
945
|
+
Value: string;
|
|
919
946
|
}
|
|
920
947
|
/**
|
|
921
948
|
* Enables multiple versions of all objects in this bucket. You might enable versioning to prevent objects from being deleted or overwritten by mistake or to archive objects so that you can retrieve previous versions of them.
|
|
@@ -928,102 +955,83 @@ export interface VersioningConfiguration {
|
|
|
928
955
|
Status: ("Enabled" | "Suspended");
|
|
929
956
|
}
|
|
930
957
|
/**
|
|
931
|
-
*
|
|
958
|
+
* Information used to configure the bucket as a static website. For more information, see [Hosting Websites on Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html).
|
|
932
959
|
*/
|
|
933
|
-
export interface
|
|
934
|
-
/**
|
|
935
|
-
* The access point that was used while performing operations on the object. The metrics configuration only includes objects that meet the filter's criteria.
|
|
936
|
-
*/
|
|
937
|
-
AccessPointArn?: string;
|
|
960
|
+
export interface WebsiteConfiguration {
|
|
938
961
|
/**
|
|
939
|
-
*
|
|
962
|
+
* The name of the error document for the website.
|
|
940
963
|
*/
|
|
941
|
-
|
|
964
|
+
ErrorDocument?: string;
|
|
942
965
|
/**
|
|
943
|
-
* The
|
|
966
|
+
* The name of the index document for the website.
|
|
944
967
|
*/
|
|
945
|
-
|
|
968
|
+
IndexDocument?: string;
|
|
946
969
|
/**
|
|
947
|
-
*
|
|
970
|
+
* Rules that define when a redirect is applied and the redirect behavior.
|
|
948
971
|
*/
|
|
949
|
-
|
|
972
|
+
RoutingRules?: RoutingRule[];
|
|
973
|
+
RedirectAllRequestsTo?: RedirectAllRequestsTo;
|
|
950
974
|
}
|
|
951
975
|
/**
|
|
952
|
-
* Specifies the
|
|
953
|
-
* For information about the S3 Intelligent-Tiering storage class, see [Storage class for automatically optimizing frequently and infrequently accessed objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access).
|
|
976
|
+
* Specifies the redirect behavior and when a redirect is applied. For more information about routing rules, see [Configuring advanced conditional redirects](https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html#advanced-conditional-redirects) in the *Amazon S3 User Guide*.
|
|
954
977
|
*/
|
|
955
|
-
export interface
|
|
978
|
+
export interface RoutingRule {
|
|
979
|
+
RedirectRule: RedirectRule;
|
|
980
|
+
RoutingRuleCondition?: RoutingRuleCondition;
|
|
981
|
+
}
|
|
982
|
+
/**
|
|
983
|
+
* Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can specify a different error code to return.
|
|
984
|
+
*/
|
|
985
|
+
export interface RedirectRule {
|
|
956
986
|
/**
|
|
957
|
-
*
|
|
987
|
+
* The host name to use in the redirect request.
|
|
958
988
|
*/
|
|
959
|
-
|
|
989
|
+
HostName?: string;
|
|
960
990
|
/**
|
|
961
|
-
*
|
|
962
|
-
* You only need Intelligent Tiering Configuration enabled on a bucket if you want to automatically move objects stored in the Intelligent-Tiering storage class to Archive Access or Deep Archive Access tiers.
|
|
991
|
+
* The HTTP redirect code to use on the response. Not required if one of the siblings is present.
|
|
963
992
|
*/
|
|
964
|
-
|
|
993
|
+
HttpRedirectCode?: string;
|
|
965
994
|
/**
|
|
966
|
-
*
|
|
995
|
+
* Protocol to use when redirecting requests. The default is the protocol that is used in the original request.
|
|
967
996
|
*/
|
|
968
|
-
|
|
997
|
+
Protocol?: ("http" | "https");
|
|
969
998
|
/**
|
|
970
|
-
* The
|
|
999
|
+
* The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix ``docs/`` (objects in the ``docs/`` folder) to ``documents/``, you can set a condition block with ``KeyPrefixEquals`` set to ``docs/`` and in the Redirect set ``ReplaceKeyPrefixWith`` to ``/documents``. Not required if one of the siblings is present. Can be present only if ``ReplaceKeyWith`` is not provided.
|
|
1000
|
+
* Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).
|
|
971
1001
|
*/
|
|
972
|
-
|
|
1002
|
+
ReplaceKeyPrefixWith?: string;
|
|
973
1003
|
/**
|
|
974
|
-
*
|
|
1004
|
+
* The specific object key to use in the redirect request. For example, redirect request to ``error.html``. Not required if one of the siblings is present. Can be present only if ``ReplaceKeyPrefixWith`` is not provided.
|
|
1005
|
+
* Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).
|
|
975
1006
|
*/
|
|
976
|
-
|
|
1007
|
+
ReplaceKeyWith?: string;
|
|
977
1008
|
}
|
|
978
1009
|
/**
|
|
979
|
-
*
|
|
1010
|
+
* A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the ``/docs`` folder, redirect to the ``/documents`` folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error.
|
|
980
1011
|
*/
|
|
981
|
-
export interface
|
|
982
|
-
/**
|
|
983
|
-
* S3 Intelligent-Tiering access tier. See [Storage class for automatically optimizing frequently and infrequently accessed objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access) for a list of access tiers in the S3 Intelligent-Tiering storage class.
|
|
984
|
-
*/
|
|
985
|
-
AccessTier: ("ARCHIVE_ACCESS" | "DEEP_ARCHIVE_ACCESS");
|
|
1012
|
+
export interface RoutingRuleCondition {
|
|
986
1013
|
/**
|
|
987
|
-
* The
|
|
1014
|
+
* The object key name prefix when the redirect is applied. For example, to redirect requests for ``ExamplePage.html``, the key prefix will be ``ExamplePage.html``. To redirect request for all pages with the prefix ``docs/``, the key prefix will be ``/docs``, which identifies all objects in the docs/ folder.
|
|
1015
|
+
* Required when the parent element ``Condition`` is specified and sibling ``HttpErrorCodeReturnedEquals`` is not specified. If both conditions are specified, both must be true for the redirect to be applied.
|
|
988
1016
|
*/
|
|
989
|
-
|
|
990
|
-
}
|
|
991
|
-
/**
|
|
992
|
-
* Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see [Enabling Cross-Origin Resource Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the *Amazon S3 User Guide*.
|
|
993
|
-
*/
|
|
994
|
-
export interface CorsConfiguration {
|
|
1017
|
+
KeyPrefixEquals?: string;
|
|
995
1018
|
/**
|
|
996
|
-
*
|
|
1019
|
+
* The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied.
|
|
1020
|
+
* Required when parent element ``Condition`` is specified and sibling ``KeyPrefixEquals`` is not specified. If both are specified, then both must be true for the redirect to be applied.
|
|
997
1021
|
*/
|
|
998
|
-
|
|
1022
|
+
HttpErrorCodeReturnedEquals?: string;
|
|
999
1023
|
}
|
|
1000
1024
|
/**
|
|
1001
|
-
*
|
|
1025
|
+
* The redirect behavior for every request to this bucket's website endpoint.
|
|
1026
|
+
* If you specify this property, you can't specify any other property.
|
|
1002
1027
|
*/
|
|
1003
|
-
export interface
|
|
1004
|
-
/**
|
|
1005
|
-
* One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript ``XMLHttpRequest`` object).
|
|
1006
|
-
*/
|
|
1007
|
-
ExposedHeaders?: string[];
|
|
1008
|
-
/**
|
|
1009
|
-
* An HTTP method that you allow the origin to run.
|
|
1010
|
-
* *Allowed values*: ``GET`` | ``PUT`` | ``HEAD`` | ``POST`` | ``DELETE``
|
|
1011
|
-
*/
|
|
1012
|
-
AllowedMethods: ("GET" | "PUT" | "HEAD" | "POST" | "DELETE")[];
|
|
1013
|
-
/**
|
|
1014
|
-
* One or more origins you want customers to be able to access the bucket from.
|
|
1015
|
-
*/
|
|
1016
|
-
AllowedOrigins: string[];
|
|
1017
|
-
/**
|
|
1018
|
-
* Headers that are specified in the ``Access-Control-Request-Headers`` header. These headers are allowed in a preflight OPTIONS request. In response to any preflight OPTIONS request, Amazon S3 returns any requested headers that are allowed.
|
|
1019
|
-
*/
|
|
1020
|
-
AllowedHeaders?: string[];
|
|
1028
|
+
export interface RedirectAllRequestsTo {
|
|
1021
1029
|
/**
|
|
1022
|
-
*
|
|
1030
|
+
* Name of the host where requests are redirected.
|
|
1023
1031
|
*/
|
|
1024
|
-
|
|
1032
|
+
HostName: string;
|
|
1025
1033
|
/**
|
|
1026
|
-
*
|
|
1034
|
+
* Protocol to use when redirecting requests. The default is the protocol that is used in the original request.
|
|
1027
1035
|
*/
|
|
1028
|
-
|
|
1036
|
+
Protocol?: ("http" | "https");
|
|
1029
1037
|
}
|