Skip to content

BucketAttributes

A reference to a bucket outside this stack.

Initializer

import ros_cdk_oss
ros_cdk_oss.BucketAttributes(
  bucket_domain_name: str = None,
  bucket_endpoint: str = None,
  bucket_name: str = None,
  bucket_website_url: str = None,
  is_website: bool = None,
  region: str = None
)

Properties

Name Type Description
bucket_domain_name str The domain name of the bucket.
bucket_endpoint str The endpoint of the bucket.
bucket_name str The name of the bucket.
bucket_website_url str The website URL of the bucket (if static web hosting is enabled).
is_website bool If this bucket has been configured for static website hosting.
region str The region this existing bucket is in.

bucket_domain_nameOptional

bucket_domain_name: str
  • Type: str
  • Default: Inferred from bucket name and region

The domain name of the bucket.


bucket_endpointOptional

bucket_endpoint: str
  • Type: str
  • Default: Inferred from region

The endpoint of the bucket.


bucket_nameOptional

bucket_name: str
  • Type: str

The name of the bucket.


bucket_website_urlOptional

bucket_website_url: str
  • Type: str
  • Default: Inferred from bucket name and region

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


is_websiteOptional

is_website: bool
  • Type: bool
  • Default: false

If this bucket has been configured for static website hosting.


regionOptional

region: str
  • Type: str
  • Default: it's assumed the bucket is in the same region as the scope it's being imported into

The region this existing bucket is in.

Features that require the region (e.g. bucketWebsiteUrl) won't fully work if the region cannot be correctly inferred.