software.amazon.awscdk.services.lightsail

Interface CfnBucketProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBucketProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-05-19T23:08:47.907Z")
 @Stability(value=Stable)
public interface CfnBucketProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnBucket`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.lightsail.*;
 CfnBucketProps cfnBucketProps = CfnBucketProps.builder()
         .bucketName("bucketName")
         .bundleId("bundleId")
         // the properties below are optional
         .accessRules(AccessRulesProperty.builder()
                 .allowPublicOverrides(false)
                 .objectAccess("objectAccess")
                 .build())
         .objectVersioning(false)
         .readOnlyAccessAccounts(List.of("readOnlyAccessAccounts"))
         .resourcesReceivingAccess(List.of("resourcesReceivingAccess"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnBucketProps.Builder A builder for CfnBucketProps
static class	CfnBucketProps.Jsii$Proxy An implementation for CfnBucketProps

Method Summary

Modifier and Type	Method and Description
static CfnBucketProps.Builder	builder()
default Object	getAccessRules() An object that describes the access rules for the bucket.
String	getBucketName() The name of the bucket.
String	getBundleId() The bundle ID for the bucket (for example, `small_1_0` ).
default Object	getObjectVersioning() Indicates whether object versioning is enabled for the bucket.
default List<String>	getReadOnlyAccessAccounts() An array of AWS account IDs that have read-only access to the bucket.
default List<String>	getResourcesReceivingAccess() An array of Lightsail instances that have access to the bucket.
default List<CfnTag>	getTags() An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getBucketName

@Stability(value=Stable)
 @NotNull
String getBucketName()

The name of the bucket.

getBundleId

@Stability(value=Stable)
 @NotNull
String getBundleId()

The bundle ID for the bucket (for example, `small_1_0` ).

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket.

getAccessRules

@Stability(value=Stable)
 @Nullable
default Object getAccessRules()

An object that describes the access rules for the bucket.

getObjectVersioning

@Stability(value=Stable)
 @Nullable
default Object getObjectVersioning()

Indicates whether object versioning is enabled for the bucket.

The following options can be configured:

• Enabled - Object versioning is enabled.
• Suspended - Object versioning was previously enabled but is currently suspended. Existing object versions are retained.
• NeverEnabled - Object versioning has never been enabled.

getReadOnlyAccessAccounts

@Stability(value=Stable)
 @Nullable
default List<String> getReadOnlyAccessAccounts()

An array of AWS account IDs that have read-only access to the bucket.

getResourcesReceivingAccess

@Stability(value=Stable)
 @Nullable
default List<String> getResourcesReceivingAccess()

An array of Lightsail instances that have access to the bucket.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

An array of key-value pairs to apply to this resource.

For more information, see Tag in the AWS CloudFormation User Guide .

The Value of Tags is optional for Lightsail resources.

builder

@Stability(value=Stable)
static CfnBucketProps.Builder builder()

Returns:

a CfnBucketProps.Builder of CfnBucketProps