Package software.amazon.awscdk.services.lightsail

Class CfnBucket

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.lightsail.CfnBucket

All Implemented Interfaces:

IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-11T15:56:01.342Z")
@Stability(Stable)
public class CfnBucket
extends CfnResource
implements IInspectable, ITaggable

The AWS::Lightsail::Bucket resource specifies a bucket.

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.*;
 CfnBucket cfnBucket = CfnBucket.Builder.create(this, "MyCfnBucket")
         .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	Class	Description
static interface	CfnBucket.AccessRulesProperty	AccessRules is a property of the AWS::Lightsail::Bucket resource.
static final class	CfnBucket.Builder	A fluent builder for CfnBucket.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnBucket(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnBucket(software.amazon.jsii.JsiiObjectRef objRef)
	CfnBucket(software.constructs.Construct scope, String id, CfnBucketProps props)

Method Summary

Modifier and Type	Method	Description
Object	getAccessRules()	An object that describes the access rules for the bucket.
IResolvable	getAttrAbleToUpdateBundle()	A Boolean value indicating whether the bundle that is currently applied to your distribution can be changed to another bundle.
String	getAttrBucketArn()	The Amazon Resource Name (ARN) of the bucket.
String	getAttrUrl()	The URL of the bucket.
String	getBucketName()	The name of the bucket.
String	getBundleId()	The bundle ID for the bucket (for example, small_1_0 ).
protected Map<String,Object>	getCfnProperties()
Object	getObjectVersioning()	Indicates whether object versioning is enabled for the bucket.
List<String>	getReadOnlyAccessAccounts()	An array of AWS account IDs that have read-only access to the bucket.
List<String>	getResourcesReceivingAccess()	An array of Lightsail instances that have access to the bucket.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAccessRules(IResolvable value)	An object that describes the access rules for the bucket.
void	setAccessRules(CfnBucket.AccessRulesProperty value)	An object that describes the access rules for the bucket.
void	setBucketName(String value)	The name of the bucket.
void	setBundleId(String value)	The bundle ID for the bucket (for example, small_1_0 ).
void	setObjectVersioning(Boolean value)	Indicates whether object versioning is enabled for the bucket.
void	setObjectVersioning(IResolvable value)	Indicates whether object versioning is enabled for the bucket.
void	setReadOnlyAccessAccounts(List<String> value)	An array of AWS account IDs that have read-only access to the bucket.
void	setResourcesReceivingAccess(List<String> value)	An array of Lightsail instances that have access to the bucket.
void	setTagsRaw(List<CfnTag> value)	An array of key-value pairs to apply to this resource.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnBucket

protected CfnBucket(software.amazon.jsii.JsiiObjectRef objRef)

CfnBucket

protected CfnBucket(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnBucket

@Stability(Stable)
public CfnBucket(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnBucketProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrAbleToUpdateBundle

@Stability(Stable)
@NotNull
public IResolvable getAttrAbleToUpdateBundle()

A Boolean value indicating whether the bundle that is currently applied to your distribution can be changed to another bundle.

getAttrBucketArn

@Stability(Stable)
@NotNull
public String getAttrBucketArn()

The Amazon Resource Name (ARN) of the bucket.

getAttrUrl

@Stability(Stable)
@NotNull
public String getAttrUrl()

The URL of the bucket.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getBucketName

@Stability(Stable)
@NotNull
public String getBucketName()

The name of the bucket.

setBucketName

@Stability(Stable)
public void setBucketName(@NotNull
 String value)

The name of the bucket.

getBundleId

@Stability(Stable)
@NotNull
public String getBundleId()

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

setBundleId

@Stability(Stable)
public void setBundleId(@NotNull
 String value)

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

getAccessRules

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

An object that describes the access rules for the bucket.

setAccessRules

@Stability(Stable)
public void setAccessRules(@Nullable
 IResolvable value)

An object that describes the access rules for the bucket.

setAccessRules

@Stability(Stable)
public void setAccessRules(@Nullable
 CfnBucket.AccessRulesProperty value)

An object that describes the access rules for the bucket.

getObjectVersioning

@Stability(Stable)
@Nullable
public Object getObjectVersioning()

Indicates whether object versioning is enabled for the bucket.

setObjectVersioning

@Stability(Stable)
public void setObjectVersioning(@Nullable
 Boolean value)

Indicates whether object versioning is enabled for the bucket.

setObjectVersioning

@Stability(Stable)
public void setObjectVersioning(@Nullable
 IResolvable value)

Indicates whether object versioning is enabled for the bucket.

getReadOnlyAccessAccounts

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

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

setReadOnlyAccessAccounts

@Stability(Stable)
public void setReadOnlyAccessAccounts(@Nullable
 List<String> value)

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

getResourcesReceivingAccess

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

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

setResourcesReceivingAccess

@Stability(Stable)
public void setResourcesReceivingAccess(@Nullable
 List<String> value)

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

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

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

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

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