com.amazonaws.services.ec2.model

Class ModifyInstanceMetadataOptionsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.ModifyInstanceMetadataOptionsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, DryRunSupportedRequest<ModifyInstanceMetadataOptionsRequest>, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ModifyInstanceMetadataOptionsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<ModifyInstanceMetadataOptionsRequest>

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ModifyInstanceMetadataOptionsRequest()

Method Summary

Modifier and Type	Method and Description
ModifyInstanceMetadataOptionsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Request<ModifyInstanceMetadataOptionsRequest>	getDryRunRequest() This method is intended for internal use only.
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	getInstanceId() The ID of the instance.
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	setInstanceId(String instanceId) The ID of the instance.
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.
ModifyInstanceMetadataOptionsRequest	withHttpEndpoint(InstanceMetadataEndpointState httpEndpoint) Enables or disables the HTTP metadata endpoint on your instances.
ModifyInstanceMetadataOptionsRequest	withHttpEndpoint(String httpEndpoint) Enables or disables the HTTP metadata endpoint on your instances.
ModifyInstanceMetadataOptionsRequest	withHttpProtocolIpv6(InstanceMetadataProtocolState httpProtocolIpv6) Enables or disables the IPv6 endpoint for the instance metadata service.
ModifyInstanceMetadataOptionsRequest	withHttpProtocolIpv6(String httpProtocolIpv6) Enables or disables the IPv6 endpoint for the instance metadata service.
ModifyInstanceMetadataOptionsRequest	withHttpPutResponseHopLimit(Integer httpPutResponseHopLimit) The desired HTTP PUT response hop limit for instance metadata requests.
ModifyInstanceMetadataOptionsRequest	withHttpTokens(HttpTokensState httpTokens) Indicates whether IMDSv2 is required.
ModifyInstanceMetadataOptionsRequest	withHttpTokens(String httpTokens) Indicates whether IMDSv2 is required.
ModifyInstanceMetadataOptionsRequest	withInstanceId(String instanceId) The ID of the instance.
ModifyInstanceMetadataOptionsRequest	withInstanceMetadataTags(InstanceMetadataTagsState instanceMetadataTags) Set to enabled to allow access to instance tags from the instance metadata.
ModifyInstanceMetadataOptionsRequest	withInstanceMetadataTags(String instanceMetadataTags) Set to enabled to allow access to instance tags from the instance metadata.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ModifyInstanceMetadataOptionsRequest

public ModifyInstanceMetadataOptionsRequest()

Method Detail

setInstanceId

public void setInstanceId(String instanceId)

The ID of the instance.

Parameters:

instanceId - The ID of the instance.

getInstanceId

public String getInstanceId()

The ID of the instance.

Returns:

The ID of the instance.

withInstanceId

public ModifyInstanceMetadataOptionsRequest withInstanceId(String instanceId)

The ID of the instance.

Parameters:

instanceId - The ID of the instance.

Returns:

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

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 and the account level default is set to no-preference, the default is required.

• If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, but the account level default is set to V1 or V2, the default is optional.

The default value can also be affected by other combinations of parameters. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.

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 and the account level default is set to no-preference, the default is required.

• If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, but the account level default is set to V1 or V2, the default is optional.

The default value can also be affected by other combinations of parameters. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.

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 and the account level default is set to no-preference, the default is required.

• If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, but the account level default is set to V1 or V2, the default is optional.

The default value can also be affected by other combinations of parameters. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.

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 and the account level default is set to no-preference, the default is required.

• If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, but the account level default is set to V1 or V2, the default is optional.

The default value can also be affected by other combinations of parameters. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.

See Also:

HttpTokensState

withHttpTokens

public ModifyInstanceMetadataOptionsRequest 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 and the account level default is set to no-preference, the default is required.

• If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, but the account level default is set to V1 or V2, the default is optional.

The default value can also be affected by other combinations of parameters. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.

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 and the account level default is set to no-preference, the default is required.

• If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, but the account level default is set to V1 or V2, the default is optional.

The default value can also be affected by other combinations of parameters. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.

Returns:

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

See Also:

HttpTokensState

withHttpTokens

public ModifyInstanceMetadataOptionsRequest 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 and the account level default is set to no-preference, the default is required.

• If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, but the account level default is set to V1 or V2, the default is optional.

The default value can also be affected by other combinations of parameters. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.

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 and the account level default is set to no-preference, the default is required.

• If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, but the account level default is set to V1 or V2, the default is optional.

The default value can also be affected by other combinations of parameters. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.

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. If no parameter is specified, the existing state is maintained.

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. If no parameter is specified, the existing state is maintained.

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. If no parameter is specified, the existing state is maintained.

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. If no parameter is specified, the existing state is maintained.

Possible values: Integers from 1 to 64

withHttpPutResponseHopLimit

public ModifyInstanceMetadataOptionsRequest 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. If no parameter is specified, the existing state is maintained.

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. If no parameter is specified, the existing state is maintained.

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 this parameter is not specified, the existing state is maintained.

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

Parameters:

httpEndpoint - Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.

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

See Also:

InstanceMetadataEndpointState

getHttpEndpoint

public String getHttpEndpoint()

Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.

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

Returns:

Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.

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

See Also:

InstanceMetadataEndpointState

withHttpEndpoint

public ModifyInstanceMetadataOptionsRequest withHttpEndpoint(String httpEndpoint)

Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.

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

Parameters:

httpEndpoint - Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.

If you specify a value of 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 ModifyInstanceMetadataOptionsRequest withHttpEndpoint(InstanceMetadataEndpointState httpEndpoint)

Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.

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

Parameters:

httpEndpoint - Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.

If you specify a value of 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)

Enables or disables the IPv6 endpoint for the instance metadata service. Applies only if you enabled the HTTP metadata endpoint.

Parameters:

httpProtocolIpv6 - Enables or disables the IPv6 endpoint for the instance metadata service. Applies only if you enabled the HTTP metadata endpoint.

See Also:

InstanceMetadataProtocolState

getHttpProtocolIpv6

public String getHttpProtocolIpv6()

Enables or disables the IPv6 endpoint for the instance metadata service. Applies only if you enabled the HTTP metadata endpoint.

Returns:

Enables or disables the IPv6 endpoint for the instance metadata service. Applies only if you enabled the HTTP metadata endpoint.

See Also:

InstanceMetadataProtocolState

withHttpProtocolIpv6

public ModifyInstanceMetadataOptionsRequest withHttpProtocolIpv6(String httpProtocolIpv6)

Enables or disables the IPv6 endpoint for the instance metadata service. Applies only if you enabled the HTTP metadata endpoint.

Parameters:

httpProtocolIpv6 - Enables or disables the IPv6 endpoint for the instance metadata service. Applies only if you enabled the HTTP metadata endpoint.

Returns:

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

See Also:

InstanceMetadataProtocolState

withHttpProtocolIpv6

public ModifyInstanceMetadataOptionsRequest withHttpProtocolIpv6(InstanceMetadataProtocolState httpProtocolIpv6)

Enables or disables the IPv6 endpoint for the instance metadata service. Applies only if you enabled the HTTP metadata endpoint.

Parameters:

httpProtocolIpv6 - Enables or disables the IPv6 endpoint for the instance metadata service. Applies only if you enabled the HTTP metadata endpoint.

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.

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.

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.

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.

See Also:

InstanceMetadataTagsState

withInstanceMetadataTags

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

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.

Returns:

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

See Also:

InstanceMetadataTagsState

withInstanceMetadataTags

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

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.

Returns:

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

See Also:

InstanceMetadataTagsState

getDryRunRequest

public Request<ModifyInstanceMetadataOptionsRequest> getDryRunRequest()

This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:

getDryRunRequest in interface DryRunSupportedRequest<ModifyInstanceMetadataOptionsRequest>

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

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()