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:
- Instance
Name string The names to use for your new Lightsail instance.
- Instance
Name string The names to use for your new Lightsail instance.
- instance
Name String The names to use for your new Lightsail instance.
- instance
Name string The names to use for your new Lightsail instance.
- instance_
name str The names to use for your new Lightsail instance.
- instance
Name String The names to use for your new Lightsail instance.
getInstance Result
The following output properties are available:
- Add
Ons List<Pulumi.Aws Native. Lightsail. Outputs. Instance Add On> An array of objects representing the add-ons to enable for the new instance.
- Hardware
Pulumi.
Aws Native. Lightsail. Outputs. Instance Hardware - Instance
Arn string - Is
Static boolIp Is the IP Address of the Instance is the static IP
- Key
Pair stringName The name of your key pair.
- Location
Pulumi.
Aws Native. Lightsail. Outputs. Instance Location - Networking
Pulumi.
Aws Native. Lightsail. Outputs. Instance Networking - Private
Ip stringAddress Private IP Address of the Instance
- Public
Ip stringAddress Public IP Address of the Instance
- Resource
Type string Resource type of Lightsail instance.
- Ssh
Key stringName SSH Key Name of the Lightsail instance.
- State
Pulumi.
Aws Native. Lightsail. Outputs. Instance State - Support
Code string Support code to help identify any issues
- List<Pulumi.
Aws Native. Lightsail. Outputs. Instance Tag> An array of key-value pairs to apply to this resource.
- User
Data 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.
- User
Name string Username of the Lightsail instance.
- Add
Ons []InstanceAdd On An array of objects representing the add-ons to enable for the new instance.
- Hardware
Instance
Hardware - Instance
Arn string - Is
Static boolIp Is the IP Address of the Instance is the static IP
- Key
Pair stringName The name of your key pair.
- Location
Instance
Location - Networking
Instance
Networking - Private
Ip stringAddress Private IP Address of the Instance
- Public
Ip stringAddress Public IP Address of the Instance
- Resource
Type string Resource type of Lightsail instance.
- Ssh
Key stringName SSH Key Name of the Lightsail instance.
- State
Instance
State Type - Support
Code string Support code to help identify any issues
- []Instance
Tag An array of key-value pairs to apply to this resource.
- User
Data 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.
- User
Name string Username of the Lightsail instance.
- add
Ons List<InstanceAdd On> An array of objects representing the add-ons to enable for the new instance.
- hardware
Instance
Hardware - instance
Arn String - is
Static BooleanIp Is the IP Address of the Instance is the static IP
- key
Pair StringName The name of your key pair.
- location
Instance
Location - networking
Instance
Networking - private
Ip StringAddress Private IP Address of the Instance
- public
Ip StringAddress Public IP Address of the Instance
- resource
Type String Resource type of Lightsail instance.
- ssh
Key StringName SSH Key Name of the Lightsail instance.
- state
Instance
State - support
Code String Support code to help identify any issues
- List<Instance
Tag> An array of key-value pairs to apply to this resource.
- user
Data 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.
- user
Name String Username of the Lightsail instance.
- add
Ons InstanceAdd On[] An array of objects representing the add-ons to enable for the new instance.
- hardware
Instance
Hardware - instance
Arn string - is
Static booleanIp Is the IP Address of the Instance is the static IP
- key
Pair stringName The name of your key pair.
- location
Instance
Location - networking
Instance
Networking - private
Ip stringAddress Private IP Address of the Instance
- public
Ip stringAddress Public IP Address of the Instance
- resource
Type string Resource type of Lightsail instance.
- ssh
Key stringName SSH Key Name of the Lightsail instance.
- state
Instance
State - support
Code string Support code to help identify any issues
- Instance
Tag[] An array of key-value pairs to apply to this resource.
- user
Data 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.
- user
Name string Username of the Lightsail instance.
- add_
ons Sequence[InstanceAdd On] An array of objects representing the add-ons to enable for the new instance.
- hardware
Instance
Hardware - instance_
arn str - is_
static_ boolip Is the IP Address of the Instance is the static IP
- key_
pair_ strname The name of your key pair.
- location
Instance
Location - networking
Instance
Networking - private_
ip_ straddress Private IP Address of the Instance
- public_
ip_ straddress Public IP Address of the Instance
- resource_
type str Resource type of Lightsail instance.
- ssh_
key_ strname SSH Key Name of the Lightsail instance.
- state
Instance
State - support_
code str Support code to help identify any issues
- Sequence[Instance
Tag] 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.
- add
Ons List<Property Map> An array of objects representing the add-ons to enable for the new instance.
- hardware Property Map
- instance
Arn String - is
Static BooleanIp Is the IP Address of the Instance is the static IP
- key
Pair StringName The name of your key pair.
- location Property Map
- networking Property Map
- private
Ip StringAddress Private IP Address of the Instance
- public
Ip StringAddress Public IP Address of the Instance
- resource
Type String Resource type of Lightsail instance.
- ssh
Key StringName SSH Key Name of the Lightsail instance.
- state Property Map
- support
Code String Support code to help identify any issues
- List<Property Map>
An array of key-value pairs to apply to this resource.
- user
Data 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.
- user
Name String Username of the Lightsail instance.
Supporting Types
InstanceAddOn
- Add
On stringType The add-on type
- Auto
Snapshot Pulumi.Add On Request Aws Native. Lightsail. Inputs. Instance Auto Snapshot Add On - Status
Pulumi.
Aws Native. Lightsail. Instance Add On Status Status of the Addon
- Add
On stringType The add-on type
- Auto
Snapshot InstanceAdd On Request Auto Snapshot Add On - Status
Instance
Add On Status Status of the Addon
- add
On StringType The add-on type
- auto
Snapshot InstanceAdd On Request Auto Snapshot Add On - status
Instance
Add On Status Status of the Addon
- add
On stringType The add-on type
- auto
Snapshot InstanceAdd On Request Auto Snapshot Add On - status
Instance
Add On Status Status of the Addon
- add_
on_ strtype The add-on type
- auto_
snapshot_ Instanceadd_ on_ request Auto Snapshot Add On - status
Instance
Add On Status Status of the Addon
- add
On StringType The add-on type
- auto
Snapshot Property MapAdd On Request - status "Enabling" | "Disabling" | "Enabled" | "Terminating" | "Terminated" | "Disabled" | "Failed"
Status of the Addon
InstanceAddOnStatus
InstanceAutoSnapshotAddOn
- Snapshot
Time stringOf Day The daily time when an automatic snapshot will be created.
- Snapshot
Time stringOf Day The daily time when an automatic snapshot will be created.
- snapshot
Time StringOf Day The daily time when an automatic snapshot will be created.
- snapshot
Time stringOf Day The daily time when an automatic snapshot will be created.
- snapshot_
time_ strof_ day The daily time when an automatic snapshot will be created.
- snapshot
Time StringOf Day The daily time when an automatic snapshot will be created.
InstanceDisk
- Disk
Name string The names to use for your new Lightsail disk.
- Path string
Path of the disk attached to the instance.
- Attached
To string Instance attached to the disk.
- Attachment
State string Attachment state of the disk.
- IOPS int
IOPS of disk.
- Is
System boolDisk Is the Attached disk is the system disk of the Instance.
- Size
In stringGb Size of the disk attached to the Instance.
- Disk
Name string The names to use for your new Lightsail disk.
- Path string
Path of the disk attached to the instance.
- Attached
To string Instance attached to the disk.
- Attachment
State string Attachment state of the disk.
- IOPS int
IOPS of disk.
- Is
System boolDisk Is the Attached disk is the system disk of the Instance.
- Size
In stringGb Size of the disk attached to the Instance.
- disk
Name String The names to use for your new Lightsail disk.
- path String
Path of the disk attached to the instance.
- attached
To String Instance attached to the disk.
- attachment
State String Attachment state of the disk.
- i
OPS Integer IOPS of disk.
- is
System BooleanDisk Is the Attached disk is the system disk of the Instance.
- size
In StringGb Size of the disk attached to the Instance.
- disk
Name string The names to use for your new Lightsail disk.
- path string
Path of the disk attached to the instance.
- attached
To string Instance attached to the disk.
- attachment
State string Attachment state of the disk.
- i
OPS number IOPS of disk.
- is
System booleanDisk Is the Attached disk is the system disk of the Instance.
- size
In stringGb 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_ booldisk Is the Attached disk is the system disk of the Instance.
- size_
in_ strgb Size of the disk attached to the Instance.
- disk
Name String The names to use for your new Lightsail disk.
- path String
Path of the disk attached to the instance.
- attached
To String Instance attached to the disk.
- attachment
State String Attachment state of the disk.
- i
OPS Number IOPS of disk.
- is
System BooleanDisk Is the Attached disk is the system disk of the Instance.
- size
In StringGb Size of the disk attached to the Instance.
InstanceHardware
- Cpu
Count int CPU count of the Instance.
- Disks
List<Pulumi.
Aws Native. Lightsail. Inputs. Instance Disk> Disks attached to the Instance.
- Ram
Size intIn Gb RAM Size of the Instance.
- Cpu
Count int CPU count of the Instance.
- Disks
[]Instance
Disk Disks attached to the Instance.
- Ram
Size intIn Gb RAM Size of the Instance.
- cpu
Count Integer CPU count of the Instance.
- disks
List<Instance
Disk> Disks attached to the Instance.
- ram
Size IntegerIn Gb RAM Size of the Instance.
- cpu
Count number CPU count of the Instance.
- disks
Instance
Disk[] Disks attached to the Instance.
- ram
Size numberIn Gb RAM Size of the Instance.
- cpu_
count int CPU count of the Instance.
- disks
Sequence[Instance
Disk] Disks attached to the Instance.
- ram_
size_ intin_ gb RAM Size of the Instance.
- cpu
Count Number CPU count of the Instance.
- disks List<Property Map>
Disks attached to the Instance.
- ram
Size NumberIn Gb RAM Size of the Instance.
InstanceLocation
- Availability
Zone 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.
- Region
Name string The Region Name in which to create your instance.
- Availability
Zone 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.
- Region
Name string The Region Name in which to create your instance.
- availability
Zone 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.
- region
Name String The Region Name in which to create your instance.
- availability
Zone 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.
- region
Name 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.
- availability
Zone 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.
- region
Name String The Region Name in which to create your instance.
InstanceMonthlyTransfer
- Gb
Per stringMonth Allocated GbPerMonthAllocated of the Instance.
- Gb
Per stringMonth Allocated GbPerMonthAllocated of the Instance.
- gb
Per StringMonth Allocated GbPerMonthAllocated of the Instance.
- gb
Per stringMonth Allocated GbPerMonthAllocated of the Instance.
- gb_
per_ strmonth_ allocated GbPerMonthAllocated of the Instance.
- gb
Per StringMonth Allocated GbPerMonthAllocated of the Instance.
InstanceNetworking
- Ports
[]Instance
Port Ports to the Instance.
- Monthly
Transfer InstanceMonthly Transfer
- ports
List<Instance
Port> Ports to the Instance.
- monthly
Transfer InstanceMonthly Transfer
- ports
Instance
Port[] Ports to the Instance.
- monthly
Transfer InstanceMonthly Transfer
- ports
Sequence[Instance
Port] Ports to the Instance.
- monthly_
transfer InstanceMonthly Transfer
- ports List<Property Map>
Ports to the Instance.
- monthly
Transfer Property Map
InstancePort
- Access
Direction string Access Direction for Protocol of the Instance(inbound/outbound).
- Access
From string Access From Protocol of the Instance.
- Access
Type string Access Type Protocol of the Instance.
- Cidr
List List<string>Aliases - Cidrs List<string>
- Common
Name string CommonName for Protocol of the Instance.
- From
Port int From Port of the Instance.
- Ipv6Cidrs List<string>
- Protocol string
Port Protocol of the Instance.
- To
Port int To Port of the Instance.
- Access
Direction string Access Direction for Protocol of the Instance(inbound/outbound).
- Access
From string Access From Protocol of the Instance.
- Access
Type string Access Type Protocol of the Instance.
- Cidr
List []stringAliases - Cidrs []string
- Common
Name string CommonName for Protocol of the Instance.
- From
Port int From Port of the Instance.
- Ipv6Cidrs []string
- Protocol string
Port Protocol of the Instance.
- To
Port int To Port of the Instance.
- access
Direction String Access Direction for Protocol of the Instance(inbound/outbound).
- access
From String Access From Protocol of the Instance.
- access
Type String Access Type Protocol of the Instance.
- cidr
List List<String>Aliases - cidrs List<String>
- common
Name String CommonName for Protocol of the Instance.
- from
Port Integer From Port of the Instance.
- ipv6Cidrs List<String>
- protocol String
Port Protocol of the Instance.
- to
Port Integer To Port of the Instance.
- access
Direction string Access Direction for Protocol of the Instance(inbound/outbound).
- access
From string Access From Protocol of the Instance.
- access
Type string Access Type Protocol of the Instance.
- cidr
List string[]Aliases - cidrs string[]
- common
Name string CommonName for Protocol of the Instance.
- from
Port number From Port of the Instance.
- ipv6Cidrs string[]
- protocol string
Port Protocol of the Instance.
- to
Port 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_ Sequence[str]aliases - 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.
- access
Direction String Access Direction for Protocol of the Instance(inbound/outbound).
- access
From String Access From Protocol of the Instance.
- access
Type String Access Type Protocol of the Instance.
- cidr
List List<String>Aliases - cidrs List<String>
- common
Name String CommonName for Protocol of the Instance.
- from
Port Number From Port of the Instance.
- ipv6Cidrs List<String>
- protocol String
Port Protocol of the Instance.
- to
Port Number To Port of the Instance.
InstanceState
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