BucketAttributes

class aws_cdk.aws_s3.BucketAttributes(*, bucket_arn=None, bucket_domain_name=None, bucket_dual_stack_domain_name=None, bucket_name=None, bucket_regional_domain_name=None, bucket_website_new_url_format=None, bucket_website_url=None, encryption_key=None)

Bases: object

__init__(*, bucket_arn=None, bucket_domain_name=None, bucket_dual_stack_domain_name=None, bucket_name=None, bucket_regional_domain_name=None, bucket_website_new_url_format=None, bucket_website_url=None, encryption_key=None)

A reference to a bucket.

The easiest way to instantiate is to call bucket.export(). Then, the consumer can use Bucket.import(this, ref) and get a Bucket.

Parameters
  • bucket_arn (Optional[str]) – The ARN of the bucket. At least one of bucketArn or bucketName must be defined in order to initialize a bucket ref.

  • bucket_domain_name (Optional[str]) – The domain name of the bucket. Default: Inferred from bucket name

  • bucket_dual_stack_domain_name (Optional[str]) – The IPv6 DNS name of the specified bucket.

  • bucket_name (Optional[str]) – The name of the bucket. If the underlying value of ARN is a string, the name will be parsed from the ARN. Otherwise, the name is optional, but some features that require the bucket name such as auto-creating a bucket policy, won’t work.

  • bucket_regional_domain_name (Optional[str]) – The regional domain name of the specified bucket.

  • bucket_website_new_url_format (Optional[bool]) – The format of the website URL of the bucket. This should be true for regions launched since 2014. Default: false

  • bucket_website_url (Optional[str]) – The website URL of the bucket (if static web hosting is enabled). Default: Inferred from bucket name

  • encryption_key (Optional[IKey]) –

Attributes

bucket_arn

The ARN of the bucket.

At least one of bucketArn or bucketName must be defined in order to initialize a bucket ref.

Return type

Optional[str]

bucket_domain_name

The domain name of the bucket.

default :default: Inferred from bucket name

Return type

Optional[str]

bucket_dual_stack_domain_name

The IPv6 DNS name of the specified bucket.

Return type

Optional[str]

bucket_name

The name of the bucket.

If the underlying value of ARN is a string, the name will be parsed from the ARN. Otherwise, the name is optional, but some features that require the bucket name such as auto-creating a bucket policy, won’t work.

Return type

Optional[str]

bucket_regional_domain_name

The regional domain name of the specified bucket.

Return type

Optional[str]

bucket_website_new_url_format

The format of the website URL of the bucket.

This should be true for regions launched since 2014.

default :default: false

Return type

Optional[bool]

bucket_website_url

The website URL of the bucket (if static web hosting is enabled).

default :default: Inferred from bucket name

Return type

Optional[str]

encryption_key
Return type

Optional[IKey]