directory_bucket
Gets an individual directory_bucket
resource
Overview
Name | directory_bucket |
Type | Resource |
Description | directory_bucket |
Id | awscc.s3express.directory_bucket |
Fields
Name | Datatype | Description |
---|---|---|
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. |
location_name | string | Specifies the AZ ID of the Availability Zone where the directory bucket will be created. An example AZ ID value is 'use1-az5'. |
data_redundancy | string | Specifies the number of Availability Zone that's used for redundancy for the bucket. |
arn | string | Returns the Amazon Resource Name (ARN) of the specified bucket. |
region | string | AWS region. |
Methods
Currently only SELECT
is supported for this resource resource.
Example
SELECT
region,
bucket_name,
location_name,
data_redundancy,
arn
FROM awscc.s3express.directory_bucket
WHERE data__Identifier = '<BucketName>';
Permissions
To operate on the directory_bucket
resource, the following permissions are required:
Read
s3express:ListAllMyDirectoryBuckets
Delete
s3express:DeleteBucket,
s3express:ListAllMyDirectoryBuckets