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() The state of token usage for your instance metadata requests.
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) The state of token usage for your instance metadata requests.
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) The state of token usage for your instance metadata requests.
InstanceMetadataOptionsRequest	withHttpTokens(String httpTokens) The state of token usage for your instance metadata requests.

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)

The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional.

If the state is optional, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.

If the state is required, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.

Parameters:

httpTokens - The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional.

If the state is optional, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.

If the state is required, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.

See Also:

HttpTokensState

getHttpTokens

public String getHttpTokens()

The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional.

If the state is optional, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.

If the state is required, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.

Returns:

The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional.

If the state is optional, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.

If the state is required, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.

See Also:

HttpTokensState

withHttpTokens

public InstanceMetadataOptionsRequest withHttpTokens(String httpTokens)

The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional.

If the state is optional, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.

If the state is required, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.

Parameters:

httpTokens - The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional.

If the state is optional, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.

If the state is required, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.

Returns:

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

See Also:

HttpTokensState

withHttpTokens

public InstanceMetadataOptionsRequest withHttpTokens(HttpTokensState httpTokens)

The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional.

If the state is optional, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.

If the state is required, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.

Parameters:

httpTokens - The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional.

If the state is optional, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.

If the state is required, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 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 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 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:

InstanceMetadataEndpointState

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:

InstanceMetadataEndpointState

withHttpEndpoint

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

InstanceMetadataEndpointState

withHttpEndpoint

public InstanceMetadataOptionsRequest withHttpEndpoint(InstanceMetadataEndpointState 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:

InstanceMetadataEndpointState

setHttpProtocolIpv6

public void setHttpProtocolIpv6(String httpProtocolIpv6)

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

Parameters:

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

See Also:

InstanceMetadataProtocolState

getHttpProtocolIpv6

public String getHttpProtocolIpv6()

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

Returns:

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

See Also:

InstanceMetadataProtocolState

withHttpProtocolIpv6

public InstanceMetadataOptionsRequest withHttpProtocolIpv6(String httpProtocolIpv6)

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

Parameters:

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

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.

Parameters:

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

Returns:

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

See Also:

InstanceMetadataProtocolState

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