interface MetadataOptionsProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.EC2.CfnInstance.MetadataOptionsProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsec2#CfnInstance_MetadataOptionsProperty |
![]() | software.amazon.awscdk.services.ec2.CfnInstance.MetadataOptionsProperty |
![]() | aws_cdk.aws_ec2.CfnInstance.MetadataOptionsProperty |
![]() | aws-cdk-lib » aws_ec2 » CfnInstance » MetadataOptionsProperty |
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 { aws_ec2 as ec2 } from 'aws-cdk-lib';
const metadataOptionsProperty: ec2.CfnInstance.MetadataOptionsProperty = {
httpEndpoint: 'httpEndpoint',
httpProtocolIpv6: 'httpProtocolIpv6',
httpPutResponseHopLimit: 123,
httpTokens: 'httpTokens',
instanceMetadataTags: 'instanceMetadataTags',
};
Properties
Name | Type | Description |
---|---|---|
http | string | Enables or disables the HTTP metadata endpoint on your instances. |
http | string | Enables or disables the IPv6 endpoint for the instance metadata service. |
http | number | The maximum number of hops that the metadata token can travel. |
http | string | Indicates whether IMDSv2 is required. |
instance | string | Set to enabled to allow access to instance tags from the instance metadata. |
httpEndpoint?
Type:
string
(optional)
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
httpProtocolIpv6?
Type:
string
(optional)
Enables or disables the IPv6 endpoint for the instance metadata service.
Default: disabled
httpPutResponseHopLimit?
Type:
number
(optional, default: 1)
The maximum number of hops that the metadata token can travel.
Possible values: Integers from 1 to 64
httpTokens?
Type:
string
(optional)
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 isv2.0
and the account level default is set tono-preference
, the default isrequired
. - If the value of
ImdsSupport
for the Amazon Machine Image (AMI) for your instance isv2.0
, but the account level default is set toV1 or V2
, the default isoptional
.
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 .
instanceMetadataTags?
Type:
string
(optional)
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