Skip to content

BucketProps

Properties for defining a Bucket.

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

Initializer 

import { BucketProps } from '@alicloud/ros-cdk-oss'
const bucketProps: BucketProps = { ... }

Properties

Name Type Description
bucketName string | @alicloud/ros-cdk-core.IResolvable Property bucketName: bucket name.
accessControl string | @alicloud/ros-cdk-core.IResolvable Property accessControl: The access control list.
corsConfiguration @alicloud/ros-cdk-core.IResolvable | CORSConfigurationProperty Property corsConfiguration: Rules that define cross-origin resource sharing of objects in this bucket.
deletionForce boolean | @alicloud/ros-cdk-core.IResolvable Property deletionForce: Whether force delete the relative objects in the bucket.
enableOssHdfsService boolean | @alicloud/ros-cdk-core.IResolvable Property enableOssHdfsService: Whether enable OSS-HDFS service.
lifecycleConfiguration @alicloud/ros-cdk-core.IResolvable | LifecycleConfigurationProperty Property lifecycleConfiguration: Rules that define how oss bucket manages objects during their lifetime.
loggingConfiguration @alicloud/ros-cdk-core.IResolvable | LoggingConfigurationProperty Property loggingConfiguration: Settings that defines where logs are stored.
policy @alicloud/ros-cdk-core.IResolvable | {[ key: string ]: any} Property policy: Bucket policy.
redundancyType string | @alicloud/ros-cdk-core.IResolvable Property redundancyType: Specifies the data disaster recovery type of the storage space.
refererConfiguration @alicloud/ros-cdk-core.IResolvable | RefererConfigurationProperty Property refererConfiguration: undefined.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: The resource group id.
serverSideEncryptionConfiguration @alicloud/ros-cdk-core.IResolvable | ServerSideEncryptionConfigurationProperty Property serverSideEncryptionConfiguration: Specifies the bucket used to store the server-side encryption rule.
storageClass string | @alicloud/ros-cdk-core.IResolvable Property storageClass: Specifies the storage class of the bucket.
tags {[ key: string ]: any} Property tags: Bucket tags in k-v pairs format.
versioningConfiguration @alicloud/ros-cdk-core.IResolvable | VersioningConfigurationProperty Property versioningConfiguration: A state of versioning.
websiteConfigurationV2 @alicloud/ros-cdk-core.IResolvable | WebsiteConfigurationV2Property Property websiteConfigurationV2: Website configuration.

bucketNameRequired 

public readonly bucketName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property bucketName: bucket name.

accessControlOptional 

public readonly accessControl: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property accessControl: The access control list.

corsConfigurationOptional 

public readonly corsConfiguration: IResolvable | CORSConfigurationProperty;

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

deletionForceOptional 

public readonly deletionForce: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

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

Default value is false.

enableOssHdfsServiceOptional 

public readonly enableOssHdfsService: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property enableOssHdfsService: Whether enable OSS-HDFS service.

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

lifecycleConfigurationOptional 

public readonly lifecycleConfiguration: IResolvable | LifecycleConfigurationProperty;

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

loggingConfigurationOptional 

public readonly loggingConfiguration: IResolvable | LoggingConfigurationProperty;

Property loggingConfiguration: Settings that defines where logs are stored.

policyOptional 

public readonly policy: IResolvable | {[ key: string ]: any};
  • Type: @alicloud/ros-cdk-core.IResolvable | {[ key: string ]: any}

Property policy: Bucket policy.

redundancyTypeOptional 

public readonly redundancyType: string | IResolvable;
  • Type: string | @alicloud/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.

refererConfigurationOptional 

public readonly refererConfiguration: IResolvable | RefererConfigurationProperty;

Property refererConfiguration: undefined.

resourceGroupIdOptional 

public readonly resourceGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property resourceGroupId: The resource group id.

serverSideEncryptionConfigurationOptional 

public readonly serverSideEncryptionConfiguration: IResolvable | ServerSideEncryptionConfigurationProperty;

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

storageClassOptional 

public readonly storageClass: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property storageClass: Specifies the storage class of the bucket.

Default is "Standard".

tagsOptional 

public readonly tags: {[ key: string ]: any};
  • Type: {[ key: string ]: any}

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

versioningConfigurationOptional 

public readonly versioningConfiguration: IResolvable | VersioningConfigurationProperty;

Property versioningConfiguration: A state of versioning.

websiteConfigurationV2Optional 

public readonly websiteConfigurationV2: IResolvable | WebsiteConfigurationV2Property;

Property websiteConfigurationV2: Website configuration.