com.amazonaws.services.ec2.model

Class InstanceMetadataOptionsResponse

java.lang.Object

com.amazonaws.services.ec2.model.InstanceMetadataOptionsResponse

All Implemented Interfaces:

Serializable, Cloneable

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

The metadata options for the instance.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
InstanceMetadataOptionsResponse()

Method Summary

Modifier and Type	Method and Description
InstanceMetadataOptionsResponse	clone()
boolean	equals(Object obj)
String	getHttpEndpoint() Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.
String	getHttpProtocolIpv6() Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.
Integer	getHttpPutResponseHopLimit() The desired HTTP PUT response hop limit for instance metadata requests.
String	getHttpTokens() Indicates whether IMDSv2 is required.
String	getInstanceMetadataTags() Indicates whether access to instance tags from the instance metadata is enabled or disabled.
String	getState() The state of the metadata option changes.
int	hashCode()
void	setHttpEndpoint(String httpEndpoint) Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.
void	setHttpProtocolIpv6(String httpProtocolIpv6) Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.
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) Indicates whether access to instance tags from the instance metadata is enabled or disabled.
void	setState(String state) The state of the metadata option changes.
String	toString() Returns a string representation of this object.
InstanceMetadataOptionsResponse	withHttpEndpoint(InstanceMetadataEndpointState httpEndpoint) Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.
InstanceMetadataOptionsResponse	withHttpEndpoint(String httpEndpoint) Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.
InstanceMetadataOptionsResponse	withHttpProtocolIpv6(InstanceMetadataProtocolState httpProtocolIpv6) Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.
InstanceMetadataOptionsResponse	withHttpProtocolIpv6(String httpProtocolIpv6) Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.
InstanceMetadataOptionsResponse	withHttpPutResponseHopLimit(Integer httpPutResponseHopLimit) The desired HTTP PUT response hop limit for instance metadata requests.
InstanceMetadataOptionsResponse	withHttpTokens(HttpTokensState httpTokens) Indicates whether IMDSv2 is required.
InstanceMetadataOptionsResponse	withHttpTokens(String httpTokens) Indicates whether IMDSv2 is required.
InstanceMetadataOptionsResponse	withInstanceMetadataTags(InstanceMetadataTagsState instanceMetadataTags) Indicates whether access to instance tags from the instance metadata is enabled or disabled.
InstanceMetadataOptionsResponse	withInstanceMetadataTags(String instanceMetadataTags) Indicates whether access to instance tags from the instance metadata is enabled or disabled.
InstanceMetadataOptionsResponse	withState(InstanceMetadataOptionsState state) The state of the metadata option changes.
InstanceMetadataOptionsResponse	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

InstanceMetadataOptionsResponse

public InstanceMetadataOptionsResponse()

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:

InstanceMetadataOptionsState

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:

InstanceMetadataOptionsState

withState

public InstanceMetadataOptionsResponse 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:

InstanceMetadataOptionsState

withState

public InstanceMetadataOptionsResponse withState(InstanceMetadataOptionsState 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:

InstanceMetadataOptionsState

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:

HttpTokensState

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:

HttpTokensState

withHttpTokens

public InstanceMetadataOptionsResponse 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:

HttpTokensState

withHttpTokens

public InstanceMetadataOptionsResponse withHttpTokens(HttpTokensState 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:

HttpTokensState

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 InstanceMetadataOptionsResponse 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)

Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.

If the value is disabled, you cannot access your instance metadata.

Parameters:

httpEndpoint - Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.

If the value is disabled, you cannot access your instance metadata.

See Also:

InstanceMetadataEndpointState

getHttpEndpoint

public String getHttpEndpoint()

Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.

If the value is disabled, you cannot access your instance metadata.

Returns:

Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.

If the value is disabled, you cannot access your instance metadata.

See Also:

InstanceMetadataEndpointState

withHttpEndpoint

public InstanceMetadataOptionsResponse withHttpEndpoint(String httpEndpoint)

Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.

If the value is disabled, you cannot access your instance metadata.

Parameters:

httpEndpoint - Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.

If the value is disabled, you cannot access your instance metadata.

Returns:

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

See Also:

InstanceMetadataEndpointState

withHttpEndpoint

public InstanceMetadataOptionsResponse withHttpEndpoint(InstanceMetadataEndpointState httpEndpoint)

Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.

If the value is disabled, you cannot access your instance metadata.

Parameters:

httpEndpoint - Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.

If the value is disabled, you cannot access your instance metadata.

Returns:

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

See Also:

InstanceMetadataEndpointState

setHttpProtocolIpv6

public void setHttpProtocolIpv6(String httpProtocolIpv6)

Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.

Parameters:

httpProtocolIpv6 - Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.

See Also:

InstanceMetadataProtocolState

getHttpProtocolIpv6

public String getHttpProtocolIpv6()

Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.

Returns:

Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.

See Also:

InstanceMetadataProtocolState

withHttpProtocolIpv6

public InstanceMetadataOptionsResponse withHttpProtocolIpv6(String httpProtocolIpv6)

Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.

Parameters:

httpProtocolIpv6 - Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.

Returns:

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

See Also:

InstanceMetadataProtocolState

withHttpProtocolIpv6

public InstanceMetadataOptionsResponse withHttpProtocolIpv6(InstanceMetadataProtocolState httpProtocolIpv6)

Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.

Parameters:

httpProtocolIpv6 - Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.

Returns:

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

See Also:

InstanceMetadataProtocolState

setInstanceMetadataTags

public void setInstanceMetadataTags(String instanceMetadataTags)

Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see Work with instance tags using the instance metadata.

Parameters:

instanceMetadataTags - Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see Work with instance tags using the instance metadata.

See Also:

InstanceMetadataTagsState

getInstanceMetadataTags

public String getInstanceMetadataTags()

Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see Work with instance tags using the instance metadata.

Returns:

Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see Work with instance tags using the instance metadata.

See Also:

InstanceMetadataTagsState

withInstanceMetadataTags

public InstanceMetadataOptionsResponse withInstanceMetadataTags(String instanceMetadataTags)

Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see Work with instance tags using the instance metadata.

Parameters:

instanceMetadataTags - Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see Work with instance tags using the instance metadata.

Returns:

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

See Also:

InstanceMetadataTagsState

withInstanceMetadataTags

public InstanceMetadataOptionsResponse withInstanceMetadataTags(InstanceMetadataTagsState instanceMetadataTags)

Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see Work with instance tags using the instance metadata.

Parameters:

instanceMetadataTags - Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see Work with instance tags using the instance metadata.

Returns:

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

See Also:

InstanceMetadataTagsState

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 InstanceMetadataOptionsResponse clone()

Overrides:

clone in class Object