1. Packages
  2. AWS Native
  3. API Docs
  4. lightsail
  5. Instance

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.100.0 published on Wednesday, Mar 27, 2024 by Pulumi

aws-native.lightsail.Instance

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.100.0 published on Wednesday, Mar 27, 2024 by Pulumi

    Resource Type definition for AWS::Lightsail::Instance

    Create Instance Resource

    new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);
    @overload
    def Instance(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 add_ons: Optional[Sequence[InstanceAddOnArgs]] = None,
                 availability_zone: Optional[str] = None,
                 blueprint_id: Optional[str] = None,
                 bundle_id: Optional[str] = None,
                 hardware: Optional[InstanceHardwareArgs] = None,
                 instance_name: Optional[str] = None,
                 key_pair_name: Optional[str] = None,
                 location: Optional[InstanceLocationArgs] = None,
                 networking: Optional[InstanceNetworkingArgs] = None,
                 state: Optional[InstanceStateArgs] = None,
                 tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                 user_data: Optional[str] = None)
    @overload
    def Instance(resource_name: str,
                 args: InstanceArgs,
                 opts: Optional[ResourceOptions] = None)
    func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)
    public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
    public Instance(String name, InstanceArgs args)
    public Instance(String name, InstanceArgs args, CustomResourceOptions options)
    
    type: aws-native:lightsail:Instance
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Instance Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Instance resource accepts the following input properties:

    BlueprintId string
    The ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0 ). Use the get blueprints operation to return a list of available images (or blueprints ).
    BundleId string
    The bundle of specification information for your virtual private server (or instance ), including the pricing plan (e.g., micro_1_0 ).
    AddOns List<Pulumi.AwsNative.Lightsail.Inputs.InstanceAddOn>
    An array of objects representing the add-ons to enable for the new 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.
    Hardware Pulumi.AwsNative.Lightsail.Inputs.InstanceHardware
    InstanceName string
    The names to use for your new Lightsail instance.
    KeyPairName string
    The name of your key pair.
    Location Pulumi.AwsNative.Lightsail.Inputs.InstanceLocation
    Networking Pulumi.AwsNative.Lightsail.Inputs.InstanceNetworking
    State Pulumi.AwsNative.Lightsail.Inputs.InstanceState
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    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.
    BlueprintId string
    The ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0 ). Use the get blueprints operation to return a list of available images (or blueprints ).
    BundleId string
    The bundle of specification information for your virtual private server (or instance ), including the pricing plan (e.g., micro_1_0 ).
    AddOns []InstanceAddOnArgs
    An array of objects representing the add-ons to enable for the new 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.
    Hardware InstanceHardwareArgs
    InstanceName string
    The names to use for your new Lightsail instance.
    KeyPairName string
    The name of your key pair.
    Location InstanceLocationArgs
    Networking InstanceNetworkingArgs
    State InstanceStateTypeArgs
    Tags TagArgs
    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.
    blueprintId String
    The ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0 ). Use the get blueprints operation to return a list of available images (or blueprints ).
    bundleId String
    The bundle of specification information for your virtual private server (or instance ), including the pricing plan (e.g., micro_1_0 ).
    addOns List<InstanceAddOn>
    An array of objects representing the add-ons to enable for the new 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.
    hardware InstanceHardware
    instanceName String
    The names to use for your new Lightsail instance.
    keyPairName String
    The name of your key pair.
    location InstanceLocation
    networking InstanceNetworking
    state InstanceState
    tags List<Tag>
    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.
    blueprintId string
    The ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0 ). Use the get blueprints operation to return a list of available images (or blueprints ).
    bundleId string
    The bundle of specification information for your virtual private server (or instance ), including the pricing plan (e.g., micro_1_0 ).
    addOns InstanceAddOn[]
    An array of objects representing the add-ons to enable for the new 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.
    hardware InstanceHardware
    instanceName string
    The names to use for your new Lightsail instance.
    keyPairName string
    The name of your key pair.
    location InstanceLocation
    networking InstanceNetworking
    state InstanceState
    tags Tag[]
    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.
    blueprint_id str
    The ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0 ). Use the get blueprints operation to return a list of available images (or blueprints ).
    bundle_id str
    The bundle of specification information for your virtual private server (or instance ), including the pricing plan (e.g., micro_1_0 ).
    add_ons Sequence[InstanceAddOnArgs]
    An array of objects representing the add-ons to enable for the new 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.
    hardware InstanceHardwareArgs
    instance_name str
    The names to use for your new Lightsail instance.
    key_pair_name str
    The name of your key pair.
    location InstanceLocationArgs
    networking InstanceNetworkingArgs
    state InstanceStateArgs
    tags TagArgs]
    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.
    blueprintId String
    The ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0 ). Use the get blueprints operation to return a list of available images (or blueprints ).
    bundleId String
    The bundle of specification information for your virtual private server (or instance ), including the pricing plan (e.g., micro_1_0 ).
    addOns List<Property Map>
    An array of objects representing the add-ons to enable for the new 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.
    hardware Property Map
    instanceName String
    The names to use for your new Lightsail instance.
    keyPairName String
    The name of your key pair.
    location Property Map
    networking Property Map
    state Property Map
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Instance resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceArn string
    IsStaticIp bool
    Is the IP Address of the Instance is the static IP
    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.
    SupportCode string
    Support code to help identify any issues
    UserName string
    Username of the Lightsail instance.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceArn string
    IsStaticIp bool
    Is the IP Address of the Instance is the static IP
    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.
    SupportCode string
    Support code to help identify any issues
    UserName string
    Username of the Lightsail instance.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceArn String
    isStaticIp Boolean
    Is the IP Address of the Instance is the static IP
    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.
    supportCode String
    Support code to help identify any issues
    userName String
    Username of the Lightsail instance.
    id string
    The provider-assigned unique ID for this managed resource.
    instanceArn string
    isStaticIp boolean
    Is the IP Address of the Instance is the static IP
    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.
    supportCode string
    Support code to help identify any issues
    userName string
    Username of the Lightsail instance.
    id str
    The provider-assigned unique ID for this managed resource.
    instance_arn str
    is_static_ip bool
    Is the IP Address of the Instance is the static IP
    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.
    support_code str
    Support code to help identify any issues
    user_name str
    Username of the Lightsail instance.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceArn String
    isStaticIp Boolean
    Is the IP Address of the Instance is the static IP
    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.
    supportCode String
    Support code to help identify any issues
    userName String
    Username of the Lightsail instance.

    Supporting Types

    InstanceAddOn, InstanceAddOnArgs

    InstanceAddOnStatus, InstanceAddOnStatusArgs

    Enabling
    Enabling
    Disabling
    Disabling
    Enabled
    Enabled
    Terminating
    Terminating
    Terminated
    Terminated
    Disabled
    Disabled
    Failed
    Failed
    InstanceAddOnStatusEnabling
    Enabling
    InstanceAddOnStatusDisabling
    Disabling
    InstanceAddOnStatusEnabled
    Enabled
    InstanceAddOnStatusTerminating
    Terminating
    InstanceAddOnStatusTerminated
    Terminated
    InstanceAddOnStatusDisabled
    Disabled
    InstanceAddOnStatusFailed
    Failed
    Enabling
    Enabling
    Disabling
    Disabling
    Enabled
    Enabled
    Terminating
    Terminating
    Terminated
    Terminated
    Disabled
    Disabled
    Failed
    Failed
    Enabling
    Enabling
    Disabling
    Disabling
    Enabled
    Enabled
    Terminating
    Terminating
    Terminated
    Terminated
    Disabled
    Disabled
    Failed
    Failed
    ENABLING
    Enabling
    DISABLING
    Disabling
    ENABLED
    Enabled
    TERMINATING
    Terminating
    TERMINATED
    Terminated
    DISABLED
    Disabled
    FAILED
    Failed
    "Enabling"
    Enabling
    "Disabling"
    Disabling
    "Enabled"
    Enabled
    "Terminating"
    Terminating
    "Terminated"
    Terminated
    "Disabled"
    Disabled
    "Failed"
    Failed

    InstanceAutoSnapshotAddOn, InstanceAutoSnapshotAddOnArgs

    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, InstanceDiskArgs

    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, InstanceHardwareArgs

    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, InstanceLocationArgs

    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, InstanceMonthlyTransferArgs

    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, InstanceNetworkingArgs

    InstancePort, InstancePortArgs

    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, InstanceStateArgs

    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, TagArgs

    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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.100.0 published on Wednesday, Mar 27, 2024 by Pulumi