software.amazon.awscdk.services.lightsail

Class CfnDisk

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

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:17.534Z")
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.
static interface	CfnDisk.LocationProperty Example:

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
	CfnDisk(Construct scope, java.lang.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
java.lang.Object	getAddOns() An array of add-ons for the disk.
java.lang.String	getAttrAttachedTo() The instance to which the disk is attached.
java.lang.String	getAttrAttachmentState() (Deprecated) The attachment state of the disk.
java.lang.String	getAttrDiskArn() The Amazon Resource Name (ARN) of the disk.
java.lang.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.
java.lang.String	getAttrLocationAvailabilityZone()
java.lang.String	getAttrLocationRegionName()
java.lang.String	getAttrPath() The path of the disk.
java.lang.String	getAttrResourceType() The resource type of the disk (for example, `Disk` ).
java.lang.String	getAttrState() The state of the disk (for example, `in-use` ).
java.lang.String	getAttrSupportCode() The support code of the disk.
java.lang.String	getAvailabilityZone() The AWS Region and Availability Zone location for the disk (for example, `us-east-1a` ).
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDiskName() The name of the disk.
java.lang.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 java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setAddOns(IResolvable value) An array of add-ons for the disk.
void	setAddOns(java.util.List<java.lang.Object> value) An array of add-ons for the disk.
void	setAvailabilityZone(java.lang.String value) The AWS Region and Availability Zone location for the disk (for example, `us-east-1a` ).
void	setDiskName(java.lang.String value) The name of the disk.
void	setSizeInGb(java.lang.Number value) The size of the disk in GB.

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

CfnDisk

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

CfnDisk

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

CfnDisk

public CfnDisk(Construct scope,
               java.lang.String id,
               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

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.

getAttrAttachedTo

public java.lang.String getAttrAttachedTo()

The instance to which the disk is attached.

getAttrAttachmentState

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

public java.lang.String getAttrDiskArn()

The Amazon Resource Name (ARN) of the disk.

getAttrIops

public java.lang.Number getAttrIops()

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

getAttrIsAttached

public IResolvable getAttrIsAttached()

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

getAttrLocationAvailabilityZone

public java.lang.String getAttrLocationAvailabilityZone()

getAttrLocationRegionName

public java.lang.String getAttrLocationRegionName()

getAttrPath

public java.lang.String getAttrPath()

The path of the disk.

getAttrResourceType

public java.lang.String getAttrResourceType()

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

getAttrState

public java.lang.String getAttrState()

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

getAttrSupportCode

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

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.

getDiskName

public java.lang.String getDiskName()

The name of the disk.

setDiskName

public void setDiskName(java.lang.String value)

The name of the disk.

getSizeInGb

public java.lang.Number getSizeInGb()

The size of the disk in GB.

setSizeInGb

public void setSizeInGb(java.lang.Number value)

The size of the disk in GB.

getAddOns

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

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

public void setAddOns(java.util.List<java.lang.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

public java.lang.String getAvailabilityZone()

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

setAvailabilityZone

public void setAvailabilityZone(java.lang.String value)

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