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

#include <InstanceMetadataOptionsRequest.h>

Public Member Functions

 InstanceMetadataOptionsRequest ()
 
 InstanceMetadataOptionsRequest (const Aws::Utils::Xml::XmlNode &xmlNode)
 
InstanceMetadataOptionsRequestoperator= (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 HttpTokensStateGetHttpTokens () const
 
bool HttpTokensHasBeenSet () const
 
void SetHttpTokens (const HttpTokensState &value)
 
void SetHttpTokens (HttpTokensState &&value)
 
InstanceMetadataOptionsRequestWithHttpTokens (const HttpTokensState &value)
 
InstanceMetadataOptionsRequestWithHttpTokens (HttpTokensState &&value)
 
int GetHttpPutResponseHopLimit () const
 
bool HttpPutResponseHopLimitHasBeenSet () const
 
void SetHttpPutResponseHopLimit (int value)
 
InstanceMetadataOptionsRequestWithHttpPutResponseHopLimit (int value)
 
const InstanceMetadataEndpointStateGetHttpEndpoint () const
 
bool HttpEndpointHasBeenSet () const
 
void SetHttpEndpoint (const InstanceMetadataEndpointState &value)
 
void SetHttpEndpoint (InstanceMetadataEndpointState &&value)
 
InstanceMetadataOptionsRequestWithHttpEndpoint (const InstanceMetadataEndpointState &value)
 
InstanceMetadataOptionsRequestWithHttpEndpoint (InstanceMetadataEndpointState &&value)
 

Detailed Description

The metadata options for the instance.

See Also:

AWS API Reference

Definition at line 32 of file InstanceMetadataOptionsRequest.h.

Constructor & Destructor Documentation

◆ InstanceMetadataOptionsRequest() [1/2]

Aws::EC2::Model::InstanceMetadataOptionsRequest::InstanceMetadataOptionsRequest ( )

◆ InstanceMetadataOptionsRequest() [2/2]

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

Member Function Documentation

◆ GetHttpEndpoint()

const InstanceMetadataEndpointState& Aws::EC2::Model::InstanceMetadataOptionsRequest::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 170 of file InstanceMetadataOptionsRequest.h.

◆ GetHttpPutResponseHopLimit()

int Aws::EC2::Model::InstanceMetadataOptionsRequest::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 139 of file InstanceMetadataOptionsRequest.h.

◆ GetHttpTokens()

const HttpTokensState& Aws::EC2::Model::InstanceMetadataOptionsRequest::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 credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.

Definition at line 56 of file InstanceMetadataOptionsRequest.h.

◆ HttpEndpointHasBeenSet()

bool Aws::EC2::Model::InstanceMetadataOptionsRequest::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 179 of file InstanceMetadataOptionsRequest.h.

◆ HttpPutResponseHopLimitHasBeenSet()

bool Aws::EC2::Model::InstanceMetadataOptionsRequest::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 146 of file InstanceMetadataOptionsRequest.h.

◆ HttpTokensHasBeenSet()

bool Aws::EC2::Model::InstanceMetadataOptionsRequest::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 credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.

Definition at line 71 of file InstanceMetadataOptionsRequest.h.

◆ operator=()

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

◆ OutputToStream() [1/2]

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

◆ OutputToStream() [2/2]

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

◆ SetHttpEndpoint() [1/2]

void Aws::EC2::Model::InstanceMetadataOptionsRequest::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 188 of file InstanceMetadataOptionsRequest.h.

◆ SetHttpEndpoint() [2/2]

void Aws::EC2::Model::InstanceMetadataOptionsRequest::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 197 of file InstanceMetadataOptionsRequest.h.

◆ SetHttpPutResponseHopLimit()

void Aws::EC2::Model::InstanceMetadataOptionsRequest::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 153 of file InstanceMetadataOptionsRequest.h.

◆ SetHttpTokens() [1/2]

void Aws::EC2::Model::InstanceMetadataOptionsRequest::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 credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.

Definition at line 86 of file InstanceMetadataOptionsRequest.h.

◆ SetHttpTokens() [2/2]

void Aws::EC2::Model::InstanceMetadataOptionsRequest::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 credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.

Definition at line 101 of file InstanceMetadataOptionsRequest.h.

◆ WithHttpEndpoint() [1/2]

InstanceMetadataOptionsRequest& Aws::EC2::Model::InstanceMetadataOptionsRequest::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 206 of file InstanceMetadataOptionsRequest.h.

◆ WithHttpEndpoint() [2/2]

InstanceMetadataOptionsRequest& Aws::EC2::Model::InstanceMetadataOptionsRequest::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 215 of file InstanceMetadataOptionsRequest.h.

◆ WithHttpPutResponseHopLimit()

InstanceMetadataOptionsRequest& Aws::EC2::Model::InstanceMetadataOptionsRequest::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 160 of file InstanceMetadataOptionsRequest.h.

◆ WithHttpTokens() [1/2]

InstanceMetadataOptionsRequest& Aws::EC2::Model::InstanceMetadataOptionsRequest::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 credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.

Definition at line 116 of file InstanceMetadataOptionsRequest.h.

◆ WithHttpTokens() [2/2]

InstanceMetadataOptionsRequest& Aws::EC2::Model::InstanceMetadataOptionsRequest::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 credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.

Definition at line 131 of file InstanceMetadataOptionsRequest.h.


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