1. Packages
  2. AWS Native
  3. API Docs
  4. s3express
  5. getDirectoryBucket

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

aws-native.s3express.getDirectoryBucket

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

    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.
    Arn string
    Returns the Amazon Resource Name (ARN) of the specified bucket.
    arn String
    Returns the Amazon Resource Name (ARN) of the specified bucket.
    arn string
    Returns the Amazon Resource Name (ARN) of the specified bucket.
    arn str
    Returns the Amazon Resource Name (ARN) of the specified bucket.
    arn String
    Returns the Amazon Resource Name (ARN) of the specified bucket.

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi