public static interface CfnLaunchTemplate.MetadataOptionsProperty
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.services.ec2.*; MetadataOptionsProperty metadataOptionsProperty = MetadataOptionsProperty.builder() .httpEndpoint("httpEndpoint") .httpProtocolIpv6("httpProtocolIpv6") .httpPutResponseHopLimit(123) .httpTokens("httpTokens") .instanceMetadataTags("instanceMetadataTags") .build();
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 |
Modifier and Type | Method and Description |
---|---|
static CfnLaunchTemplate.MetadataOptionsProperty.Builder |
builder() |
default java.lang.String |
getHttpEndpoint()
Enables or disables the HTTP metadata endpoint on your instances.
|
default java.lang.String |
getHttpProtocolIpv6()
Enables or disables the IPv6 endpoint for the instance metadata service.
|
default java.lang.Number |
getHttpPutResponseHopLimit()
The desired HTTP PUT response hop limit for instance metadata requests.
|
default java.lang.String |
getHttpTokens()
IMDSv2 uses token-backed sessions.
|
default java.lang.String |
getInstanceMetadataTags()
Set to `enabled` to allow access to instance tags from the instance metadata.
|
default java.lang.String getHttpEndpoint()
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.
default java.lang.String getHttpProtocolIpv6()
Default: disabled
default java.lang.Number getHttpPutResponseHopLimit()
The larger the number, the further instance metadata requests can travel.
Default: 1
Possible values: Integers from 1 to 64
default java.lang.String getHttpTokens()
Set the use of HTTP tokens to optional
(in other words, set the use of IMDSv2 to optional
) or required
(in other words, set the use of IMDSv2 to required
).
optional
- When IMDSv2 is optional, you can choose to retrieve instance metadata with or without a session token in your request. If you retrieve the IAM role credentials without a token, the IMDSv1 role credentials are returned. If you retrieve the IAM role credentials using a valid session token, the IMDSv2 role credentials are returned.required
- When IMDSv2 is required, you must send a session token with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.
Default: optional
default java.lang.String getInstanceMetadataTags()
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
static CfnLaunchTemplate.MetadataOptionsProperty.Builder builder()