Package software.amazon.awscdk.services.s3express

Class CfnDirectoryBucket

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.s3express.CfnDirectoryBucket
All Implemented Interfaces:
IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-12T19:34:09.213Z") @Stability(Stable) public class CfnDirectoryBucket extends CfnResource implements IInspectable
The AWS::S3Express::DirectoryBucket resource creates an Amazon S3 directory 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.

  • Permissions - The required permissions for CloudFormation to use are based on the operations that are performed on the stack.
  • Create
  • s3express:CreateBucket
  • s3express:ListAllMyDirectoryBuckets
  • Read
  • s3express:ListAllMyDirectoryBuckets
  • Delete
  • s3express:DeleteBucket
  • s3express:ListAllMyDirectoryBuckets
  • List
  • s3express:ListAllMyDirectoryBuckets

The following operations are related to AWS::S3Express::DirectoryBucket :

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.s3express.*;
 CfnDirectoryBucket cfnDirectoryBucket = CfnDirectoryBucket.Builder.create(this, "MyCfnDirectoryBucket")
         .dataRedundancy("dataRedundancy")
         .locationName("locationName")
         // the properties below are optional
         .bucketName("bucketName")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnDirectoryBucket

      protected CfnDirectoryBucket(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnDirectoryBucket

      protected CfnDirectoryBucket(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnDirectoryBucket

      @Stability(Stable) public CfnDirectoryBucket(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDirectoryBucketProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrArn()
      Returns the Amazon Resource Name (ARN) of the specified bucket.

      Example: arn:aws:s3express: *us-west-2* : *account_id* :bucket/ *DOC-EXAMPLE-BUCKET* -- *usw2-az1* --x-s3

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getDataRedundancy

      @Stability(Stable) @NotNull public String getDataRedundancy()
      The number of Availability Zone that's used for redundancy for the bucket.

    • setDataRedundancy

      @Stability(Stable) public void setDataRedundancy(@NotNull String value)
      The number of Availability Zone that's used for redundancy for the bucket.

    • getLocationName

      @Stability(Stable) @NotNull public String getLocationName()
      The name of the location where the bucket will be created.

    • setLocationName

      @Stability(Stable) public void setLocationName(@NotNull String value)
      The name of the location where the bucket will be created.

    • getBucketName

      @Stability(Stable) @Nullable public String getBucketName()
      A name for the bucket.

    • setBucketName

      @Stability(Stable) public void setBucketName(@Nullable String value)
      A name for the bucket.