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 { datasource } from '@alicloud/ros-cdk-oss'
new datasource.Bucket(scope: Construct, id: string, props: BucketProps, enableResourcePropertyConstraint?: boolean)

Name	Type	Description
scope	@alicloud/ros-cdk-core.Construct	No description.
id	string	No description.
props	BucketProps	No description.
enableResourcePropertyConstraint	boolean	No description.

---

scope^Required

• Type: @alicloud/ros-cdk-core.Construct

---

id^Required

• Type: string

---

props^Required

• Type: BucketProps

---

enableResourcePropertyConstraint^Optional

• Type: boolean

---

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 toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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.

session^Required

• Type: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

---

addCondition

public addCondition(condition: RosCondition): void

condition^Required

• Type: @alicloud/ros-cdk-core.RosCondition

---

addCount

public addCount(count: number | IResolvable): void

count^Required

• Type: number | @alicloud/ros-cdk-core.IResolvable

---

addDependency

public addDependency(resource: Resource): void

resource^Required

• Type: @alicloud/ros-cdk-core.Resource

---

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

---

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

• Type: @alicloud/ros-cdk-core.RemovalPolicy

---

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

---

setMetadata

public setMetadata(key: string, value: any): void

key^Required

• Type: string

---

value^Required

• Type: any

---

Static Functions

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

---

isConstruct

import { datasource } from '@alicloud/ros-cdk-oss'
datasource.Bucket.isConstruct(x: any)

Return whether the given object is a Construct.

x^Required

• Type: any

---

Properties

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

---

node^Required

public readonly node: ConstructNode;

• Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

public readonly ref: string;

• Type: string

---

stack^Required

public readonly stack: Stack;

• Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

---

resource^Optional

public readonly resource: RosResource;

• Type: @alicloud/ros-cdk-core.RosResource

---

attrCreateTime^Required

public readonly attrCreateTime: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute CreateTime: The creation time of the Bucket.

---

attrExtranetEndpoint^Required

public readonly attrExtranetEndpoint: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute ExtranetEndpoint: The domain name of the Bucket.

---

attrIntranetEndpoint^Required

public readonly attrIntranetEndpoint: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

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

---

attrLocation^Required

public readonly attrLocation: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute Location: The region where the Bucket is located.

---

attrName^Required

public readonly attrName: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute Name: Bucket name.

---

attrOwner^Required

public readonly attrOwner: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute Owner: Container for storing Bucket owner information.

---

attrStorageClass^Required

public readonly attrStorageClass: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute StorageClass: The storage type of the Bucket.

---