interface CfnDirectoryBucketProps

Language	Type name
.NET	`Amazon.CDK.aws_s3express.CfnDirectoryBucketProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awss3express#CfnDirectoryBucketProps`
Java	`software.amazon.awscdk.services.s3express.CfnDirectoryBucketProps`
Python	`aws_cdk.aws_s3express.CfnDirectoryBucketProps`
TypeScript	`aws-cdk-lib` » `aws_s3express` » `CfnDirectoryBucketProps`

Properties for defining a CfnDirectoryBucket.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_s3express as s3express } from 'aws-cdk-lib';
const cfnDirectoryBucketProps: s3express.CfnDirectoryBucketProps = {
  dataRedundancy: 'dataRedundancy',
  locationName: 'locationName',

  // the properties below are optional
  bucketEncryption: {
    serverSideEncryptionConfiguration: [{
      bucketKeyEnabled: false,
      serverSideEncryptionByDefault: {
        sseAlgorithm: 'sseAlgorithm',

        // the properties below are optional
        kmsMasterKeyId: 'kmsMasterKeyId',
      },
    }],
  },
  bucketName: 'bucketName',
  lifecycleConfiguration: {
    rules: [{
      status: 'status',

      // the properties below are optional
      abortIncompleteMultipartUpload: {
        daysAfterInitiation: 123,
      },
      expirationInDays: 123,
      id: 'id',
      objectSizeGreaterThan: 'objectSizeGreaterThan',
      objectSizeLessThan: 'objectSizeLessThan',
      prefix: 'prefix',
    }],
  },
};

Properties

Name	Type	Description
dataRedundancy	`string`	The number of Zone (Availability Zone or Local Zone) that's used for redundancy for the bucket.
locationName	`string`	The name of the location where the bucket will be created.
bucketEncryption?	`IResolvable` `\|` `BucketEncryptionProperty`	Specifies default encryption for a bucket using server-side encryption with Amazon S3 managed keys (SSE-S3) or AWS KMS keys (SSE-KMS).
bucketName?	`string`	A name for the bucket.
lifecycleConfiguration?	`IResolvable` `\|` `LifecycleConfigurationProperty`	Container for lifecycle rules. You can add as many as 1000 rules.

dataRedundancy

Type: string

The number of Zone (Availability Zone or Local Zone) that's used for redundancy for the bucket.

locationName

Type: string

The name of the location where the bucket will be created.

For directory buckets, the name of the location is the Zone ID of the Availability Zone (AZ) or Local Zone (LZ) where the bucket will be created. An example AZ ID value is usw2-az1 .

bucketEncryption?

Type: IResolvable | BucketEncryptionProperty (optional)

Specifies default encryption for a bucket using server-side encryption with Amazon S3 managed keys (SSE-S3) or AWS KMS keys (SSE-KMS).

For information about default encryption for directory buckets, see Setting and monitoring default encryption for directory buckets in the Amazon S3 User Guide .

bucketName?

Type: string (optional)

A name for the bucket.

The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Zone (Availability Zone or Local Zone). The bucket name must also follow the format *bucket_base_name* -- *zone_id* --x-s3 (for example, *bucket_base_name* -- *usw2-az1* --x-s3 ). If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name. For information about bucket naming restrictions, see Directory bucket naming rules 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.

lifecycleConfiguration?

Type: IResolvable | LifecycleConfigurationProperty (optional)

Container for lifecycle rules. You can add as many as 1000 rules.

For more information see, Creating and managing a lifecycle configuration for directory buckets in the Amazon S3 User Guide .