Bucket

• Implements: IBucket

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

Initializers

using AlibabaCloud.SDK.ROS.CDK.Oss;
new Bucket(Construct Scope, string Id, BucketProps Props, bool EnableResourcePropertyConstraint = null);

Scope^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.Construct

Id^Required

• Type: string

Props^Required

• Type: BucketProps

EnableResourcePropertyConstraint^Optional

• Type: bool

Methods

ToString

private string ToString()

Returns a string representation of this construct.

Synthesize

private 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.

Session^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.ISynthesisSession

The synthesis session.

AddCondition

private void AddCondition(RosCondition Condition)

Condition^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.RosCondition

AddCount

private void AddCount(object Count)

Count^Required

• Type: object

AddDependency

private void AddDependency(Resource Resource)

Resource^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.Resource

AddResourceDesc

private void AddResourceDesc(string Desc)

Desc^Required

• Type: string

ApplyRemovalPolicy

private void ApplyRemovalPolicy(RemovalPolicy Policy)

Policy^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicy

FetchCondition

private RosCondition FetchCondition()

FetchDependency

private string[] FetchDependency()

FetchResourceDesc

private string FetchResourceDesc()

GetAtt

private IResolvable GetAtt(string Name)

Name^Required

• Type: string

SetMetadata

private void SetMetadata(string Key, object Value)

Key^Required

• Type: string

Value^Required

• Type: object

ArnForObjects

private string ArnForObjects(string KeyPattern)

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

private ManagedPolicy GrantFullAccess(IPrincipal Identity, string ObjectsKeyPattern = null)

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

Identity^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Ram.IPrincipal

The principal.

ObjectsKeyPattern^Optional

• Type: string

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

GrantList

private ManagedPolicy GrantList(IPrincipal Identity, string ObjectsKeyPattern = null)

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

Identity^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Ram.IPrincipal

The principal.

ObjectsKeyPattern^Optional

• Type: string

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

GrantRead

private ManagedPolicy GrantRead(IPrincipal Identity, string ObjectsKeyPattern = null)

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

Identity^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Ram.IPrincipal

The principal.

ObjectsKeyPattern^Optional

• Type: string

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

GrantReadWrite

private ManagedPolicy GrantReadWrite(IPrincipal Identity, string ObjectsKeyPattern = null)

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

Identity^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Ram.IPrincipal

The principal.

ObjectsKeyPattern^Optional

• Type: string

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

Static Functions

IsConstruct

using AlibabaCloud.SDK.ROS.CDK.Oss;
Bucket.IsConstruct(object X);

Return whether the given object is a Construct.

X^Required

• Type: object

ValidateBucketName

using AlibabaCloud.SDK.ROS.CDK.Oss;
Bucket.ValidateBucketName(string PhysicalName);

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

PhysicalName^Required

• Type: string

name of the bucket.

Properties

Node^Required

public ConstructNode Node { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode

The construct tree node associated with this construct.

Env^Required

public IResourceEnvironment Env { get; }

• Type: AlibabaCloud.SDK.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 string Ref { get; }

• Type: string

Stack^Required

public Stack Stack { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.Stack

The stack in which this resource is defined.

Resource^Optional

public RosResource Resource { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.RosResource

AttrArn^Required

public object AttrArn { get; }

• Type: object

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

AttrDomainName^Required

public object AttrDomainName { get; }

• Type: object

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

AttrInternalDomainName^Required

public object AttrInternalDomainName { get; }

• Type: object

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

AttrName^Required

public object AttrName { get; }

• Type: object

Attribute Name: The name of Bucket.

Props^Required

public BucketProps Props { get; }

• Type: BucketProps