Class LaunchTemplateInstanceMetadataOptions
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<LaunchTemplateInstanceMetadataOptions.Builder,
LaunchTemplateInstanceMetadataOptions>
The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon Elastic Compute Cloud User Guide.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
Enables or disables the HTTP metadata endpoint on your instances.final String
Enables or disables the HTTP metadata endpoint on your instances.Enables or disables the IPv6 endpoint for the instance metadata service.final String
Enables or disables the IPv6 endpoint for the instance metadata service.final Integer
The desired HTTP PUT response hop limit for instance metadata requests.Indicates whether IMDSv2 is required.final String
Indicates whether IMDSv2 is required.Set toenabled
to allow access to instance tags from the instance metadata.final String
Set toenabled
to allow access to instance tags from the instance metadata.static Class
<? extends LaunchTemplateInstanceMetadataOptions.Builder> state()
The state of the metadata option changes.final String
The state of the metadata option changes.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
state
The state of the metadata option changes.
pending
- The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.applied
- The metadata options have been successfully applied on the instance.If the service returns an enum value that is not available in the current SDK version,
state
will returnLaunchTemplateInstanceMetadataOptionsState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The state of the metadata option changes.
pending
- The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.applied
- The metadata options have been successfully applied on the instance. - See Also:
-
stateAsString
The state of the metadata option changes.
pending
- The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.applied
- The metadata options have been successfully applied on the instance.If the service returns an enum value that is not available in the current SDK version,
state
will returnLaunchTemplateInstanceMetadataOptionsState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The state of the metadata option changes.
pending
- The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.applied
- The metadata options have been successfully applied on the instance. - See Also:
-
httpTokens
Indicates whether IMDSv2 is required.
-
optional
- IMDSv2 is optional. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials. -
required
- IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.
If the service returns an enum value that is not available in the current SDK version,
httpTokens
will returnLaunchTemplateHttpTokensState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhttpTokensAsString()
.- Returns:
- Indicates whether IMDSv2 is required.
-
optional
- IMDSv2 is optional. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials. -
required
- IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.
-
- See Also:
-
-
httpTokensAsString
Indicates whether IMDSv2 is required.
-
optional
- IMDSv2 is optional. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials. -
required
- IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.
If the service returns an enum value that is not available in the current SDK version,
httpTokens
will returnLaunchTemplateHttpTokensState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhttpTokensAsString()
.- Returns:
- Indicates whether IMDSv2 is required.
-
optional
- IMDSv2 is optional. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials. -
required
- IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.
-
- See Also:
-
-
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
- Returns:
- 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
-
httpEndpoint
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 returnLaunchTemplateInstanceMetadataEndpointState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhttpEndpointAsString()
.- Returns:
- 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. - See Also:
-
httpEndpointAsString
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 returnLaunchTemplateInstanceMetadataEndpointState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhttpEndpointAsString()
.- Returns:
- 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. - See Also:
-
httpProtocolIpv6
Enables or disables the IPv6 endpoint for the instance metadata service.
Default:
disabled
If the service returns an enum value that is not available in the current SDK version,
httpProtocolIpv6
will returnLaunchTemplateInstanceMetadataProtocolIpv6.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhttpProtocolIpv6AsString()
.- Returns:
- Enables or disables the IPv6 endpoint for the instance metadata service.
Default:
disabled
- See Also:
-
httpProtocolIpv6AsString
Enables or disables the IPv6 endpoint for the instance metadata service.
Default:
disabled
If the service returns an enum value that is not available in the current SDK version,
httpProtocolIpv6
will returnLaunchTemplateInstanceMetadataProtocolIpv6.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhttpProtocolIpv6AsString()
.- Returns:
- Enables or disables the IPv6 endpoint for the instance metadata service.
Default:
disabled
- See Also:
-
instanceMetadataTags
Set to
enabled
to allow access to instance tags from the instance metadata. Set todisabled
to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.Default:
disabled
If the service returns an enum value that is not available in the current SDK version,
instanceMetadataTags
will returnLaunchTemplateInstanceMetadataTagsState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceMetadataTagsAsString()
.- Returns:
- Set to
enabled
to allow access to instance tags from the instance metadata. Set todisabled
to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.Default:
disabled
- See Also:
-
instanceMetadataTagsAsString
Set to
enabled
to allow access to instance tags from the instance metadata. Set todisabled
to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.Default:
disabled
If the service returns an enum value that is not available in the current SDK version,
instanceMetadataTags
will returnLaunchTemplateInstanceMetadataTagsState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceMetadataTagsAsString()
.- Returns:
- Set to
enabled
to allow access to instance tags from the instance metadata. Set todisabled
to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.Default:
disabled
- See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<LaunchTemplateInstanceMetadataOptions.Builder,
LaunchTemplateInstanceMetadataOptions> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends LaunchTemplateInstanceMetadataOptions.Builder> serializableBuilderClass() -
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-