software.amazon.awscdk.services.lightsail

Class CfnInstance

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

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.172Z")
 @Stability(value=Stable)
public class CfnInstance
extends CfnResource
implements IInspectable

A CloudFormation `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.*;
 CfnInstance cfnInstance = CfnInstance.Builder.create(this, "MyCfnInstance")
         .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	Class and Description
static interface	CfnInstance.AddOnProperty Example:
static interface	CfnInstance.AutoSnapshotAddOnProperty Example:
static class	CfnInstance.Builder A fluent builder for CfnInstance.
static interface	CfnInstance.DiskProperty Example:
static interface	CfnInstance.HardwareProperty Example:
static interface	CfnInstance.LocationProperty Example:
static interface	CfnInstance.MonthlyTransferProperty Example:
static interface	CfnInstance.NetworkingProperty Example:
static interface	CfnInstance.PortProperty Example:
static interface	CfnInstance.StateProperty Example:

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

Method Summary

Modifier and Type	Method and Description
Object	getAddOns() `AWS::Lightsail::Instance.AddOns`.
Number	getAttrHardwareCpuCount()
Number	getAttrHardwareRamSizeInGb()
String	getAttrInstanceArn()
IResolvable	getAttrIsStaticIp()
String	getAttrLocationAvailabilityZone()
String	getAttrLocationRegionName()
String	getAttrNetworkingMonthlyTransferGbPerMonthAllocated()
String	getAttrPrivateIpAddress()
String	getAttrPublicIpAddress()
String	getAttrResourceType()
String	getAttrSshKeyName()
Number	getAttrStateCode()
String	getAttrStateName()
String	getAttrSupportCode()
String	getAttrUserName()
String	getAvailabilityZone() `AWS::Lightsail::Instance.AvailabilityZone`.
String	getBlueprintId() `AWS::Lightsail::Instance.BlueprintId`.
String	getBundleId() `AWS::Lightsail::Instance.BundleId`.
protected Map<String,Object>	getCfnProperties()
Object	getHardware() `AWS::Lightsail::Instance.Hardware`.
String	getInstanceName() `AWS::Lightsail::Instance.InstanceName`.
String	getKeyPairName() `AWS::Lightsail::Instance.KeyPairName`.
Object	getNetworking() `AWS::Lightsail::Instance.Networking`.
TagManager	getTags() `AWS::Lightsail::Instance.Tags`.
String	getUserData() `AWS::Lightsail::Instance.UserData`.
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::Instance.AddOns`.
void	setAddOns(List<Object> value) `AWS::Lightsail::Instance.AddOns`.
void	setAvailabilityZone(String value) `AWS::Lightsail::Instance.AvailabilityZone`.
void	setBlueprintId(String value) `AWS::Lightsail::Instance.BlueprintId`.
void	setBundleId(String value) `AWS::Lightsail::Instance.BundleId`.
void	setHardware(CfnInstance.HardwareProperty value) `AWS::Lightsail::Instance.Hardware`.
void	setHardware(IResolvable value) `AWS::Lightsail::Instance.Hardware`.
void	setInstanceName(String value) `AWS::Lightsail::Instance.InstanceName`.
void	setKeyPairName(String value) `AWS::Lightsail::Instance.KeyPairName`.
void	setNetworking(CfnInstance.NetworkingProperty value) `AWS::Lightsail::Instance.Networking`.
void	setNetworking(IResolvable value) `AWS::Lightsail::Instance.Networking`.
void	setUserData(String value) `AWS::Lightsail::Instance.UserData`.

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

CfnInstance

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

CfnInstance

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

CfnInstance

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

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

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::Instance.AddOns`.

setAddOns

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

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

setAddOns

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

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

getAttrHardwareCpuCount

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

getAttrHardwareRamSizeInGb

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

getAttrInstanceArn

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

getAttrIsStaticIp

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

getAttrLocationAvailabilityZone

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

getAttrLocationRegionName

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

getAttrNetworkingMonthlyTransferGbPerMonthAllocated

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

getAttrPrivateIpAddress

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

getAttrPublicIpAddress

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

getAttrResourceType

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

getAttrSshKeyName

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

getAttrStateCode

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

getAttrStateName

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

getAttrSupportCode

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

getAttrUserName

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

getAvailabilityZone

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

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

setAvailabilityZone

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

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

getBlueprintId

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

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

setBlueprintId

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

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

getBundleId

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

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

setBundleId

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

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getHardware

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

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

setHardware

@Stability(value=Stable)
public void setHardware(@Nullable
                                                 CfnInstance.HardwareProperty value)

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

setHardware

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

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

getInstanceName

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

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

setInstanceName

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

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

getKeyPairName

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

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

setKeyPairName

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

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

getNetworking

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

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

setNetworking

@Stability(value=Stable)
public void setNetworking(@Nullable
                                                   CfnInstance.NetworkingProperty value)

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

setNetworking

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

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

getTags

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

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

getUserData

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

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

setUserData

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

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