Class CfnInstance.MetadataOptionsProperty

Specifies the metadata options for the instance.

Inheritance

object

CfnInstance.MetadataOptionsProperty

Implements

CfnInstance.IMetadataOptionsProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.EC2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnInstance.MetadataOptionsProperty : CfnInstance.IMetadataOptionsProperty

Syntax (vb)

Public Class CfnInstance.MetadataOptionsProperty Implements CfnInstance.IMetadataOptionsProperty

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.EC2;

             var metadataOptionsProperty = new MetadataOptionsProperty {
                 HttpEndpoint = "httpEndpoint",
                 HttpProtocolIpv6 = "httpProtocolIpv6",
                 HttpPutResponseHopLimit = 123,
                 HttpTokens = "httpTokens",
                 InstanceMetadataTags = "instanceMetadataTags"
             };

Synopsis

Constructors

MetadataOptionsProperty()

Specifies the metadata options for the instance.

Properties

HttpEndpoint	Enables or disables the HTTP metadata endpoint on your instances.
HttpProtocolIpv6	Enables or disables the IPv6 endpoint for the instance metadata service.
HttpPutResponseHopLimit	The maximum number of hops that the metadata token can travel.
HttpTokens	Indicates whether IMDSv2 is required.
InstanceMetadataTags	Set to enabled to allow access to instance tags from the instance metadata.

Constructors

MetadataOptionsProperty()

Specifies the metadata options for the instance.

public MetadataOptionsProperty()

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.EC2;

             var metadataOptionsProperty = new MetadataOptionsProperty {
                 HttpEndpoint = "httpEndpoint",
                 HttpProtocolIpv6 = "httpProtocolIpv6",
                 HttpPutResponseHopLimit = 123,
                 HttpTokens = "httpTokens",
                 InstanceMetadataTags = "instanceMetadataTags"
             };

Properties

HttpEndpoint

Enables or disables the HTTP metadata endpoint on your instances.

public string? HttpEndpoint { get; set; }

Property Value

string

Remarks

If you specify a value of disabled , you cannot access your instance metadata.

Default: enabled

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

HttpProtocolIpv6

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

public string? HttpProtocolIpv6 { get; set; }

Property Value

string

Remarks

Default: disabled

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

HttpPutResponseHopLimit

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

public double? HttpPutResponseHopLimit { get; set; }

Property Value

double?

Remarks

Possible values: Integers from 1 to 64

Default: - 1

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

HttpTokens

Indicates whether IMDSv2 is required.

public string? HttpTokens { get; set; }

Property Value

string

Remarks

Default:

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

InstanceMetadataTags

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

public string? InstanceMetadataTags { get; set; }

Property Value

string

Remarks

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

Implements

CfnInstance.IMetadataOptionsProperty