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

#include <LaunchTemplateInstanceMetadataOptions.h>

Public Member Functions

 LaunchTemplateInstanceMetadataOptions ()
 
 LaunchTemplateInstanceMetadataOptions (const Aws::Utils::Xml::XmlNode &xmlNode)
 
LaunchTemplateInstanceMetadataOptionsoperator= (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 LaunchTemplateInstanceMetadataOptionsStateGetState () const
 
bool StateHasBeenSet () const
 
void SetState (const LaunchTemplateInstanceMetadataOptionsState &value)
 
void SetState (LaunchTemplateInstanceMetadataOptionsState &&value)
 
LaunchTemplateInstanceMetadataOptionsWithState (const LaunchTemplateInstanceMetadataOptionsState &value)
 
LaunchTemplateInstanceMetadataOptionsWithState (LaunchTemplateInstanceMetadataOptionsState &&value)
 
const LaunchTemplateHttpTokensStateGetHttpTokens () const
 
bool HttpTokensHasBeenSet () const
 
void SetHttpTokens (const LaunchTemplateHttpTokensState &value)
 
void SetHttpTokens (LaunchTemplateHttpTokensState &&value)
 
LaunchTemplateInstanceMetadataOptionsWithHttpTokens (const LaunchTemplateHttpTokensState &value)
 
LaunchTemplateInstanceMetadataOptionsWithHttpTokens (LaunchTemplateHttpTokensState &&value)
 
int GetHttpPutResponseHopLimit () const
 
bool HttpPutResponseHopLimitHasBeenSet () const
 
void SetHttpPutResponseHopLimit (int value)
 
LaunchTemplateInstanceMetadataOptionsWithHttpPutResponseHopLimit (int value)
 
const LaunchTemplateInstanceMetadataEndpointStateGetHttpEndpoint () const
 
bool HttpEndpointHasBeenSet () const
 
void SetHttpEndpoint (const LaunchTemplateInstanceMetadataEndpointState &value)
 
void SetHttpEndpoint (LaunchTemplateInstanceMetadataEndpointState &&value)
 
LaunchTemplateInstanceMetadataOptionsWithHttpEndpoint (const LaunchTemplateInstanceMetadataEndpointState &value)
 
LaunchTemplateInstanceMetadataOptionsWithHttpEndpoint (LaunchTemplateInstanceMetadataEndpointState &&value)
 
const LaunchTemplateInstanceMetadataProtocolIpv6GetHttpProtocolIpv6 () const
 
bool HttpProtocolIpv6HasBeenSet () const
 
void SetHttpProtocolIpv6 (const LaunchTemplateInstanceMetadataProtocolIpv6 &value)
 
void SetHttpProtocolIpv6 (LaunchTemplateInstanceMetadataProtocolIpv6 &&value)
 
LaunchTemplateInstanceMetadataOptionsWithHttpProtocolIpv6 (const LaunchTemplateInstanceMetadataProtocolIpv6 &value)
 
LaunchTemplateInstanceMetadataOptionsWithHttpProtocolIpv6 (LaunchTemplateInstanceMetadataProtocolIpv6 &&value)
 

Detailed Description

The metadata options for the instance. For more information, see Instance Metadata and User Data in the Amazon Elastic Compute Cloud User Guide.

See Also:

AWS API Reference

Definition at line 37 of file LaunchTemplateInstanceMetadataOptions.h.

Constructor & Destructor Documentation

◆ LaunchTemplateInstanceMetadataOptions() [1/2]

Aws::EC2::Model::LaunchTemplateInstanceMetadataOptions::LaunchTemplateInstanceMetadataOptions ( )

◆ LaunchTemplateInstanceMetadataOptions() [2/2]

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

Member Function Documentation

◆ GetHttpEndpoint()

const LaunchTemplateInstanceMetadataEndpointState& Aws::EC2::Model::LaunchTemplateInstanceMetadataOptions::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 224 of file LaunchTemplateInstanceMetadataOptions.h.

◆ GetHttpProtocolIpv6()

const LaunchTemplateInstanceMetadataProtocolIpv6& Aws::EC2::Model::LaunchTemplateInstanceMetadataOptions::GetHttpProtocolIpv6 ( ) const
inline

Enables or disables the IPv6 endpoint for the instance metadata service.

Default: disabled

Definition at line 276 of file LaunchTemplateInstanceMetadataOptions.h.

◆ GetHttpPutResponseHopLimit()

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

◆ GetHttpTokens()

const LaunchTemplateHttpTokensState& Aws::EC2::Model::LaunchTemplateInstanceMetadataOptions::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 110 of file LaunchTemplateInstanceMetadataOptions.h.

◆ GetState()

const LaunchTemplateInstanceMetadataOptionsState& Aws::EC2::Model::LaunchTemplateInstanceMetadataOptions::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 54 of file LaunchTemplateInstanceMetadataOptions.h.

◆ HttpEndpointHasBeenSet()

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

◆ HttpProtocolIpv6HasBeenSet()

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

Enables or disables the IPv6 endpoint for the instance metadata service.

Default: disabled

Definition at line 282 of file LaunchTemplateInstanceMetadataOptions.h.

◆ HttpPutResponseHopLimitHasBeenSet()

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

◆ HttpTokensHasBeenSet()

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

◆ operator=()

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

◆ OutputToStream() [1/2]

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

◆ OutputToStream() [2/2]

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

◆ SetHttpEndpoint() [1/2]

void Aws::EC2::Model::LaunchTemplateInstanceMetadataOptions::SetHttpEndpoint ( const LaunchTemplateInstanceMetadataEndpointState 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 242 of file LaunchTemplateInstanceMetadataOptions.h.

◆ SetHttpEndpoint() [2/2]

void Aws::EC2::Model::LaunchTemplateInstanceMetadataOptions::SetHttpEndpoint ( LaunchTemplateInstanceMetadataEndpointState &&  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 251 of file LaunchTemplateInstanceMetadataOptions.h.

◆ SetHttpProtocolIpv6() [1/2]

void Aws::EC2::Model::LaunchTemplateInstanceMetadataOptions::SetHttpProtocolIpv6 ( const LaunchTemplateInstanceMetadataProtocolIpv6 value)
inline

Enables or disables the IPv6 endpoint for the instance metadata service.

Default: disabled

Definition at line 288 of file LaunchTemplateInstanceMetadataOptions.h.

◆ SetHttpProtocolIpv6() [2/2]

void Aws::EC2::Model::LaunchTemplateInstanceMetadataOptions::SetHttpProtocolIpv6 ( LaunchTemplateInstanceMetadataProtocolIpv6 &&  value)
inline

Enables or disables the IPv6 endpoint for the instance metadata service.

Default: disabled

Definition at line 294 of file LaunchTemplateInstanceMetadataOptions.h.

◆ SetHttpPutResponseHopLimit()

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

◆ SetHttpTokens() [1/2]

void Aws::EC2::Model::LaunchTemplateInstanceMetadataOptions::SetHttpTokens ( const LaunchTemplateHttpTokensState 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 140 of file LaunchTemplateInstanceMetadataOptions.h.

◆ SetHttpTokens() [2/2]

void Aws::EC2::Model::LaunchTemplateInstanceMetadataOptions::SetHttpTokens ( LaunchTemplateHttpTokensState &&  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 155 of file LaunchTemplateInstanceMetadataOptions.h.

◆ SetState() [1/2]

void Aws::EC2::Model::LaunchTemplateInstanceMetadataOptions::SetState ( const LaunchTemplateInstanceMetadataOptionsState 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 70 of file LaunchTemplateInstanceMetadataOptions.h.

◆ SetState() [2/2]

void Aws::EC2::Model::LaunchTemplateInstanceMetadataOptions::SetState ( LaunchTemplateInstanceMetadataOptionsState &&  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 78 of file LaunchTemplateInstanceMetadataOptions.h.

◆ StateHasBeenSet()

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

◆ WithHttpEndpoint() [1/2]

LaunchTemplateInstanceMetadataOptions& Aws::EC2::Model::LaunchTemplateInstanceMetadataOptions::WithHttpEndpoint ( const LaunchTemplateInstanceMetadataEndpointState 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 260 of file LaunchTemplateInstanceMetadataOptions.h.

◆ WithHttpEndpoint() [2/2]

LaunchTemplateInstanceMetadataOptions& Aws::EC2::Model::LaunchTemplateInstanceMetadataOptions::WithHttpEndpoint ( LaunchTemplateInstanceMetadataEndpointState &&  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 269 of file LaunchTemplateInstanceMetadataOptions.h.

◆ WithHttpProtocolIpv6() [1/2]

LaunchTemplateInstanceMetadataOptions& Aws::EC2::Model::LaunchTemplateInstanceMetadataOptions::WithHttpProtocolIpv6 ( const LaunchTemplateInstanceMetadataProtocolIpv6 value)
inline

Enables or disables the IPv6 endpoint for the instance metadata service.

Default: disabled

Definition at line 300 of file LaunchTemplateInstanceMetadataOptions.h.

◆ WithHttpProtocolIpv6() [2/2]

LaunchTemplateInstanceMetadataOptions& Aws::EC2::Model::LaunchTemplateInstanceMetadataOptions::WithHttpProtocolIpv6 ( LaunchTemplateInstanceMetadataProtocolIpv6 &&  value)
inline

Enables or disables the IPv6 endpoint for the instance metadata service.

Default: disabled

Definition at line 306 of file LaunchTemplateInstanceMetadataOptions.h.

◆ WithHttpPutResponseHopLimit()

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

◆ WithHttpTokens() [1/2]

LaunchTemplateInstanceMetadataOptions& Aws::EC2::Model::LaunchTemplateInstanceMetadataOptions::WithHttpTokens ( const LaunchTemplateHttpTokensState 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 170 of file LaunchTemplateInstanceMetadataOptions.h.

◆ WithHttpTokens() [2/2]

LaunchTemplateInstanceMetadataOptions& Aws::EC2::Model::LaunchTemplateInstanceMetadataOptions::WithHttpTokens ( LaunchTemplateHttpTokensState &&  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 185 of file LaunchTemplateInstanceMetadataOptions.h.

◆ WithState() [1/2]

LaunchTemplateInstanceMetadataOptions& Aws::EC2::Model::LaunchTemplateInstanceMetadataOptions::WithState ( const LaunchTemplateInstanceMetadataOptionsState 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 86 of file LaunchTemplateInstanceMetadataOptions.h.

◆ WithState() [2/2]

LaunchTemplateInstanceMetadataOptions& Aws::EC2::Model::LaunchTemplateInstanceMetadataOptions::WithState ( LaunchTemplateInstanceMetadataOptionsState &&  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 94 of file LaunchTemplateInstanceMetadataOptions.h.


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