software.amazon.awscdk.services.lightsail

Interface CfnInstanceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnInstanceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:07.174Z")
 @Stability(value=Stable)
public interface CfnInstanceProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::Lightsail::Instance`.

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.*;
 CfnInstanceProps cfnInstanceProps = CfnInstanceProps.builder()
         .blueprintId("blueprintId")
         .bundleId("bundleId")
         .instanceName("instanceName")
         // 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")
         .hardware(HardwareProperty.builder()
                 .cpuCount(123)
                 .disks(List.of(DiskProperty.builder()
                         .diskName("diskName")
                         .path("path")
                         // the properties below are optional
                         .attachedTo("attachedTo")
                         .attachmentState("attachmentState")
                         .iops(123)
                         .isSystemDisk(false)
                         .sizeInGb("sizeInGb")
                         .build()))
                 .ramSizeInGb(123)
                 .build())
         .keyPairName("keyPairName")
         .networking(NetworkingProperty.builder()
                 .ports(List.of(PortProperty.builder()
                         .accessDirection("accessDirection")
                         .accessFrom("accessFrom")
                         .accessType("accessType")
                         .cidrListAliases(List.of("cidrListAliases"))
                         .cidrs(List.of("cidrs"))
                         .commonName("commonName")
                         .fromPort(123)
                         .ipv6Cidrs(List.of("ipv6Cidrs"))
                         .protocol("protocol")
                         .toPort(123)
                         .build()))
                 // the properties below are optional
                 .monthlyTransfer(123)
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .userData("userData")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnInstanceProps.Builder	builder()
default Object	getAddOns() `AWS::Lightsail::Instance.AddOns`.
default String	getAvailabilityZone() `AWS::Lightsail::Instance.AvailabilityZone`.
String	getBlueprintId() `AWS::Lightsail::Instance.BlueprintId`.
String	getBundleId() `AWS::Lightsail::Instance.BundleId`.
default Object	getHardware() `AWS::Lightsail::Instance.Hardware`.
String	getInstanceName() `AWS::Lightsail::Instance.InstanceName`.
default String	getKeyPairName() `AWS::Lightsail::Instance.KeyPairName`.
default Object	getNetworking() `AWS::Lightsail::Instance.Networking`.
default List<CfnTag>	getTags() `AWS::Lightsail::Instance.Tags`.
default String	getUserData() `AWS::Lightsail::Instance.UserData`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAddOns

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

`AWS::Lightsail::Instance.AddOns`.

getAvailabilityZone

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

`AWS::Lightsail::Instance.AvailabilityZone`.

getBlueprintId

@Stability(value=Stable)
 @NotNull
String getBlueprintId()

`AWS::Lightsail::Instance.BlueprintId`.

getBundleId

@Stability(value=Stable)
 @NotNull
String getBundleId()

`AWS::Lightsail::Instance.BundleId`.

getHardware

@Stability(value=Stable)
 @Nullable
default Object getHardware()

`AWS::Lightsail::Instance.Hardware`.

getInstanceName

@Stability(value=Stable)
 @NotNull
String getInstanceName()

`AWS::Lightsail::Instance.InstanceName`.

getKeyPairName

@Stability(value=Stable)
 @Nullable
default String getKeyPairName()

`AWS::Lightsail::Instance.KeyPairName`.

getNetworking

@Stability(value=Stable)
 @Nullable
default Object getNetworking()

`AWS::Lightsail::Instance.Networking`.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

`AWS::Lightsail::Instance.Tags`.

getUserData

@Stability(value=Stable)
 @Nullable
default String getUserData()

`AWS::Lightsail::Instance.UserData`.

builder

@Stability(value=Stable)
static CfnInstanceProps.Builder builder()

Returns:

a CfnInstanceProps.Builder of CfnInstanceProps