com.amazonaws.services.lightsail.model

Class InstanceMetadataOptions

java.lang.Object

com.amazonaws.services.lightsail.model.InstanceMetadataOptions

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

The metadata options for the instance.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
InstanceMetadataOptions()

Method Summary

Modifier and Type	Method and Description
InstanceMetadataOptions	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() The state of token usage for your instance metadata requests.
String	getState() The state of the metadata option changes.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
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) The state of token usage for your instance metadata requests.
void	setState(String state) The state of the metadata option changes.
String	toString() Returns a string representation of this object.
InstanceMetadataOptions	withHttpEndpoint(HttpEndpoint httpEndpoint) Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.
InstanceMetadataOptions	withHttpEndpoint(String httpEndpoint) Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.
InstanceMetadataOptions	withHttpProtocolIpv6(HttpProtocolIpv6 httpProtocolIpv6) Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.
InstanceMetadataOptions	withHttpProtocolIpv6(String httpProtocolIpv6) Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.
InstanceMetadataOptions	withHttpPutResponseHopLimit(Integer httpPutResponseHopLimit) The desired HTTP PUT response hop limit for instance metadata requests.
InstanceMetadataOptions	withHttpTokens(HttpTokens httpTokens) The state of token usage for your instance metadata requests.
InstanceMetadataOptions	withHttpTokens(String httpTokens) The state of token usage for your instance metadata requests.
InstanceMetadataOptions	withState(InstanceMetadataState state) The state of the metadata option changes.
InstanceMetadataOptions	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

InstanceMetadataOptions

public InstanceMetadataOptions()

Method Detail

setState

public void setState(String state)

The state of the metadata option changes.

The following states are possible:

• pending - The metadata options are being updated. The instance is not yet ready to process metadata traffic with the new selection.

• applied - The metadata options have been successfully applied to the instance.

Parameters:

state - The state of the metadata option changes.

The following states are possible:

• pending - The metadata options are being updated. The instance is not yet ready to process metadata traffic with the new selection.

• applied - The metadata options have been successfully applied to the instance.

See Also:

InstanceMetadataState

getState

public String getState()

The state of the metadata option changes.

The following states are possible:

• pending - The metadata options are being updated. The instance is not yet ready to process metadata traffic with the new selection.

• applied - The metadata options have been successfully applied to the instance.

Returns:

The state of the metadata option changes.

The following states are possible:

• pending - The metadata options are being updated. The instance is not yet ready to process metadata traffic with the new selection.

• applied - The metadata options have been successfully applied to the instance.

See Also:

InstanceMetadataState

withState

public InstanceMetadataOptions withState(String state)

The state of the metadata option changes.

The following states are possible:

• pending - The metadata options are being updated. The instance is not yet ready to process metadata traffic with the new selection.

• applied - The metadata options have been successfully applied to the instance.

Parameters:

state - The state of the metadata option changes.

The following states are possible:

• pending - The metadata options are being updated. The instance is not yet ready to process metadata traffic with the new selection.

• applied - The metadata options have been successfully applied to the instance.

Returns:

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

See Also:

InstanceMetadataState

withState

public InstanceMetadataOptions withState(InstanceMetadataState state)

The state of the metadata option changes.

The following states are possible:

• pending - The metadata options are being updated. The instance is not yet ready to process metadata traffic with the new selection.

• applied - The metadata options have been successfully applied to the instance.

Parameters:

state - The state of the metadata option changes.

The following states are possible:

• pending - The metadata options are being updated. The instance is not yet ready to process metadata traffic with the new selection.

• applied - The metadata options have been successfully applied to the instance.

Returns:

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

See Also:

InstanceMetadataState

setHttpTokens

public void setHttpTokens(String httpTokens)

The state of token usage for your instance metadata requests.

If the state is optional, you can choose whether to retrieve instance metadata with 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 by 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 all instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The version 1.0 credentials are not available.

Not all instance blueprints in Lightsail support version 2.0 credentials. Use the MetadataNoToken instance metric to track the number of calls to the instance metadata service that are using version 1.0 credentials. For more information, see Viewing instance metrics in Amazon Lightsail in the Amazon Lightsail Developer Guide.

Parameters:

httpTokens - The state of token usage for your instance metadata requests.

If the state is optional, you can choose whether to retrieve instance metadata with 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 by 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 all instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The version 1.0 credentials are not available.

Not all instance blueprints in Lightsail support version 2.0 credentials. Use the MetadataNoToken instance metric to track the number of calls to the instance metadata service that are using version 1.0 credentials. For more information, see Viewing instance metrics in Amazon Lightsail in the Amazon Lightsail Developer Guide.

See Also:

HttpTokens

getHttpTokens

public String getHttpTokens()

The state of token usage for your instance metadata requests.

If the state is optional, you can choose whether to retrieve instance metadata with 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 by 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 all instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The version 1.0 credentials are not available.

Not all instance blueprints in Lightsail support version 2.0 credentials. Use the MetadataNoToken instance metric to track the number of calls to the instance metadata service that are using version 1.0 credentials. For more information, see Viewing instance metrics in Amazon Lightsail in the Amazon Lightsail Developer Guide.

Returns:

The state of token usage for your instance metadata requests.

If the state is optional, you can choose whether to retrieve instance metadata with 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 by 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 all instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The version 1.0 credentials are not available.

Not all instance blueprints in Lightsail support version 2.0 credentials. Use the MetadataNoToken instance metric to track the number of calls to the instance metadata service that are using version 1.0 credentials. For more information, see Viewing instance metrics in Amazon Lightsail in the Amazon Lightsail Developer Guide.

See Also:

HttpTokens

withHttpTokens

public InstanceMetadataOptions withHttpTokens(String httpTokens)

The state of token usage for your instance metadata requests.

If the state is optional, you can choose whether to retrieve instance metadata with 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 by 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 all instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The version 1.0 credentials are not available.

Not all instance blueprints in Lightsail support version 2.0 credentials. Use the MetadataNoToken instance metric to track the number of calls to the instance metadata service that are using version 1.0 credentials. For more information, see Viewing instance metrics in Amazon Lightsail in the Amazon Lightsail Developer Guide.

Parameters:

httpTokens - The state of token usage for your instance metadata requests.

If the state is optional, you can choose whether to retrieve instance metadata with 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 by 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 all instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The version 1.0 credentials are not available.

Not all instance blueprints in Lightsail support version 2.0 credentials. Use the MetadataNoToken instance metric to track the number of calls to the instance metadata service that are using version 1.0 credentials. For more information, see Viewing instance metrics in Amazon Lightsail in the Amazon Lightsail Developer Guide.

Returns:

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

See Also:

HttpTokens

withHttpTokens

public InstanceMetadataOptions withHttpTokens(HttpTokens httpTokens)

The state of token usage for your instance metadata requests.

If the state is optional, you can choose whether to retrieve instance metadata with 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 by 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 all instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The version 1.0 credentials are not available.

Not all instance blueprints in Lightsail support version 2.0 credentials. Use the MetadataNoToken instance metric to track the number of calls to the instance metadata service that are using version 1.0 credentials. For more information, see Viewing instance metrics in Amazon Lightsail in the Amazon Lightsail Developer Guide.

Parameters:

httpTokens - The state of token usage for your instance metadata requests.

If the state is optional, you can choose whether to retrieve instance metadata with 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 by 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 all instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The version 1.0 credentials are not available.

Not all instance blueprints in Lightsail support version 2.0 credentials. Use the MetadataNoToken instance metric to track the number of calls to the instance metadata service that are using version 1.0 credentials. For more information, see Viewing instance metrics in Amazon Lightsail in the Amazon Lightsail Developer Guide.

Returns:

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

See Also:

HttpTokens

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:

HttpEndpoint

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:

HttpEndpoint

withHttpEndpoint

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

HttpEndpoint

withHttpEndpoint

public InstanceMetadataOptions withHttpEndpoint(HttpEndpoint 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:

HttpEndpoint

setHttpPutResponseHopLimit

public void setHttpPutResponseHopLimit(Integer httpPutResponseHopLimit)

The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance metadata requests can travel farther.

Parameters:

httpPutResponseHopLimit - The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance metadata requests can travel farther.

getHttpPutResponseHopLimit

public Integer getHttpPutResponseHopLimit()

The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance metadata requests can travel farther.

Returns:

The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance metadata requests can travel farther.

withHttpPutResponseHopLimit

public InstanceMetadataOptions withHttpPutResponseHopLimit(Integer httpPutResponseHopLimit)

The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance metadata requests can travel farther.

Parameters:

httpPutResponseHopLimit - The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance metadata requests can travel farther.

Returns:

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

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:

HttpProtocolIpv6

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:

HttpProtocolIpv6

withHttpProtocolIpv6

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

HttpProtocolIpv6

withHttpProtocolIpv6

public InstanceMetadataOptions withHttpProtocolIpv6(HttpProtocolIpv6 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:

HttpProtocolIpv6

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

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.