Skip to content

BucketAttributes

A reference to a bucket outside this stack.

Initializer

import { BucketAttributes } from '@alicloud/ros-cdk-oss'
const bucketAttributes: BucketAttributes = { ... }

Properties

Name Type Description
bucketDomainName string The domain name of the bucket.
bucketEndpoint string The endpoint of the bucket.
bucketName string The name of the bucket.
bucketWebsiteUrl string The website URL of the bucket (if static web hosting is enabled).
isWebsite boolean If this bucket has been configured for static website hosting.
region string The region this existing bucket is in.

bucketDomainNameOptional

public readonly bucketDomainName: string;
  • Type: string
  • Default: Inferred from bucket name and region

The domain name of the bucket.


bucketEndpointOptional

public readonly bucketEndpoint: string;
  • Type: string
  • Default: Inferred from region

The endpoint of the bucket.


bucketNameOptional

public readonly bucketName: string;
  • Type: string

The name of the bucket.


bucketWebsiteUrlOptional

public readonly bucketWebsiteUrl: string;
  • Type: string
  • Default: Inferred from bucket name and region

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


isWebsiteOptional

public readonly isWebsite: boolean;
  • Type: boolean
  • Default: false

If this bucket has been configured for static website hosting.


regionOptional

public readonly region: string;
  • Type: string
  • 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.