Package 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.102.0 (build e354887)",
           date="2024-08-23T05:56:19.186Z")
@Stability(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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	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 Details

getBucketName

@Stability(Stable)
@NotNull
String getBucketName()

The name of the bucket.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html#cfn-lightsail-bucket-bucketname

getBundleId

@Stability(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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html#cfn-lightsail-bucket-bundleid

getAccessRules

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

An object that describes the access rules for the bucket.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html#cfn-lightsail-bucket-accessrules

getObjectVersioning

@Stability(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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html#cfn-lightsail-bucket-objectversioning

getReadOnlyAccessAccounts

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html#cfn-lightsail-bucket-readonlyaccessaccounts

getResourcesReceivingAccess

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html#cfn-lightsail-bucket-resourcesreceivingaccess

getTags

@Stability(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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html#cfn-lightsail-bucket-tags

builder

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

Returns:

a CfnBucketProps.Builder of CfnBucketProps