Package software.amazon.awscdk.mixins.preview.services.lightsail.mixins

Interface CfnInstanceMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnInstanceMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:27.932Z")
@Stability(Stable)
public interface CfnInstanceMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnInstancePropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.mixins.preview.services.lightsail.mixins.*;
 CfnInstanceMixinProps cfnInstanceMixinProps = CfnInstanceMixinProps.builder()
         .addOns(List.of(AddOnProperty.builder()
                 .addOnType("addOnType")
                 .autoSnapshotAddOnRequest(AutoSnapshotAddOnProperty.builder()
                         .snapshotTimeOfDay("snapshotTimeOfDay")
                         .build())
                 .status("status")
                 .build()))
         .availabilityZone("availabilityZone")
         .blueprintId("blueprintId")
         .bundleId("bundleId")
         .hardware(HardwareProperty.builder()
                 .cpuCount(123)
                 .disks(List.of(DiskProperty.builder()
                         .attachedTo("attachedTo")
                         .attachmentState("attachmentState")
                         .diskName("diskName")
                         .iops(123)
                         .isSystemDisk(false)
                         .path("path")
                         .sizeInGb("sizeInGb")
                         .build()))
                 .ramSizeInGb(123)
                 .build())
         .instanceName("instanceName")
         .keyPairName("keyPairName")
         .location(LocationProperty.builder()
                 .availabilityZone("availabilityZone")
                 .regionName("regionName")
                 .build())
         .networking(NetworkingProperty.builder()
                 .monthlyTransfer(MonthlyTransferProperty.builder()
                         .gbPerMonthAllocated("gbPerMonthAllocated")
                         .build())
                 .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()))
                 .build())
         .state(StateProperty.builder()
                 .code(123)
                 .name("name")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .userData("userData")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnInstanceMixinProps.Builder	builder()
default Object	getAddOns()	An array of add-ons for the instance.
default String	getAvailabilityZone()	The Availability Zone for the instance.
default String	getBlueprintId()	The blueprint ID for the instance (for example, os_amlinux_2016_03 ).
default String	getBundleId()	The bundle ID for the instance (for example, micro_1_0 ).
default Object	getHardware()	The hardware properties for the instance, such as the vCPU count, attached disks, and amount of RAM.
default String	getInstanceName()	The name of the instance.
default String	getKeyPairName()	The name of the key pair to use for the instance.
default Object	getLocation()	The location for the instance, such as the AWS Region and Availability Zone.
default Object	getNetworking()	The public ports and the monthly amount of data transfer allocated for the instance.
default Object	getState()	The status code and the state (for example, running ) of the instance.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.
default String	getUserData()	The optional launch script for the instance.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAddOns

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnInstancePropsMixin.AddOnProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-addons

getAvailabilityZone

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

The Availability Zone for the instance.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-availabilityzone

getBlueprintId

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-blueprintid

getBundleId

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-bundleid

getHardware

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

Returns union: either IResolvable or CfnInstancePropsMixin.HardwareProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-hardware

getInstanceName

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

The name of the instance.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-instancename

getKeyPairName

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-keypairname

getLocation

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

Returns union: either IResolvable or CfnInstancePropsMixin.LocationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-location

getNetworking

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

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

Returns union: either IResolvable or CfnInstancePropsMixin.NetworkingProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-networking

getState

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

Returns union: either IResolvable or CfnInstancePropsMixin.StateProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-state

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-tags

getUserData

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-userdata

builder

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

Returns:

a CfnInstanceMixinProps.Builder of CfnInstanceMixinProps