aws-cdk-lib.aws_lightsail.CfnInstance

class CfnInstance (construct)

LanguageType name
.NETAmazon.CDK.AWS.Lightsail.CfnInstance
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awslightsail#CfnInstance
Javasoftware.amazon.awscdk.services.lightsail.CfnInstance
Pythonaws_cdk.aws_lightsail.CfnInstance
TypeScript aws-cdk-lib » aws_lightsail » CfnInstance

Implements IConstruct, IDependable, 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 { aws_lightsail as lightsail } from 'aws-cdk-lib';
const cfnInstance = new lightsail.CfnInstance(this, 'MyCfnInstance', {
  blueprintId: 'blueprintId',
  bundleId: 'bundleId',
  instanceName: 'instanceName',

  // the properties below are optional
  addOns: [{
    addOnType: 'addOnType',

    // the properties below are optional
    autoSnapshotAddOnRequest: {
      snapshotTimeOfDay: 'snapshotTimeOfDay',
    },
    status: 'status',
  }],
  availabilityZone: 'availabilityZone',
  hardware: {
    cpuCount: 123,
    disks: [{
      diskName: 'diskName',
      path: 'path',

      // the properties below are optional
      attachedTo: 'attachedTo',
      attachmentState: 'attachmentState',
      iops: 123,
      isSystemDisk: false,
      sizeInGb: 'sizeInGb',
    }],
    ramSizeInGb: 123,
  },
  keyPairName: 'keyPairName',
  location: {
    availabilityZone: 'availabilityZone',
    regionName: 'regionName',
  },
  networking: {
    ports: [{
      accessDirection: 'accessDirection',
      accessFrom: 'accessFrom',
      accessType: 'accessType',
      cidrListAliases: ['cidrListAliases'],
      cidrs: ['cidrs'],
      commonName: 'commonName',
      fromPort: 123,
      ipv6Cidrs: ['ipv6Cidrs'],
      protocol: 'protocol',
      toPort: 123,
    }],

    // the properties below are optional
    monthlyTransfer: 123,
  },
  state: {
    code: 123,
    name: 'name',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  userData: 'userData',
});

Initializer

new CfnInstance(scope: Construct, id: string, props: CfnInstanceProps)

Parameters

  • scope Construct — - scope in which this resource is defined.
  • id string — - scoped id of the resource.
  • props CfnInstanceProps — - resource properties.

Create a new AWS::Lightsail::Instance.

Construct Props

NameTypeDescription
blueprintIdstringThe blueprint ID for the instance (for example, os_amlinux_2016_03 ).
bundleIdstringThe bundle ID for the instance (for example, micro_1_0 ).
instanceNamestringThe name of the instance.
addOns?IResolvable | IResolvable | AddOnProperty[]An array of add-ons for the instance.
availabilityZone?stringThe Availability Zone for the instance.
hardware?IResolvable | HardwarePropertyThe hardware properties for the instance, such as the vCPU count, attached disks, and amount of RAM.
keyPairName?stringThe name of the key pair to use for the instance.
location?IResolvable | LocationPropertyThe location for the instance, such as the AWS Region and Availability Zone.
networking?IResolvable | NetworkingPropertyThe public ports and the monthly amount of data transfer allocated for the instance.
state?IResolvable | StatePropertyThe status code and the state (for example, running ) of the instance.
tags?CfnTag[]An array of key-value pairs to apply to this resource.
userData?stringThe optional launch script for the instance.

blueprintId

Type: string

The blueprint ID for the instance (for example, os_amlinux_2016_03 ).


bundleId

Type: string

The bundle ID for the instance (for example, micro_1_0 ).


instanceName

Type: string

The name of the instance.


addOns?

Type: IResolvable | IResolvable | AddOnProperty[] (optional)

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.


availabilityZone?

Type: string (optional)

The Availability Zone for the instance.


hardware?

Type: IResolvable | HardwareProperty (optional)

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.


keyPairName?

Type: string (optional)

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.


location?

Type: IResolvable | LocationProperty (optional)

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.


networking?

Type: IResolvable | NetworkingProperty (optional)

The public ports and the monthly amount of data transfer allocated for the instance.


state?

Type: IResolvable | StateProperty (optional)

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.


tags?

Type: CfnTag[] (optional)

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.


userData?

Type: string (optional)

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 .

Properties

NameTypeDescription
attrHardwareCpuCountnumberThe number of vCPUs the instance has.
attrHardwareRamSizeInGbnumberThe amount of RAM in GB on the instance (for example, 1.0 ).
attrInstanceArnstringThe Amazon Resource Name (ARN) of the instance (for example, arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE ).
attrIsStaticIpIResolvableA Boolean value indicating whether the instance has a static IP assigned to it.
attrLocationAvailabilityZonestringThe AWS Region and Availability Zone where the instance is located.
attrLocationRegionNamestringThe AWS Region of the instance.
attrNetworkingMonthlyTransferGbPerMonthAllocatedstringThe amount of allocated monthly data transfer (in GB) for an instance.
attrPrivateIpAddressstringThe private IP address of the instance.
attrPublicIpAddressstringThe public IP address of the instance.
attrResourceTypestringThe resource type of the instance (for example, Instance ).
attrSshKeyNamestringThe name of the SSH key pair used by the instance.
attrStateCodenumberThe status code of the instance.
attrStateNamestringThe state of the instance (for example, running or pending ).
attrSupportCodestringThe support code of the instance.
attrUserNamestringThe user name for connecting to the instance (for example, ec2-user ).
blueprintIdstringThe blueprint ID for the instance (for example, os_amlinux_2016_03 ).
bundleIdstringThe bundle ID for the instance (for example, micro_1_0 ).
cfnOptionsICfnResourceOptionsOptions for this resource, such as condition, update policy etc.
cfnProperties{ [string]: any }
cfnResourceTypestringAWS resource type.
creationStackstring[]
instanceNamestringThe name of the instance.
logicalIdstringThe logical ID for this CloudFormation stack element.
nodeNodeThe tree node.
refstringReturn a string that will be resolved to a CloudFormation { Ref } for this element.
stackStackThe stack in which this element is defined.
tagsTagManagerAn array of key-value pairs to apply to this resource.
addOns?IResolvable | IResolvable | AddOnProperty[]An array of add-ons for the instance.
availabilityZone?stringThe Availability Zone for the instance.
hardware?IResolvable | HardwarePropertyThe hardware properties for the instance, such as the vCPU count, attached disks, and amount of RAM.
keyPairName?stringThe name of the key pair to use for the instance.
location?IResolvable | LocationPropertyThe location for the instance, such as the AWS Region and Availability Zone.
networking?IResolvable | NetworkingPropertyThe public ports and the monthly amount of data transfer allocated for the instance.
state?IResolvable | StatePropertyThe status code and the state (for example, running ) of the instance.
userData?stringThe optional launch script for the instance.
static CFN_RESOURCE_TYPE_NAMEstringThe CloudFormation resource type name for this resource class.

attrHardwareCpuCount

Type: number

The number of vCPUs the instance has.


attrHardwareRamSizeInGb

Type: number

The amount of RAM in GB on the instance (for example, 1.0 ).


attrInstanceArn

Type: string

The Amazon Resource Name (ARN) of the instance (for example, arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE ).


attrIsStaticIp

Type: IResolvable

A Boolean value indicating whether the instance has a static IP assigned to it.


attrLocationAvailabilityZone

Type: string

The AWS Region and Availability Zone where the instance is located.


attrLocationRegionName

Type: string

The AWS Region of the instance.


attrNetworkingMonthlyTransferGbPerMonthAllocated

Type: string

The amount of allocated monthly data transfer (in GB) for an instance.


attrPrivateIpAddress

Type: string

The private IP address of the instance.


attrPublicIpAddress

Type: string

The public IP address of the instance.


attrResourceType

Type: string

The resource type of the instance (for example, Instance ).


attrSshKeyName

Type: string

The name of the SSH key pair used by the instance.


attrStateCode

Type: number

The status code of the instance.


attrStateName

Type: string

The state of the instance (for example, running or pending ).


attrSupportCode

Type: string

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.


attrUserName

Type: string

The user name for connecting to the instance (for example, ec2-user ).


blueprintId

Type: string

The blueprint ID for the instance (for example, os_amlinux_2016_03 ).


bundleId

Type: string

The bundle ID for the instance (for example, micro_1_0 ).


cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.


cfnProperties

Type: { [string]: any }


cfnResourceType

Type: string

AWS resource type.


creationStack

Type: string[]


instanceName

Type: string

The name of the instance.


logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).


node

Type: Node

The tree node.


ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).


stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).


tags

Type: TagManager

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.


addOns?

Type: IResolvable | IResolvable | AddOnProperty[] (optional)

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.


availabilityZone?

Type: string (optional)

The Availability Zone for the instance.


hardware?

Type: IResolvable | HardwareProperty (optional)

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.


keyPairName?

Type: string (optional)

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.


location?

Type: IResolvable | LocationProperty (optional)

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.


networking?

Type: IResolvable | NetworkingProperty (optional)

The public ports and the monthly amount of data transfer allocated for the instance.


state?

Type: IResolvable | StateProperty (optional)

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.


userData?

Type: string (optional)

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 .


static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

NameDescription
addDeletionOverride(path)Syntactic sugar for addOverride(path, undefined).
addDependency(target)Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)Returns a token for an runtime attribute of this resource.
getMetadata(key)Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)Examines the CloudFormation resource and discloses attributes.
obtainDependencies()Retrieves an array of resources this resource depends on.
obtainResourceDependencies()Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)Replaces one dependency with another.
toString()Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

  • path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).


addDependency(target)

public addDependency(target: CfnResource): void

Parameters

  • target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.


addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

  • target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.


addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

  • key string
  • value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)


addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

  • path string — - The path of the property, you can use dot notation to override values in complex types.
  • value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.


addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

  • propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.


addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

  • propertyPath string — The path of the property.
  • value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).


applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

  • policy RemovalPolicy
  • options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options


getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

  • attributeName string — The name of the attribute.
  • typeHint ResolutionTypeHint

Returns

  • Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.


getMetadata(key)

public getMetadata(key: string): any

Parameters

  • key string

Returns

  • any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)


inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

  • inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.


obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

  • Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.


obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

  • CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.


overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

  • newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.


removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

  • target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.


replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

  • target CfnResource — The dependency to replace.
  • newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.


toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.


protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

  • props { [string]: any }

Returns

  • { [string]: any }