software.amazon.awscdk.services.lightsail

Class CfnDisk

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.CfnDisk

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:07.171Z")
 @Stability(value=Stable)
public class CfnDisk
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Lightsail::Disk`.

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.*;
 CfnDisk cfnDisk = CfnDisk.Builder.create(this, "MyCfnDisk")
         .diskName("diskName")
         .sizeInGb(123)
         // the properties below are optional
         .addOns(List.of(AddOnProperty.builder()
                 .addOnType("addOnType")
                 // the properties below are optional
                 .autoSnapshotAddOnRequest(AutoSnapshotAddOnProperty.builder()
                         .snapshotTimeOfDay("snapshotTimeOfDay")
                         .build())
                 .status("status")
                 .build()))
         .availabilityZone("availabilityZone")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnDisk.AddOnProperty Example:
static interface	CfnDisk.AutoSnapshotAddOnProperty Example:
static class	CfnDisk.Builder A fluent builder for CfnDisk.

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
	CfnDisk(software.constructs.Construct scope, String id, CfnDiskProps props) Create a new `AWS::Lightsail::Disk`.
protected	CfnDisk(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDisk(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getAddOns() `AWS::Lightsail::Disk.AddOns`.
String	getAttrAttachedTo()
String	getAttrAttachmentState()
String	getAttrDiskArn()
Number	getAttrIops()
IResolvable	getAttrIsAttached()
String	getAttrPath()
String	getAttrResourceType()
String	getAttrState()
String	getAttrSupportCode()
String	getAvailabilityZone() `AWS::Lightsail::Disk.AvailabilityZone`.
protected Map<String,Object>	getCfnProperties()
String	getDiskName() `AWS::Lightsail::Disk.DiskName`.
Number	getSizeInGb() `AWS::Lightsail::Disk.SizeInGb`.
TagManager	getTags() `AWS::Lightsail::Disk.Tags`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAddOns(IResolvable value) `AWS::Lightsail::Disk.AddOns`.
void	setAddOns(List<Object> value) `AWS::Lightsail::Disk.AddOns`.
void	setAvailabilityZone(String value) `AWS::Lightsail::Disk.AvailabilityZone`.
void	setDiskName(String value) `AWS::Lightsail::Disk.DiskName`.
void	setSizeInGb(Number value) `AWS::Lightsail::Disk.SizeInGb`.

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

CfnDisk

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

CfnDisk

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

CfnDisk

@Stability(value=Stable)
public CfnDisk(@NotNull
                                        software.constructs.Construct scope,
                                        @NotNull
                                        String id,
                                        @NotNull
                                        CfnDiskProps props)

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

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.

getAddOns

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

`AWS::Lightsail::Disk.AddOns`.

setAddOns

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

`AWS::Lightsail::Disk.AddOns`.

setAddOns

@Stability(value=Stable)
public void setAddOns(@Nullable
                                               List<Object> value)

`AWS::Lightsail::Disk.AddOns`.

getAttrAttachedTo

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

getAttrAttachmentState

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

getAttrDiskArn

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

getAttrIops

@Stability(value=Stable)
 @NotNull
public Number getAttrIops()

getAttrIsAttached

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrIsAttached()

getAttrPath

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

getAttrResourceType

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

getAttrState

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

getAttrSupportCode

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

getAvailabilityZone

@Stability(value=Stable)
 @Nullable
public String getAvailabilityZone()

`AWS::Lightsail::Disk.AvailabilityZone`.

setAvailabilityZone

@Stability(value=Stable)
public void setAvailabilityZone(@Nullable
                                                         String value)

`AWS::Lightsail::Disk.AvailabilityZone`.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getDiskName

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

`AWS::Lightsail::Disk.DiskName`.

setDiskName

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

`AWS::Lightsail::Disk.DiskName`.

getSizeInGb

@Stability(value=Stable)
 @NotNull
public Number getSizeInGb()

`AWS::Lightsail::Disk.SizeInGb`.

setSizeInGb

@Stability(value=Stable)
public void setSizeInGb(@NotNull
                                                 Number value)

`AWS::Lightsail::Disk.SizeInGb`.

getTags

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

`AWS::Lightsail::Disk.Tags`.