Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. s3express
  5. DirectoryBucket

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.s3express.DirectoryBucket

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::S3Express::DirectoryBucket.

    Create DirectoryBucket Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DirectoryBucket(name: string, args: DirectoryBucketArgs, opts?: CustomResourceOptions);
    @overload
def DirectoryBucket(resource_name: str,
                    args: DirectoryBucketArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def DirectoryBucket(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    data_redundancy: Optional[DirectoryBucketDataRedundancy] = None,
                    location_name: Optional[str] = None,
                    bucket_encryption: Optional[DirectoryBucketBucketEncryptionArgs] = None,
                    bucket_name: Optional[str] = None)
    func NewDirectoryBucket(ctx *Context, name string, args DirectoryBucketArgs, opts ...ResourceOption) (*DirectoryBucket, error)
    public DirectoryBucket(string name, DirectoryBucketArgs args, CustomResourceOptions? opts = null)
    public DirectoryBucket(String name, DirectoryBucketArgs args)
public DirectoryBucket(String name, DirectoryBucketArgs args, CustomResourceOptions options)

    type: aws-native:s3express:DirectoryBucket
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args DirectoryBucketArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DirectoryBucketArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DirectoryBucketArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DirectoryBucketArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DirectoryBucketArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    DirectoryBucket Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The DirectoryBucket resource accepts the following input properties:

    DataRedundancy Pulumi.AwsNative.S3Express.DirectoryBucketDataRedundancy
    Specifies the number of Availability Zone that's used for redundancy for the bucket.
    LocationName string
    Specifies the AZ ID of the Availability Zone where the directory bucket will be created. An example AZ ID value is 'use1-az5'.
    BucketEncryption Pulumi.AwsNative.S3Express.Inputs.DirectoryBucketBucketEncryption
    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 string
    Specifies 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 physical ID and uses that ID for the bucket name.
    DataRedundancy DirectoryBucketDataRedundancy
    Specifies the number of Availability Zone that's used for redundancy for the bucket.
    LocationName string
    Specifies the AZ ID of the Availability Zone where the directory bucket will be created. An example AZ ID value is 'use1-az5'.
    BucketEncryption DirectoryBucketBucketEncryptionArgs
    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 string
    Specifies 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 physical ID and uses that ID for the bucket name.
    dataRedundancy DirectoryBucketDataRedundancy
    Specifies the number of Availability Zone that's used for redundancy for the bucket.
    locationName String
    Specifies the AZ ID of the Availability Zone where the directory bucket will be created. An example AZ ID value is 'use1-az5'.
    bucketEncryption DirectoryBucketBucketEncryption
    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 String
    Specifies 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 physical ID and uses that ID for the bucket name.
    dataRedundancy DirectoryBucketDataRedundancy
    Specifies the number of Availability Zone that's used for redundancy for the bucket.
    locationName string
    Specifies the AZ ID of the Availability Zone where the directory bucket will be created. An example AZ ID value is 'use1-az5'.
    bucketEncryption DirectoryBucketBucketEncryption
    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 string
    Specifies 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 physical ID and uses that ID for the bucket name.
    data_redundancy DirectoryBucketDataRedundancy
    Specifies the number of Availability Zone that's used for redundancy for the bucket.
    location_name str
    Specifies the AZ ID of the Availability Zone where the directory bucket will be created. An example AZ ID value is 'use1-az5'.
    bucket_encryption DirectoryBucketBucketEncryptionArgs
    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 str
    Specifies 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 physical ID and uses that ID for the bucket name.
    dataRedundancy "SingleAvailabilityZone"
    Specifies the number of Availability Zone that's used for redundancy for the bucket.
    locationName String
    Specifies the AZ ID of the Availability Zone where the directory bucket will be created. An example AZ ID value is 'use1-az5'.
    bucketEncryption Property Map
    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 String
    Specifies 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 physical ID and uses that ID for the bucket name.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DirectoryBucket resource produces the following output properties:

    Arn string
    Returns the Amazon Resource Name (ARN) of the specified bucket.
    AvailabilityZoneName string
    Returns the code for the Availability Zone where the directory bucket was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    Returns the Amazon Resource Name (ARN) of the specified bucket.
    AvailabilityZoneName string
    Returns the code for the Availability Zone where the directory bucket was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    Returns the Amazon Resource Name (ARN) of the specified bucket.
    availabilityZoneName String
    Returns the code for the Availability Zone where the directory bucket was created.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    Returns the Amazon Resource Name (ARN) of the specified bucket.
    availabilityZoneName string
    Returns the code for the Availability Zone where the directory bucket was created.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    Returns the Amazon Resource Name (ARN) of the specified bucket.
    availability_zone_name str
    Returns the code for the Availability Zone where the directory bucket was created.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    Returns the Amazon Resource Name (ARN) of the specified bucket.
    availabilityZoneName String
    Returns the code for the Availability Zone where the directory bucket was created.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    DirectoryBucketBucketEncryption, DirectoryBucketBucketEncryptionArgs

    ServerSideEncryptionConfiguration []DirectoryBucketServerSideEncryptionRule
    Specifies the default server-side-encryption configuration.
    serverSideEncryptionConfiguration List<DirectoryBucketServerSideEncryptionRule>
    Specifies the default server-side-encryption configuration.
    serverSideEncryptionConfiguration DirectoryBucketServerSideEncryptionRule[]
    Specifies the default server-side-encryption configuration.
    server_side_encryption_configuration Sequence[DirectoryBucketServerSideEncryptionRule]
    Specifies the default server-side-encryption configuration.
    serverSideEncryptionConfiguration List<Property Map>
    Specifies the default server-side-encryption configuration.

    DirectoryBucketDataRedundancy, DirectoryBucketDataRedundancyArgs

    SingleAvailabilityZone
    SingleAvailabilityZone
    DirectoryBucketDataRedundancySingleAvailabilityZone
    SingleAvailabilityZone
    SingleAvailabilityZone
    SingleAvailabilityZone
    SingleAvailabilityZone
    SingleAvailabilityZone
    SINGLE_AVAILABILITY_ZONE
    SingleAvailabilityZone
    "SingleAvailabilityZone"
    SingleAvailabilityZone

    DirectoryBucketServerSideEncryptionByDefault, DirectoryBucketServerSideEncryptionByDefaultArgs

    SseAlgorithm Pulumi.AwsNative.S3Express.DirectoryBucketServerSideEncryptionByDefaultSseAlgorithm

    Server-side encryption algorithm to use for the default encryption.

    For directory buckets, there are only two supported values for server-side encryption: AES256 and aws:kms .

    KmsMasterKeyId string
    AWS Key Management Service (KMS) customer managed key ID to use for the default encryption. This parameter is allowed only if SSEAlgorithm is set to aws:kms. You can specify this parameter with the key ID or the Amazon Resource Name (ARN) of the KMS key
    SseAlgorithm DirectoryBucketServerSideEncryptionByDefaultSseAlgorithm

    Server-side encryption algorithm to use for the default encryption.

    For directory buckets, there are only two supported values for server-side encryption: AES256 and aws:kms .

    KmsMasterKeyId string
    AWS Key Management Service (KMS) customer managed key ID to use for the default encryption. This parameter is allowed only if SSEAlgorithm is set to aws:kms. You can specify this parameter with the key ID or the Amazon Resource Name (ARN) of the KMS key
    sseAlgorithm DirectoryBucketServerSideEncryptionByDefaultSseAlgorithm

    Server-side encryption algorithm to use for the default encryption.

    For directory buckets, there are only two supported values for server-side encryption: AES256 and aws:kms .

    kmsMasterKeyId String
    AWS Key Management Service (KMS) customer managed key ID to use for the default encryption. This parameter is allowed only if SSEAlgorithm is set to aws:kms. You can specify this parameter with the key ID or the Amazon Resource Name (ARN) of the KMS key
    sseAlgorithm DirectoryBucketServerSideEncryptionByDefaultSseAlgorithm

    Server-side encryption algorithm to use for the default encryption.

    For directory buckets, there are only two supported values for server-side encryption: AES256 and aws:kms .

    kmsMasterKeyId string
    AWS Key Management Service (KMS) customer managed key ID to use for the default encryption. This parameter is allowed only if SSEAlgorithm is set to aws:kms. You can specify this parameter with the key ID or the Amazon Resource Name (ARN) of the KMS key
    sse_algorithm DirectoryBucketServerSideEncryptionByDefaultSseAlgorithm

    Server-side encryption algorithm to use for the default encryption.

    For directory buckets, there are only two supported values for server-side encryption: AES256 and aws:kms .

    kms_master_key_id str
    AWS Key Management Service (KMS) customer managed key ID to use for the default encryption. This parameter is allowed only if SSEAlgorithm is set to aws:kms. You can specify this parameter with the key ID or the Amazon Resource Name (ARN) of the KMS key
    sseAlgorithm "aws:kms" | "AES256"

    Server-side encryption algorithm to use for the default encryption.

    For directory buckets, there are only two supported values for server-side encryption: AES256 and aws:kms .

    kmsMasterKeyId String
    AWS Key Management Service (KMS) customer managed key ID to use for the default encryption. This parameter is allowed only if SSEAlgorithm is set to aws:kms. You can specify this parameter with the key ID or the Amazon Resource Name (ARN) of the KMS key

    DirectoryBucketServerSideEncryptionByDefaultSseAlgorithm, DirectoryBucketServerSideEncryptionByDefaultSseAlgorithmArgs

    Awskms
    aws:kms
    Aes256
    AES256
    DirectoryBucketServerSideEncryptionByDefaultSseAlgorithmAwskms
    aws:kms
    DirectoryBucketServerSideEncryptionByDefaultSseAlgorithmAes256
    AES256
    Awskms
    aws:kms
    Aes256
    AES256
    Awskms
    aws:kms
    Aes256
    AES256
    AWSKMS
    aws:kms
    AES256
    AES256
    "aws:kms"
    aws:kms
    "AES256"
    AES256

    DirectoryBucketServerSideEncryptionRule, DirectoryBucketServerSideEncryptionRuleArgs

    BucketKeyEnabled bool
    Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Amazon S3 Express One Zone uses an S3 Bucket Key with SSE-KMS and S3 Bucket Key cannot be disabled. It's only allowed to set the BucketKeyEnabled element to true.
    ServerSideEncryptionByDefault Pulumi.AwsNative.S3Express.Inputs.DirectoryBucketServerSideEncryptionByDefault
    Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied.
    BucketKeyEnabled bool
    Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Amazon S3 Express One Zone uses an S3 Bucket Key with SSE-KMS and S3 Bucket Key cannot be disabled. It's only allowed to set the BucketKeyEnabled element to true.
    ServerSideEncryptionByDefault DirectoryBucketServerSideEncryptionByDefault
    Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied.
    bucketKeyEnabled Boolean
    Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Amazon S3 Express One Zone uses an S3 Bucket Key with SSE-KMS and S3 Bucket Key cannot be disabled. It's only allowed to set the BucketKeyEnabled element to true.
    serverSideEncryptionByDefault DirectoryBucketServerSideEncryptionByDefault
    Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied.
    bucketKeyEnabled boolean
    Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Amazon S3 Express One Zone uses an S3 Bucket Key with SSE-KMS and S3 Bucket Key cannot be disabled. It's only allowed to set the BucketKeyEnabled element to true.
    serverSideEncryptionByDefault DirectoryBucketServerSideEncryptionByDefault
    Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied.
    bucket_key_enabled bool
    Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Amazon S3 Express One Zone uses an S3 Bucket Key with SSE-KMS and S3 Bucket Key cannot be disabled. It's only allowed to set the BucketKeyEnabled element to true.
    server_side_encryption_by_default DirectoryBucketServerSideEncryptionByDefault
    Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied.
    bucketKeyEnabled Boolean
    Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Amazon S3 Express One Zone uses an S3 Bucket Key with SSE-KMS and S3 Bucket Key cannot be disabled. It's only allowed to set the BucketKeyEnabled element to true.
    serverSideEncryptionByDefault Property Map
    Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native