Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. s3express
  6. getDirectoryBucket

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

Viewing docs for AWS Native v0.126.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.s3express.getDirectoryBucket

aws-native logo aws-native logo

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

Viewing docs for AWS Native v0.126.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
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)
public static Output<GetDirectoryBucketResult> getDirectoryBucket(GetDirectoryBucketArgs args, InvokeOptions options)

    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 object

    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 .

    Search the CloudFormation User Guide for AWS::S3Express::DirectoryBucket for more information about the expected schema for this property.

    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 interface{}

    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 .

    Search the CloudFormation User Guide for AWS::S3Express::DirectoryBucket for more information about the expected schema for this property.

    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 Object

    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 .

    Search the CloudFormation User Guide for AWS::S3Express::DirectoryBucket for more information about the expected schema for this property.

    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 any

    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 .

    Search the CloudFormation User Guide for AWS::S3Express::DirectoryBucket for more information about the expected schema for this property.

    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 Any

    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 .

    Search the CloudFormation User Guide for AWS::S3Express::DirectoryBucket for more information about the expected schema for this property.

    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 Any

    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 .

    Search the CloudFormation User Guide for AWS::S3Express::DirectoryBucket for more information about the expected schema for this property.

    Package Details

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

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

    Viewing docs for AWS Native v0.126.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-aws-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial