Docs Home
Packages
We recommend new projects start with resources from the AWS provider.
aws-native.s3express.getDirectoryBucket
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
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 dictionaryThe following arguments are supported:
- Bucket
Name 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 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 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 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.
- bucket
Name 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.
- Availability
Zone stringName - Returns the code for the Availability Zone where the directory bucket was created.
- Bucket
Encryption 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::DirectoryBucketfor more information about the expected schema for this property.
- Arn string
- Returns the Amazon Resource Name (ARN) of the specified bucket.
- Availability
Zone stringName - Returns the code for the Availability Zone where the directory bucket was created.
- Bucket
Encryption 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::DirectoryBucketfor more information about the expected schema for this property.
- arn String
- Returns the Amazon Resource Name (ARN) of the specified bucket.
- availability
Zone StringName - Returns the code for the Availability Zone where the directory bucket was created.
- bucket
Encryption 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::DirectoryBucketfor more information about the expected schema for this property.
- arn string
- Returns the Amazon Resource Name (ARN) of the specified bucket.
- availability
Zone stringName - 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::DirectoryBucketfor more information about the expected schema for this property.
- arn str
- Returns the Amazon Resource Name (ARN) of the specified bucket.
- availability_
zone_ strname - 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::DirectoryBucketfor more information about the expected schema for this property.
- arn String
- Returns the Amazon Resource Name (ARN) of the specified bucket.
- availability
Zone StringName - 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::DirectoryBucketfor more information about the expected schema for this property.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.