com.amazonaws.services.ec2.model

Class InstanceMetadataOptionsRequest

java.lang.Object

com.amazonaws.services.ec2.model.InstanceMetadataOptionsRequest

All Implemented Interfaces:

Serializable, Cloneable

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

The metadata options for the instance.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
InstanceMetadataOptionsRequest()

Method Summary

Modifier and Type	Method and Description
InstanceMetadataOptionsRequest	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.
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.
String	toString() Returns a string representation of this object.
InstanceMetadataOptionsRequest	withHttpEndpoint(InstanceMetadataEndpointState httpEndpoint) Enables or disables the HTTP metadata endpoint on your instances.
InstanceMetadataOptionsRequest	withHttpEndpoint(String httpEndpoint) Enables or disables the HTTP metadata endpoint on your instances.
InstanceMetadataOptionsRequest	withHttpProtocolIpv6(InstanceMetadataProtocolState httpProtocolIpv6) Enables or disables the IPv6 endpoint for the instance metadata service.
InstanceMetadataOptionsRequest	withHttpProtocolIpv6(String httpProtocolIpv6) Enables or disables the IPv6 endpoint for the instance metadata service.
InstanceMetadataOptionsRequest	withHttpPutResponseHopLimit(Integer httpPutResponseHopLimit) The desired HTTP PUT response hop limit for instance metadata requests.
InstanceMetadataOptionsRequest	withHttpTokens(HttpTokensState httpTokens) Indicates whether IMDSv2 is required.
InstanceMetadataOptionsRequest	withHttpTokens(String httpTokens) Indicates whether IMDSv2 is required.
InstanceMetadataOptionsRequest	withInstanceMetadataTags(InstanceMetadataTagsState instanceMetadataTags) Set to enabled to allow access to instance tags from the instance metadata.
InstanceMetadataOptionsRequest	withInstanceMetadataTags(String instanceMetadataTags) Set to enabled to allow access to instance tags from the instance metadata.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

InstanceMetadataOptionsRequest

public InstanceMetadataOptionsRequest()

Method Detail

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.

Default: If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, the default is required.

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.

Default: If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, the default is required.

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.

Default: If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, the default is required.

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.

Default: If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, the default is required.

See Also:

HttpTokensState

withHttpTokens

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

Default: If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, the default is required.

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.

Default: If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, the default is required.

Returns:

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

See Also:

HttpTokensState

withHttpTokens

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

Default: If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, the default is required.

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.

Default: If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, the default is required.

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 InstanceMetadataOptionsRequest 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 you specify a value of disabled, you cannot access your instance metadata.

Default: enabled

Parameters:

httpEndpoint - Enables or disables the HTTP metadata endpoint on your instances.

If you specify a value of disabled, you cannot access your instance metadata.

Default: enabled

See Also:

InstanceMetadataEndpointState

getHttpEndpoint

public String getHttpEndpoint()

Enables or disables the HTTP metadata endpoint on your instances.

If you specify a value of disabled, you cannot access your instance metadata.

Default: enabled

Returns:

Enables or disables the HTTP metadata endpoint on your instances.

If you specify a value of disabled, you cannot access your instance metadata.

Default: enabled

See Also:

InstanceMetadataEndpointState

withHttpEndpoint

public InstanceMetadataOptionsRequest withHttpEndpoint(String httpEndpoint)

Enables or disables the HTTP metadata endpoint on your instances.

If you specify a value of disabled, you cannot access your instance metadata.

Default: enabled

Parameters:

httpEndpoint - Enables or disables the HTTP metadata endpoint on your instances.

If you specify a value of disabled, you cannot access your instance metadata.

Default: enabled

Returns:

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

See Also:

InstanceMetadataEndpointState

withHttpEndpoint

public InstanceMetadataOptionsRequest withHttpEndpoint(InstanceMetadataEndpointState httpEndpoint)

Enables or disables the HTTP metadata endpoint on your instances.

If you specify a value of disabled, you cannot access your instance metadata.

Default: enabled

Parameters:

httpEndpoint - Enables or disables the HTTP metadata endpoint on your instances.

If you specify a value of disabled, you cannot access your instance metadata.

Default: enabled

Returns:

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

See Also:

InstanceMetadataEndpointState

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:

InstanceMetadataProtocolState

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:

InstanceMetadataProtocolState

withHttpProtocolIpv6

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

InstanceMetadataProtocolState

withHttpProtocolIpv6

public InstanceMetadataOptionsRequest withHttpProtocolIpv6(InstanceMetadataProtocolState 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:

InstanceMetadataProtocolState

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:

InstanceMetadataTagsState

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:

InstanceMetadataTagsState

withInstanceMetadataTags

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

InstanceMetadataTagsState

withInstanceMetadataTags

public InstanceMetadataOptionsRequest withInstanceMetadataTags(InstanceMetadataTagsState 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:

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

Overrides:

clone in class Object