Package software.amazon.awscdk.services.lightsail

Interface CfnDiskProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDiskProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:29:59.732Z")
@Stability(Stable)
public interface CfnDiskProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDisk.

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.*;
 CfnDiskProps cfnDiskProps = CfnDiskProps.builder()
         .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")
         .location(LocationProperty.builder()
                 .availabilityZone("availabilityZone")
                 .regionName("regionName")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDiskProps.Builder	A builder for CfnDiskProps
static final class	CfnDiskProps.Jsii$Proxy	An implementation for CfnDiskProps

Method Summary

Modifier and Type	Method	Description
static CfnDiskProps.Builder	builder()
default Object	getAddOns()	An array of add-ons for the disk.
default String	getAvailabilityZone()	The AWS Region and Availability Zone location for the disk (for example, us-east-1a ).
String	getDiskName()	The name of the disk.
default Object	getLocation()	AWS::Lightsail::Disk.Location.
Number	getSizeInGb()	The size of the disk in GB.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDiskName

@Stability(Stable)
@NotNull
String getDiskName()

The name of the disk.

getSizeInGb

@Stability(Stable)
@NotNull
Number getSizeInGb()

The size of the disk in GB.

getAddOns

@Stability(Stable)
@Nullable
default 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.

getAvailabilityZone

@Stability(Stable)
@Nullable
default String getAvailabilityZone()

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

getLocation

@Stability(Stable)
@Nullable
default Object getLocation()

AWS::Lightsail::Disk.Location.

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> 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.

builder

@Stability(Stable)
static CfnDiskProps.Builder builder()

Returns:

a CfnDiskProps.Builder of CfnDiskProps