Bucket

• Implements: IBucket

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

Initializers

import ros_cdk_oss
ros_cdk_oss.Bucket(
  scope: Construct,
  id: str,
  bucket_name: typing.Union[str, IResolvable],
  access_control: typing.Union[str, IResolvable] = None,
  block_public_access: typing.Union[bool, IResolvable] = None,
  cors_configuration: typing.Union[IResolvable, CORSConfigurationProperty] = None,
  deletion_force: typing.Union[bool, IResolvable] = None,
  enable_oss_hdfs_service: typing.Union[bool, IResolvable] = None,
  lifecycle_configuration: typing.Union[IResolvable, LifecycleConfigurationProperty] = None,
  logging_configuration: typing.Union[IResolvable, LoggingConfigurationProperty] = None,
  policy: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  redundancy_type: typing.Union[str, IResolvable] = None,
  referer_configuration: typing.Union[IResolvable, RefererConfigurationProperty] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  server_side_encryption_configuration: typing.Union[IResolvable, ServerSideEncryptionConfigurationProperty] = None,
  storage_class: typing.Union[str, IResolvable] = None,
  tags: typing.Mapping[typing.Any] = None,
  versioning_configuration: typing.Union[IResolvable, VersioningConfigurationProperty] = None,
  website_configuration_v2: typing.Union[IResolvable, WebsiteConfigurationV2Property] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

bucket_name^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property bucketName: bucket name.

access_control^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property accessControl: The access control list.

block_public_access^Optional

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property blockPublicAccess: Whether to block public access.

cors_configuration^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, CORSConfigurationProperty]

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

deletion_force^Optional

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

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

Default value is false.

enable_oss_hdfs_service^Optional

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property enableOssHdfsService: Whether enable OSS-HDFS service.

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

lifecycle_configuration^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, LifecycleConfigurationProperty]

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

logging_configuration^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, LoggingConfigurationProperty]

Property loggingConfiguration: Settings that defines where logs are stored.

policy^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]

Property policy: Bucket policy.

redundancy_type^Optional

• Type: typing.Union[str, 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.

referer_configuration^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, RefererConfigurationProperty]

Property refererConfiguration: undefined.

resource_group_id^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property resourceGroupId: The resource group id.

server_side_encryption_configuration^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, ServerSideEncryptionConfigurationProperty]

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

storage_class^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property storageClass: Specifies the storage class of the bucket.

Default is "Standard".

tags^Optional

• Type: typing.Mapping[typing.Any]

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

versioning_configuration^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, VersioningConfigurationProperty]

Property versioningConfiguration: A state of versioning.

website_configuration_v2^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, WebsiteConfigurationV2Property]

Property websiteConfigurationV2: Website configuration.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

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: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

arn_for_objects

def arn_for_objects(
  key_pattern: str
) -> str

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}/*)

key_pattern^Required

• Type: str

grant_full_access

def grant_full_access(
  identity: IPrincipal,
  objects_key_pattern: str = None
) -> ManagedPolicy

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

identity^Required

• Type: ros_cdk_ram.IPrincipal

The principal.

objects_key_pattern^Optional

• Type: str

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

grant_list

def grant_list(
  identity: IPrincipal,
  objects_key_pattern: str = None
) -> ManagedPolicy

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

identity^Required

• Type: ros_cdk_ram.IPrincipal

The principal.

objects_key_pattern^Optional

• Type: str

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

grant_read

def grant_read(
  identity: IPrincipal,
  objects_key_pattern: str = None
) -> ManagedPolicy

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

identity^Required

• Type: ros_cdk_ram.IPrincipal

The principal.

objects_key_pattern^Optional

• Type: str

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

grant_read_write

def grant_read_write(
  identity: IPrincipal,
  objects_key_pattern: str = None
) -> ManagedPolicy

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

identity^Required

• Type: ros_cdk_ram.IPrincipal

The principal.

objects_key_pattern^Optional

• Type: str

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

Static Functions

is_construct

import ros_cdk_oss
ros_cdk_oss.Bucket.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

validate_bucket_name

import ros_cdk_oss
ros_cdk_oss.Bucket.validate_bucket_name(
  physical_name: str
)

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

physical_name^Required

• Type: str

name of the bucket.

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: 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

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_arn^Required

attr_arn: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

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

attr_domain_name^Required

attr_domain_name: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

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

attr_internal_domain_name^Required

attr_internal_domain_name: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

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

attr_name^Required

attr_name: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Name: The name of Bucket.

props^Required

props: BucketProps

• Type: BucketProps