Package software.amazon.awscdk.services.s3

Interface CfnBucketProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBucketProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-05T03:43:50.660Z")
@Stability(Stable)
public interface CfnBucketProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnBucket.

Example:

 CfnBucket rawBucket = CfnBucket.Builder.create(this, "Bucket").build();
 // -or-
 CfnBucket rawBucketAlt = (CfnBucket)myBucket.getNode().getDefaultChild();
 // then
 rawBucket.getCfnOptions().getCondition() = CfnCondition.Builder.create(this, "EnableBucket").build();
 rawBucket.getCfnOptions().getMetadata() = Map.of(
         "metadataKey", "MetadataValue");
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnBucketProps.Builder	A builder for CfnBucketProps
static final class	CfnBucketProps.Jsii$Proxy	An implementation for CfnBucketProps

Method Summary

Modifier and Type	Method	Description
static CfnBucketProps.Builder	builder()
default Object	getAccelerateConfiguration()	Configures the transfer acceleration state for an Amazon S3 bucket.
default String	getAccessControl()
default Object	getAnalyticsConfigurations()	Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.
default Object	getBucketEncryption()	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).
default String	getBucketName()	A name for the bucket.
default Object	getCorsConfiguration()	Describes the cross-origin access configuration for objects in an Amazon S3 bucket.
default Object	getIntelligentTieringConfigurations()	Defines how Amazon S3 handles Intelligent-Tiering storage.
default Object	getInventoryConfigurations()	Specifies the inventory configuration for an Amazon S3 bucket.
default Object	getLifecycleConfiguration()	Specifies the lifecycle configuration for objects in an Amazon S3 bucket.
default Object	getLoggingConfiguration()	Settings that define where logs are stored.
default Object	getMetricsConfigurations()	Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket.
default Object	getNotificationConfiguration()	Configuration that defines how Amazon S3 handles bucket notifications.
default Object	getObjectLockConfiguration()
default Object	getObjectLockEnabled()	Indicates whether this bucket has an Object Lock configuration enabled.
default Object	getOwnershipControls()	Configuration that defines how Amazon S3 handles Object Ownership rules.
default Object	getPublicAccessBlockConfiguration()	Configuration that defines how Amazon S3 handles public access.
default Object	getReplicationConfiguration()	Configuration for replicating objects in an S3 bucket.
default List<CfnTag>	getTags()	An arbitrary set of tags (key-value pairs) for this S3 bucket.
default Object	getVersioningConfiguration()	Enables multiple versions of all objects in this bucket.
default Object	getWebsiteConfiguration()	Information used to configure the bucket as a static website.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccelerateConfiguration

@Stability(Stable)
@Nullable
default Object getAccelerateConfiguration()

Configures the transfer acceleration state for an Amazon S3 bucket.

For more information, see Amazon S3 Transfer Acceleration in the Amazon S3 User Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-accelerateconfiguration

getAccessControl

@Stability(Stable)
@Nullable
default String getAccessControl()

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 in the Amazon S3 User Guide .

A canned access control list (ACL) that grants predefined permissions to the bucket. For more information about canned ACLs, see Canned ACL in the Amazon S3 User Guide .

S3 buckets are created with ACLs disabled by default. Therefore, unless you explicitly set the AWS::S3::OwnershipControls property to enable ACLs, your resource will fail to deploy with any value other than Private. Use cases requiring ACLs are uncommon.

The majority of access control configurations can be successfully and more easily achieved with bucket policies. For more information, see AWS::S3::BucketPolicy . For examples of common policy configurations, including S3 Server Access Logs buckets and more, see Bucket policy examples in the Amazon S3 User Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-accesscontrol

getAnalyticsConfigurations

@Stability(Stable)
@Nullable
default Object getAnalyticsConfigurations()

Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-analyticsconfigurations

getBucketEncryption

@Stability(Stable)
@Nullable
default Object getBucketEncryption()

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 in the Amazon S3 User Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-bucketencryption

getBucketName

@Stability(Stable)
@Nullable
default String getBucketName()

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 . For more information, see Rules for naming Amazon S3 buckets in the Amazon S3 User Guide .

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-bucketname

getCorsConfiguration

@Stability(Stable)
@Nullable
default Object getCorsConfiguration()

Describes the cross-origin access configuration for objects in an Amazon S3 bucket.

For more information, see Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-corsconfiguration

getIntelligentTieringConfigurations

@Stability(Stable)
@Nullable
default Object getIntelligentTieringConfigurations()

Defines how Amazon S3 handles Intelligent-Tiering storage.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-intelligenttieringconfigurations

getInventoryConfigurations

@Stability(Stable)
@Nullable
default Object getInventoryConfigurations()

Specifies the inventory configuration for an Amazon S3 bucket.

For more information, see GET Bucket inventory in the Amazon S3 API Reference .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-inventoryconfigurations

getLifecycleConfiguration

@Stability(Stable)
@Nullable
default Object getLifecycleConfiguration()

Specifies the lifecycle configuration for objects in an Amazon S3 bucket.

For more information, see Object Lifecycle Management in the Amazon S3 User Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-lifecycleconfiguration

getLoggingConfiguration

@Stability(Stable)
@Nullable
default Object getLoggingConfiguration()

Settings that define where logs are stored.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-loggingconfiguration

getMetricsConfigurations

@Stability(Stable)
@Nullable
default Object getMetricsConfigurations()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-metricsconfigurations

getNotificationConfiguration

@Stability(Stable)
@Nullable
default Object getNotificationConfiguration()

Configuration that defines how Amazon S3 handles bucket notifications.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-notificationconfiguration

getObjectLockConfiguration

@Stability(Stable)
@Nullable
default Object getObjectLockConfiguration()

This operation is not supported by directory buckets.

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 .

• The DefaultRetention settings require both a mode and a period.
• The DefaultRetention period can be either Days or Years but you must select one. You cannot specify Days and Years at the same time.
• You can enable Object Lock for new or existing buckets. For more information, see Configuring Object Lock .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-objectlockconfiguration

getObjectLockEnabled

@Stability(Stable)
@Nullable
default Object getObjectLockEnabled()

Indicates whether this bucket has an Object Lock configuration enabled.

Enable ObjectLockEnabled when you apply ObjectLockConfiguration to a bucket.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-objectlockenabled

getOwnershipControls

@Stability(Stable)
@Nullable
default Object getOwnershipControls()

Configuration that defines how Amazon S3 handles Object Ownership rules.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-ownershipcontrols

getPublicAccessBlockConfiguration

@Stability(Stable)
@Nullable
default Object getPublicAccessBlockConfiguration()

Configuration that defines how Amazon S3 handles public access.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-publicaccessblockconfiguration

getReplicationConfiguration

@Stability(Stable)
@Nullable
default Object getReplicationConfiguration()

Configuration for replicating objects in an S3 bucket.

To enable replication, you must also enable versioning by using the VersioningConfiguration property.

Amazon S3 can store replicated objects in a single destination bucket or multiple destination buckets. The destination bucket or buckets must already exist.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-replicationconfiguration

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

An arbitrary set of tags (key-value pairs) for this S3 bucket.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-tags

getVersioningConfiguration

@Stability(Stable)
@Nullable
default Object getVersioningConfiguration()

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.

When you enable versioning on a bucket for the first time, it might take a short amount of time for the change to be fully propagated. We recommend that you wait for 15 minutes after enabling versioning before issuing write operations ( PUT or DELETE ) on objects in the bucket.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-versioningconfiguration

getWebsiteConfiguration

@Stability(Stable)
@Nullable
default Object getWebsiteConfiguration()

Information used to configure the bucket as a static website.

For more information, see Hosting Websites on Amazon S3 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-websiteconfiguration

builder

@Stability(Stable)
static CfnBucketProps.Builder builder()

Returns:

a CfnBucketProps.Builder of CfnBucketProps