[ aws . lightsail ]

get-static-ip

Description

Returns information about a specific static IP.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-static-ip
--static-ip-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--static-ip-name (string)

The name of the static IP in Lightsail.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To get information about a static IP

The following get-static-ip example displays details about the specified static IP.

aws lightsail get-static-ip \
    --static-ip-name StaticIp-1

Output:

{
    "staticIp": {
        "name": "StaticIp-1",
        "arn": "arn:aws:lightsail:us-west-2:111122223333:StaticIp/2257cd76-1f0e-4ac0-82e2-2EXAMPLE23ad",
        "supportCode": "6EXAMPLE3362/192.0.2.0",
        "createdAt": 1571071325.076,
        "location": {
            "availabilityZone": "all",
            "regionName": "us-west-2"
        },
        "resourceType": "StaticIp",
        "ipAddress": "192.0.2.0",
        "isAttached": false
    }
}

Output

staticIp -> (structure)

An array of key-value pairs containing information about the requested static IP.

name -> (string)

The name of the static IP (e.g., StaticIP-Ohio-EXAMPLE ).

arn -> (string)

The Amazon Resource Name (ARN) of the static IP (e.g., arn:aws:lightsail:us-east-2:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE ).

supportCode -> (string)

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

createdAt -> (timestamp)

The timestamp when the static IP was created (e.g., 1479735304.222 ).

location -> (structure)

The region and Availability Zone where the static IP was created.

availabilityZone -> (string)

The Availability Zone. Follows the format us-east-2a (case-sensitive).

regionName -> (string)

The AWS Region name.

resourceType -> (string)

The resource type (usually StaticIp ).

ipAddress -> (string)

The static IP address.

attachedTo -> (string)

The instance where the static IP is attached (e.g., Amazon_Linux-1GB-Ohio-1 ).

isAttached -> (boolean)

A Boolean value indicating whether the static IP is attached.