software.amazon.awscdk.services.lightsail

Class CfnBucket

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.lightsail.CfnBucket

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)",
           date="2022-06-22T23:27:51.571Z")
public class CfnBucket
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Lightsail::Bucket`.

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnBucket.AccessRulesProperty `AccessRules` is a property of the [AWS::Lightsail::Bucket](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html) resource.
static class	CfnBucket.Builder A fluent builder for CfnBucket.

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnBucket(Construct scope, java.lang.String id, CfnBucketProps props) Create a new `AWS::Lightsail::Bucket`.
protected	CfnBucket(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnBucket(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.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.
java.lang.String	getAttrBucketArn() The Amazon Resource Name (ARN) of the bucket.
java.lang.String	getAttrUrl() The URL of the bucket.
java.lang.String	getBucketName() The name of the bucket.
java.lang.String	getBundleId() The bundle ID for the bucket (for example, `small_1_0` ).
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.Object	getObjectVersioning() Indicates whether object versioning is enabled for the bucket.
java.util.List<java.lang.String>	getReadOnlyAccessAccounts() An array of AWS account IDs that have read-only access to the bucket.
java.util.List<java.lang.String>	getResourcesReceivingAccess() An array of Lightsail instances that have access to the bucket.
TagManager	getTags() An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setAccessRules(CfnBucket.AccessRulesProperty value) An object that describes the access rules for the bucket.
void	setAccessRules(IResolvable value) An object that describes the access rules for the bucket.
void	setBucketName(java.lang.String value) The name of the bucket.
void	setBundleId(java.lang.String value) The bundle ID for the bucket (for example, `small_1_0` ).
void	setObjectVersioning(java.lang.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(java.util.List<java.lang.String> value) An array of AWS account IDs that have read-only access to the bucket.
void	setResourcesReceivingAccess(java.util.List<java.lang.String> value) An array of Lightsail instances that have access to the bucket.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnBucket

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

CfnBucket

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

CfnBucket

public CfnBucket(Construct scope,
                 java.lang.String id,
                 CfnBucketProps props)

Create a new `AWS::Lightsail::Bucket`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrAbleToUpdateBundle

public IResolvable getAttrAbleToUpdateBundle()

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

getAttrBucketArn

public java.lang.String getAttrBucketArn()

The Amazon Resource Name (ARN) of the bucket.

getAttrUrl

public java.lang.String getAttrUrl()

The URL of the bucket.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager 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.

getBucketName

public java.lang.String getBucketName()

The name of the bucket.

setBucketName

public void setBucketName(java.lang.String value)

The name of the bucket.

getBundleId

public java.lang.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.

setBundleId

public void setBundleId(java.lang.String value)

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

public java.lang.Object getAccessRules()

An object that describes the access rules for the bucket.

setAccessRules

public void setAccessRules(IResolvable value)

An object that describes the access rules for the bucket.

setAccessRules

public void setAccessRules(CfnBucket.AccessRulesProperty value)

An object that describes the access rules for the bucket.

getObjectVersioning

public java.lang.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.

setObjectVersioning

public void setObjectVersioning(java.lang.Boolean value)

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.

setObjectVersioning

public void setObjectVersioning(IResolvable value)

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

public java.util.List<java.lang.String> getReadOnlyAccessAccounts()

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

setReadOnlyAccessAccounts

public void setReadOnlyAccessAccounts(java.util.List<java.lang.String> value)

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

getResourcesReceivingAccess

public java.util.List<java.lang.String> getResourcesReceivingAccess()

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

setResourcesReceivingAccess

public void setResourcesReceivingAccess(java.util.List<java.lang.String> value)

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