InstanceMetadataOptionsProperty Struct
The instance metadata options that apply to the HTTP requests that pipeline builds use to launch EC2 build and test instances.
For more information about instance metadata options, see Configure the instance metadata options in the Amazon EC2 User Guide for Linux instances, or Configure the instance metadata options in the Amazon EC2 Windows Guide for Windows instances.
| Source | |
|---|---|
| Type last changed |
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_imagebuilder as imagebuilder } from 'aws-cdk-lib';
const instanceMetadataOptionsProperty: imagebuilder.CfnInfrastructureConfiguration.InstanceMetadataOptionsProperty = {
httpPutResponseHopLimit: 123,
httpTokens: 'httpTokens',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_imagebuilder as imagebuilder
instance_metadata_options_property = imagebuilder.CfnInfrastructureConfiguration.InstanceMetadataOptionsProperty(
http_put_response_hop_limit=123,
http_tokens="httpTokens"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.imagebuilder.*;
InstanceMetadataOptionsProperty instanceMetadataOptionsProperty = InstanceMetadataOptionsProperty.builder()
.httpPutResponseHopLimit(123)
.httpTokens("httpTokens")
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ImageBuilder;
var instanceMetadataOptionsProperty = new InstanceMetadataOptionsProperty {
HttpPutResponseHopLimit = 123,
HttpTokens = "httpTokens"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
instanceMetadataOptionsProperty := &InstanceMetadataOptionsProperty{
HttpPutResponseHopLimit: jsii.Number(123),
HttpTokens: jsii.String("httpTokens"),
}
Properties
httpPutResponseHopLimitoptionalnumberhttp_put_response_hop_limitoptionalint | floathttpPutResponseHopLimitoptionalNumberHttpPutResponseHopLimitoptionaldoubleHttpPutResponseHopLimitoptional*float64 #Limit the number of hops that an instance metadata request can traverse to reach its destination.
The default is one hop. However, if HTTP tokens are required, container image builds need a minimum of two hops.
httpTokensoptionalstringhttp_tokensoptionalstrhttpTokensoptionalStringHttpTokensoptionalstringHttpTokensoptional*string #Indicates whether a signed token header is required for instance metadata retrieval requests.
notes
The values affect the response as follows:
- required – When you retrieve the IAM role credentials, version 2.0 credentials are returned in all cases.
- optional – You can include a signed token header in your request to retrieve instance metadata, or you can leave it out. If you include it, version 2.0 credentials are returned for the IAM role. Otherwise, version 1.0 credentials are returned.
The default setting is optional .