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

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.getDirectoryBucket

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.

    Using getDirectoryBucket

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getDirectoryBucket(args: GetDirectoryBucketArgs, opts?: InvokeOptions): Promise<GetDirectoryBucketResult>
function getDirectoryBucketOutput(args: GetDirectoryBucketOutputArgs, opts?: InvokeOptions): Output<GetDirectoryBucketResult>
    def get_directory_bucket(bucket_name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetDirectoryBucketResult
def get_directory_bucket_output(bucket_name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetDirectoryBucketResult]
    func LookupDirectoryBucket(ctx *Context, args *LookupDirectoryBucketArgs, opts ...InvokeOption) (*LookupDirectoryBucketResult, error)
func LookupDirectoryBucketOutput(ctx *Context, args *LookupDirectoryBucketOutputArgs, opts ...InvokeOption) LookupDirectoryBucketResultOutput

    > Note: This function is named LookupDirectoryBucket in the Go SDK.

    public static class GetDirectoryBucket 
{
    public static Task<GetDirectoryBucketResult> InvokeAsync(GetDirectoryBucketArgs args, InvokeOptions? opts = null)
    public static Output<GetDirectoryBucketResult> Invoke(GetDirectoryBucketInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDirectoryBucketResult> getDirectoryBucket(GetDirectoryBucketArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:s3express:getDirectoryBucket
  arguments:
    # arguments dictionary

    The following arguments are supported:

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

    getDirectoryBucket Result

    The following output properties are available:

    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.
    BucketEncryption Pulumi.AwsNative.S3Express.Outputs.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 .
    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.
    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 .
    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.
    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 .
    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.
    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 .
    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.
    bucket_encryption 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 .
    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.
    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 .

    Supporting Types

    DirectoryBucketBucketEncryption

    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.

    DirectoryBucketServerSideEncryptionByDefault

    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

    DirectoryBucketServerSideEncryptionRule

    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