[ aws . lightsail ]

set-ip-address-type

Description

Sets the IP address type for an Amazon Lightsail resource.

Use this action to enable dual-stack for a resource, which enables IPv4 and IPv6 for the specified resource. Alternately, you can use this action to disable dual-stack, and enable IPv4 only.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  set-ip-address-type
--resource-type <value>
--resource-name <value>
--ip-address-type <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--resource-type (string)

The resource type.

The possible values are Distribution , Instance , and LoadBalancer .

Note

Distribution-related APIs are available only in the N. Virginia (us-east-1 ) AWS Region. Set your AWS Region configuration to us-east-1 to create, view, or edit distributions.

Possible values:

• ContainerService

• Instance

• StaticIp

• KeyPair

• InstanceSnapshot

• Domain

• PeeredVpc

• LoadBalancer

• LoadBalancerTlsCertificate

• Disk

• DiskSnapshot

• RelationalDatabase

• RelationalDatabaseSnapshot

• ExportSnapshotRecord

• CloudFormationStackRecord

• Alarm

• ContactMethod

• Distribution

• Certificate

--resource-name (string)

The name of the resource for which to set the IP address type.

--ip-address-type (string)

The IP address type to set for the specified resource.

The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.

Possible values:

• dualstack

• ipv4

--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.

See ‘aws help’ for descriptions of global parameters.

Output

operations -> (list)

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

(structure)

Describes the API operation.

id -> (string)

The ID of the operation.

resourceName -> (string)

The resource name.

resourceType -> (string)

The resource type.

createdAt -> (timestamp)

The timestamp when the operation was initialized (e.g., 1479816991.349 ).

location -> (structure)

The AWS Region and Availability Zone.

availabilityZone -> (string)

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

regionName -> (string)

The AWS Region name.

isTerminal -> (boolean)

A Boolean value indicating whether the operation is terminal.

operationDetails -> (string)

Details about the operation (e.g., Debian-1GB-Ohio-1 ).

operationType -> (string)

The type of operation.

status -> (string)

The status of the operation.

statusChangedAt -> (timestamp)

The timestamp when the status was changed (e.g., 1479816991.349 ).

errorCode -> (string)

The error code.

errorDetails -> (string)

The error details.