com.amazonaws.services.ec2.model

Class LaunchTemplateInstanceMetadataOptions

java.lang.Object

com.amazonaws.services.ec2.model.LaunchTemplateInstanceMetadataOptions

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class LaunchTemplateInstanceMetadataOptions
extends Object
implements Serializable, Cloneable

The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon EC2 User Guide.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
LaunchTemplateInstanceMetadataOptions()

Method Summary

Modifier and Type	Method and Description
LaunchTemplateInstanceMetadataOptions	clone()
boolean	equals(Object obj)
String	getHttpEndpoint() Enables or disables the HTTP metadata endpoint on your instances.
String	getHttpProtocolIpv6() Enables or disables the IPv6 endpoint for the instance metadata service.
Integer	getHttpPutResponseHopLimit() The desired HTTP PUT response hop limit for instance metadata requests.
String	getHttpTokens() Indicates whether IMDSv2 is required.
String	getInstanceMetadataTags() Set to enabled to allow access to instance tags from the instance metadata.
String	getState() The state of the metadata option changes.
int	hashCode()
void	setHttpEndpoint(String httpEndpoint) Enables or disables the HTTP metadata endpoint on your instances.
void	setHttpProtocolIpv6(String httpProtocolIpv6) Enables or disables the IPv6 endpoint for the instance metadata service.
void	setHttpPutResponseHopLimit(Integer httpPutResponseHopLimit) The desired HTTP PUT response hop limit for instance metadata requests.
void	setHttpTokens(String httpTokens) Indicates whether IMDSv2 is required.
void	setInstanceMetadataTags(String instanceMetadataTags) Set to enabled to allow access to instance tags from the instance metadata.
void	setState(String state) The state of the metadata option changes.
String	toString() Returns a string representation of this object.
LaunchTemplateInstanceMetadataOptions	withHttpEndpoint(LaunchTemplateInstanceMetadataEndpointState httpEndpoint) Enables or disables the HTTP metadata endpoint on your instances.
LaunchTemplateInstanceMetadataOptions	withHttpEndpoint(String httpEndpoint) Enables or disables the HTTP metadata endpoint on your instances.
LaunchTemplateInstanceMetadataOptions	withHttpProtocolIpv6(LaunchTemplateInstanceMetadataProtocolIpv6 httpProtocolIpv6) Enables or disables the IPv6 endpoint for the instance metadata service.
LaunchTemplateInstanceMetadataOptions	withHttpProtocolIpv6(String httpProtocolIpv6) Enables or disables the IPv6 endpoint for the instance metadata service.
LaunchTemplateInstanceMetadataOptions	withHttpPutResponseHopLimit(Integer httpPutResponseHopLimit) The desired HTTP PUT response hop limit for instance metadata requests.
LaunchTemplateInstanceMetadataOptions	withHttpTokens(LaunchTemplateHttpTokensState httpTokens) Indicates whether IMDSv2 is required.
LaunchTemplateInstanceMetadataOptions	withHttpTokens(String httpTokens) Indicates whether IMDSv2 is required.
LaunchTemplateInstanceMetadataOptions	withInstanceMetadataTags(LaunchTemplateInstanceMetadataTagsState instanceMetadataTags) Set to enabled to allow access to instance tags from the instance metadata.
LaunchTemplateInstanceMetadataOptions	withInstanceMetadataTags(String instanceMetadataTags) Set to enabled to allow access to instance tags from the instance metadata.
LaunchTemplateInstanceMetadataOptions	withState(LaunchTemplateInstanceMetadataOptionsState state) The state of the metadata option changes.
LaunchTemplateInstanceMetadataOptions	withState(String state) The state of the metadata option changes.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LaunchTemplateInstanceMetadataOptions

public LaunchTemplateInstanceMetadataOptions()

Method Detail

setState

public void setState(String 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.

Parameters:

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.

See Also:

LaunchTemplateInstanceMetadataOptionsState

getState

public String getState()

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.

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:

LaunchTemplateInstanceMetadataOptionsState

withState

public LaunchTemplateInstanceMetadataOptions withState(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LaunchTemplateInstanceMetadataOptionsState

withState

public LaunchTemplateInstanceMetadataOptions withState(LaunchTemplateInstanceMetadataOptionsState 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LaunchTemplateInstanceMetadataOptionsState

setHttpTokens

public void setHttpTokens(String 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.

Parameters:

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.

See Also:

LaunchTemplateHttpTokensState

getHttpTokens

public String getHttpTokens()

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.

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:

LaunchTemplateHttpTokensState

withHttpTokens

public LaunchTemplateInstanceMetadataOptions withHttpTokens(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LaunchTemplateHttpTokensState

withHttpTokens

public LaunchTemplateInstanceMetadataOptions withHttpTokens(LaunchTemplateHttpTokensState 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LaunchTemplateHttpTokensState

setHttpPutResponseHopLimit

public void setHttpPutResponseHopLimit(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

Parameters:

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

getHttpPutResponseHopLimit

public Integer getHttpPutResponseHopLimit()

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

withHttpPutResponseHopLimit

public LaunchTemplateInstanceMetadataOptions withHttpPutResponseHopLimit(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

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setHttpEndpoint

public void setHttpEndpoint(String 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.

Parameters:

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.

See Also:

LaunchTemplateInstanceMetadataEndpointState

getHttpEndpoint

public String getHttpEndpoint()

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.

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:

LaunchTemplateInstanceMetadataEndpointState

withHttpEndpoint

public LaunchTemplateInstanceMetadataOptions withHttpEndpoint(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LaunchTemplateInstanceMetadataEndpointState

withHttpEndpoint

public LaunchTemplateInstanceMetadataOptions withHttpEndpoint(LaunchTemplateInstanceMetadataEndpointState 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LaunchTemplateInstanceMetadataEndpointState

setHttpProtocolIpv6

public void setHttpProtocolIpv6(String httpProtocolIpv6)

Enables or disables the IPv6 endpoint for the instance metadata service.

Default: disabled

Parameters:

httpProtocolIpv6 - Enables or disables the IPv6 endpoint for the instance metadata service.

Default: disabled

See Also:

LaunchTemplateInstanceMetadataProtocolIpv6

getHttpProtocolIpv6

public String getHttpProtocolIpv6()

Enables or disables the IPv6 endpoint for the instance metadata service.

Default: disabled

Returns:

Enables or disables the IPv6 endpoint for the instance metadata service.

Default: disabled

See Also:

LaunchTemplateInstanceMetadataProtocolIpv6

withHttpProtocolIpv6

public LaunchTemplateInstanceMetadataOptions withHttpProtocolIpv6(String httpProtocolIpv6)

Enables or disables the IPv6 endpoint for the instance metadata service.

Default: disabled

Parameters:

httpProtocolIpv6 - Enables or disables the IPv6 endpoint for the instance metadata service.

Default: disabled

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LaunchTemplateInstanceMetadataProtocolIpv6

withHttpProtocolIpv6

public LaunchTemplateInstanceMetadataOptions withHttpProtocolIpv6(LaunchTemplateInstanceMetadataProtocolIpv6 httpProtocolIpv6)

Enables or disables the IPv6 endpoint for the instance metadata service.

Default: disabled

Parameters:

httpProtocolIpv6 - Enables or disables the IPv6 endpoint for the instance metadata service.

Default: disabled

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LaunchTemplateInstanceMetadataProtocolIpv6

setInstanceMetadataTags

public void setInstanceMetadataTags(String instanceMetadataTags)

Set to enabled to allow access to instance tags from the instance metadata. Set to disabled 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

Parameters:

instanceMetadataTags - Set to enabled to allow access to instance tags from the instance metadata. Set to disabled 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:

LaunchTemplateInstanceMetadataTagsState

getInstanceMetadataTags

public String getInstanceMetadataTags()

Set to enabled to allow access to instance tags from the instance metadata. Set to disabled 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

Returns:

Set to enabled to allow access to instance tags from the instance metadata. Set to disabled 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:

LaunchTemplateInstanceMetadataTagsState

withInstanceMetadataTags

public LaunchTemplateInstanceMetadataOptions withInstanceMetadataTags(String instanceMetadataTags)

Set to enabled to allow access to instance tags from the instance metadata. Set to disabled 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

Parameters:

instanceMetadataTags - Set to enabled to allow access to instance tags from the instance metadata. Set to disabled 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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LaunchTemplateInstanceMetadataTagsState

withInstanceMetadataTags

public LaunchTemplateInstanceMetadataOptions withInstanceMetadataTags(LaunchTemplateInstanceMetadataTagsState instanceMetadataTags)

Set to enabled to allow access to instance tags from the instance metadata. Set to disabled 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

Parameters:

instanceMetadataTags - Set to enabled to allow access to instance tags from the instance metadata. Set to disabled 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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LaunchTemplateInstanceMetadataTagsState

toString

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

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public LaunchTemplateInstanceMetadataOptions clone()

Overrides:

clone in class Object