AWS SDK for C++  1.9.129
AWS SDK for C++
Public Member Functions | List of all members
Aws::AutoScaling::Model::InstanceMetadataOptions Class Reference

#include <InstanceMetadataOptions.h>

Public Member Functions

 InstanceMetadataOptions ()
 
 InstanceMetadataOptions (const Aws::Utils::Xml::XmlNode &xmlNode)
 
InstanceMetadataOptionsoperator= (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 InstanceMetadataHttpTokensStateGetHttpTokens () const
 
bool HttpTokensHasBeenSet () const
 
void SetHttpTokens (const InstanceMetadataHttpTokensState &value)
 
void SetHttpTokens (InstanceMetadataHttpTokensState &&value)
 
InstanceMetadataOptionsWithHttpTokens (const InstanceMetadataHttpTokensState &value)
 
InstanceMetadataOptionsWithHttpTokens (InstanceMetadataHttpTokensState &&value)
 
int GetHttpPutResponseHopLimit () const
 
bool HttpPutResponseHopLimitHasBeenSet () const
 
void SetHttpPutResponseHopLimit (int value)
 
InstanceMetadataOptionsWithHttpPutResponseHopLimit (int value)
 
const InstanceMetadataEndpointStateGetHttpEndpoint () const
 
bool HttpEndpointHasBeenSet () const
 
void SetHttpEndpoint (const InstanceMetadataEndpointState &value)
 
void SetHttpEndpoint (InstanceMetadataEndpointState &&value)
 
InstanceMetadataOptionsWithHttpEndpoint (const InstanceMetadataEndpointState &value)
 
InstanceMetadataOptionsWithHttpEndpoint (InstanceMetadataEndpointState &&value)
 

Detailed Description

The metadata options for the instances. For more information, see Configuring the Instance Metadata Options in the Amazon EC2 Auto Scaling User Guide.

See Also:

AWS API Reference

Definition at line 35 of file InstanceMetadataOptions.h.

Constructor & Destructor Documentation

◆ InstanceMetadataOptions() [1/2]

Aws::AutoScaling::Model::InstanceMetadataOptions::InstanceMetadataOptions ( )

◆ InstanceMetadataOptions() [2/2]

Aws::AutoScaling::Model::InstanceMetadataOptions::InstanceMetadataOptions ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ GetHttpEndpoint()

const InstanceMetadataEndpointState& Aws::AutoScaling::Model::InstanceMetadataOptions::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 173 of file InstanceMetadataOptions.h.

◆ GetHttpPutResponseHopLimit()

int Aws::AutoScaling::Model::InstanceMetadataOptions::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

Definition at line 142 of file InstanceMetadataOptions.h.

◆ GetHttpTokens()

const InstanceMetadataHttpTokensState& Aws::AutoScaling::Model::InstanceMetadataOptions::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 59 of file InstanceMetadataOptions.h.

◆ HttpEndpointHasBeenSet()

bool Aws::AutoScaling::Model::InstanceMetadataOptions::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 182 of file InstanceMetadataOptions.h.

◆ HttpPutResponseHopLimitHasBeenSet()

bool Aws::AutoScaling::Model::InstanceMetadataOptions::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

Definition at line 149 of file InstanceMetadataOptions.h.

◆ HttpTokensHasBeenSet()

bool Aws::AutoScaling::Model::InstanceMetadataOptions::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 74 of file InstanceMetadataOptions.h.

◆ operator=()

InstanceMetadataOptions& Aws::AutoScaling::Model::InstanceMetadataOptions::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OutputToStream() [1/2]

void Aws::AutoScaling::Model::InstanceMetadataOptions::OutputToStream ( Aws::OStream oStream,
const char *  location 
) const

◆ OutputToStream() [2/2]

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

◆ SetHttpEndpoint() [1/2]

void Aws::AutoScaling::Model::InstanceMetadataOptions::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 191 of file InstanceMetadataOptions.h.

◆ SetHttpEndpoint() [2/2]

void Aws::AutoScaling::Model::InstanceMetadataOptions::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 200 of file InstanceMetadataOptions.h.

◆ SetHttpPutResponseHopLimit()

void Aws::AutoScaling::Model::InstanceMetadataOptions::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

Definition at line 156 of file InstanceMetadataOptions.h.

◆ SetHttpTokens() [1/2]

void Aws::AutoScaling::Model::InstanceMetadataOptions::SetHttpTokens ( const InstanceMetadataHttpTokensState 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 89 of file InstanceMetadataOptions.h.

◆ SetHttpTokens() [2/2]

void Aws::AutoScaling::Model::InstanceMetadataOptions::SetHttpTokens ( InstanceMetadataHttpTokensState &&  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 104 of file InstanceMetadataOptions.h.

◆ WithHttpEndpoint() [1/2]

InstanceMetadataOptions& Aws::AutoScaling::Model::InstanceMetadataOptions::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 209 of file InstanceMetadataOptions.h.

◆ WithHttpEndpoint() [2/2]

InstanceMetadataOptions& Aws::AutoScaling::Model::InstanceMetadataOptions::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 218 of file InstanceMetadataOptions.h.

◆ WithHttpPutResponseHopLimit()

InstanceMetadataOptions& Aws::AutoScaling::Model::InstanceMetadataOptions::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

Definition at line 163 of file InstanceMetadataOptions.h.

◆ WithHttpTokens() [1/2]

InstanceMetadataOptions& Aws::AutoScaling::Model::InstanceMetadataOptions::WithHttpTokens ( const InstanceMetadataHttpTokensState 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 119 of file InstanceMetadataOptions.h.

◆ WithHttpTokens() [2/2]

InstanceMetadataOptions& Aws::AutoScaling::Model::InstanceMetadataOptions::WithHttpTokens ( InstanceMetadataHttpTokensState &&  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 134 of file InstanceMetadataOptions.h.


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