@Generated(value="software.amazon.awssdk:codegen") public final class LaunchTemplateInstanceMetadataOptionsRequest extends Object implements SdkPojo, Serializable, ToCopyableBuilder<LaunchTemplateInstanceMetadataOptionsRequest.Builder,LaunchTemplateInstanceMetadataOptionsRequest>
The metadata options for the instance. For more information, see Instance Metadata and User Data in the Amazon Elastic Compute Cloud User Guide.
Modifier and Type | Class and Description |
---|---|
static interface |
LaunchTemplateInstanceMetadataOptionsRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static LaunchTemplateInstanceMetadataOptionsRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
LaunchTemplateInstanceMetadataEndpointState |
httpEndpoint()
This parameter enables or disables the HTTP metadata endpoint on your instances.
|
String |
httpEndpointAsString()
This parameter enables or disables the HTTP metadata endpoint on your instances.
|
Integer |
httpPutResponseHopLimit()
The desired HTTP PUT response hop limit for instance metadata requests.
|
LaunchTemplateHttpTokensState |
httpTokens()
The state of token usage for your instance metadata requests.
|
String |
httpTokensAsString()
The state of token usage for your instance metadata requests.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends LaunchTemplateInstanceMetadataOptionsRequest.Builder> |
serializableBuilderClass() |
LaunchTemplateInstanceMetadataOptionsRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
copy
public final LaunchTemplateHttpTokensState httpTokens()
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 to retrieve instance metadata with or without 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 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 any instance metadata retrieval
requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the
version 1.0 credentials are not available.
If the service returns an enum value that is not available in the current SDK version, httpTokens
will
return LaunchTemplateHttpTokensState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from httpTokensAsString()
.
optional
.
If the state is optional
, you can choose to retrieve instance metadata with or without 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 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 any instance metadata
retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0
credentials; the version 1.0 credentials are not available.
LaunchTemplateHttpTokensState
public final String httpTokensAsString()
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 to retrieve instance metadata with or without 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 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 any instance metadata retrieval
requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the
version 1.0 credentials are not available.
If the service returns an enum value that is not available in the current SDK version, httpTokens
will
return LaunchTemplateHttpTokensState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from httpTokensAsString()
.
optional
.
If the state is optional
, you can choose to retrieve instance metadata with or without 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 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 any instance metadata
retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0
credentials; the version 1.0 credentials are not available.
LaunchTemplateHttpTokensState
public final Integer httpPutResponseHopLimit()
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default: 1
Possible values: Integers from 1 to 64
Default: 1
Possible values: Integers from 1 to 64
public final LaunchTemplateInstanceMetadataEndpointState httpEndpoint()
This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not
specified, the default state is enabled
.
If you specify a value of disabled
, you will not be able to access your instance metadata.
If the service returns an enum value that is not available in the current SDK version, httpEndpoint
will
return LaunchTemplateInstanceMetadataEndpointState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the
service is available from httpEndpointAsString()
.
enabled
.
If you specify a value of disabled
, you will not be able to access your instance metadata.
LaunchTemplateInstanceMetadataEndpointState
public final String httpEndpointAsString()
This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not
specified, the default state is enabled
.
If you specify a value of disabled
, you will not be able to access your instance metadata.
If the service returns an enum value that is not available in the current SDK version, httpEndpoint
will
return LaunchTemplateInstanceMetadataEndpointState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the
service is available from httpEndpointAsString()
.
enabled
.
If you specify a value of disabled
, you will not be able to access your instance metadata.
LaunchTemplateInstanceMetadataEndpointState
public LaunchTemplateInstanceMetadataOptionsRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<LaunchTemplateInstanceMetadataOptionsRequest.Builder,LaunchTemplateInstanceMetadataOptionsRequest>
public static LaunchTemplateInstanceMetadataOptionsRequest.Builder builder()
public static Class<? extends LaunchTemplateInstanceMetadataOptionsRequest.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.