Bucket
- Implements: @alicloud/ros-cdk-oss.datasource.IBucket
This class encapsulates and extends the ROS resource type DATASOURCE::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. |
scopeRequired
- Type: @alicloud/ros-cdk-core.Construct
idRequired
- Type: string
propsRequired
- Type: BucketProps
enableResourcePropertyConstraintOptional
- 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. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | 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.
- Type: @alicloud/ros-cdk-core.ISynthesisSession
The synthesis session.
addCondition
public addCondition(condition: RosCondition): void
- Type: @alicloud/ros-cdk-core.RosCondition
addCount
public addCount(count: number | IResolvable): void
- Type: number | @alicloud/ros-cdk-core.IResolvable
addDependency
public addDependency(resource: Resource): void
- Type: @alicloud/ros-cdk-core.Resource
addResourceDesc
public addResourceDesc(desc: string): void
- Type: string
applyRemovalPolicy
public applyRemovalPolicy(policy: RemovalPolicy): void
- Type: @alicloud/ros-cdk-core.RemovalPolicy
fetchCondition
public fetchCondition(): RosCondition
fetchDependency
public fetchDependency(): string[]
fetchResourceDesc
public fetchResourceDesc(): string
getAtt
public getAtt(name: string): IResolvable
- Type: string
setMetadata
public setMetadata(key: string, value: any): void
- Type: string
- 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.
- Type: any
Properties
| Name | Type | Description |
|---|---|---|
node | @alicloud/ros-cdk-core.ConstructNode | The construct tree node associated with this construct. |
env | @alicloud/ros-cdk-core.IResourceEnvironment | The environment this resource belongs to. |
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 | string | @alicloud/ros-cdk-core.IResolvable | Attribute CreateTime: The creation time of the Bucket. |
attrExtranetEndpoint | string | @alicloud/ros-cdk-core.IResolvable | Attribute ExtranetEndpoint: The domain name of the Bucket. |
attrIntranetEndpoint | string | @alicloud/ros-cdk-core.IResolvable | Attribute IntranetEndpoint: The intranet domain name of the ECS instance that accesses the Bucket in the same region. |
attrLocation | string | @alicloud/ros-cdk-core.IResolvable | Attribute Location: The region where the Bucket is located. |
attrName | string | @alicloud/ros-cdk-core.IResolvable | Attribute Name: Bucket name. |
attrOwner | string | @alicloud/ros-cdk-core.IResolvable | Attribute Owner: Container for storing Bucket owner information. |
attrStorageClass | string | @alicloud/ros-cdk-core.IResolvable | Attribute StorageClass: The storage type of the Bucket. |
props | BucketProps | No description. |
nodeRequired
public readonly node: ConstructNode;
- Type: @alicloud/ros-cdk-core.ConstructNode
The construct tree node associated with this construct.
envRequired
public readonly env: IResourceEnvironment;
- Type: @alicloud/ros-cdk-core.IResourceEnvironment
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
refRequired
public readonly ref: string;
- Type: string
stackRequired
public readonly stack: Stack;
- Type: @alicloud/ros-cdk-core.Stack
The stack in which this resource is defined.
resourceOptional
public readonly resource: RosResource;
- Type: @alicloud/ros-cdk-core.RosResource
attrCreateTimeRequired
public readonly attrCreateTime: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute CreateTime: The creation time of the Bucket.
attrExtranetEndpointRequired
public readonly attrExtranetEndpoint: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ExtranetEndpoint: The domain name of the Bucket.
attrIntranetEndpointRequired
public readonly attrIntranetEndpoint: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute IntranetEndpoint: The intranet domain name of the ECS instance that accesses the Bucket in the same region.
attrLocationRequired
public readonly attrLocation: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Location: The region where the Bucket is located.
attrNameRequired
public readonly attrName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Name: Bucket name.
attrOwnerRequired
public readonly attrOwner: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Owner: Container for storing Bucket owner information.
attrStorageClassRequired
public readonly attrStorageClass: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute StorageClass: The storage type of the Bucket.
propsRequired
public readonly props: BucketProps;
- Type: BucketProps