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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.57.0 (build f614666)",
           date="2022-04-22T09:30:49.184Z")
 @Stability(value=Stable)
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnBucket(software.constructs.Construct scope, 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
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() 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(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(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.

Methods inherited from class software.amazon.awscdk.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.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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnBucket(@NotNull
                                          software.constructs.Construct scope,
                                          @NotNull
                                          String id,
                                          @NotNull
                                          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

@Stability(value=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(value=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(value=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(value=Stable)
 @NotNull
public String getAttrBucketArn()

The Amazon Resource Name (ARN) of the bucket.

getAttrUrl

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

The URL of the bucket.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
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

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

The name of the bucket.

setBucketName

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

The name of the bucket.

getBundleId

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
public void setBundleId(@NotNull
                                                 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

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

An object that describes the access rules for the bucket.

setAccessRules

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

An object that describes the access rules for the bucket.

setAccessRules

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

An object that describes the access rules for the bucket.

getObjectVersioning

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setObjectVersioning(@Nullable
                                                         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

@Stability(value=Stable)
public void setObjectVersioning(@Nullable
                                                         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

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

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

setReadOnlyAccessAccounts

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

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

getResourcesReceivingAccess

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

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

setResourcesReceivingAccess

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

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