Package software.amazon.awscdk.services.ec2

Interface CfnInstance.MetadataOptionsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnInstance.MetadataOptionsProperty.Jsii$Proxy

Enclosing class:

CfnInstance

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

Specifies the metadata options for the instance.

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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnInstance.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 maximum number of hops that the metadata token can travel.
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 you specify a value of disabled , you cannot access your instance metadata.

Default: enabled

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-metadataoptions.html#cfn-ec2-instance-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-instance-metadataoptions.html#cfn-ec2-instance-metadataoptions-httpprotocolipv6

getHttpPutResponseHopLimit

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

The maximum number of hops that the metadata token can travel.

Possible values: Integers from 1 to 64

Default: - 1

See Also:

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

getHttpTokens

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

Indicates whether IMDSv2 is required.

• optional - IMDSv2 is optional, which means that you can use either IMDSv2 or IMDSv1.
• required - IMDSv2 is required, which means that IMDSv1 is disabled, and you must use IMDSv2.

Default:

• If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0 and the account level default is set to no-preference , the default is required .
• If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0 , but the account level default is set to V1 or V2 , the default is optional .

The default value can also be affected by other combinations of parameters. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-metadataoptions.html#cfn-ec2-instance-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 Work with instance tags using the instance metadata .

Default: disabled

See Also:

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

builder

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

Returns:

a CfnInstance.MetadataOptionsProperty.Builder of CfnInstance.MetadataOptionsProperty