Skip to content

BucketProps

Properties for defining a Bucket.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-oss-bucket

Initializer 

import ros_cdk_oss
ros_cdk_oss.BucketProps(
  bucket_name: typing.Union[str, IResolvable],
  access_control: typing.Union[str, 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
)

Properties

Name Type Description
bucket_name typing.Union[str, ros_cdk_core.IResolvable] Property bucketName: bucket name.
access_control typing.Union[str, ros_cdk_core.IResolvable] Property accessControl: The access control list.
cors_configuration typing.Union[ros_cdk_core.IResolvable, CORSConfigurationProperty] Property corsConfiguration: Rules that define cross-origin resource sharing of objects in this bucket.
deletion_force typing.Union[bool, ros_cdk_core.IResolvable] Property deletionForce: Whether force delete the relative objects in the bucket.
enable_oss_hdfs_service typing.Union[bool, ros_cdk_core.IResolvable] Property enableOssHdfsService: Whether enable OSS-HDFS service.
lifecycle_configuration typing.Union[ros_cdk_core.IResolvable, LifecycleConfigurationProperty] Property lifecycleConfiguration: Rules that define how oss bucket manages objects during their lifetime.
logging_configuration typing.Union[ros_cdk_core.IResolvable, LoggingConfigurationProperty] Property loggingConfiguration: Settings that defines where logs are stored.
policy typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] Property policy: Bucket policy.
redundancy_type typing.Union[str, ros_cdk_core.IResolvable] Property redundancyType: Specifies the data disaster recovery type of the storage space.
referer_configuration typing.Union[ros_cdk_core.IResolvable, RefererConfigurationProperty] Property refererConfiguration: undefined.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: The resource group id.
server_side_encryption_configuration typing.Union[ros_cdk_core.IResolvable, ServerSideEncryptionConfigurationProperty] Property serverSideEncryptionConfiguration: Specifies the bucket used to store the server-side encryption rule.
storage_class typing.Union[str, ros_cdk_core.IResolvable] Property storageClass: Specifies the storage class of the bucket.
tags typing.Mapping[typing.Any] Property tags: Bucket tags in k-v pairs format.
versioning_configuration typing.Union[ros_cdk_core.IResolvable, VersioningConfigurationProperty] Property versioningConfiguration: A state of versioning.
website_configuration_v2 typing.Union[ros_cdk_core.IResolvable, WebsiteConfigurationV2Property] Property websiteConfigurationV2: Website configuration.

bucket_nameRequired 

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

Property bucketName: bucket name.

access_controlOptional 

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

Property accessControl: The access control list.

cors_configurationOptional 

cors_configuration: typing.Union[IResolvable, CORSConfigurationProperty]

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

deletion_forceOptional 

deletion_force: typing.Union[bool, IResolvable]
  • 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_serviceOptional 

enable_oss_hdfs_service: typing.Union[bool, IResolvable]
  • 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_configurationOptional 

lifecycle_configuration: typing.Union[IResolvable, LifecycleConfigurationProperty]

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

logging_configurationOptional 

logging_configuration: typing.Union[IResolvable, LoggingConfigurationProperty]

Property loggingConfiguration: Settings that defines where logs are stored.

policyOptional 

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

Property policy: Bucket policy.

redundancy_typeOptional 

redundancy_type: typing.Union[str, IResolvable]
  • 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_configurationOptional 

referer_configuration: typing.Union[IResolvable, RefererConfigurationProperty]

Property refererConfiguration: undefined.

resource_group_idOptional 

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

Property resourceGroupId: The resource group id.

server_side_encryption_configurationOptional 

server_side_encryption_configuration: typing.Union[IResolvable, ServerSideEncryptionConfigurationProperty]

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

storage_classOptional 

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

Property storageClass: Specifies the storage class of the bucket.

Default is "Standard".

tagsOptional 

tags: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]

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

versioning_configurationOptional 

versioning_configuration: typing.Union[IResolvable, VersioningConfigurationProperty]

Property versioningConfiguration: A state of versioning.

website_configuration_v2Optional 

website_configuration_v2: typing.Union[IResolvable, WebsiteConfigurationV2Property]

Property websiteConfigurationV2: Website configuration.