software.amazon.awscdk.services.s3

Class CfnBucketProps.Builder

java.lang.Object

software.amazon.awscdk.services.s3.CfnBucketProps.Builder

Enclosing interface:

CfnBucketProps

public static final class CfnBucketProps.Builder
extends java.lang.Object

A builder for CfnBucketProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnBucketProps.Builder	accelerateConfiguration(CfnBucket.AccelerateConfigurationProperty accelerateConfiguration) Sets the value of CfnBucketProps.getAccelerateConfiguration()
CfnBucketProps.Builder	accelerateConfiguration(IResolvable accelerateConfiguration) Sets the value of CfnBucketProps.getAccelerateConfiguration()
CfnBucketProps.Builder	accessControl(java.lang.String accessControl) Sets the value of CfnBucketProps.getAccessControl()
CfnBucketProps.Builder	analyticsConfigurations(IResolvable analyticsConfigurations) Sets the value of CfnBucketProps.getAnalyticsConfigurations()
CfnBucketProps.Builder	analyticsConfigurations(java.util.List<? extends java.lang.Object> analyticsConfigurations) Sets the value of CfnBucketProps.getAnalyticsConfigurations()
CfnBucketProps.Builder	bucketEncryption(CfnBucket.BucketEncryptionProperty bucketEncryption) Sets the value of CfnBucketProps.getBucketEncryption()
CfnBucketProps.Builder	bucketEncryption(IResolvable bucketEncryption) Sets the value of CfnBucketProps.getBucketEncryption()
CfnBucketProps.Builder	bucketName(java.lang.String bucketName) Sets the value of CfnBucketProps.getBucketName()
CfnBucketProps	build() Builds the configured instance.
CfnBucketProps.Builder	corsConfiguration(CfnBucket.CorsConfigurationProperty corsConfiguration) Sets the value of CfnBucketProps.getCorsConfiguration()
CfnBucketProps.Builder	corsConfiguration(IResolvable corsConfiguration) Sets the value of CfnBucketProps.getCorsConfiguration()
CfnBucketProps.Builder	intelligentTieringConfigurations(IResolvable intelligentTieringConfigurations) Sets the value of CfnBucketProps.getIntelligentTieringConfigurations()
CfnBucketProps.Builder	intelligentTieringConfigurations(java.util.List<? extends java.lang.Object> intelligentTieringConfigurations) Sets the value of CfnBucketProps.getIntelligentTieringConfigurations()
CfnBucketProps.Builder	inventoryConfigurations(IResolvable inventoryConfigurations) Sets the value of CfnBucketProps.getInventoryConfigurations()
CfnBucketProps.Builder	inventoryConfigurations(java.util.List<? extends java.lang.Object> inventoryConfigurations) Sets the value of CfnBucketProps.getInventoryConfigurations()
CfnBucketProps.Builder	lifecycleConfiguration(CfnBucket.LifecycleConfigurationProperty lifecycleConfiguration) Sets the value of CfnBucketProps.getLifecycleConfiguration()
CfnBucketProps.Builder	lifecycleConfiguration(IResolvable lifecycleConfiguration) Sets the value of CfnBucketProps.getLifecycleConfiguration()
CfnBucketProps.Builder	loggingConfiguration(CfnBucket.LoggingConfigurationProperty loggingConfiguration) Sets the value of CfnBucketProps.getLoggingConfiguration()
CfnBucketProps.Builder	loggingConfiguration(IResolvable loggingConfiguration) Sets the value of CfnBucketProps.getLoggingConfiguration()
CfnBucketProps.Builder	metricsConfigurations(IResolvable metricsConfigurations) Sets the value of CfnBucketProps.getMetricsConfigurations()
CfnBucketProps.Builder	metricsConfigurations(java.util.List<? extends java.lang.Object> metricsConfigurations) Sets the value of CfnBucketProps.getMetricsConfigurations()
CfnBucketProps.Builder	notificationConfiguration(CfnBucket.NotificationConfigurationProperty notificationConfiguration) Sets the value of CfnBucketProps.getNotificationConfiguration()
CfnBucketProps.Builder	notificationConfiguration(IResolvable notificationConfiguration) Sets the value of CfnBucketProps.getNotificationConfiguration()
CfnBucketProps.Builder	objectLockConfiguration(CfnBucket.ObjectLockConfigurationProperty objectLockConfiguration) Sets the value of CfnBucketProps.getObjectLockConfiguration()
CfnBucketProps.Builder	objectLockConfiguration(IResolvable objectLockConfiguration) Sets the value of CfnBucketProps.getObjectLockConfiguration()
CfnBucketProps.Builder	objectLockEnabled(java.lang.Boolean objectLockEnabled) Sets the value of CfnBucketProps.getObjectLockEnabled()
CfnBucketProps.Builder	objectLockEnabled(IResolvable objectLockEnabled) Sets the value of CfnBucketProps.getObjectLockEnabled()
CfnBucketProps.Builder	ownershipControls(CfnBucket.OwnershipControlsProperty ownershipControls) Sets the value of CfnBucketProps.getOwnershipControls()
CfnBucketProps.Builder	ownershipControls(IResolvable ownershipControls) Sets the value of CfnBucketProps.getOwnershipControls()
CfnBucketProps.Builder	publicAccessBlockConfiguration(CfnBucket.PublicAccessBlockConfigurationProperty publicAccessBlockConfiguration) Sets the value of CfnBucketProps.getPublicAccessBlockConfiguration()
CfnBucketProps.Builder	publicAccessBlockConfiguration(IResolvable publicAccessBlockConfiguration) Sets the value of CfnBucketProps.getPublicAccessBlockConfiguration()
CfnBucketProps.Builder	replicationConfiguration(CfnBucket.ReplicationConfigurationProperty replicationConfiguration) Sets the value of CfnBucketProps.getReplicationConfiguration()
CfnBucketProps.Builder	replicationConfiguration(IResolvable replicationConfiguration) Sets the value of CfnBucketProps.getReplicationConfiguration()
CfnBucketProps.Builder	tags(java.util.List<? extends CfnTag> tags) Sets the value of CfnBucketProps.getTags()
CfnBucketProps.Builder	versioningConfiguration(CfnBucket.VersioningConfigurationProperty versioningConfiguration) Sets the value of CfnBucketProps.getVersioningConfiguration()
CfnBucketProps.Builder	versioningConfiguration(IResolvable versioningConfiguration) Sets the value of CfnBucketProps.getVersioningConfiguration()
CfnBucketProps.Builder	websiteConfiguration(CfnBucket.WebsiteConfigurationProperty websiteConfiguration) Sets the value of CfnBucketProps.getWebsiteConfiguration()
CfnBucketProps.Builder	websiteConfiguration(IResolvable websiteConfiguration) Sets the value of CfnBucketProps.getWebsiteConfiguration()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

accelerateConfiguration

public CfnBucketProps.Builder accelerateConfiguration(IResolvable accelerateConfiguration)

Sets the value of CfnBucketProps.getAccelerateConfiguration()

Parameters:

accelerateConfiguration - Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see Amazon S3 Transfer Acceleration in the Amazon S3 User Guide .

Returns:

this

accelerateConfiguration

public CfnBucketProps.Builder accelerateConfiguration(CfnBucket.AccelerateConfigurationProperty accelerateConfiguration)

Sets the value of CfnBucketProps.getAccelerateConfiguration()

Parameters:

accelerateConfiguration - Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see Amazon S3 Transfer Acceleration in the Amazon S3 User Guide .

Returns:

this

accessControl

public CfnBucketProps.Builder accessControl(java.lang.String accessControl)

Sets the value of CfnBucketProps.getAccessControl()

Parameters:

accessControl - 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 .

Be aware that the syntax for this property differs from the information provided in the Amazon S3 User Guide . The AccessControl property is case-sensitive and must be one of the following values: Private, PublicRead, PublicReadWrite, AuthenticatedRead, LogDeliveryWrite, BucketOwnerRead, BucketOwnerFullControl, or AwsExecRead.

Returns:

this

analyticsConfigurations

public CfnBucketProps.Builder analyticsConfigurations(IResolvable analyticsConfigurations)

Sets the value of CfnBucketProps.getAnalyticsConfigurations()

Parameters:

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

Returns:

this

analyticsConfigurations

public CfnBucketProps.Builder analyticsConfigurations(java.util.List<? extends java.lang.Object> analyticsConfigurations)

Sets the value of CfnBucketProps.getAnalyticsConfigurations()

Parameters:

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

Returns:

this

bucketEncryption

public CfnBucketProps.Builder bucketEncryption(IResolvable bucketEncryption)

Sets the value of CfnBucketProps.getBucketEncryption()

Parameters:

bucketEncryption - Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3) or AWS KMS-managed keys (SSE-KMS) bucket. For information about the Amazon S3 default encryption feature, see Amazon S3 Default Encryption for S3 Buckets in the Amazon S3 User Guide .

Returns:

this

bucketEncryption

public CfnBucketProps.Builder bucketEncryption(CfnBucket.BucketEncryptionProperty bucketEncryption)

Sets the value of CfnBucketProps.getBucketEncryption()

Parameters:

bucketEncryption - Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3) or AWS KMS-managed keys (SSE-KMS) bucket. For information about the Amazon S3 default encryption feature, see Amazon S3 Default Encryption for S3 Buckets in the Amazon S3 User Guide .

Returns:

this

bucketName

public CfnBucketProps.Builder bucketName(java.lang.String bucketName)

Sets the value of CfnBucketProps.getBucketName()

Parameters:

bucketName - 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.

Returns:

this

corsConfiguration

public CfnBucketProps.Builder corsConfiguration(IResolvable corsConfiguration)

Sets the value of CfnBucketProps.getCorsConfiguration()

Parameters:

corsConfiguration - 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 .

Returns:

this

corsConfiguration

public CfnBucketProps.Builder corsConfiguration(CfnBucket.CorsConfigurationProperty corsConfiguration)

Sets the value of CfnBucketProps.getCorsConfiguration()

Parameters:

corsConfiguration - 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 .

Returns:

this

intelligentTieringConfigurations

public CfnBucketProps.Builder intelligentTieringConfigurations(IResolvable intelligentTieringConfigurations)

Sets the value of CfnBucketProps.getIntelligentTieringConfigurations()

Parameters:

intelligentTieringConfigurations - Defines how Amazon S3 handles Intelligent-Tiering storage.

Returns:

this

intelligentTieringConfigurations

public CfnBucketProps.Builder intelligentTieringConfigurations(java.util.List<? extends java.lang.Object> intelligentTieringConfigurations)

Sets the value of CfnBucketProps.getIntelligentTieringConfigurations()

Parameters:

intelligentTieringConfigurations - Defines how Amazon S3 handles Intelligent-Tiering storage.

Returns:

this

inventoryConfigurations

public CfnBucketProps.Builder inventoryConfigurations(IResolvable inventoryConfigurations)

Sets the value of CfnBucketProps.getInventoryConfigurations()

Parameters:

inventoryConfigurations - Specifies the inventory configuration for an Amazon S3 bucket. For more information, see GET Bucket inventory in the Amazon S3 API Reference .

Returns:

this

inventoryConfigurations

public CfnBucketProps.Builder inventoryConfigurations(java.util.List<? extends java.lang.Object> inventoryConfigurations)

Sets the value of CfnBucketProps.getInventoryConfigurations()

Parameters:

inventoryConfigurations - Specifies the inventory configuration for an Amazon S3 bucket. For more information, see GET Bucket inventory in the Amazon S3 API Reference .

Returns:

this

lifecycleConfiguration

public CfnBucketProps.Builder lifecycleConfiguration(IResolvable lifecycleConfiguration)

Sets the value of CfnBucketProps.getLifecycleConfiguration()

Parameters:

lifecycleConfiguration - Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see Object Lifecycle Management in the Amazon S3 User Guide .

Returns:

this

lifecycleConfiguration

public CfnBucketProps.Builder lifecycleConfiguration(CfnBucket.LifecycleConfigurationProperty lifecycleConfiguration)

Sets the value of CfnBucketProps.getLifecycleConfiguration()

Parameters:

lifecycleConfiguration - Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see Object Lifecycle Management in the Amazon S3 User Guide .

Returns:

this

loggingConfiguration

public CfnBucketProps.Builder loggingConfiguration(IResolvable loggingConfiguration)

Sets the value of CfnBucketProps.getLoggingConfiguration()

Parameters:

loggingConfiguration - Settings that define where logs are stored.

Returns:

this

loggingConfiguration

public CfnBucketProps.Builder loggingConfiguration(CfnBucket.LoggingConfigurationProperty loggingConfiguration)

Sets the value of CfnBucketProps.getLoggingConfiguration()

Parameters:

loggingConfiguration - Settings that define where logs are stored.

Returns:

this

metricsConfigurations

public CfnBucketProps.Builder metricsConfigurations(IResolvable metricsConfigurations)

Sets the value of CfnBucketProps.getMetricsConfigurations()

Parameters:

metricsConfigurations - 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 .

Returns:

this

metricsConfigurations

public CfnBucketProps.Builder metricsConfigurations(java.util.List<? extends java.lang.Object> metricsConfigurations)

Sets the value of CfnBucketProps.getMetricsConfigurations()

Parameters:

metricsConfigurations - 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 .

Returns:

this

notificationConfiguration

public CfnBucketProps.Builder notificationConfiguration(IResolvable notificationConfiguration)

Sets the value of CfnBucketProps.getNotificationConfiguration()

Parameters:

notificationConfiguration - Configuration that defines how Amazon S3 handles bucket notifications.

Returns:

this

notificationConfiguration

public CfnBucketProps.Builder notificationConfiguration(CfnBucket.NotificationConfigurationProperty notificationConfiguration)

Sets the value of CfnBucketProps.getNotificationConfiguration()

Parameters:

notificationConfiguration - Configuration that defines how Amazon S3 handles bucket notifications.

Returns:

this

objectLockConfiguration

public CfnBucketProps.Builder objectLockConfiguration(IResolvable objectLockConfiguration)

Sets the value of CfnBucketProps.getObjectLockConfiguration()

Parameters:

objectLockConfiguration - 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 only enable Object Lock for new buckets. If you want to turn on Object Lock for an existing bucket, contact AWS Support.

Returns:

this

objectLockConfiguration

public CfnBucketProps.Builder objectLockConfiguration(CfnBucket.ObjectLockConfigurationProperty objectLockConfiguration)

Sets the value of CfnBucketProps.getObjectLockConfiguration()

Parameters:

objectLockConfiguration - 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 only enable Object Lock for new buckets. If you want to turn on Object Lock for an existing bucket, contact AWS Support.

Returns:

this

objectLockEnabled

public CfnBucketProps.Builder objectLockEnabled(java.lang.Boolean objectLockEnabled)

Sets the value of CfnBucketProps.getObjectLockEnabled()

Parameters:

objectLockEnabled - Indicates whether this bucket has an Object Lock configuration enabled. Enable ObjectLockEnabled when you apply ObjectLockConfiguration to a bucket.

Returns:

this

objectLockEnabled

public CfnBucketProps.Builder objectLockEnabled(IResolvable objectLockEnabled)

Sets the value of CfnBucketProps.getObjectLockEnabled()

Parameters:

objectLockEnabled - Indicates whether this bucket has an Object Lock configuration enabled. Enable ObjectLockEnabled when you apply ObjectLockConfiguration to a bucket.

Returns:

this

ownershipControls

public CfnBucketProps.Builder ownershipControls(IResolvable ownershipControls)

Sets the value of CfnBucketProps.getOwnershipControls()

Parameters:

ownershipControls - Configuration that defines how Amazon S3 handles Object Ownership rules.

Returns:

this

ownershipControls

public CfnBucketProps.Builder ownershipControls(CfnBucket.OwnershipControlsProperty ownershipControls)

Sets the value of CfnBucketProps.getOwnershipControls()

Parameters:

ownershipControls - Configuration that defines how Amazon S3 handles Object Ownership rules.

Returns:

this

publicAccessBlockConfiguration

public CfnBucketProps.Builder publicAccessBlockConfiguration(IResolvable publicAccessBlockConfiguration)

Sets the value of CfnBucketProps.getPublicAccessBlockConfiguration()

Parameters:

publicAccessBlockConfiguration - Configuration that defines how Amazon S3 handles public access.

Returns:

this

publicAccessBlockConfiguration

public CfnBucketProps.Builder publicAccessBlockConfiguration(CfnBucket.PublicAccessBlockConfigurationProperty publicAccessBlockConfiguration)

Sets the value of CfnBucketProps.getPublicAccessBlockConfiguration()

Parameters:

publicAccessBlockConfiguration - Configuration that defines how Amazon S3 handles public access.

Returns:

this

replicationConfiguration

public CfnBucketProps.Builder replicationConfiguration(IResolvable replicationConfiguration)

Sets the value of CfnBucketProps.getReplicationConfiguration()

Parameters:

replicationConfiguration - 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.

Returns:

this

replicationConfiguration

public CfnBucketProps.Builder replicationConfiguration(CfnBucket.ReplicationConfigurationProperty replicationConfiguration)

Sets the value of CfnBucketProps.getReplicationConfiguration()

Parameters:

replicationConfiguration - 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.

Returns:

this

tags

public CfnBucketProps.Builder tags(java.util.List<? extends CfnTag> tags)

Sets the value of CfnBucketProps.getTags()

Parameters:

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

Returns:

this

versioningConfiguration

public CfnBucketProps.Builder versioningConfiguration(IResolvable versioningConfiguration)

Sets the value of CfnBucketProps.getVersioningConfiguration()

Parameters:

versioningConfiguration - 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.

Returns:

this

versioningConfiguration

public CfnBucketProps.Builder versioningConfiguration(CfnBucket.VersioningConfigurationProperty versioningConfiguration)

Sets the value of CfnBucketProps.getVersioningConfiguration()

Parameters:

versioningConfiguration - 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.

Returns:

this

websiteConfiguration

public CfnBucketProps.Builder websiteConfiguration(IResolvable websiteConfiguration)

Sets the value of CfnBucketProps.getWebsiteConfiguration()

Parameters:

websiteConfiguration - Information used to configure the bucket as a static website. For more information, see Hosting Websites on Amazon S3 .

Returns:

this

websiteConfiguration

public CfnBucketProps.Builder websiteConfiguration(CfnBucket.WebsiteConfigurationProperty websiteConfiguration)

Sets the value of CfnBucketProps.getWebsiteConfiguration()

Parameters:

websiteConfiguration - Information used to configure the bucket as a static website. For more information, see Hosting Websites on Amazon S3 .

Returns:

this

build

public CfnBucketProps build()

Builds the configured instance.

Returns:

a new instance of CfnBucketProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided