Skip to content

BucketAttributes

A reference to a bucket outside this stack.

Initializer

import com.aliyun.ros.cdk.oss.BucketAttributes;
BucketAttributes.builder()
//  .bucketDomainName(java.lang.String)
//  .bucketEndpoint(java.lang.String)
//  .bucketName(java.lang.String)
//  .bucketWebsiteUrl(java.lang.String)
//  .isWebsite(java.lang.Boolean)
//  .region(java.lang.String)
    .build();

Properties

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

bucketDomainNameOptional

public java.lang.String getBucketDomainName();
  • Type: java.lang.String
  • Default: Inferred from bucket name and region

The domain name of the bucket.


bucketEndpointOptional

public java.lang.String getBucketEndpoint();
  • Type: java.lang.String
  • Default: Inferred from region

The endpoint of the bucket.


bucketNameOptional

public java.lang.String getBucketName();
  • Type: java.lang.String

The name of the bucket.


bucketWebsiteUrlOptional

public java.lang.String getBucketWebsiteUrl();
  • Type: java.lang.String
  • Default: Inferred from bucket name and region

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


isWebsiteOptional

public java.lang.Boolean getIsWebsite();
  • Type: java.lang.Boolean
  • Default: false

If this bucket has been configured for static website hosting.


regionOptional

public java.lang.String getRegion();
  • Type: java.lang.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.