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
bucketName: 'bucketName',
};
Properties
Name | Type | Description |
---|---|---|
data | string | The number of Availability Zone that's used for redundancy for the bucket. |
location | string | The name of the location where the bucket will be created. |
bucket | string | A name for the bucket. |
dataRedundancy
Type:
string
The number of Availability 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 AZ ID of the Availability Zone where the bucket will be created. An example AZ ID value is usw2-az1
.
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 Availability Zone. The bucket name must also follow the format *bucket_base_name* -- *az_id* --x-s3
(for example, *DOC-EXAMPLE-BUCKET* -- *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.