Bucket

• Implements: IBucket

This class encapsulates and extends the ROS resource type ALIYUN::OSS::Bucket.

Initializers

import { Bucket } from '@alicloud/ros-cdk-oss'
new Bucket(scope: Construct, id: string, props: BucketProps, enableResourcePropertyConstraint?: boolean)

scope^Required

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

id^Required

• Type: string

props^Required

• Type: BucketProps

enableResourcePropertyConstraint^Optional

• Type: boolean

Methods

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

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

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

arnForObjects

public arnForObjects(keyPattern: string): string

Returns an ARN that represents all objects within the bucket that match the key pattern specified.

To represent all keys, specify "*".

If you need to specify a keyPattern with multiple components, concatenate them into a single string, e.g.:

arnForObjects(home/${team}/${user}/*)

keyPattern^Required

• Type: string

grantFullAccess

public grantFullAccess(identity: IPrincipal, objectsKeyPattern?: string): ManagedPolicy

Grant an RAM principal (Role/Group/User) full control over this bucket.

identity^Required

• Type: @alicloud/ros-cdk-ram.IPrincipal

The principal.

objectsKeyPattern^Optional

• Type: string

Restrict the permission to a certain key pattern (default '*').

grantList

public grantList(identity: IPrincipal, objectsKeyPattern?: string): ManagedPolicy

Grant an RAM principal (Role/Group/User) permission to list resources for this bucket.

identity^Required

• Type: @alicloud/ros-cdk-ram.IPrincipal

The principal.

objectsKeyPattern^Optional

• Type: string

Restrict the permission to a certain key pattern (default '*').

grantRead

public grantRead(identity: IPrincipal, objectsKeyPattern?: string): ManagedPolicy

Grant an RAM principal (Role/Group/User) permission to list and read all resources for this bucket.

identity^Required

• Type: @alicloud/ros-cdk-ram.IPrincipal

The principal.

objectsKeyPattern^Optional

• Type: string

Restrict the permission to a certain key pattern (default '*').

grantReadWrite

public grantReadWrite(identity: IPrincipal, objectsKeyPattern?: string): ManagedPolicy

Grant an RAM principal (Role/Group/User) permission to read and write resources for this bucket.

identity^Required

• Type: @alicloud/ros-cdk-ram.IPrincipal

The principal.

objectsKeyPattern^Optional

• Type: string

Restrict the permission to a certain key pattern (default '*').

Static Functions

isConstruct

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

Return whether the given object is a Construct.

x^Required

• Type: any

validateBucketName

import { Bucket } from '@alicloud/ros-cdk-oss'
Bucket.validateBucketName(physicalName: string)

Thrown an exception if the given bucket name is not valid.

physicalName^Required

• Type: string

name of the bucket.

Properties

node^Required

public readonly node: ConstructNode;

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

The construct tree node associated with this construct.

env^Required

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.

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

attrArn^Required

public readonly attrArn: string | IResolvable;

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

Attribute Arn: The Alibaba Cloud Resource Name (ARN).

attrDomainName^Required

public readonly attrDomainName: string | IResolvable;

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

Attribute DomainName: The public DNS name of the specified bucket.

attrInternalDomainName^Required

public readonly attrInternalDomainName: string | IResolvable;

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

Attribute InternalDomainName: The internal DNS name of the specified bucket.

attrName^Required

public readonly attrName: string | IResolvable;

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

Attribute Name: The name of Bucket.

props^Required

public readonly props: BucketProps;

• Type: BucketProps