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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnBucketProps
static final class
An implementation forCfnBucketProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnBucketProps.Builder
builder()
default Object
An object that describes the access rules for the bucket.The name of the bucket.The bundle ID for the bucket (for example,small_1_0
).default Object
Indicates whether object versioning is enabled for the bucket.An array of AWS account IDs that have read-only access to the bucket.An array of Lightsail instances that have access to the bucket.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
The name of the bucket.- See Also:
-
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:
-
getAccessRules
An object that describes the access rules for the bucket.- See Also:
-
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:
-
getReadOnlyAccessAccounts
An array of AWS account IDs that have read-only access to the bucket.- See Also:
-
getResourcesReceivingAccess
An array of Lightsail instances that have access to the bucket.- See Also:
-
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
ofTags
is optional for Lightsail resources.- See Also:
-
builder
- Returns:
- a
CfnBucketProps.Builder
ofCfnBucketProps
-