AWS Native v0.49.0, Jan 26 23

aws-native.lightsail.getInstance

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)
// Output-based functions aren't available in Java yet

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
InstanceArn string
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
Networking Pulumi.AwsNative.Lightsail.Outputs.InstanceNetworking
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
SupportCode string: Support code to help identify any issues
Tags List<Pulumi.AwsNative.Lightsail.Outputs.InstanceTag>: An array of key-value pairs to apply to this resource.
UserData string: A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update.
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
InstanceArn string
IsStaticIp bool: Is the IP Address of the Instance is the static IP
KeyPairName string: The name of your key pair.
Location InstanceLocation
Networking InstanceNetworking
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
SupportCode string: Support code to help identify any issues
Tags []InstanceTag: An array of key-value pairs to apply to this resource.
UserData string: A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update.
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
instanceArn String
isStaticIp Boolean: Is the IP Address of the Instance is the static IP
keyPairName String: The name of your key pair.
location InstanceLocation
networking InstanceNetworking
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
supportCode String: Support code to help identify any issues
tags List<InstanceTag>: An array of key-value pairs to apply to this resource.
userData String: A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update.
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
instanceArn string
isStaticIp boolean: Is the IP Address of the Instance is the static IP
keyPairName string: The name of your key pair.
location InstanceLocation
networking InstanceNetworking
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
supportCode string: Support code to help identify any issues
tags InstanceTag[]: An array of key-value pairs to apply to this resource.
userData string: A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update.
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
instance_arn str
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
networking InstanceNetworking
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
support_code str: Support code to help identify any issues
tags Sequence[InstanceTag]: An array of key-value pairs to apply to this resource.
user_data str: A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update.
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
instanceArn String
isStaticIp Boolean: Is the IP Address of the Instance is the static IP
keyPairName String: The name of your key pair.
location Property Map
networking Property Map
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
supportCode String: Support code to help identify any issues
tags List<Property Map>: An array of key-value pairs to apply to this resource.
userData String: A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update.
userName String: Username of the Lightsail instance.

Supporting Types

InstanceAddOn

AddOnType string: The add-on type
AutoSnapshotAddOnRequest Pulumi.AwsNative.Lightsail.Inputs.InstanceAutoSnapshotAddOn
Status Pulumi.AwsNative.Lightsail.InstanceAddOnStatus: Status of the Addon

AddOnType string: The add-on type
AutoSnapshotAddOnRequest InstanceAutoSnapshotAddOn
Status InstanceAddOnStatus: Status of the Addon

addOnType String: The add-on type
autoSnapshotAddOnRequest InstanceAutoSnapshotAddOn
status InstanceAddOnStatus: Status of the Addon

addOnType string: The add-on type
autoSnapshotAddOnRequest InstanceAutoSnapshotAddOn
status InstanceAddOnStatus: Status of the Addon

add_on_type str: The add-on type
auto_snapshot_add_on_request InstanceAutoSnapshotAddOn
status InstanceAddOnStatus: Status of the Addon

addOnType String: The add-on type
autoSnapshotAddOnRequest Property Map
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.
i_ops 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

Ports []InstancePort: Ports to the Instance.
MonthlyTransfer InstanceMonthlyTransfer

ports List<InstancePort>: Ports to the Instance.
monthlyTransfer InstanceMonthlyTransfer

ports InstancePort[]: Ports to the Instance.
monthlyTransfer InstanceMonthlyTransfer

ports Sequence[InstancePort]: Ports to the Instance.
monthly_transfer InstanceMonthlyTransfer

ports List<Property Map>: Ports to the Instance.
monthlyTransfer Property Map

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>
Cidrs List<string>
CommonName string: CommonName for Protocol of the Instance.
FromPort int: From Port of the Instance.
Ipv6Cidrs List<string>
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
Cidrs []string
CommonName string: CommonName for Protocol of the Instance.
FromPort int: From Port of the Instance.
Ipv6Cidrs []string
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>
cidrs List<String>
commonName String: CommonName for Protocol of the Instance.
fromPort Integer: From Port of the Instance.
ipv6Cidrs List<String>
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[]
cidrs string[]
commonName string: CommonName for Protocol of the Instance.
fromPort number: From Port of the Instance.
ipv6Cidrs string[]
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]
cidrs Sequence[str]
common_name str: CommonName for Protocol of the Instance.
from_port int: From Port of the Instance.
ipv6_cidrs Sequence[str]
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>
cidrs List<String>
commonName String: CommonName for Protocol of the Instance.
fromPort Number: From Port of the Instance.
ipv6Cidrs List<String>
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.

InstanceTag

Key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Value string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Value string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value String: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key str: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value str: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value String: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Package Details

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