Skip to content

Bucket

This class encapsulates and extends the ROS resource type DATASOURCE::OSS::Bucket, which is used to query the information about an Object Storage Service (OSS) bucket.

Initializers 

import com.aliyun.ros.cdk.oss.datasource.Bucket;
Bucket.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .bucketName(java.lang.String)
    .bucketName(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
bucketName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property bucketName: Bucket name.
refreshOptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

bucketNameRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property bucketName: Bucket name.

The naming conventions for buckets are as follows: Only lowercase letters, numbers, and dashes (-) can be included. Must start and end with lowercase letters or numbers. The length must be between 3 and 63 characters.

refreshOptionsOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

  • Never: Never refresh the datasource resource when the stack is updated.
  • Always: Always refresh the datasource resource when the stack is updated. Default is Never.

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

toString 

public java.lang.String toString()

Returns a string representation of this construct.

synthesize 

public void synthesize(ISynthesisSession session)

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

sessionRequired

  • Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount 

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency 

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct 

import com.aliyun.ros.cdk.oss.datasource.Bucket;
Bucket.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrCreateTime com.aliyun.ros.cdk.core.IResolvable Attribute CreateTime: The creation time of the Bucket.
attrExtranetEndpoint com.aliyun.ros.cdk.core.IResolvable Attribute ExtranetEndpoint: The domain name of the Bucket.
attrIntranetEndpoint com.aliyun.ros.cdk.core.IResolvable Attribute IntranetEndpoint: The intranet domain name of the ECS instance that accesses the Bucket in the same region.
attrLocation com.aliyun.ros.cdk.core.IResolvable Attribute Location: The region where the Bucket is located.
attrName com.aliyun.ros.cdk.core.IResolvable Attribute Name: Bucket name.
attrOwner com.aliyun.ros.cdk.core.IResolvable Attribute Owner: Container for storing Bucket owner information.
attrStorageClass com.aliyun.ros.cdk.core.IResolvable Attribute StorageClass: The storage type of the Bucket.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

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

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrCreateTimeRequired 

public IResolvable getAttrCreateTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute CreateTime: The creation time of the Bucket.

attrExtranetEndpointRequired 

public IResolvable getAttrExtranetEndpoint();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ExtranetEndpoint: The domain name of the Bucket.

attrIntranetEndpointRequired 

public IResolvable getAttrIntranetEndpoint();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute IntranetEndpoint: The intranet domain name of the ECS instance that accesses the Bucket in the same region.

attrLocationRequired 

public IResolvable getAttrLocation();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Location: The region where the Bucket is located.

attrNameRequired 

public IResolvable getAttrName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Name: Bucket name.

attrOwnerRequired 

public IResolvable getAttrOwner();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Owner: Container for storing Bucket owner information.

attrStorageClassRequired 

public IResolvable getAttrStorageClass();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute StorageClass: The storage type of the Bucket.