CfnBucket (AWS CDK 1.202.0 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.constructs.Construct
  - - software.amazon.awscdk.core.Construct
    - - software.amazon.awscdk.core.CfnElement
      - software.amazon.awscdk.core.CfnRefElement
        
        software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.s3.CfnBucket

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
```
@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-05-19T23:09:24.602Z")
 @Stability(value=Stable)
public class CfnBucket
extends CfnResource
implements IInspectable
```
A CloudFormation `AWS::S3::Bucket`.
The AWS::S3::Bucket resource creates an Amazon S3 bucket in the same AWS Region where you create the AWS CloudFormation stack.
To control how AWS CloudFormation handles the bucket when the stack is deleted, you can set a deletion policy for your bucket. You can choose to retain the bucket or to delete the bucket. For more information, see DeletionPolicy Attribute .

You can only delete empty buckets. Deletion fails for buckets that have contents.

Example:
```
 CfnInclude cfnTemplate;
 CfnBucket cfnBucket = (CfnBucket)cfnTemplate.getResource("Bucket");
 Role role = Role.Builder.create(this, "Role")
         .assumedBy(new AnyPrincipal())
         .build();
 role.addToPolicy(PolicyStatement.Builder.create()
         .actions(List.of("s3:*"))
         .resources(List.of(cfnBucket.getAttrArn()))
         .build());
 
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CfnBucket.AbortIncompleteMultipartUploadProperty` Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload.
`static interface`	`CfnBucket.AccelerateConfigurationProperty` Configures the transfer acceleration state for an Amazon S3 bucket.
`static interface`	`CfnBucket.AccessControlTranslationProperty` 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.
`static interface`	`CfnBucket.AnalyticsConfigurationProperty` Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.
`static interface`	`CfnBucket.BucketEncryptionProperty` 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.
`static class`	`CfnBucket.Builder` A fluent builder for `CfnBucket`.
`static interface`	`CfnBucket.CorsConfigurationProperty` Describes the cross-origin access configuration for objects in an Amazon S3 bucket.
`static interface`	`CfnBucket.CorsRuleProperty` Specifies a cross-origin access rule for an Amazon S3 bucket.
`static interface`	`CfnBucket.DataExportProperty` Specifies how data related to the storage class analysis for an Amazon S3 bucket should be exported.
`static interface`	`CfnBucket.DefaultRetentionProperty` The container element for specifying the default Object Lock retention settings for new objects placed in the specified bucket.
`static interface`	`CfnBucket.DeleteMarkerReplicationProperty` Specifies whether Amazon S3 replicates delete markers.
`static interface`	`CfnBucket.DestinationProperty` Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket.
`static interface`	`CfnBucket.EncryptionConfigurationProperty` Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects.
`static interface`	`CfnBucket.EventBridgeConfigurationProperty` Amazon S3 can send events to Amazon EventBridge whenever certain events happen in your bucket, see [Using EventBridge](https://docs.aws.amazon.com/AmazonS3/latest/userguide/EventBridge.html) in the Amazon S3 User Guide .
`static interface`	`CfnBucket.FilterRuleProperty` Specifies the Amazon S3 object key name to filter on and whether to filter on the suffix or prefix of the key name.
`static interface`	`CfnBucket.IntelligentTieringConfigurationProperty` Specifies the S3 Intelligent-Tiering configuration for an Amazon S3 bucket.
`static interface`	`CfnBucket.InventoryConfigurationProperty` Specifies the inventory configuration for an Amazon S3 bucket.
`static interface`	`CfnBucket.LambdaConfigurationProperty` Describes the AWS Lambda functions to invoke and the events for which to invoke them.
`static interface`	`CfnBucket.LifecycleConfigurationProperty` Specifies the lifecycle configuration for objects in an Amazon S3 bucket.
`static interface`	`CfnBucket.LoggingConfigurationProperty` Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket.
`static interface`	`CfnBucket.MetricsConfigurationProperty` Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket.
`static interface`	`CfnBucket.MetricsProperty` A container specifying replication metrics-related settings enabling replication metrics and events.
`static interface`	`CfnBucket.NoncurrentVersionExpirationProperty` Specifies when noncurrent object versions expire.
`static interface`	`CfnBucket.NoncurrentVersionTransitionProperty` 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.
`static interface`	`CfnBucket.NotificationConfigurationProperty` Describes the notification configuration for an Amazon S3 bucket.
`static interface`	`CfnBucket.NotificationFilterProperty` Specifies object key name filtering rules.
`static interface`	`CfnBucket.ObjectLockConfigurationProperty` Places an Object Lock configuration on the specified bucket.
`static interface`	`CfnBucket.ObjectLockRuleProperty` Specifies the Object Lock rule for the specified object.
`static interface`	`CfnBucket.OwnershipControlsProperty` Specifies the container element for Object Ownership rules.
`static interface`	`CfnBucket.OwnershipControlsRuleProperty` Specifies an Object Ownership rule.
`static interface`	`CfnBucket.PublicAccessBlockConfigurationProperty` The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket.
`static interface`	`CfnBucket.QueueConfigurationProperty` Specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events.
`static interface`	`CfnBucket.RedirectAllRequestsToProperty` Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.
`static interface`	`CfnBucket.RedirectRuleProperty` Specifies how requests are redirected.
`static interface`	`CfnBucket.ReplicaModificationsProperty` A filter that you can specify for selection for modifications on replicas.
`static interface`	`CfnBucket.ReplicationConfigurationProperty` A container for replication rules.
`static interface`	`CfnBucket.ReplicationDestinationProperty` A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC).
`static interface`	`CfnBucket.ReplicationRuleAndOperatorProperty` A container for specifying rule filters.
`static interface`	`CfnBucket.ReplicationRuleFilterProperty` A filter that identifies the subset of objects to which the replication rule applies.
`static interface`	`CfnBucket.ReplicationRuleProperty` Specifies which Amazon S3 objects to replicate and where to store the replicas.
`static interface`	`CfnBucket.ReplicationTimeProperty` A container specifying S3 Replication Time Control (S3 RTC) related information, including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated.
`static interface`	`CfnBucket.ReplicationTimeValueProperty` A container specifying the time value for S3 Replication Time Control (S3 RTC) and replication metrics `EventThreshold` .
`static interface`	`CfnBucket.RoutingRuleConditionProperty` A container for describing a condition that must be met for the specified redirect to apply.
`static interface`	`CfnBucket.RoutingRuleProperty` Specifies the redirect behavior and when a redirect is applied.
`static interface`	`CfnBucket.RuleProperty` Specifies lifecycle rules for an Amazon S3 bucket.
`static interface`	`CfnBucket.S3KeyFilterProperty` A container for object key name prefix and suffix filtering rules.
`static interface`	`CfnBucket.ServerSideEncryptionByDefaultProperty` Describes the default server-side encryption to apply to new objects in the bucket.
`static interface`	`CfnBucket.ServerSideEncryptionRuleProperty` Specifies the default server-side encryption configuration.
`static interface`	`CfnBucket.SourceSelectionCriteriaProperty` A container that describes additional filters for identifying the source objects that you want to replicate.
`static interface`	`CfnBucket.SseKmsEncryptedObjectsProperty` A container for filter information for the selection of S3 objects encrypted with AWS KMS.
`static interface`	`CfnBucket.StorageClassAnalysisProperty` 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.
`static interface`	`CfnBucket.TagFilterProperty` Specifies tags to use to identify a subset of objects for an Amazon S3 bucket.
`static interface`	`CfnBucket.TieringProperty` 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.
`static interface`	`CfnBucket.TopicConfigurationProperty` 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.
`static interface`	`CfnBucket.TransitionProperty` Specifies when an object transitions to a specified storage class.
`static interface`	`CfnBucket.VersioningConfigurationProperty` Describes the versioning state of an Amazon S3 bucket.
`static interface`	`CfnBucket.WebsiteConfigurationProperty` Specifies website configuration parameters for an Amazon S3 bucket.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnBucket(Construct scope, String id)` Create a new `AWS::S3::Bucket`.
	`CfnBucket(Construct scope, String id, CfnBucketProps props)` Create a new `AWS::S3::Bucket`.
`protected`	`CfnBucket(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnBucket(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`getAccelerateConfiguration()` Configures the transfer acceleration state for an Amazon S3 bucket.
`String`	`getAccessControl()` A canned access control list (ACL) that grants predefined permissions to the bucket.
`Object`	`getAnalyticsConfigurations()` Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.
`String`	`getAttrArn()` Returns the Amazon Resource Name (ARN) of the specified bucket.
`String`	`getAttrDomainName()` Returns the IPv4 DNS name of the specified bucket.
`String`	`getAttrDualStackDomainName()` Returns the IPv6 DNS name of the specified bucket.
`String`	`getAttrRegionalDomainName()` Returns the regional domain name of the specified bucket.
`String`	`getAttrWebsiteUrl()` Returns the Amazon S3 website endpoint for the specified bucket.
`Object`	`getBucketEncryption()` 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.
`String`	`getBucketName()` A name for the bucket.
`protected Map<String,Object>`	`getCfnProperties()`
`Object`	`getCorsConfiguration()` Describes the cross-origin access configuration for objects in an Amazon S3 bucket.
`Object`	`getIntelligentTieringConfigurations()` Defines how Amazon S3 handles Intelligent-Tiering storage.
`Object`	`getInventoryConfigurations()` Specifies the inventory configuration for an Amazon S3 bucket.
`Object`	`getLifecycleConfiguration()` Specifies the lifecycle configuration for objects in an Amazon S3 bucket.
`Object`	`getLoggingConfiguration()` Settings that define where logs are stored.
`Object`	`getMetricsConfigurations()` Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket.
`Object`	`getNotificationConfiguration()` Configuration that defines how Amazon S3 handles bucket notifications.
`Object`	`getObjectLockConfiguration()` Places an Object Lock configuration on the specified bucket.
`Object`	`getObjectLockEnabled()` Indicates whether this bucket has an Object Lock configuration enabled.
`Object`	`getOwnershipControls()` Configuration that defines how Amazon S3 handles Object Ownership rules.
`Object`	`getPublicAccessBlockConfiguration()` Configuration that defines how Amazon S3 handles public access.
`Object`	`getReplicationConfiguration()` Configuration for replicating objects in an S3 bucket.
`TagManager`	`getTags()` An arbitrary set of tags (key-value pairs) for this S3 bucket.
`Object`	`getVersioningConfiguration()` Enables multiple versions of all objects in this bucket.
`Object`	`getWebsiteConfiguration()` Information used to configure the bucket as a static website.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected Map<String,Object>`	`renderProperties(Map<String,Object> props)`
`void`	`setAccelerateConfiguration(CfnBucket.AccelerateConfigurationProperty value)` Configures the transfer acceleration state for an Amazon S3 bucket.
`void`	`setAccelerateConfiguration(IResolvable value)` Configures the transfer acceleration state for an Amazon S3 bucket.
`void`	`setAccessControl(String value)` A canned access control list (ACL) that grants predefined permissions to the bucket.
`void`	`setAnalyticsConfigurations(IResolvable value)` Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.
`void`	`setAnalyticsConfigurations(List<Object> value)` Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.
`void`	`setBucketEncryption(CfnBucket.BucketEncryptionProperty value)` 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.
`void`	`setBucketEncryption(IResolvable value)` 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.
`void`	`setBucketName(String value)` A name for the bucket.
`void`	`setCorsConfiguration(CfnBucket.CorsConfigurationProperty value)` Describes the cross-origin access configuration for objects in an Amazon S3 bucket.
`void`	`setCorsConfiguration(IResolvable value)` Describes the cross-origin access configuration for objects in an Amazon S3 bucket.
`void`	`setIntelligentTieringConfigurations(IResolvable value)` Defines how Amazon S3 handles Intelligent-Tiering storage.
`void`	`setIntelligentTieringConfigurations(List<Object> value)` Defines how Amazon S3 handles Intelligent-Tiering storage.
`void`	`setInventoryConfigurations(IResolvable value)` Specifies the inventory configuration for an Amazon S3 bucket.
`void`	`setInventoryConfigurations(List<Object> value)` Specifies the inventory configuration for an Amazon S3 bucket.
`void`	`setLifecycleConfiguration(CfnBucket.LifecycleConfigurationProperty value)` Specifies the lifecycle configuration for objects in an Amazon S3 bucket.
`void`	`setLifecycleConfiguration(IResolvable value)` Specifies the lifecycle configuration for objects in an Amazon S3 bucket.
`void`	`setLoggingConfiguration(CfnBucket.LoggingConfigurationProperty value)` Settings that define where logs are stored.
`void`	`setLoggingConfiguration(IResolvable value)` Settings that define where logs are stored.
`void`	`setMetricsConfigurations(IResolvable value)` Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket.
`void`	`setMetricsConfigurations(List<Object> value)` Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket.
`void`	`setNotificationConfiguration(CfnBucket.NotificationConfigurationProperty value)` Configuration that defines how Amazon S3 handles bucket notifications.
`void`	`setNotificationConfiguration(IResolvable value)` Configuration that defines how Amazon S3 handles bucket notifications.
`void`	`setObjectLockConfiguration(CfnBucket.ObjectLockConfigurationProperty value)` Places an Object Lock configuration on the specified bucket.
`void`	`setObjectLockConfiguration(IResolvable value)` Places an Object Lock configuration on the specified bucket.
`void`	`setObjectLockEnabled(Boolean value)` Indicates whether this bucket has an Object Lock configuration enabled.
`void`	`setObjectLockEnabled(IResolvable value)` Indicates whether this bucket has an Object Lock configuration enabled.
`void`	`setOwnershipControls(CfnBucket.OwnershipControlsProperty value)` Configuration that defines how Amazon S3 handles Object Ownership rules.
`void`	`setOwnershipControls(IResolvable value)` Configuration that defines how Amazon S3 handles Object Ownership rules.
`void`	`setPublicAccessBlockConfiguration(CfnBucket.PublicAccessBlockConfigurationProperty value)` Configuration that defines how Amazon S3 handles public access.
`void`	`setPublicAccessBlockConfiguration(IResolvable value)` Configuration that defines how Amazon S3 handles public access.
`void`	`setReplicationConfiguration(CfnBucket.ReplicationConfigurationProperty value)` Configuration for replicating objects in an S3 bucket.
`void`	`setReplicationConfiguration(IResolvable value)` Configuration for replicating objects in an S3 bucket.
`void`	`setVersioningConfiguration(CfnBucket.VersioningConfigurationProperty value)` Enables multiple versions of all objects in this bucket.
`void`	`setVersioningConfiguration(IResolvable value)` Enables multiple versions of all objects in this bucket.
`void`	`setWebsiteConfiguration(CfnBucket.WebsiteConfigurationProperty value)` Information used to configure the bucket as a static website.
`void`	`setWebsiteConfiguration(IResolvable value)` Information used to configure the bucket as a static website.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnBucket
```
protected CfnBucket(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnBucket
```
protected CfnBucket(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnBucket
```
@Stability(value=Stable)
public CfnBucket(@NotNull
                                          Construct scope,
                                          @NotNull
                                          String id,
                                          @Nullable
                                          CfnBucketProps props)
```
    Create a new `AWS::S3::Bucket`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    props - - resource properties.
  - CfnBucket
```
@Stability(value=Stable)
public CfnBucket(@NotNull
                                          Construct scope,
                                          @NotNull
                                          String id)
```
    Create a new `AWS::S3::Bucket`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
- Method Detail
  - inspect
```
@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)
```
    Examines the CloudFormation resource and discloses attributes.
    
    Specified by:
    
    inspect in interface IInspectable
    
    Parameters:
    
    inspector - - tree inspector to collect and process attributes. This parameter is required.
  - renderProperties
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrArn
```
@Stability(value=Stable)
 @NotNull
public String getAttrArn()
```
    Returns the Amazon Resource Name (ARN) of the specified bucket.
    Example: arn:aws:s3:::DOC-EXAMPLE-BUCKET
  - getAttrDomainName
```
@Stability(value=Stable)
 @NotNull
public String getAttrDomainName()
```
    Returns the IPv4 DNS name of the specified bucket.
    Example: DOC-EXAMPLE-BUCKET.s3.amazonaws.com
  - getAttrDualStackDomainName
```
@Stability(value=Stable)
 @NotNull
public String getAttrDualStackDomainName()
```
    Returns the IPv6 DNS name of the specified bucket.
    Example: DOC-EXAMPLE-BUCKET.s3.dualstack.us-east-2.amazonaws.com
    For more information about dual-stack endpoints, see Using Amazon S3 Dual-Stack Endpoints .
  - getAttrRegionalDomainName
```
@Stability(value=Stable)
 @NotNull
public String getAttrRegionalDomainName()
```
    Returns the regional domain name of the specified bucket.
    Example: DOC-EXAMPLE-BUCKET.s3.us-east-2.amazonaws.com
  - getAttrWebsiteUrl
```
@Stability(value=Stable)
 @NotNull
public String getAttrWebsiteUrl()
```
    Returns the Amazon S3 website endpoint for the specified bucket.
    Example (IPv4): http://DOC-EXAMPLE-BUCKET.s3-website.us-east-2.amazonaws.com
    Example (IPv6): http://DOC-EXAMPLE-BUCKET.s3.dualstack.us-east-2.amazonaws.com
  - getCfnProperties
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
@Stability(value=Stable)
 @NotNull
public TagManager getTags()
```
    An arbitrary set of tags (key-value pairs) for this S3 bucket.
  - getAccelerateConfiguration
```
@Stability(value=Stable)
 @Nullable
public 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 .
  - setAccelerateConfiguration
```
@Stability(value=Stable)
public void setAccelerateConfiguration(@Nullable
                                                                IResolvable value)
```
    Configures the transfer acceleration state for an Amazon S3 bucket.
    For more information, see Amazon S3 Transfer Acceleration in the Amazon S3 User Guide .
  - setAccelerateConfiguration
```
@Stability(value=Stable)
public void setAccelerateConfiguration(@Nullable
                                                                CfnBucket.AccelerateConfigurationProperty value)
```
    Configures the transfer acceleration state for an Amazon S3 bucket.
    For more information, see Amazon S3 Transfer Acceleration in the Amazon S3 User Guide .
  - getAccessControl
```
@Stability(value=Stable)
 @Nullable
public String getAccessControl()
```
    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.
  - setAccessControl
```
@Stability(value=Stable)
public void setAccessControl(@Nullable
                                                      String value)
```
    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.
  - getAnalyticsConfigurations
```
@Stability(value=Stable)
 @Nullable
public Object getAnalyticsConfigurations()
```
    Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.
  - setAnalyticsConfigurations
```
@Stability(value=Stable)
public void setAnalyticsConfigurations(@Nullable
                                                                IResolvable value)
```
    Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.
  - setAnalyticsConfigurations
```
@Stability(value=Stable)
public void setAnalyticsConfigurations(@Nullable
                                                                List<Object> value)
```
    Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.
  - getBucketEncryption
```
@Stability(value=Stable)
 @Nullable
public Object getBucketEncryption()
```
    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 .
  - setBucketEncryption
```
@Stability(value=Stable)
public void setBucketEncryption(@Nullable
                                                         IResolvable value)
```
    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 .
  - setBucketEncryption
```
@Stability(value=Stable)
public void setBucketEncryption(@Nullable
                                                         CfnBucket.BucketEncryptionProperty value)
```
    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 .
  - getBucketName
```
@Stability(value=Stable)
 @Nullable
public 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.
  - setBucketName
```
@Stability(value=Stable)
public void setBucketName(@Nullable
                                                   String value)
```
    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.
  - getCorsConfiguration
```
@Stability(value=Stable)
 @Nullable
public 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 .
  - setCorsConfiguration
```
@Stability(value=Stable)
public void setCorsConfiguration(@Nullable
                                                          IResolvable value)
```
    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 .
  - setCorsConfiguration
```
@Stability(value=Stable)
public void setCorsConfiguration(@Nullable
                                                          CfnBucket.CorsConfigurationProperty value)
```
    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 .
  - getIntelligentTieringConfigurations
```
@Stability(value=Stable)
 @Nullable
public Object getIntelligentTieringConfigurations()
```
    Defines how Amazon S3 handles Intelligent-Tiering storage.
  - setIntelligentTieringConfigurations
```
@Stability(value=Stable)
public void setIntelligentTieringConfigurations(@Nullable
                                                                         IResolvable value)
```
    Defines how Amazon S3 handles Intelligent-Tiering storage.
  - setIntelligentTieringConfigurations
```
@Stability(value=Stable)
public void setIntelligentTieringConfigurations(@Nullable
                                                                         List<Object> value)
```
    Defines how Amazon S3 handles Intelligent-Tiering storage.
  - getInventoryConfigurations
```
@Stability(value=Stable)
 @Nullable
public Object getInventoryConfigurations()
```
    Specifies the inventory configuration for an Amazon S3 bucket.
    For more information, see GET Bucket inventory in the Amazon S3 API Reference .
  - setInventoryConfigurations
```
@Stability(value=Stable)
public void setInventoryConfigurations(@Nullable
                                                                IResolvable value)
```
    Specifies the inventory configuration for an Amazon S3 bucket.
    For more information, see GET Bucket inventory in the Amazon S3 API Reference .
  - setInventoryConfigurations
```
@Stability(value=Stable)
public void setInventoryConfigurations(@Nullable
                                                                List<Object> value)
```
    Specifies the inventory configuration for an Amazon S3 bucket.
    For more information, see GET Bucket inventory in the Amazon S3 API Reference .
  - getLifecycleConfiguration
```
@Stability(value=Stable)
 @Nullable
public 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 .
  - setLifecycleConfiguration
```
@Stability(value=Stable)
public void setLifecycleConfiguration(@Nullable
                                                               IResolvable value)
```
    Specifies the lifecycle configuration for objects in an Amazon S3 bucket.
    For more information, see Object Lifecycle Management in the Amazon S3 User Guide .
  - setLifecycleConfiguration
```
@Stability(value=Stable)
public void setLifecycleConfiguration(@Nullable
                                                               CfnBucket.LifecycleConfigurationProperty value)
```
    Specifies the lifecycle configuration for objects in an Amazon S3 bucket.
    For more information, see Object Lifecycle Management in the Amazon S3 User Guide .
  - getLoggingConfiguration
```
@Stability(value=Stable)
 @Nullable
public Object getLoggingConfiguration()
```
    Settings that define where logs are stored.
  - setLoggingConfiguration
```
@Stability(value=Stable)
public void setLoggingConfiguration(@Nullable
                                                             IResolvable value)
```
    Settings that define where logs are stored.
  - setLoggingConfiguration
```
@Stability(value=Stable)
public void setLoggingConfiguration(@Nullable
                                                             CfnBucket.LoggingConfigurationProperty value)
```
    Settings that define where logs are stored.
  - getMetricsConfigurations
```
@Stability(value=Stable)
 @Nullable
public 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 .
  - setMetricsConfigurations
```
@Stability(value=Stable)
public void setMetricsConfigurations(@Nullable
                                                              IResolvable value)
```
    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 .
  - setMetricsConfigurations
```
@Stability(value=Stable)
public void setMetricsConfigurations(@Nullable
                                                              List<Object> value)
```
    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 .
  - getNotificationConfiguration
```
@Stability(value=Stable)
 @Nullable
public Object getNotificationConfiguration()
```
    Configuration that defines how Amazon S3 handles bucket notifications.
  - setNotificationConfiguration
```
@Stability(value=Stable)
public void setNotificationConfiguration(@Nullable
                                                                  IResolvable value)
```
    Configuration that defines how Amazon S3 handles bucket notifications.
  - setNotificationConfiguration
```
@Stability(value=Stable)
public void setNotificationConfiguration(@Nullable
                                                                  CfnBucket.NotificationConfigurationProperty value)
```
    Configuration that defines how Amazon S3 handles bucket notifications.
  - getObjectLockConfiguration
```
@Stability(value=Stable)
 @Nullable
public Object getObjectLockConfiguration()
```
    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.
  - setObjectLockConfiguration
```
@Stability(value=Stable)
public void setObjectLockConfiguration(@Nullable
                                                                IResolvable value)
```
    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.
  - setObjectLockConfiguration
```
@Stability(value=Stable)
public void setObjectLockConfiguration(@Nullable
                                                                CfnBucket.ObjectLockConfigurationProperty value)
```
    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.
  - getObjectLockEnabled
```
@Stability(value=Stable)
 @Nullable
public Object getObjectLockEnabled()
```
    Indicates whether this bucket has an Object Lock configuration enabled.
    Enable ObjectLockEnabled when you apply ObjectLockConfiguration to a bucket.
  - setObjectLockEnabled
```
@Stability(value=Stable)
public void setObjectLockEnabled(@Nullable
                                                          Boolean value)
```
    Indicates whether this bucket has an Object Lock configuration enabled.
    Enable ObjectLockEnabled when you apply ObjectLockConfiguration to a bucket.
  - setObjectLockEnabled
```
@Stability(value=Stable)
public void setObjectLockEnabled(@Nullable
                                                          IResolvable value)
```
    Indicates whether this bucket has an Object Lock configuration enabled.
    Enable ObjectLockEnabled when you apply ObjectLockConfiguration to a bucket.
  - getOwnershipControls
```
@Stability(value=Stable)
 @Nullable
public Object getOwnershipControls()
```
    Configuration that defines how Amazon S3 handles Object Ownership rules.
  - setOwnershipControls
```
@Stability(value=Stable)
public void setOwnershipControls(@Nullable
                                                          IResolvable value)
```
    Configuration that defines how Amazon S3 handles Object Ownership rules.
  - setOwnershipControls
```
@Stability(value=Stable)
public void setOwnershipControls(@Nullable
                                                          CfnBucket.OwnershipControlsProperty value)
```
    Configuration that defines how Amazon S3 handles Object Ownership rules.
  - getPublicAccessBlockConfiguration
```
@Stability(value=Stable)
 @Nullable
public Object getPublicAccessBlockConfiguration()
```
    Configuration that defines how Amazon S3 handles public access.
  - setPublicAccessBlockConfiguration
```
@Stability(value=Stable)
public void setPublicAccessBlockConfiguration(@Nullable
                                                                       IResolvable value)
```
    Configuration that defines how Amazon S3 handles public access.
  - setPublicAccessBlockConfiguration
```
@Stability(value=Stable)
public void setPublicAccessBlockConfiguration(@Nullable
                                                                       CfnBucket.PublicAccessBlockConfigurationProperty value)
```
    Configuration that defines how Amazon S3 handles public access.
  - getReplicationConfiguration
```
@Stability(value=Stable)
 @Nullable
public 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.
  - setReplicationConfiguration
```
@Stability(value=Stable)
public void setReplicationConfiguration(@Nullable
                                                                 IResolvable value)
```
    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.
  - setReplicationConfiguration
```
@Stability(value=Stable)
public void setReplicationConfiguration(@Nullable
                                                                 CfnBucket.ReplicationConfigurationProperty value)
```
    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.
  - getVersioningConfiguration
```
@Stability(value=Stable)
 @Nullable
public 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.
  - setVersioningConfiguration
```
@Stability(value=Stable)
public void setVersioningConfiguration(@Nullable
                                                                IResolvable value)
```
    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.
  - setVersioningConfiguration
```
@Stability(value=Stable)
public void setVersioningConfiguration(@Nullable
                                                                CfnBucket.VersioningConfigurationProperty value)
```
    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.
  - getWebsiteConfiguration
```
@Stability(value=Stable)
 @Nullable
public Object getWebsiteConfiguration()
```
    Information used to configure the bucket as a static website.
    For more information, see Hosting Websites on Amazon S3 .
  - setWebsiteConfiguration
```
@Stability(value=Stable)
public void setWebsiteConfiguration(@Nullable
                                                             IResolvable value)
```
    Information used to configure the bucket as a static website.
    For more information, see Hosting Websites on Amazon S3 .
  - setWebsiteConfiguration
```
@Stability(value=Stable)
public void setWebsiteConfiguration(@Nullable
                                                             CfnBucket.WebsiteConfigurationProperty value)
```
    Information used to configure the bucket as a static website.
    For more information, see Hosting Websites on Amazon S3 .

Class CfnBucket

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnBucket

CfnBucket

CfnBucket

CfnBucket

Method Detail

inspect

renderProperties

getAttrArn

getAttrDomainName

getAttrDualStackDomainName

getAttrRegionalDomainName

getAttrWebsiteUrl

getCfnProperties

getTags

getAccelerateConfiguration

setAccelerateConfiguration

setAccelerateConfiguration

getAccessControl

setAccessControl

getAnalyticsConfigurations

setAnalyticsConfigurations

setAnalyticsConfigurations

getBucketEncryption

setBucketEncryption

setBucketEncryption

getBucketName

setBucketName

getCorsConfiguration

setCorsConfiguration

setCorsConfiguration

getIntelligentTieringConfigurations

setIntelligentTieringConfigurations

setIntelligentTieringConfigurations

getInventoryConfigurations

setInventoryConfigurations

setInventoryConfigurations

getLifecycleConfiguration

setLifecycleConfiguration

setLifecycleConfiguration

getLoggingConfiguration

setLoggingConfiguration

setLoggingConfiguration

getMetricsConfigurations

setMetricsConfigurations

setMetricsConfigurations

getNotificationConfiguration

setNotificationConfiguration

setNotificationConfiguration

getObjectLockConfiguration

setObjectLockConfiguration

setObjectLockConfiguration

getObjectLockEnabled

setObjectLockEnabled

setObjectLockEnabled

getOwnershipControls

setOwnershipControls

setOwnershipControls

getPublicAccessBlockConfiguration

setPublicAccessBlockConfiguration

setPublicAccessBlockConfiguration

getReplicationConfiguration

setReplicationConfiguration