Package software.amazon.awscdk.cfnpropertymixins.services.ec2

Interface CfnLaunchTemplatePropsMixin.MetadataOptionsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLaunchTemplatePropsMixin.MetadataOptionsProperty.Jsii$Proxy

Enclosing class:

CfnLaunchTemplatePropsMixin

@Stability(Stable)
public static interface CfnLaunchTemplatePropsMixin.MetadataOptionsProperty
extends software.amazon.jsii.JsiiSerializable

The metadata options for the instance.

For more information, see Instance metadata and user data in the Amazon EC2 User Guide .

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.cfnpropertymixins.services.ec2.*;
 MetadataOptionsProperty metadataOptionsProperty = MetadataOptionsProperty.builder()
         .httpEndpoint("httpEndpoint")
         .httpProtocolIpv6("httpProtocolIpv6")
         .httpPutResponseHopLimit(123)
         .httpTokens("httpTokens")
         .instanceMetadataTags("instanceMetadataTags")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-metadataoptions.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnLaunchTemplatePropsMixin.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()	Indicates whether IMDSv2 is required.
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 Details

getHttpEndpoint

@Stability(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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-metadataoptions.html#cfn-ec2-launchtemplate-metadataoptions-httpendpoint

getHttpProtocolIpv6

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

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

Default: disabled

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-metadataoptions.html#cfn-ec2-launchtemplate-metadataoptions-httpprotocolipv6

getHttpPutResponseHopLimit

@Stability(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-metadataoptions.html#cfn-ec2-launchtemplate-metadataoptions-httpputresponsehoplimit

getHttpTokens

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

Indicates whether IMDSv2 is required.

• optional - IMDSv2 is optional. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials.
• required - IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.

Default: If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0 , the default is required .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-metadataoptions.html#cfn-ec2-launchtemplate-metadataoptions-httptokens

getInstanceMetadataTags

@Stability(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 View tags for your EC2 instances using instance metadata .

Default: disabled

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-metadataoptions.html#cfn-ec2-launchtemplate-metadataoptions-instancemetadatatags

builder

@Stability(Stable)
static CfnLaunchTemplatePropsMixin.MetadataOptionsProperty.Builder builder()

Returns:

a CfnLaunchTemplatePropsMixin.MetadataOptionsProperty.Builder of CfnLaunchTemplatePropsMixin.MetadataOptionsProperty