AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
Modifies the Amazon Lightsail instance metadata parameters on a running or stopped instance. When you modify the parameters on a running instance, the GetInstance
or GetInstances
API operation initially responds with a state of pending
. After the parameter modifications are successfully applied, the state changes to applied
in subsequent GetInstance
or GetInstances
API calls. For more information, see Use IMDSv2 with an Amazon Lightsail instance in the Amazon Lightsail Developer Guide .
See also: AWS API Documentation
update-instance-metadata-options
--instance-name <value>
[--http-tokens <value>]
[--http-endpoint <value>]
[--http-put-response-hop-limit <value>]
[--http-protocol-ipv6 <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--instance-name
(string)
The name of the instance for which to update metadata parameters.
--http-tokens
(string)
The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is
optional
.If the state is
optional
, you can choose whether to retrieve instance metadata with a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials by using a valid signed token, the version 2.0 role credentials are returned.If the state is
required
, you must send a signed token header with all instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The version 1.0 credentials are not available.Possible values:
optional
required
--http-endpoint
(string)
Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.
If you specify a value of
disabled
, you cannot access your instance metadata.Possible values:
disabled
enabled
--http-put-response-hop-limit
(integer)
The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance metadata requests can travel farther. If no parameter is specified, the existing state is maintained.
--http-protocol-ipv6
(string)
Enables or disables the IPv6 endpoint for the instance metadata service. This setting applies only when the HTTP metadata endpoint is enabled.
Note
This parameter is available only for instances in the Europe (Stockholm) Amazon Web Services Region (eu-north-1
).Possible values:
disabled
enabled
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI 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.
--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
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
operation -> (structure)
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.
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 (1479816991.349
).location -> (structure)
The Amazon Web Services Region and Availability Zone.
availabilityZone -> (string)
The Availability Zone. Follows the formatus-east-2a
(case-sensitive).regionName -> (string)
The Amazon Web Services Region name.isTerminal -> (boolean)
A Boolean value indicating whether the operation is terminal.operationDetails -> (string)
Details about the operation (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 (1479816991.349
).errorCode -> (string)
The error code.errorDetails -> (string)
The error details.