AWS SDK for C++  1.9.109
AWS SDK for C++
Public Member Functions | List of all members
Aws::EC2::Model::InstanceMetadataOptionsResponse Class Reference

#include <InstanceMetadataOptionsResponse.h>

Public Member Functions

 InstanceMetadataOptionsResponse ()
 
 InstanceMetadataOptionsResponse (const Aws::Utils::Xml::XmlNode &xmlNode)
 
InstanceMetadataOptionsResponseoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void OutputToStream (Aws::OStream &ostream, const char *location, unsigned index, const char *locationValue) const
 
void OutputToStream (Aws::OStream &oStream, const char *location) const
 
const InstanceMetadataOptionsStateGetState () const
 
bool StateHasBeenSet () const
 
void SetState (const InstanceMetadataOptionsState &value)
 
void SetState (InstanceMetadataOptionsState &&value)
 
InstanceMetadataOptionsResponseWithState (const InstanceMetadataOptionsState &value)
 
InstanceMetadataOptionsResponseWithState (InstanceMetadataOptionsState &&value)
 
const HttpTokensStateGetHttpTokens () const
 
bool HttpTokensHasBeenSet () const
 
void SetHttpTokens (const HttpTokensState &value)
 
void SetHttpTokens (HttpTokensState &&value)
 
InstanceMetadataOptionsResponseWithHttpTokens (const HttpTokensState &value)
 
InstanceMetadataOptionsResponseWithHttpTokens (HttpTokensState &&value)
 
int GetHttpPutResponseHopLimit () const
 
bool HttpPutResponseHopLimitHasBeenSet () const
 
void SetHttpPutResponseHopLimit (int value)
 
InstanceMetadataOptionsResponseWithHttpPutResponseHopLimit (int value)
 
const InstanceMetadataEndpointStateGetHttpEndpoint () const
 
bool HttpEndpointHasBeenSet () const
 
void SetHttpEndpoint (const InstanceMetadataEndpointState &value)
 
void SetHttpEndpoint (InstanceMetadataEndpointState &&value)
 
InstanceMetadataOptionsResponseWithHttpEndpoint (const InstanceMetadataEndpointState &value)
 
InstanceMetadataOptionsResponseWithHttpEndpoint (InstanceMetadataEndpointState &&value)
 
const InstanceMetadataProtocolStateGetHttpProtocolIpv6 () const
 
bool HttpProtocolIpv6HasBeenSet () const
 
void SetHttpProtocolIpv6 (const InstanceMetadataProtocolState &value)
 
void SetHttpProtocolIpv6 (InstanceMetadataProtocolState &&value)
 
InstanceMetadataOptionsResponseWithHttpProtocolIpv6 (const InstanceMetadataProtocolState &value)
 
InstanceMetadataOptionsResponseWithHttpProtocolIpv6 (InstanceMetadataProtocolState &&value)
 

Detailed Description

The metadata options for the instance.

See Also:

AWS API Reference

Definition at line 34 of file InstanceMetadataOptionsResponse.h.

Constructor & Destructor Documentation

◆ InstanceMetadataOptionsResponse() [1/2]

Aws::EC2::Model::InstanceMetadataOptionsResponse::InstanceMetadataOptionsResponse ( )

◆ InstanceMetadataOptionsResponse() [2/2]

Aws::EC2::Model::InstanceMetadataOptionsResponse::InstanceMetadataOptionsResponse ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ GetHttpEndpoint()

const InstanceMetadataEndpointState& Aws::EC2::Model::InstanceMetadataOptionsResponse::GetHttpEndpoint ( ) const
inline

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.

Definition at line 221 of file InstanceMetadataOptionsResponse.h.

◆ GetHttpProtocolIpv6()

const InstanceMetadataProtocolState& Aws::EC2::Model::InstanceMetadataOptionsResponse::GetHttpProtocolIpv6 ( ) const
inline

Whether or not the IPv6 endpoint for the instance metadata service is enabled or disabled.

Definition at line 273 of file InstanceMetadataOptionsResponse.h.

◆ GetHttpPutResponseHopLimit()

int Aws::EC2::Model::InstanceMetadataOptionsResponse::GetHttpPutResponseHopLimit ( ) const
inline

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

Definition at line 190 of file InstanceMetadataOptionsResponse.h.

◆ GetHttpTokens()

const HttpTokensState& Aws::EC2::Model::InstanceMetadataOptionsResponse::GetHttpTokens ( ) const
inline

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.

Definition at line 107 of file InstanceMetadataOptionsResponse.h.

◆ GetState()

const InstanceMetadataOptionsState& Aws::EC2::Model::InstanceMetadataOptionsResponse::GetState ( ) const
inline

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.

Definition at line 51 of file InstanceMetadataOptionsResponse.h.

◆ HttpEndpointHasBeenSet()

bool Aws::EC2::Model::InstanceMetadataOptionsResponse::HttpEndpointHasBeenSet ( ) const
inline

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.

Definition at line 230 of file InstanceMetadataOptionsResponse.h.

◆ HttpProtocolIpv6HasBeenSet()

bool Aws::EC2::Model::InstanceMetadataOptionsResponse::HttpProtocolIpv6HasBeenSet ( ) const
inline

Whether or not the IPv6 endpoint for the instance metadata service is enabled or disabled.

Definition at line 279 of file InstanceMetadataOptionsResponse.h.

◆ HttpPutResponseHopLimitHasBeenSet()

bool Aws::EC2::Model::InstanceMetadataOptionsResponse::HttpPutResponseHopLimitHasBeenSet ( ) const
inline

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

Definition at line 197 of file InstanceMetadataOptionsResponse.h.

◆ HttpTokensHasBeenSet()

bool Aws::EC2::Model::InstanceMetadataOptionsResponse::HttpTokensHasBeenSet ( ) const
inline

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.

Definition at line 122 of file InstanceMetadataOptionsResponse.h.

◆ operator=()

InstanceMetadataOptionsResponse& Aws::EC2::Model::InstanceMetadataOptionsResponse::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OutputToStream() [1/2]

void Aws::EC2::Model::InstanceMetadataOptionsResponse::OutputToStream ( Aws::OStream oStream,
const char *  location 
) const

◆ OutputToStream() [2/2]

void Aws::EC2::Model::InstanceMetadataOptionsResponse::OutputToStream ( Aws::OStream ostream,
const char *  location,
unsigned  index,
const char *  locationValue 
) const

◆ SetHttpEndpoint() [1/2]

void Aws::EC2::Model::InstanceMetadataOptionsResponse::SetHttpEndpoint ( const InstanceMetadataEndpointState value)
inline

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.

Definition at line 239 of file InstanceMetadataOptionsResponse.h.

◆ SetHttpEndpoint() [2/2]

void Aws::EC2::Model::InstanceMetadataOptionsResponse::SetHttpEndpoint ( InstanceMetadataEndpointState &&  value)
inline

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.

Definition at line 248 of file InstanceMetadataOptionsResponse.h.

◆ SetHttpProtocolIpv6() [1/2]

void Aws::EC2::Model::InstanceMetadataOptionsResponse::SetHttpProtocolIpv6 ( const InstanceMetadataProtocolState value)
inline

Whether or not the IPv6 endpoint for the instance metadata service is enabled or disabled.

Definition at line 285 of file InstanceMetadataOptionsResponse.h.

◆ SetHttpProtocolIpv6() [2/2]

void Aws::EC2::Model::InstanceMetadataOptionsResponse::SetHttpProtocolIpv6 ( InstanceMetadataProtocolState &&  value)
inline

Whether or not the IPv6 endpoint for the instance metadata service is enabled or disabled.

Definition at line 291 of file InstanceMetadataOptionsResponse.h.

◆ SetHttpPutResponseHopLimit()

void Aws::EC2::Model::InstanceMetadataOptionsResponse::SetHttpPutResponseHopLimit ( int  value)
inline

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

Definition at line 204 of file InstanceMetadataOptionsResponse.h.

◆ SetHttpTokens() [1/2]

void Aws::EC2::Model::InstanceMetadataOptionsResponse::SetHttpTokens ( const HttpTokensState value)
inline

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.

Definition at line 137 of file InstanceMetadataOptionsResponse.h.

◆ SetHttpTokens() [2/2]

void Aws::EC2::Model::InstanceMetadataOptionsResponse::SetHttpTokens ( HttpTokensState &&  value)
inline

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.

Definition at line 152 of file InstanceMetadataOptionsResponse.h.

◆ SetState() [1/2]

void Aws::EC2::Model::InstanceMetadataOptionsResponse::SetState ( const InstanceMetadataOptionsState value)
inline

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.

Definition at line 67 of file InstanceMetadataOptionsResponse.h.

◆ SetState() [2/2]

void Aws::EC2::Model::InstanceMetadataOptionsResponse::SetState ( InstanceMetadataOptionsState &&  value)
inline

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.

Definition at line 75 of file InstanceMetadataOptionsResponse.h.

◆ StateHasBeenSet()

bool Aws::EC2::Model::InstanceMetadataOptionsResponse::StateHasBeenSet ( ) const
inline

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.

Definition at line 59 of file InstanceMetadataOptionsResponse.h.

◆ WithHttpEndpoint() [1/2]

InstanceMetadataOptionsResponse& Aws::EC2::Model::InstanceMetadataOptionsResponse::WithHttpEndpoint ( const InstanceMetadataEndpointState value)
inline

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.

Definition at line 257 of file InstanceMetadataOptionsResponse.h.

◆ WithHttpEndpoint() [2/2]

InstanceMetadataOptionsResponse& Aws::EC2::Model::InstanceMetadataOptionsResponse::WithHttpEndpoint ( InstanceMetadataEndpointState &&  value)
inline

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.

Definition at line 266 of file InstanceMetadataOptionsResponse.h.

◆ WithHttpProtocolIpv6() [1/2]

InstanceMetadataOptionsResponse& Aws::EC2::Model::InstanceMetadataOptionsResponse::WithHttpProtocolIpv6 ( const InstanceMetadataProtocolState value)
inline

Whether or not the IPv6 endpoint for the instance metadata service is enabled or disabled.

Definition at line 297 of file InstanceMetadataOptionsResponse.h.

◆ WithHttpProtocolIpv6() [2/2]

InstanceMetadataOptionsResponse& Aws::EC2::Model::InstanceMetadataOptionsResponse::WithHttpProtocolIpv6 ( InstanceMetadataProtocolState &&  value)
inline

Whether or not the IPv6 endpoint for the instance metadata service is enabled or disabled.

Definition at line 303 of file InstanceMetadataOptionsResponse.h.

◆ WithHttpPutResponseHopLimit()

InstanceMetadataOptionsResponse& Aws::EC2::Model::InstanceMetadataOptionsResponse::WithHttpPutResponseHopLimit ( int  value)
inline

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

Definition at line 211 of file InstanceMetadataOptionsResponse.h.

◆ WithHttpTokens() [1/2]

InstanceMetadataOptionsResponse& Aws::EC2::Model::InstanceMetadataOptionsResponse::WithHttpTokens ( const HttpTokensState value)
inline

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.

Definition at line 167 of file InstanceMetadataOptionsResponse.h.

◆ WithHttpTokens() [2/2]

InstanceMetadataOptionsResponse& Aws::EC2::Model::InstanceMetadataOptionsResponse::WithHttpTokens ( HttpTokensState &&  value)
inline

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.

Definition at line 182 of file InstanceMetadataOptionsResponse.h.

◆ WithState() [1/2]

InstanceMetadataOptionsResponse& Aws::EC2::Model::InstanceMetadataOptionsResponse::WithState ( const InstanceMetadataOptionsState value)
inline

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.

Definition at line 83 of file InstanceMetadataOptionsResponse.h.

◆ WithState() [2/2]

InstanceMetadataOptionsResponse& Aws::EC2::Model::InstanceMetadataOptionsResponse::WithState ( InstanceMetadataOptionsState &&  value)
inline

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.

Definition at line 91 of file InstanceMetadataOptionsResponse.h.


The documentation for this class was generated from the following file: