Skip to content

BucketProps

Properties for defining a Bucket.

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

Initializer 

import com.aliyun.ros.cdk.oss.BucketProps;
BucketProps.builder()
    .bucketName(java.lang.String)
    .bucketName(IResolvable)
//  .accessControl(java.lang.String)
//  .accessControl(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();

Properties

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

bucketNameRequired 

public java.lang.Object getBucketName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property bucketName: bucket name.

accessControlOptional 

public java.lang.Object getAccessControl();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property accessControl: The access control list.

corsConfigurationOptional 

public java.lang.Object getCorsConfiguration();

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

deletionForceOptional 

public java.lang.Object getDeletionForce();
  • 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.

enableOssHdfsServiceOptional 

public java.lang.Object getEnableOssHdfsService();
  • 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.

lifecycleConfigurationOptional 

public java.lang.Object getLifecycleConfiguration();

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

loggingConfigurationOptional 

public java.lang.Object getLoggingConfiguration();

Property loggingConfiguration: Settings that defines where logs are stored.

policyOptional 

public java.lang.Object getPolicy();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

Property policy: Bucket policy.

redundancyTypeOptional 

public java.lang.Object getRedundancyType();
  • 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.

refererConfigurationOptional 

public java.lang.Object getRefererConfiguration();

Property refererConfiguration: undefined.

resourceGroupIdOptional 

public java.lang.Object getResourceGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: The resource group id.

serverSideEncryptionConfigurationOptional 

public java.lang.Object getServerSideEncryptionConfiguration();

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

storageClassOptional 

public java.lang.Object getStorageClass();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property storageClass: Specifies the storage class of the bucket.

Default is "Standard".

tagsOptional 

public java.util.Map<java.lang.String, java.lang.Object> getTags();
  • Type: java.util.Map

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

versioningConfigurationOptional 

public java.lang.Object getVersioningConfiguration();

Property versioningConfiguration: A state of versioning.

websiteConfigurationV2Optional 

public java.lang.Object getWebsiteConfigurationV2();

Property websiteConfigurationV2: Website configuration.