com.amazonaws.services.imagebuilder.model

Class InstanceMetadataOptions

java.lang.Object

com.amazonaws.services.imagebuilder.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 instance metadata options that apply to the HTTP requests that pipeline builds use to launch EC2 build and test instances. For more information about instance metadata options, see Configure the instance metadata options in the Amazon EC2 User Guide for Linux instances, or Configure the instance metadata options in the Amazon EC2 Windows Guide for Windows instances.

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)
Integer	getHttpPutResponseHopLimit() Limit the number of hops that an instance metadata request can traverse to reach its destination.
String	getHttpTokens() Indicates whether a signed token header is required for instance metadata retrieval requests.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setHttpPutResponseHopLimit(Integer httpPutResponseHopLimit) Limit the number of hops that an instance metadata request can traverse to reach its destination.
void	setHttpTokens(String httpTokens) Indicates whether a signed token header is required for instance metadata retrieval requests.
String	toString() Returns a string representation of this object.
InstanceMetadataOptions	withHttpPutResponseHopLimit(Integer httpPutResponseHopLimit) Limit the number of hops that an instance metadata request can traverse to reach its destination.
InstanceMetadataOptions	withHttpTokens(String httpTokens) Indicates whether a signed token header is required for instance metadata retrieval requests.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

InstanceMetadataOptions

public InstanceMetadataOptions()

Method Detail

setHttpTokens

public void setHttpTokens(String httpTokens)

Indicates whether a signed token header is required for instance metadata retrieval requests. The values affect the response as follows:

• required – When you retrieve the IAM role credentials, version 2.0 credentials are returned in all cases.

• optional – You can include a signed token header in your request to retrieve instance metadata, or you can leave it out. If you include it, version 2.0 credentials are returned for the IAM role. Otherwise, version 1.0 credentials are returned.

The default setting is optional.

Parameters:

httpTokens - Indicates whether a signed token header is required for instance metadata retrieval requests. The values affect the response as follows:

• required – When you retrieve the IAM role credentials, version 2.0 credentials are returned in all cases.

• optional – You can include a signed token header in your request to retrieve instance metadata, or you can leave it out. If you include it, version 2.0 credentials are returned for the IAM role. Otherwise, version 1.0 credentials are returned.

The default setting is optional.

getHttpTokens

public String getHttpTokens()

Indicates whether a signed token header is required for instance metadata retrieval requests. The values affect the response as follows:

• required – When you retrieve the IAM role credentials, version 2.0 credentials are returned in all cases.

• optional – You can include a signed token header in your request to retrieve instance metadata, or you can leave it out. If you include it, version 2.0 credentials are returned for the IAM role. Otherwise, version 1.0 credentials are returned.

The default setting is optional.

Returns:

Indicates whether a signed token header is required for instance metadata retrieval requests. The values affect the response as follows:

• required – When you retrieve the IAM role credentials, version 2.0 credentials are returned in all cases.

• optional – You can include a signed token header in your request to retrieve instance metadata, or you can leave it out. If you include it, version 2.0 credentials are returned for the IAM role. Otherwise, version 1.0 credentials are returned.

The default setting is optional.

withHttpTokens

public InstanceMetadataOptions withHttpTokens(String httpTokens)

Indicates whether a signed token header is required for instance metadata retrieval requests. The values affect the response as follows:

• required – When you retrieve the IAM role credentials, version 2.0 credentials are returned in all cases.

• optional – You can include a signed token header in your request to retrieve instance metadata, or you can leave it out. If you include it, version 2.0 credentials are returned for the IAM role. Otherwise, version 1.0 credentials are returned.

The default setting is optional.

Parameters:

httpTokens - Indicates whether a signed token header is required for instance metadata retrieval requests. The values affect the response as follows:

• required – When you retrieve the IAM role credentials, version 2.0 credentials are returned in all cases.

• optional – You can include a signed token header in your request to retrieve instance metadata, or you can leave it out. If you include it, version 2.0 credentials are returned for the IAM role. Otherwise, version 1.0 credentials are returned.

The default setting is optional.

Returns:

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

setHttpPutResponseHopLimit

public void setHttpPutResponseHopLimit(Integer httpPutResponseHopLimit)

Limit the number of hops that an instance metadata request can traverse to reach its destination. The default is one hop. However, if HTTP tokens are required, container image builds need a minimum of two hops.

Parameters:

httpPutResponseHopLimit - Limit the number of hops that an instance metadata request can traverse to reach its destination. The default is one hop. However, if HTTP tokens are required, container image builds need a minimum of two hops.

getHttpPutResponseHopLimit

public Integer getHttpPutResponseHopLimit()

Limit the number of hops that an instance metadata request can traverse to reach its destination. The default is one hop. However, if HTTP tokens are required, container image builds need a minimum of two hops.

Returns:

Limit the number of hops that an instance metadata request can traverse to reach its destination. The default is one hop. However, if HTTP tokens are required, container image builds need a minimum of two hops.

withHttpPutResponseHopLimit

public InstanceMetadataOptions withHttpPutResponseHopLimit(Integer httpPutResponseHopLimit)

Limit the number of hops that an instance metadata request can traverse to reach its destination. The default is one hop. However, if HTTP tokens are required, container image builds need a minimum of two hops.

Parameters:

httpPutResponseHopLimit - Limit the number of hops that an instance metadata request can traverse to reach its destination. The default is one hop. However, if HTTP tokens are required, container image builds need a minimum of two hops.

Returns:

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

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.