latest--aws-s3-bucket
shared| Type | object |
|---|---|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-s3-bucket.json |
| Parent schema | serverless-framework-configuration |
Resource Type definition for AWS::S3::Bucket. Source:- No source definition found, add manually please
Properties
1 nested properties
Configures the transfer acceleration state for an Amazon S3 bucket.
A canned access control list (ACL) that grants predefined permissions to the bucket.
The configuration and any analyses for the analytics filter of an Amazon S3 bucket.
Specifies default encryption for a bucket using server-side encryption with either Amazon S3-managed keys (SSE-S3) or AWS KMS-managed keys (SSE-KMS).
1 nested properties
Specifies the default server-side-encryption configuration.
A name for the bucket. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name.
1 nested properties
Specifies the S3 Intelligent-Tiering configuration for an Amazon S3 bucket.
The inventory configuration for an Amazon S3 bucket.
1 nested properties
A lifecycle rule for individual objects in an Amazon S3 bucket.
2 nested properties
The name of an Amazon S3 bucket where Amazon S3 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.
Settings that define a metrics configuration for the CloudWatch request metrics from the bucket.
Describes the notification configuration for an Amazon S3 bucket.
4 nested properties
Describes the Amazon EventBridge notification configuration for an Amazon S3 bucket.
1 nested properties
Specifies whether to send notifications to Amazon EventBridge when events occur in an Amazon S3 bucket.
2 nested properties
Indicates whether this bucket has an Object Lock configuration enabled.
1 nested properties
Configuration that defines how Amazon S3 handles public access.
4 nested properties
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:
- PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.
- PUT Object calls fail if the request includes a public ACL. Enabling this setting doesn't affect existing policies or ACLs.
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. Enabling this setting doesn't affect existing bucket policies.
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. Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.
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 services and authorized users within this account if the bucket has a public policy. 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.
A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB.
2 nested properties
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that Amazon S3 assumes when replicating objects.
An arbitrary set of tags (key-value pairs) for this S3 bucket.
Describes the versioning state of an Amazon S3 bucket.
1 nested properties
The versioning state of the bucket.
Specifies website configuration parameters for an Amazon S3 bucket.
4 nested properties
The name of the error document for the website.
The name of the index document for the website.
Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.
2 nested properties
Name of the host where requests are redirected.
Protocol to use when redirecting requests. The default is the protocol that is used in the original request.
Definitions
Tags to use to identify a subset of objects for an Amazon S3 bucket.
Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket and S3 Replication Time Control (S3 RTC).
The Amazon Resource Name (ARN) of the bucket to which data is exported.
Specifies the file format used when exporting data to Amazon S3.
The account ID that owns the destination S3 bucket.
The prefix to use when exporting data. The prefix is prepended to all results.
Configures the transfer acceleration state for an Amazon S3 bucket.
Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.
Specifies data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes for an Amazon S3 bucket.
1 nested properties
Specifies how data related to the storage class analysis for an Amazon S3 bucket should be exported.
2 nested properties
Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket and S3 Replication Time Control (S3 RTC).
The version of the output schema to use when exporting data.
The ID that identifies the analytics configuration.
The prefix that an object must have to be included in the analytics results.
Specifies data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes for an Amazon S3 bucket.
Specifies how data related to the storage class analysis for an Amazon S3 bucket should be exported.
2 nested properties
Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket and S3 Replication Time Control (S3 RTC).
4 nested properties
The Amazon Resource Name (ARN) of the bucket to which data is exported.
Specifies the file format used when exporting data to Amazon S3.
The account ID that owns the destination S3 bucket.
The prefix to use when exporting data. The prefix is prepended to all results.
The version of the output schema to use when exporting data.
Specifies how data related to the storage class analysis for an Amazon S3 bucket should be exported.
Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket and S3 Replication Time Control (S3 RTC).
4 nested properties
The Amazon Resource Name (ARN) of the bucket to which data is exported.
Specifies the file format used when exporting data to Amazon S3.
The account ID that owns the destination S3 bucket.
The prefix to use when exporting data. The prefix is prepended to all results.
The version of the output schema to use when exporting data.
Specifies default encryption for a bucket using server-side encryption with either Amazon S3-managed keys (SSE-S3) or AWS KMS-managed keys (SSE-KMS).
Specifies the default server-side-encryption configuration.
Specifies the default server-side encryption configuration.
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.
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.
2 nested properties
"KMSMasterKeyID" can only be used when you set the value of SSEAlgorithm as aws:kms.
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.
"KMSMasterKeyID" can only be used when you set the value of SSEAlgorithm as aws:kms.
A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the configuration.
An HTTP method that you allow the origin to execute.
One or more origins you want customers to be able to access the bucket from.
Headers that are specified in the Access-Control-Request-Headers header.
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).
A unique identifier for this rule.
The time in seconds that your browser is to cache the preflight response for the specified resource.
The ID used to identify the S3 Intelligent-Tiering configuration.
Specifies the status of the configuration.
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.
An object key name prefix that identifies the subset of objects to which the rule applies.
S3 Intelligent-Tiering access tier. See Storage class for automatically optimizing frequently and infrequently accessed objects for a list of access tiers in the S3 Intelligent-Tiering storage class.
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).
Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket and S3 Replication Time Control (S3 RTC).
4 nested properties
The Amazon Resource Name (ARN) of the bucket to which data is exported.
Specifies the file format used when exporting data to Amazon S3.
The account ID that owns the destination S3 bucket.
The prefix to use when exporting data. The prefix is prepended to all results.
Specifies whether the inventory is enabled or disabled.
The ID used to identify the inventory configuration.
Object versions to include in the inventory list.
Specifies the schedule for generating inventory results.
Contains the optional fields that are included in the inventory results.
The prefix that is prepended to all inventory results.
A lifecycle rule for individual objects in an Amazon S3 bucket.
You must specify at least one of the following properties: AbortIncompleteMultipartUpload, ExpirationDate, ExpirationInDays, NoncurrentVersionExpirationInDays, NoncurrentVersionTransition, NoncurrentVersionTransitions, Transition, or Transitions.
Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload.
1 nested properties
Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload.
The date value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ssZ)
Container for the expiration rule that describes when noncurrent objects are expired. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 expire noncurrent object versions at a specific period in the object's lifetime
2 nested properties
Specified the number of days an object is noncurrent before Amazon S3 can perform the associated action
Specified the number of newer noncurrent and current versions that must exists before performing the associated action
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.
3 nested properties
The class of storage used to store the object.
Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action.
Specified the number of newer noncurrent and current versions that must exists before performing the associated action
You must specify at least one of "TransitionDate" and "TransitionInDays"
3 nested properties
The date value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ssZ)
Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload.
Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload.
The date value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ssZ)
Container for the expiration rule that describes when noncurrent objects are expired. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 expire noncurrent object versions at a specific period in the object's lifetime
Specified the number of days an object is noncurrent before Amazon S3 can perform the associated action
Specified the number of newer noncurrent and current versions that must exists before performing the associated action
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.
The class of storage used to store the object.
Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action.
Specified the number of newer noncurrent and current versions that must exists before performing the associated action
You must specify at least one of "TransitionDate" and "TransitionInDays"
The date value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ssZ)
The name of an Amazon S3 bucket where Amazon S3 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.
Describes the notification configuration for an Amazon S3 bucket.
Describes the Amazon EventBridge notification configuration for an Amazon S3 bucket.
1 nested properties
Specifies whether to send notifications to Amazon EventBridge when events occur in an Amazon S3 bucket.
Describes the Amazon EventBridge notification configuration for an Amazon S3 bucket.
Specifies whether to send notifications to Amazon EventBridge when events occur in an Amazon S3 bucket.
Describes the AWS Lambda functions to invoke and the events for which to invoke them.
The Amazon S3 bucket event for which to invoke the AWS Lambda function.
The Amazon Resource Name (ARN) of the AWS Lambda function that Amazon S3 invokes when the specified event type occurs.
Specifies object key name filtering rules.
1 nested properties
A container for object key name prefix and suffix filtering rules.
1 nested properties
The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages.
The Amazon S3 bucket event about which you want to publish messages to Amazon SQS.
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.
Specifies object key name filtering rules.
1 nested properties
A container for object key name prefix and suffix filtering rules.
1 nested properties
The topic to which notifications are sent and the events for which notifications are generated.
The Amazon S3 bucket event about which to send notifications.
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.
Specifies object key name filtering rules.
1 nested properties
A container for object key name prefix and suffix filtering rules.
1 nested properties
Specifies object key name filtering rules.
A container for object key name prefix and suffix filtering rules.
1 nested properties
A container for object key name prefix and suffix filtering rules.
Specifies the Amazon S3 object key name to filter on and whether to filter on the suffix or prefix of the key name.
The Object Lock rule in place for the specified object.
The default retention period that you want to apply to new objects placed in the specified bucket.
3 nested properties
The default retention period that you want to apply to new objects placed in the specified bucket.
Specifies an object ownership rule.
Configuration that defines how Amazon S3 handles public access.
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:
- PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.
- PUT Object calls fail if the request includes a public ACL. Enabling this setting doesn't affect existing policies or ACLs.
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. Enabling this setting doesn't affect existing bucket policies.
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. Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.
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 services and authorized users within this account if the bucket has a public policy. 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.
A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB.
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that Amazon S3 assumes when replicating objects.
Specifies which Amazon S3 objects to replicate and where to store the replicas.
Specifies which Amazon S3 bucket to store replicated objects in and their storage class.
7 nested properties
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.
1 nested properties
Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects.
1 nested properties
Specifies the ID (Key ARN or Alias ARN) of the customer managed customer master key (CMK) stored in AWS Key Management Service (KMS) for the destination bucket.
2 nested properties
The storage class to use when replicating objects, such as S3 Standard or reduced redundancy.
Specifies whether the rule is enabled.
1 nested properties
3 nested properties
2 nested properties
Tags to use to identify a subset of objects for an Amazon S3 bucket.
2 nested properties
A unique identifier for the rule.
An object key name prefix that identifies the object or objects to which the rule applies.
A container that describes additional filters for identifying the source objects that you want to replicate.
2 nested properties
1 nested properties
Specifies whether Amazon S3 replicates modifications on replicas.
A container for filter information for the selection of S3 objects encrypted with AWS KMS.
1 nested properties
Specifies whether Amazon S3 replicates objects created with server-side encryption using a customer master key (CMK) stored in AWS Key Management Service.
Specifies which Amazon S3 bucket to store replicated objects in and their storage class.
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.
1 nested properties
Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects.
1 nested properties
Specifies the ID (Key ARN or Alias ARN) of the customer managed customer master key (CMK) stored in AWS Key Management Service (KMS) for the destination bucket.
2 nested properties
1 nested properties
2 nested properties
1 nested properties
The storage class to use when replicating objects, such as S3 Standard or reduced redundancy.
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.
Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects.
Specifies the ID (Key ARN or Alias ARN) of the customer managed customer master key (CMK) stored in AWS Key Management Service (KMS) for the destination bucket.
1 nested properties
1 nested properties
2 nested properties
Tags to use to identify a subset of objects for an Amazon S3 bucket.
2 nested properties
A container that describes additional filters for identifying the source objects that you want to replicate.
1 nested properties
Specifies whether Amazon S3 replicates modifications on replicas.
A container for filter information for the selection of S3 objects encrypted with AWS KMS.
1 nested properties
Specifies whether Amazon S3 replicates objects created with server-side encryption using a customer master key (CMK) stored in AWS Key Management Service.
Specifies whether Amazon S3 replicates modifications on replicas.
A container for filter information for the selection of S3 objects encrypted with AWS KMS.
Specifies whether Amazon S3 replicates objects created with server-side encryption using a customer master key (CMK) stored in AWS Key Management Service.
Describes the versioning state of an Amazon S3 bucket.
The versioning state of the bucket.
Specifies website configuration parameters for an Amazon S3 bucket.
The name of the error document for the website.
The name of the index document for the website.
Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.
2 nested properties
Name of the host where requests are redirected.
Protocol to use when redirecting requests. The default is the protocol that is used in the original request.
Specifies the redirect behavior and when a redirect is applied.
Specifies how requests are redirected. In the event of an error, you can specify a different error code to return.
5 nested properties
The host name to use in the redirect request.
The HTTP redirect code to use on the response. Not required if one of the siblings is present.
Protocol to use when redirecting requests. The default is the protocol that is used in the original request.
The object key prefix to use in the redirect request.
The specific object key to use in the redirect request.d
A container for describing a condition that must be met for the specified redirect to apply.You must specify at least one of HttpErrorCodeReturnedEquals and KeyPrefixEquals
2 nested properties
The object key name prefix when the redirect is applied.
The HTTP error code when the redirect is applied.
Specifies how requests are redirected. In the event of an error, you can specify a different error code to return.
The host name to use in the redirect request.
The HTTP redirect code to use on the response. Not required if one of the siblings is present.
Protocol to use when redirecting requests. The default is the protocol that is used in the original request.
The object key prefix to use in the redirect request.
The specific object key to use in the redirect request.d
A container for describing a condition that must be met for the specified redirect to apply.You must specify at least one of HttpErrorCodeReturnedEquals and KeyPrefixEquals
The object key name prefix when the redirect is applied.
The HTTP error code when the redirect is applied.
Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.
Name of the host where requests are redirected.
Protocol to use when redirecting requests. The default is the protocol that is used in the original request.
the Amazon Resource Name (ARN) of the specified bucket.