software.amazon.awscdk.services.ec2

Interface CfnLaunchTemplate.MetadataOptionsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLaunchTemplate.MetadataOptionsProperty.Jsii$Proxy

Enclosing class:

CfnLaunchTemplate

@Stability(value=Stable)
public static interface CfnLaunchTemplate.MetadataOptionsProperty
extends software.amazon.jsii.JsiiSerializable

Specifies the metadata options for the instance.

MetadataOptions is a property of AWS::EC2::LaunchTemplate LaunchTemplateData .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 MetadataOptionsProperty metadataOptionsProperty = MetadataOptionsProperty.builder()
         .httpEndpoint("httpEndpoint")
         .httpProtocolIpv6("httpProtocolIpv6")
         .httpPutResponseHopLimit(123)
         .httpTokens("httpTokens")
         .instanceMetadataTags("instanceMetadataTags")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnLaunchTemplate.MetadataOptionsProperty.Builder A builder for CfnLaunchTemplate.MetadataOptionsProperty
static class	CfnLaunchTemplate.MetadataOptionsProperty.Jsii$Proxy An implementation for CfnLaunchTemplate.MetadataOptionsProperty

Method Summary

Modifier and Type	Method and Description
static CfnLaunchTemplate.MetadataOptionsProperty.Builder	builder()
default String	getHttpEndpoint() Enables or disables the HTTP metadata endpoint on your instances.
default String	getHttpProtocolIpv6() Enables or disables the IPv6 endpoint for the instance metadata service.
default Number	getHttpPutResponseHopLimit() The desired HTTP PUT response hop limit for instance metadata requests.
default String	getHttpTokens() The state of token usage for your instance metadata requests.
default String	getInstanceMetadataTags() Set to `enabled` to allow access to instance tags from the instance metadata.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getHttpEndpoint

@Stability(value=Stable)
 @Nullable
default String getHttpEndpoint()

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.

getHttpProtocolIpv6

@Stability(value=Stable)
 @Nullable
default String getHttpProtocolIpv6()

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

Default: disabled

getHttpPutResponseHopLimit

@Stability(value=Stable)
 @Nullable
default Number getHttpPutResponseHopLimit()

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

getHttpTokens

@Stability(value=Stable)
 @Nullable
default String getHttpTokens()

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.

getInstanceMetadataTags

@Stability(value=Stable)
 @Nullable
default String getInstanceMetadataTags()

Set to `enabled` to allow access to instance tags from the instance metadata.

Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata .

Default: disabled

builder

@Stability(value=Stable)
static CfnLaunchTemplate.MetadataOptionsProperty.Builder builder()

Returns:

a CfnLaunchTemplate.MetadataOptionsProperty.Builder of CfnLaunchTemplate.MetadataOptionsProperty