Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. lightsail
  5. getInstance

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.lightsail.getInstance

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Lightsail::Instance

    Using getInstance

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getInstance(args: GetInstanceArgs, opts?: InvokeOptions): Promise<GetInstanceResult>
function getInstanceOutput(args: GetInstanceOutputArgs, opts?: InvokeOptions): Output<GetInstanceResult>
    def get_instance(instance_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetInstanceResult
def get_instance_output(instance_name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetInstanceResult]
    func LookupInstance(ctx *Context, args *LookupInstanceArgs, opts ...InvokeOption) (*LookupInstanceResult, error)
func LookupInstanceOutput(ctx *Context, args *LookupInstanceOutputArgs, opts ...InvokeOption) LookupInstanceResultOutput

    > Note: This function is named LookupInstance in the Go SDK.

    public static class GetInstance 
{
    public static Task<GetInstanceResult> InvokeAsync(GetInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetInstanceResult> Invoke(GetInstanceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)
public static Output<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:lightsail:getInstance
  arguments:
    # arguments dictionary

    The following arguments are supported:

    InstanceName string
    The names to use for your new Lightsail instance.
    InstanceName string
    The names to use for your new Lightsail instance.
    instanceName String
    The names to use for your new Lightsail instance.
    instanceName string
    The names to use for your new Lightsail instance.
    instance_name str
    The names to use for your new Lightsail instance.
    instanceName String
    The names to use for your new Lightsail instance.

    getInstance Result

    The following output properties are available:

    AddOns List<Pulumi.AwsNative.Lightsail.Outputs.InstanceAddOn>
    An array of objects representing the add-ons to enable for the new instance.
    Hardware Pulumi.AwsNative.Lightsail.Outputs.InstanceHardware

    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.

    InstanceArn string
    The Amazon Resource Name (ARN) of the instance (for example, arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE ).
    Ipv6Addresses List<string>
    IPv6 addresses of the instance
    IsStaticIp bool
    Is the IP Address of the Instance is the static IP
    KeyPairName string
    The name of your key pair.
    Location Pulumi.AwsNative.Lightsail.Outputs.InstanceLocation

    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 Pulumi.AwsNative.Lightsail.Outputs.InstanceNetworking
    The public ports and the monthly amount of data transfer allocated for the instance.
    PrivateIpAddress string
    Private IP Address of the Instance
    PublicIpAddress string
    Public IP Address of the Instance
    ResourceType string
    Resource type of Lightsail instance.
    SshKeyName string
    SSH Key Name of the Lightsail instance.
    State Pulumi.AwsNative.Lightsail.Outputs.InstanceState

    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.

    SupportCode string
    Support code to help identify any issues
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this resource.
    UserName string
    Username of the Lightsail instance.
    AddOns []InstanceAddOn
    An array of objects representing the add-ons to enable for the new instance.
    Hardware InstanceHardware

    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.

    InstanceArn string
    The Amazon Resource Name (ARN) of the instance (for example, arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE ).
    Ipv6Addresses []string
    IPv6 addresses of the instance
    IsStaticIp bool
    Is the IP Address of the Instance is the static IP
    KeyPairName string
    The name of your key pair.
    Location InstanceLocation

    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 InstanceNetworking
    The public ports and the monthly amount of data transfer allocated for the instance.
    PrivateIpAddress string
    Private IP Address of the Instance
    PublicIpAddress string
    Public IP Address of the Instance
    ResourceType string
    Resource type of Lightsail instance.
    SshKeyName string
    SSH Key Name of the Lightsail instance.
    State InstanceStateType

    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.

    SupportCode string
    Support code to help identify any issues
    Tags Tag
    An array of key-value pairs to apply to this resource.
    UserName string
    Username of the Lightsail instance.
    addOns List<InstanceAddOn>
    An array of objects representing the add-ons to enable for the new instance.
    hardware InstanceHardware

    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.

    instanceArn String
    The Amazon Resource Name (ARN) of the instance (for example, arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE ).
    ipv6Addresses List<String>
    IPv6 addresses of the instance
    isStaticIp Boolean
    Is the IP Address of the Instance is the static IP
    keyPairName String
    The name of your key pair.
    location InstanceLocation

    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 InstanceNetworking
    The public ports and the monthly amount of data transfer allocated for the instance.
    privateIpAddress String
    Private IP Address of the Instance
    publicIpAddress String
    Public IP Address of the Instance
    resourceType String
    Resource type of Lightsail instance.
    sshKeyName String
    SSH Key Name of the Lightsail instance.
    state InstanceState

    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.

    supportCode String
    Support code to help identify any issues
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    userName String
    Username of the Lightsail instance.
    addOns InstanceAddOn[]
    An array of objects representing the add-ons to enable for the new instance.
    hardware InstanceHardware

    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.

    instanceArn string
    The Amazon Resource Name (ARN) of the instance (for example, arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE ).
    ipv6Addresses string[]
    IPv6 addresses of the instance
    isStaticIp boolean
    Is the IP Address of the Instance is the static IP
    keyPairName string
    The name of your key pair.
    location InstanceLocation

    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 InstanceNetworking
    The public ports and the monthly amount of data transfer allocated for the instance.
    privateIpAddress string
    Private IP Address of the Instance
    publicIpAddress string
    Public IP Address of the Instance
    resourceType string
    Resource type of Lightsail instance.
    sshKeyName string
    SSH Key Name of the Lightsail instance.
    state InstanceState

    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.

    supportCode string
    Support code to help identify any issues
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    userName string
    Username of the Lightsail instance.
    add_ons Sequence[InstanceAddOn]
    An array of objects representing the add-ons to enable for the new instance.
    hardware InstanceHardware

    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.

    instance_arn str
    The Amazon Resource Name (ARN) of the instance (for example, arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE ).
    ipv6_addresses Sequence[str]
    IPv6 addresses of the instance
    is_static_ip bool
    Is the IP Address of the Instance is the static IP
    key_pair_name str
    The name of your key pair.
    location InstanceLocation

    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 InstanceNetworking
    The public ports and the monthly amount of data transfer allocated for the instance.
    private_ip_address str
    Private IP Address of the Instance
    public_ip_address str
    Public IP Address of the Instance
    resource_type str
    Resource type of Lightsail instance.
    ssh_key_name str
    SSH Key Name of the Lightsail instance.
    state InstanceState

    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.

    support_code str
    Support code to help identify any issues
    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource.
    user_name str
    Username of the Lightsail instance.
    addOns List<Property Map>
    An array of objects representing the add-ons to enable for the new instance.
    hardware Property Map

    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.

    instanceArn String
    The Amazon Resource Name (ARN) of the instance (for example, arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE ).
    ipv6Addresses List<String>
    IPv6 addresses of the instance
    isStaticIp Boolean
    Is the IP Address of the Instance is the static IP
    keyPairName String
    The name of your key pair.
    location Property Map

    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 Property Map
    The public ports and the monthly amount of data transfer allocated for the instance.
    privateIpAddress String
    Private IP Address of the Instance
    publicIpAddress String
    Public IP Address of the Instance
    resourceType String
    Resource type of Lightsail instance.
    sshKeyName String
    SSH Key Name of the Lightsail instance.
    state Property Map

    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.

    supportCode String
    Support code to help identify any issues
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.
    userName String
    Username of the Lightsail instance.

    Supporting Types

    InstanceAddOn

    AddOnType string
    The add-on type
    AutoSnapshotAddOnRequest Pulumi.AwsNative.Lightsail.Inputs.InstanceAutoSnapshotAddOn
    The parameters for the automatic snapshot add-on, such as the daily time when an automatic snapshot will be created.
    Status Pulumi.AwsNative.Lightsail.InstanceAddOnStatus
    Status of the Addon
    AddOnType string
    The add-on type
    AutoSnapshotAddOnRequest InstanceAutoSnapshotAddOn
    The parameters for the automatic snapshot add-on, such as the daily time when an automatic snapshot will be created.
    Status InstanceAddOnStatus
    Status of the Addon
    addOnType String
    The add-on type
    autoSnapshotAddOnRequest InstanceAutoSnapshotAddOn
    The parameters for the automatic snapshot add-on, such as the daily time when an automatic snapshot will be created.
    status InstanceAddOnStatus
    Status of the Addon
    addOnType string
    The add-on type
    autoSnapshotAddOnRequest InstanceAutoSnapshotAddOn
    The parameters for the automatic snapshot add-on, such as the daily time when an automatic snapshot will be created.
    status InstanceAddOnStatus
    Status of the Addon
    add_on_type str
    The add-on type
    auto_snapshot_add_on_request InstanceAutoSnapshotAddOn
    The parameters for the automatic snapshot add-on, such as the daily time when an automatic snapshot will be created.
    status InstanceAddOnStatus
    Status of the Addon
    addOnType String
    The add-on type
    autoSnapshotAddOnRequest Property Map
    The parameters for the automatic snapshot add-on, such as the daily time when an automatic snapshot will be created.
    status "Enabling" | "Disabling" | "Enabled" | "Terminating" | "Terminated" | "Disabled" | "Failed"
    Status of the Addon

    InstanceAddOnStatus

    InstanceAutoSnapshotAddOn

    SnapshotTimeOfDay string
    The daily time when an automatic snapshot will be created.
    SnapshotTimeOfDay string
    The daily time when an automatic snapshot will be created.
    snapshotTimeOfDay String
    The daily time when an automatic snapshot will be created.
    snapshotTimeOfDay string
    The daily time when an automatic snapshot will be created.
    snapshot_time_of_day str
    The daily time when an automatic snapshot will be created.
    snapshotTimeOfDay String
    The daily time when an automatic snapshot will be created.

    InstanceDisk

    DiskName string
    The names to use for your new Lightsail disk.
    Path string
    Path of the disk attached to the instance.
    AttachedTo string
    Instance attached to the disk.
    AttachmentState string
    Attachment state of the disk.
    Iops int
    IOPS of disk.
    IsSystemDisk bool
    Is the Attached disk is the system disk of the Instance.
    SizeInGb string
    Size of the disk attached to the Instance.
    DiskName string
    The names to use for your new Lightsail disk.
    Path string
    Path of the disk attached to the instance.
    AttachedTo string
    Instance attached to the disk.
    AttachmentState string
    Attachment state of the disk.
    Iops int
    IOPS of disk.
    IsSystemDisk bool
    Is the Attached disk is the system disk of the Instance.
    SizeInGb string
    Size of the disk attached to the Instance.
    diskName String
    The names to use for your new Lightsail disk.
    path String
    Path of the disk attached to the instance.
    attachedTo String
    Instance attached to the disk.
    attachmentState String
    Attachment state of the disk.
    iops Integer
    IOPS of disk.
    isSystemDisk Boolean
    Is the Attached disk is the system disk of the Instance.
    sizeInGb String
    Size of the disk attached to the Instance.
    diskName string
    The names to use for your new Lightsail disk.
    path string
    Path of the disk attached to the instance.
    attachedTo string
    Instance attached to the disk.
    attachmentState string
    Attachment state of the disk.
    iops number
    IOPS of disk.
    isSystemDisk boolean
    Is the Attached disk is the system disk of the Instance.
    sizeInGb string
    Size of the disk attached to the Instance.
    disk_name str
    The names to use for your new Lightsail disk.
    path str
    Path of the disk attached to the instance.
    attached_to str
    Instance attached to the disk.
    attachment_state str
    Attachment state of the disk.
    iops int
    IOPS of disk.
    is_system_disk bool
    Is the Attached disk is the system disk of the Instance.
    size_in_gb str
    Size of the disk attached to the Instance.
    diskName String
    The names to use for your new Lightsail disk.
    path String
    Path of the disk attached to the instance.
    attachedTo String
    Instance attached to the disk.
    attachmentState String
    Attachment state of the disk.
    iops Number
    IOPS of disk.
    isSystemDisk Boolean
    Is the Attached disk is the system disk of the Instance.
    sizeInGb String
    Size of the disk attached to the Instance.

    InstanceHardware

    CpuCount int
    CPU count of the Instance.
    Disks List<Pulumi.AwsNative.Lightsail.Inputs.InstanceDisk>
    Disks attached to the Instance.
    RamSizeInGb int
    RAM Size of the Instance.
    CpuCount int
    CPU count of the Instance.
    Disks []InstanceDisk
    Disks attached to the Instance.
    RamSizeInGb int
    RAM Size of the Instance.
    cpuCount Integer
    CPU count of the Instance.
    disks List<InstanceDisk>
    Disks attached to the Instance.
    ramSizeInGb Integer
    RAM Size of the Instance.
    cpuCount number
    CPU count of the Instance.
    disks InstanceDisk[]
    Disks attached to the Instance.
    ramSizeInGb number
    RAM Size of the Instance.
    cpu_count int
    CPU count of the Instance.
    disks Sequence[InstanceDisk]
    Disks attached to the Instance.
    ram_size_in_gb int
    RAM Size of the Instance.
    cpuCount Number
    CPU count of the Instance.
    disks List<Property Map>
    Disks attached to the Instance.
    ramSizeInGb Number
    RAM Size of the Instance.

    InstanceLocation

    AvailabilityZone string
    The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request.
    RegionName string
    The Region Name in which to create your instance.
    AvailabilityZone string
    The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request.
    RegionName string
    The Region Name in which to create your instance.
    availabilityZone String
    The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request.
    regionName String
    The Region Name in which to create your instance.
    availabilityZone string
    The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request.
    regionName string
    The Region Name in which to create your instance.
    availability_zone str
    The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request.
    region_name str
    The Region Name in which to create your instance.
    availabilityZone String
    The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request.
    regionName String
    The Region Name in which to create your instance.

    InstanceMonthlyTransfer

    GbPerMonthAllocated string
    GbPerMonthAllocated of the Instance.
    GbPerMonthAllocated string
    GbPerMonthAllocated of the Instance.
    gbPerMonthAllocated String
    GbPerMonthAllocated of the Instance.
    gbPerMonthAllocated string
    GbPerMonthAllocated of the Instance.
    gb_per_month_allocated str
    GbPerMonthAllocated of the Instance.
    gbPerMonthAllocated String
    GbPerMonthAllocated of the Instance.

    InstanceNetworking

    Ports List<Pulumi.AwsNative.Lightsail.Inputs.InstancePort>
    Ports to the Instance.
    MonthlyTransfer Pulumi.AwsNative.Lightsail.Inputs.InstanceMonthlyTransfer
    The monthly amount of data transfer, in GB, allocated for the instance
    Ports []InstancePort
    Ports to the Instance.
    MonthlyTransfer InstanceMonthlyTransfer
    The monthly amount of data transfer, in GB, allocated for the instance
    ports List<InstancePort>
    Ports to the Instance.
    monthlyTransfer InstanceMonthlyTransfer
    The monthly amount of data transfer, in GB, allocated for the instance
    ports InstancePort[]
    Ports to the Instance.
    monthlyTransfer InstanceMonthlyTransfer
    The monthly amount of data transfer, in GB, allocated for the instance
    ports Sequence[InstancePort]
    Ports to the Instance.
    monthly_transfer InstanceMonthlyTransfer
    The monthly amount of data transfer, in GB, allocated for the instance
    ports List<Property Map>
    Ports to the Instance.
    monthlyTransfer Property Map
    The monthly amount of data transfer, in GB, allocated for the instance

    InstancePort

    AccessDirection string
    Access Direction for Protocol of the Instance(inbound/outbound).
    AccessFrom string
    Access From Protocol of the Instance.
    AccessType string
    Access Type Protocol of the Instance.
    CidrListAliases List<string>

    An alias that defines access for a preconfigured range of IP addresses.

    The only alias currently supported is lightsail-connect , which allows IP addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your instance.

    Cidrs List<string>

    The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol.

    The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to connect to an instance.

    Examples:

    • To allow the IP address 192.0.2.44 , specify 192.0.2.44 or 192.0.2.44/32 .
    • To allow the IP addresses 192.0.2.0 to 192.0.2.255 , specify 192.0.2.0/24 .
    CommonName string
    CommonName for Protocol of the Instance.
    FromPort int
    From Port of the Instance.
    Ipv6Cidrs List<string>

    The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol. Only devices with an IPv6 address can connect to an instance through IPv6; otherwise, IPv4 should be used.

    The cidrs parameter lists the IPv4 addresses that are allowed to connect to an instance.

    Protocol string
    Port Protocol of the Instance.
    ToPort int
    To Port of the Instance.
    AccessDirection string
    Access Direction for Protocol of the Instance(inbound/outbound).
    AccessFrom string
    Access From Protocol of the Instance.
    AccessType string
    Access Type Protocol of the Instance.
    CidrListAliases []string

    An alias that defines access for a preconfigured range of IP addresses.

    The only alias currently supported is lightsail-connect , which allows IP addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your instance.

    Cidrs []string

    The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol.

    The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to connect to an instance.

    Examples:

    • To allow the IP address 192.0.2.44 , specify 192.0.2.44 or 192.0.2.44/32 .
    • To allow the IP addresses 192.0.2.0 to 192.0.2.255 , specify 192.0.2.0/24 .
    CommonName string
    CommonName for Protocol of the Instance.
    FromPort int
    From Port of the Instance.
    Ipv6Cidrs []string

    The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol. Only devices with an IPv6 address can connect to an instance through IPv6; otherwise, IPv4 should be used.

    The cidrs parameter lists the IPv4 addresses that are allowed to connect to an instance.

    Protocol string
    Port Protocol of the Instance.
    ToPort int
    To Port of the Instance.
    accessDirection String
    Access Direction for Protocol of the Instance(inbound/outbound).
    accessFrom String
    Access From Protocol of the Instance.
    accessType String
    Access Type Protocol of the Instance.
    cidrListAliases List<String>

    An alias that defines access for a preconfigured range of IP addresses.

    The only alias currently supported is lightsail-connect , which allows IP addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your instance.

    cidrs List<String>

    The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol.

    The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to connect to an instance.

    Examples:

    • To allow the IP address 192.0.2.44 , specify 192.0.2.44 or 192.0.2.44/32 .
    • To allow the IP addresses 192.0.2.0 to 192.0.2.255 , specify 192.0.2.0/24 .
    commonName String
    CommonName for Protocol of the Instance.
    fromPort Integer
    From Port of the Instance.
    ipv6Cidrs List<String>

    The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol. Only devices with an IPv6 address can connect to an instance through IPv6; otherwise, IPv4 should be used.

    The cidrs parameter lists the IPv4 addresses that are allowed to connect to an instance.

    protocol String
    Port Protocol of the Instance.
    toPort Integer
    To Port of the Instance.
    accessDirection string
    Access Direction for Protocol of the Instance(inbound/outbound).
    accessFrom string
    Access From Protocol of the Instance.
    accessType string
    Access Type Protocol of the Instance.
    cidrListAliases string[]

    An alias that defines access for a preconfigured range of IP addresses.

    The only alias currently supported is lightsail-connect , which allows IP addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your instance.

    cidrs string[]

    The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol.

    The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to connect to an instance.

    Examples:

    • To allow the IP address 192.0.2.44 , specify 192.0.2.44 or 192.0.2.44/32 .
    • To allow the IP addresses 192.0.2.0 to 192.0.2.255 , specify 192.0.2.0/24 .
    commonName string
    CommonName for Protocol of the Instance.
    fromPort number
    From Port of the Instance.
    ipv6Cidrs string[]

    The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol. Only devices with an IPv6 address can connect to an instance through IPv6; otherwise, IPv4 should be used.

    The cidrs parameter lists the IPv4 addresses that are allowed to connect to an instance.

    protocol string
    Port Protocol of the Instance.
    toPort number
    To Port of the Instance.
    access_direction str
    Access Direction for Protocol of the Instance(inbound/outbound).
    access_from str
    Access From Protocol of the Instance.
    access_type str
    Access Type Protocol of the Instance.
    cidr_list_aliases Sequence[str]

    An alias that defines access for a preconfigured range of IP addresses.

    The only alias currently supported is lightsail-connect , which allows IP addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your instance.

    cidrs Sequence[str]

    The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol.

    The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to connect to an instance.

    Examples:

    • To allow the IP address 192.0.2.44 , specify 192.0.2.44 or 192.0.2.44/32 .
    • To allow the IP addresses 192.0.2.0 to 192.0.2.255 , specify 192.0.2.0/24 .
    common_name str
    CommonName for Protocol of the Instance.
    from_port int
    From Port of the Instance.
    ipv6_cidrs Sequence[str]

    The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol. Only devices with an IPv6 address can connect to an instance through IPv6; otherwise, IPv4 should be used.

    The cidrs parameter lists the IPv4 addresses that are allowed to connect to an instance.

    protocol str
    Port Protocol of the Instance.
    to_port int
    To Port of the Instance.
    accessDirection String
    Access Direction for Protocol of the Instance(inbound/outbound).
    accessFrom String
    Access From Protocol of the Instance.
    accessType String
    Access Type Protocol of the Instance.
    cidrListAliases List<String>

    An alias that defines access for a preconfigured range of IP addresses.

    The only alias currently supported is lightsail-connect , which allows IP addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your instance.

    cidrs List<String>

    The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol.

    The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to connect to an instance.

    Examples:

    • To allow the IP address 192.0.2.44 , specify 192.0.2.44 or 192.0.2.44/32 .
    • To allow the IP addresses 192.0.2.0 to 192.0.2.255 , specify 192.0.2.0/24 .
    commonName String
    CommonName for Protocol of the Instance.
    fromPort Number
    From Port of the Instance.
    ipv6Cidrs List<String>

    The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol. Only devices with an IPv6 address can connect to an instance through IPv6; otherwise, IPv4 should be used.

    The cidrs parameter lists the IPv4 addresses that are allowed to connect to an instance.

    protocol String
    Port Protocol of the Instance.
    toPort Number
    To Port of the Instance.

    InstanceState

    Code int
    Status code of the Instance.
    Name string
    Status code of the Instance.
    Code int
    Status code of the Instance.
    Name string
    Status code of the Instance.
    code Integer
    Status code of the Instance.
    name String
    Status code of the Instance.
    code number
    Status code of the Instance.
    name string
    Status code of the Instance.
    code int
    Status code of the Instance.
    name str
    Status code of the Instance.
    code Number
    Status code of the Instance.
    name String
    Status code of the Instance.

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native