CfnDirectoryBucketProps

class aws_cdk.aws_s3express.CfnDirectoryBucketProps(*, data_redundancy, location_name, bucket_name=None)

Bases: object

Properties for defining a CfnDirectoryBucket.

Parameters:

  • data_redundancy (str) – The number of Availability Zone that’s used for redundancy for the bucket.

  • location_name (str) – 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 .

  • bucket_name (Optional[str]) – 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 . .. epigraph:: 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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3express-directorybucket.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_s3express as s3express

cfn_directory_bucket_props = s3express.CfnDirectoryBucketProps(
    data_redundancy="dataRedundancy",
    location_name="locationName",

    # the properties below are optional
    bucket_name="bucketName"
)

Attributes

bucket_name

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 . .. epigraph:

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.
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3express-directorybucket.html#cfn-s3express-directorybucket-bucketname

data_redundancy

The number of Availability Zone that’s used for redundancy for the bucket.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3express-directorybucket.html#cfn-s3express-directorybucket-dataredundancy

location_name

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 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3express-directorybucket.html#cfn-s3express-directorybucket-locationname