software.amazon.awssdk.services.ec2.model

Interface InstanceMetadataOptionsResponse.Builder

All Superinterfaces:

Buildable, CopyableBuilder<InstanceMetadataOptionsResponse.Builder,InstanceMetadataOptionsResponse>, SdkBuilder<InstanceMetadataOptionsResponse.Builder,InstanceMetadataOptionsResponse>, SdkPojo

Enclosing class:

InstanceMetadataOptionsResponse

public static interface InstanceMetadataOptionsResponse.Builder
extends SdkPojo, CopyableBuilder<InstanceMetadataOptionsResponse.Builder,InstanceMetadataOptionsResponse>

Method Summary

Modifier and Type	Method and Description
InstanceMetadataOptionsResponse.Builder	httpEndpoint(InstanceMetadataEndpointState httpEndpoint) This parameter enables or disables the HTTP metadata endpoint on your instances.
InstanceMetadataOptionsResponse.Builder	httpEndpoint(String httpEndpoint) This parameter enables or disables the HTTP metadata endpoint on your instances.
InstanceMetadataOptionsResponse.Builder	httpPutResponseHopLimit(Integer httpPutResponseHopLimit) The desired HTTP PUT response hop limit for instance metadata requests.
InstanceMetadataOptionsResponse.Builder	httpTokens(HttpTokensState httpTokens) The state of token usage for your instance metadata requests.
InstanceMetadataOptionsResponse.Builder	httpTokens(String httpTokens) The state of token usage for your instance metadata requests.
InstanceMetadataOptionsResponse.Builder	state(InstanceMetadataOptionsState state) The state of the metadata option changes.
InstanceMetadataOptionsResponse.Builder	state(String state) The state of the metadata option changes.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

state

InstanceMetadataOptionsResponse.Builder state(String state)

The state of the metadata option changes.

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

applied - The metadata options have been successfully applied on the instance.

Parameters:

state - The state of the metadata option changes.

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

applied - The metadata options have been successfully applied on the instance.

Returns:

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

See Also:

InstanceMetadataOptionsState, InstanceMetadataOptionsState

state

InstanceMetadataOptionsResponse.Builder state(InstanceMetadataOptionsState state)

The state of the metadata option changes.

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

applied - The metadata options have been successfully applied on the instance.

Parameters:

state - The state of the metadata option changes.

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

applied - The metadata options have been successfully applied on the instance.

Returns:

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

See Also:

InstanceMetadataOptionsState, InstanceMetadataOptionsState

httpTokens

InstanceMetadataOptionsResponse.Builder httpTokens(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 credential 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 credential 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, HttpTokensState

httpTokens

InstanceMetadataOptionsResponse.Builder httpTokens(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 credential 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 credential 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, HttpTokensState

httpPutResponseHopLimit

InstanceMetadataOptionsResponse.Builder httpPutResponseHopLimit(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.

httpEndpoint

InstanceMetadataOptionsResponse.Builder httpEndpoint(String httpEndpoint)

This parameter 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 - This parameter 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, InstanceMetadataEndpointState

httpEndpoint

InstanceMetadataOptionsResponse.Builder httpEndpoint(InstanceMetadataEndpointState httpEndpoint)

This parameter 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 - This parameter 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, InstanceMetadataEndpointState