Package software.amazon.awscdk.services.s3express

Interface CfnDirectoryBucketProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDirectoryBucketProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2025-01-10T21:56:59.103Z")
@Stability(Stable)
public interface CfnDirectoryBucketProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.s3express.*;
 CfnDirectoryBucketProps cfnDirectoryBucketProps = CfnDirectoryBucketProps.builder()
         .dataRedundancy("dataRedundancy")
         .locationName("locationName")
         // the properties below are optional
         .bucketEncryption(BucketEncryptionProperty.builder()
                 .serverSideEncryptionConfiguration(List.of(ServerSideEncryptionRuleProperty.builder()
                         .bucketKeyEnabled(false)
                         .serverSideEncryptionByDefault(ServerSideEncryptionByDefaultProperty.builder()
                                 .sseAlgorithm("sseAlgorithm")
                                 // the properties below are optional
                                 .kmsMasterKeyId("kmsMasterKeyId")
                                 .build())
                         .build()))
                 .build())
         .bucketName("bucketName")
         .lifecycleConfiguration(LifecycleConfigurationProperty.builder()
                 .rules(List.of(RuleProperty.builder()
                         .status("status")
                         // the properties below are optional
                         .abortIncompleteMultipartUpload(AbortIncompleteMultipartUploadProperty.builder()
                                 .daysAfterInitiation(123)
                                 .build())
                         .expirationInDays(123)
                         .id("id")
                         .objectSizeGreaterThan("objectSizeGreaterThan")
                         .objectSizeLessThan("objectSizeLessThan")
                         .prefix("prefix")
                         .build()))
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDirectoryBucketProps.Builder	A builder for CfnDirectoryBucketProps
static final class	CfnDirectoryBucketProps.Jsii$Proxy	An implementation for CfnDirectoryBucketProps

Method Summary

Modifier and Type	Method	Description
static CfnDirectoryBucketProps.Builder	builder()
default Object	getBucketEncryption()	Specifies default encryption for a bucket using server-side encryption with Amazon S3 managed keys (SSE-S3) or AWS KMS keys (SSE-KMS).
default String	getBucketName()	A name for the bucket.
String	getDataRedundancy()	The number of Zone (Availability Zone or Local Zone) that's used for redundancy for the bucket.
default Object	getLifecycleConfiguration()	Container for lifecycle rules.
String	getLocationName()	The name of the location where the bucket will be created.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDataRedundancy

@Stability(Stable)
@NotNull
String getDataRedundancy()

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

See Also:

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

getLocationName

@Stability(Stable)
@NotNull
String getLocationName()

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 Also:

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

getBucketEncryption

@Stability(Stable)
@Nullable
default Object getBucketEncryption()

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 Also:

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

getBucketName

@Stability(Stable)
@Nullable
default String getBucketName()

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.

See Also:

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

getLifecycleConfiguration

@Stability(Stable)
@Nullable
default Object getLifecycleConfiguration()

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 Also:

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

builder

@Stability(Stable)
static CfnDirectoryBucketProps.Builder builder()

Returns:

a CfnDirectoryBucketProps.Builder of CfnDirectoryBucketProps