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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.653Z")
 @Stability(value=Stable)
public class CfnDisk
extends CfnResource
implements IInspectable

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

The AWS::Lightsail::Disk resource specifies a disk that can be attached to an Amazon Lightsail instance that is in the same AWS Region and Availability Zone.

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 `AddOn` is a property of the [AWS::Lightsail::Disk](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html) resource.
static interface	CfnDisk.AutoSnapshotAddOnProperty `AutoSnapshotAddOn` is a property of the [AddOn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-disk-addon.html) property.
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() An array of add-ons for the disk.
String	getAttrAttachedTo() The instance to which the disk is attached.
String	getAttrAttachmentState() (Deprecated) The attachment state of the disk.
String	getAttrDiskArn() The Amazon Resource Name (ARN) of the disk.
Number	getAttrIops() The input/output operations per second (IOPS) of the disk.
IResolvable	getAttrIsAttached() A Boolean value indicating whether the disk is attached to an instance.
String	getAttrPath() The path of the disk.
String	getAttrResourceType() The resource type of the disk (for example, `Disk` ).
String	getAttrState() The state of the disk (for example, `in-use` ).
String	getAttrSupportCode() The support code of the disk.
String	getAvailabilityZone() The AWS Region and Availability Zone location for the disk (for example, `us-east-1a` ).
protected Map<String,Object>	getCfnProperties()
String	getDiskName() The name of the disk.
Number	getSizeInGb() The size of the disk in GB.
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	setAddOns(IResolvable value) An array of add-ons for the disk.
void	setAddOns(List<Object> value) An array of add-ons for the disk.
void	setAvailabilityZone(String value) The AWS Region and Availability Zone location for the disk (for example, `us-east-1a` ).
void	setDiskName(String value) The name of the disk.
void	setSizeInGb(Number value) The size of the disk in GB.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, 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.

getAttrAttachedTo

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

The instance to which the disk is attached.

getAttrAttachmentState

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

(Deprecated) The attachment state of the disk.

In releases prior to November 14, 2017, this parameter returned attached for system disks in the API response. It is now deprecated, but still included in the response. Use isAttached instead.

getAttrDiskArn

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

The Amazon Resource Name (ARN) of the disk.

getAttrIops

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

The input/output operations per second (IOPS) of the disk.

getAttrIsAttached

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

A Boolean value indicating whether the disk is attached to an instance.

getAttrPath

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

The path of the disk.

getAttrResourceType

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

The resource type of the disk (for example, `Disk` ).

getAttrState

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

The state of the disk (for example, `in-use` ).

getAttrSupportCode

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

The support code of the disk.

Include this code in your email to support when you have questions about a disk or another resource in Lightsail . This code helps our support team to look up your Lightsail information.

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.

getDiskName

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

The name of the disk.

setDiskName

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

The name of the disk.

getSizeInGb

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

The size of the disk in GB.

setSizeInGb

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

The size of the disk in GB.

getAddOns

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

An array of add-ons for the disk.

If the disk has an add-on enabled when performing a delete disk request, the add-on is automatically disabled before the disk is deleted.

setAddOns

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

An array of add-ons for the disk.

If the disk has an add-on enabled when performing a delete disk request, the add-on is automatically disabled before the disk is deleted.

setAddOns

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

An array of add-ons for the disk.

If the disk has an add-on enabled when performing a delete disk request, the add-on is automatically disabled before the disk is deleted.

getAvailabilityZone

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

The AWS Region and Availability Zone location for the disk (for example, `us-east-1a` ).

setAvailabilityZone

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

The AWS Region and Availability Zone location for the disk (for example, `us-east-1a` ).