CfnInstance

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

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:24.018Z")
public class CfnInstance
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Lightsail::Instance`.

The AWS::Lightsail::Instance resource specifies an Amazon 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")
         .location(LocationProperty.builder()
                 .availabilityZone("availabilityZone")
                 .regionName("regionName")
                 .build())
         .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())
         .state(StateProperty.builder()
                 .code(123)
                 .name("name")
                 .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` `AddOn` is a property of the [AWS::Lightsail::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html) resource.
`static interface`	`CfnInstance.AutoSnapshotAddOnProperty` `AutoSnapshotAddOn` is a property of the [AddOn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-addon.html) property.
`static class`	`CfnInstance.Builder` A fluent builder for `CfnInstance`.
`static interface`	`CfnInstance.DiskProperty` `Disk` is a property of the [Hardware](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-hardware.html) property.
`static interface`	`CfnInstance.HardwareProperty` `Hardware` is a property of the [AWS::Lightsail::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html) resource.
`static interface`	`CfnInstance.LocationProperty` `Location` is a property of the [AWS::Lightsail::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html) resource.
`static interface`	`CfnInstance.MonthlyTransferProperty` `MonthlyTransfer` is a property of the [Networking](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-networking.html) property.
`static interface`	`CfnInstance.NetworkingProperty` `Networking` is a property of the [AWS::Lightsail::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html) resource.
`static interface`	`CfnInstance.PortProperty` `Port` is a property of the [Networking](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-networking.html) property.
`static interface`	`CfnInstance.StateProperty` `State` is a property of the [AWS::Lightsail::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html) resource.

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.

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
	`CfnInstance(Construct scope, java.lang.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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`getAddOns()` An array of add-ons for the instance.
`java.lang.Number`	`getAttrHardwareCpuCount()` The number of vCPUs the instance has.
`java.lang.Number`	`getAttrHardwareRamSizeInGb()` The amount of RAM in GB on the instance (for example, `1.0` ).
`java.lang.String`	`getAttrInstanceArn()` The Amazon Resource Name (ARN) of the instance (for example, `arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE` ).
`IResolvable`	`getAttrIsStaticIp()` A Boolean value indicating whether the instance has a static IP assigned to it.
`java.lang.String`	`getAttrLocationAvailabilityZone()` The AWS Region and Availability Zone where the instance is located.
`java.lang.String`	`getAttrLocationRegionName()` The AWS Region of the instance.
`java.lang.String`	`getAttrNetworkingMonthlyTransferGbPerMonthAllocated()` The amount of allocated monthly data transfer (in GB) for an instance.
`java.lang.String`	`getAttrPrivateIpAddress()` The private IP address of the instance.
`java.lang.String`	`getAttrPublicIpAddress()` The public IP address of the instance.
`java.lang.String`	`getAttrResourceType()` The resource type of the instance (for example, `Instance` ).
`java.lang.String`	`getAttrSshKeyName()` The name of the SSH key pair used by the instance.
`java.lang.Number`	`getAttrStateCode()` The status code of the instance.
`java.lang.String`	`getAttrStateName()` The state of the instance (for example, `running` or `pending` ).
`java.lang.String`	`getAttrSupportCode()` The support code of the instance.
`java.lang.String`	`getAttrUserName()` The user name for connecting to the instance (for example, `ec2-user` ).
`java.lang.String`	`getAvailabilityZone()` The Availability Zone for the instance.
`java.lang.String`	`getBlueprintId()` The blueprint ID for the instance (for example, `os_amlinux_2016_03` ).
`java.lang.String`	`getBundleId()` The bundle ID for the instance (for example, `micro_1_0` ).
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.Object`	`getHardware()` The hardware properties for the instance, such as the vCPU count, attached disks, and amount of RAM.
`java.lang.String`	`getInstanceName()` The name of the instance.
`java.lang.String`	`getKeyPairName()` The name of the key pair to use for the instance.
`java.lang.Object`	`getLocation()` The location for the instance, such as the AWS Region and Availability Zone.
`java.lang.Object`	`getNetworking()` The public ports and the monthly amount of data transfer allocated for the instance.
`java.lang.Object`	`getState()` The status code and the state (for example, `running` ) of the instance.
`TagManager`	`getTags()` An array of key-value pairs to apply to this resource.
`java.lang.String`	`getUserData()` The optional launch script for the instance.
`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 instance.
`void`	`setAddOns(java.util.List<java.lang.Object> value)` An array of add-ons for the instance.
`void`	`setAvailabilityZone(java.lang.String value)` The Availability Zone for the instance.
`void`	`setBlueprintId(java.lang.String value)` The blueprint ID for the instance (for example, `os_amlinux_2016_03` ).
`void`	`setBundleId(java.lang.String value)` The bundle ID for the instance (for example, `micro_1_0` ).
`void`	`setHardware(CfnInstance.HardwareProperty value)` The hardware properties for the instance, such as the vCPU count, attached disks, and amount of RAM.
`void`	`setHardware(IResolvable value)` The hardware properties for the instance, such as the vCPU count, attached disks, and amount of RAM.
`void`	`setInstanceName(java.lang.String value)` The name of the instance.
`void`	`setKeyPairName(java.lang.String value)` The name of the key pair to use for the instance.
`void`	`setLocation(CfnInstance.LocationProperty value)` The location for the instance, such as the AWS Region and Availability Zone.
`void`	`setLocation(IResolvable value)` The location for the instance, such as the AWS Region and Availability Zone.
`void`	`setNetworking(CfnInstance.NetworkingProperty value)` The public ports and the monthly amount of data transfer allocated for the instance.
`void`	`setNetworking(IResolvable value)` The public ports and the monthly amount of data transfer allocated for the instance.
`void`	`setState(CfnInstance.StateProperty value)` The status code and the state (for example, `running` ) of the instance.
`void`	`setState(IResolvable value)` The status code and the state (for example, `running` ) of the instance.
`void`	`setUserData(java.lang.String value)` The optional launch script for the instance.

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
  - CfnInstance
```
protected CfnInstance(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnInstance
```
protected CfnInstance(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnInstance
```
public CfnInstance(Construct scope,
                   java.lang.String id,
                   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
```
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.
  - getAttrHardwareCpuCount
```
public java.lang.Number getAttrHardwareCpuCount()
```
    The number of vCPUs the instance has.
  - getAttrHardwareRamSizeInGb
```
public java.lang.Number getAttrHardwareRamSizeInGb()
```
    The amount of RAM in GB on the instance (for example, `1.0` ).
  - getAttrInstanceArn
```
public java.lang.String getAttrInstanceArn()
```
    The Amazon Resource Name (ARN) of the instance (for example, `arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE` ).
  - getAttrIsStaticIp
```
public IResolvable getAttrIsStaticIp()
```
    A Boolean value indicating whether the instance has a static IP assigned to it.
  - getAttrLocationAvailabilityZone
```
public java.lang.String getAttrLocationAvailabilityZone()
```
    The AWS Region and Availability Zone where the instance is located.
  - getAttrLocationRegionName
```
public java.lang.String getAttrLocationRegionName()
```
    The AWS Region of the instance.
  - getAttrNetworkingMonthlyTransferGbPerMonthAllocated
```
public java.lang.String getAttrNetworkingMonthlyTransferGbPerMonthAllocated()
```
    The amount of allocated monthly data transfer (in GB) for an instance.
  - getAttrPrivateIpAddress
```
public java.lang.String getAttrPrivateIpAddress()
```
    The private IP address of the instance.
  - getAttrPublicIpAddress
```
public java.lang.String getAttrPublicIpAddress()
```
    The public IP address of the instance.
  - getAttrResourceType
```
public java.lang.String getAttrResourceType()
```
    The resource type of the instance (for example, `Instance` ).
  - getAttrSshKeyName
```
public java.lang.String getAttrSshKeyName()
```
    The name of the SSH key pair used by the instance.
  - getAttrStateCode
```
public java.lang.Number getAttrStateCode()
```
    The status code of the instance.
  - getAttrStateName
```
public java.lang.String getAttrStateName()
```
    The state of the instance (for example, `running` or `pending` ).
  - getAttrSupportCode
```
public java.lang.String getAttrSupportCode()
```
    The support code of the instance.
    Include this code in your email to support when you have questions about an instance or another resource in Lightsail . This code helps our support team to look up your Lightsail information.
  - getAttrUserName
```
public java.lang.String getAttrUserName()
```
    The user name for connecting to the instance (for example, `ec2-user` ).
  - 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.
  - getBlueprintId
```
public java.lang.String getBlueprintId()
```
    The blueprint ID for the instance (for example, `os_amlinux_2016_03` ).
  - setBlueprintId
```
public void setBlueprintId(java.lang.String value)
```
    The blueprint ID for the instance (for example, `os_amlinux_2016_03` ).
  - getBundleId
```
public java.lang.String getBundleId()
```
    The bundle ID for the instance (for example, `micro_1_0` ).
  - setBundleId
```
public void setBundleId(java.lang.String value)
```
    The bundle ID for the instance (for example, `micro_1_0` ).
  - getInstanceName
```
public java.lang.String getInstanceName()
```
    The name of the instance.
  - setInstanceName
```
public void setInstanceName(java.lang.String value)
```
    The name of the instance.
  - getAddOns
```
public java.lang.Object getAddOns()
```
    An array of add-ons for the instance.
    
    If the instance has an add-on enabled when performing a delete instance request, the add-on is automatically disabled before the instance is deleted.
  - setAddOns
```
public void setAddOns(IResolvable value)
```
    An array of add-ons for the instance.
    
    If the instance has an add-on enabled when performing a delete instance request, the add-on is automatically disabled before the instance is deleted.
  - setAddOns
```
public void setAddOns(java.util.List<java.lang.Object> value)
```
    An array of add-ons for the instance.
    
    If the instance has an add-on enabled when performing a delete instance request, the add-on is automatically disabled before the instance is deleted.
  - getAvailabilityZone
```
public java.lang.String getAvailabilityZone()
```
    The Availability Zone for the instance.
  - setAvailabilityZone
```
public void setAvailabilityZone(java.lang.String value)
```
    The Availability Zone for the instance.
  - getHardware
```
public java.lang.Object getHardware()
```
    The hardware properties for the instance, such as the vCPU count, attached disks, and amount of RAM.
    
    The instance restarts when performing an attach disk or detach disk request. This resets the public IP address of your instance if a static IP isn't attached to it.
  - setHardware
```
public void setHardware(IResolvable value)
```
    The hardware properties for the instance, such as the vCPU count, attached disks, and amount of RAM.
    
    The instance restarts when performing an attach disk or detach disk request. This resets the public IP address of your instance if a static IP isn't attached to it.
  - setHardware
```
public void setHardware(CfnInstance.HardwareProperty value)
```
    The hardware properties for the instance, such as the vCPU count, attached disks, and amount of RAM.
    
    The instance restarts when performing an attach disk or detach disk request. This resets the public IP address of your instance if a static IP isn't attached to it.
  - getKeyPairName
```
public java.lang.String getKeyPairName()
```
    The name of the key pair to use for the instance.
    If no key pair name is specified, the Regional Lightsail default key pair is used.
  - setKeyPairName
```
public void setKeyPairName(java.lang.String value)
```
    The name of the key pair to use for the instance.
    If no key pair name is specified, the Regional Lightsail default key pair is used.
  - getLocation
```
public java.lang.Object getLocation()
```
    The location for the instance, such as the AWS Region and Availability Zone.
    
    The Location property is read-only and should not be specified in a create instance or update instance request.
  - setLocation
```
public void setLocation(IResolvable value)
```
    The location for the instance, such as the AWS Region and Availability Zone.
    
    The Location property is read-only and should not be specified in a create instance or update instance request.
  - setLocation
```
public void setLocation(CfnInstance.LocationProperty value)
```
    The location for the instance, such as the AWS Region and Availability Zone.
    
    The Location property is read-only and should not be specified in a create instance or update instance request.
  - getNetworking
```
public java.lang.Object getNetworking()
```
    The public ports and the monthly amount of data transfer allocated for the instance.
  - setNetworking
```
public void setNetworking(IResolvable value)
```
    The public ports and the monthly amount of data transfer allocated for the instance.
  - setNetworking
```
public void setNetworking(CfnInstance.NetworkingProperty value)
```
    The public ports and the monthly amount of data transfer allocated for the instance.
  - getState
```
public java.lang.Object getState()
```
    The status code and the state (for example, `running` ) of the instance.
    
    The State property is read-only and should not be specified in a create instance or update instance request.
  - setState
```
public void setState(IResolvable value)
```
    The status code and the state (for example, `running` ) of the instance.
    
    The State property is read-only and should not be specified in a create instance or update instance request.
  - setState
```
public void setState(CfnInstance.StateProperty value)
```
    The status code and the state (for example, `running` ) of the instance.
    
    The State property is read-only and should not be specified in a create instance or update instance request.
  - getUserData
```
public java.lang.String getUserData()
```
    The optional launch script for the instance.
    Specify a launch script to configure an instance with additional user data. For example, you might want to specify apt-get -y update as a launch script.
    
    Depending on the blueprint of your instance, the command to get software on your instance varies. Amazon Linux and CentOS use yum , Debian and Ubuntu use apt-get , and FreeBSD uses pkg .
  - setUserData
```
public void setUserData(java.lang.String value)
```
    The optional launch script for the instance.
    Specify a launch script to configure an instance with additional user data. For example, you might want to specify apt-get -y update as a launch script.
    
    Depending on the blueprint of your instance, the command to get software on your instance varies. Amazon Linux and CentOS use yum , Debian and Ubuntu use apt-get , and FreeBSD uses pkg .

Class CfnInstance

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnInstance

CfnInstance

CfnInstance

Method Detail

inspect

renderProperties

getAttrHardwareCpuCount

getAttrHardwareRamSizeInGb

getAttrInstanceArn

getAttrIsStaticIp

getAttrLocationAvailabilityZone

getAttrLocationRegionName

getAttrNetworkingMonthlyTransferGbPerMonthAllocated

getAttrPrivateIpAddress

getAttrPublicIpAddress

getAttrResourceType

getAttrSshKeyName

getAttrStateCode

getAttrStateName

getAttrSupportCode

getAttrUserName

getCfnProperties

getTags

getBlueprintId

setBlueprintId

getBundleId

setBundleId

getInstanceName

setInstanceName

getAddOns

setAddOns

setAddOns

getAvailabilityZone

setAvailabilityZone

getHardware

setHardware

setHardware

getKeyPairName

setKeyPairName

getLocation

setLocation

setLocation

getNetworking

setNetworking

setNetworking

getState

setState

setState

getUserData

setUserData