Bucket

• Implements: IBucket

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

Initializers

import com.aliyun.ros.cdk.oss.Bucket;
Bucket.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .bucketName(java.lang.String)
    .bucketName(IResolvable)
//  .accessControl(java.lang.String)
//  .accessControl(IResolvable)
//  .blockPublicAccess(java.lang.Boolean)
//  .blockPublicAccess(IResolvable)
//  .corsConfiguration(IResolvable)
//  .corsConfiguration(CORSConfigurationProperty)
//  .deletionForce(java.lang.Boolean)
//  .deletionForce(IResolvable)
//  .enableOssHdfsService(java.lang.Boolean)
//  .enableOssHdfsService(IResolvable)
//  .lifecycleConfiguration(IResolvable)
//  .lifecycleConfiguration(LifecycleConfigurationProperty)
//  .loggingConfiguration(IResolvable)
//  .loggingConfiguration(LoggingConfigurationProperty)
//  .policy(IResolvable)
//  .policy(java.util.Map<java.lang.String, java.lang.Object>)
//  .redundancyType(java.lang.String)
//  .redundancyType(IResolvable)
//  .refererConfiguration(IResolvable)
//  .refererConfiguration(RefererConfigurationProperty)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .serverSideEncryptionConfiguration(IResolvable)
//  .serverSideEncryptionConfiguration(ServerSideEncryptionConfigurationProperty)
//  .storageClass(java.lang.String)
//  .storageClass(IResolvable)
//  .tags(java.util.Map<java.lang.String, java.lang.Object>)
//  .versioningConfiguration(IResolvable)
//  .versioningConfiguration(VersioningConfigurationProperty)
//  .websiteConfigurationV2(IResolvable)
//  .websiteConfigurationV2(WebsiteConfigurationV2Property)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

bucketName^Required

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

Property bucketName: bucket name.

accessControl^Optional

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

Property accessControl: The access control list.

blockPublicAccess^Optional

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

Property blockPublicAccess: Whether to block public access.

corsConfiguration^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR CORSConfigurationProperty

Property corsConfiguration: Rules that define cross-origin resource sharing of objects in this bucket.

deletionForce^Optional

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

Property deletionForce: Whether force delete the relative objects in the bucket.

Default value is false.

enableOssHdfsService^Optional

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

Property enableOssHdfsService: Whether enable OSS-HDFS service.

Note: Once it's enabled, it can't be disabled again.

lifecycleConfiguration^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR LifecycleConfigurationProperty

Property lifecycleConfiguration: Rules that define how oss bucket manages objects during their lifetime.

loggingConfiguration^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR LoggingConfigurationProperty

Property loggingConfiguration: Settings that defines where logs are stored.

policy^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

Property policy: Bucket policy.

redundancyType^Optional

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

Property redundancyType: Specifies the data disaster recovery type of the storage space.

The value range is as follows: LRS (default): Local redundant LRS stores your data redundantly on different storage devices in the same availability zone, and can support data loss and normal access even when two storage devices are damaged concurrently. ZRS: Intra-city redundant ZRS adopts a data redundancy storage mechanism in multiple availability zones (AZ), and stores user data redundantly in multiple availability zones in the same region. When an availability zone is unavailable, normal access to data can still be guaranteed.

refererConfiguration^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR RefererConfigurationProperty

Property refererConfiguration: undefined.

resourceGroupId^Optional

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

Property resourceGroupId: The resource group id.

serverSideEncryptionConfiguration^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR ServerSideEncryptionConfigurationProperty

Property serverSideEncryptionConfiguration: Specifies the bucket used to store the server-side encryption rule.

storageClass^Optional

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

Property storageClass: Specifies the storage class of the bucket.

Default is "Standard".

tags^Optional

• Type: java.util.Map

Property tags: Bucket tags in k-v pairs format.

versioningConfiguration^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR VersioningConfigurationProperty

Property versioningConfiguration: A state of versioning.

websiteConfigurationV2^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR WebsiteConfigurationV2Property

Property websiteConfigurationV2: Website configuration.

Methods

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.

session^Required

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

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

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

addCount

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

count^Required

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

addDependency

public void addDependency(Resource resource)

resource^Required

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

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

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

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

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

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

arnForObjects

public java.lang.String arnForObjects(java.lang.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: java.lang.String

grantFullAccess

public ManagedPolicy grantFullAccess(IPrincipal identity)
public ManagedPolicy grantFullAccess(IPrincipal identity, java.lang.String objectsKeyPattern)

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

identity^Required

• Type: com.aliyun.ros.cdk.ram.IPrincipal

The principal.

objectsKeyPattern^Optional

• Type: java.lang.String

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

grantList

public ManagedPolicy grantList(IPrincipal identity)
public ManagedPolicy grantList(IPrincipal identity, java.lang.String objectsKeyPattern)

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

identity^Required

• Type: com.aliyun.ros.cdk.ram.IPrincipal

The principal.

objectsKeyPattern^Optional

• Type: java.lang.String

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

grantRead

public ManagedPolicy grantRead(IPrincipal identity)
public ManagedPolicy grantRead(IPrincipal identity, java.lang.String objectsKeyPattern)

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

identity^Required

• Type: com.aliyun.ros.cdk.ram.IPrincipal

The principal.

objectsKeyPattern^Optional

• Type: java.lang.String

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

grantReadWrite

public ManagedPolicy grantReadWrite(IPrincipal identity)
public ManagedPolicy grantReadWrite(IPrincipal identity, java.lang.String objectsKeyPattern)

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

identity^Required

• Type: com.aliyun.ros.cdk.ram.IPrincipal

The principal.

objectsKeyPattern^Optional

• Type: java.lang.String

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

Static Functions

isConstruct

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

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

validateBucketName

import com.aliyun.ros.cdk.oss.Bucket;
Bucket.validateBucketName(java.lang.String physicalName)

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

physicalName^Required

• Type: java.lang.String

name of the bucket.

Properties

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.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 java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

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

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

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

attrArn^Required

public java.lang.Object getAttrArn();

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

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

attrDomainName^Required

public java.lang.Object getAttrDomainName();

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

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

attrInternalDomainName^Required

public java.lang.Object getAttrInternalDomainName();

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

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

attrName^Required

public java.lang.Object getAttrName();

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

Attribute Name: The name of Bucket.

props^Required

public BucketProps getProps();

• Type: BucketProps