CfnDirectoryBucketProps

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

Bases: object

Properties for defining a CfnDirectoryBucket.

Parameters:

data_redundancy (str) – The number of Zone (Availability Zone or Local 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 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 .
bucket_encryption (Union[IResolvable, BucketEncryptionProperty, Dict[str, Any], None]) – 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 .
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 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 . .. 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.
lifecycle_configuration (Union[IResolvable, LifecycleConfigurationProperty, Dict[str, Any], None]) – 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 .

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_encryption=s3express.CfnDirectoryBucket.BucketEncryptionProperty(
        server_side_encryption_configuration=[s3express.CfnDirectoryBucket.ServerSideEncryptionRuleProperty(
            bucket_key_enabled=False,
            server_side_encryption_by_default=s3express.CfnDirectoryBucket.ServerSideEncryptionByDefaultProperty(
                sse_algorithm="sseAlgorithm",

                # the properties below are optional
                kms_master_key_id="kmsMasterKeyId"
            )
        )]
    ),
    bucket_name="bucketName",
    lifecycle_configuration=s3express.CfnDirectoryBucket.LifecycleConfigurationProperty(
        rules=[s3express.CfnDirectoryBucket.RuleProperty(
            status="status",

            # the properties below are optional
            abort_incomplete_multipart_upload=s3express.CfnDirectoryBucket.AbortIncompleteMultipartUploadProperty(
                days_after_initiation=123
            ),
            expiration_in_days=123,
            id="id",
            object_size_greater_than="objectSizeGreaterThan",
            object_size_less_than="objectSizeLessThan",
            prefix="prefix"
        )]
    )
)

Attributes

bucket_encryption

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 .

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

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 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 . .. 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 Zone (Availability Zone or Local 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

lifecycle_configuration

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 .

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

location_name

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 .

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