Package software.amazon.awscdk.services.imagebuilder

Interface CfnInfrastructureConfiguration.InstanceMetadataOptionsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnInfrastructureConfiguration.InstanceMetadataOptionsProperty.Jsii$Proxy

Enclosing class:

CfnInfrastructureConfiguration

@Stability(Stable)
public static interface CfnInfrastructureConfiguration.InstanceMetadataOptionsProperty
extends software.amazon.jsii.JsiiSerializable

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.

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.imagebuilder.*;
 InstanceMetadataOptionsProperty instanceMetadataOptionsProperty = InstanceMetadataOptionsProperty.builder()
         .httpPutResponseHopLimit(123)
         .httpTokens("httpTokens")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnInfrastructureConfiguration.InstanceMetadataOptionsProperty.Builder	builder()
default Number	getHttpPutResponseHopLimit()	Limit the number of hops that an instance metadata request can traverse to reach its destination.
default String	getHttpTokens()	Indicates whether a signed token header is required for instance metadata retrieval requests.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getHttpPutResponseHopLimit

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

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.

getHttpTokens

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

Indicates whether a signed token header is required for instance metadata retrieval requests.

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 .

builder

@Stability(Stable)
static CfnInfrastructureConfiguration.InstanceMetadataOptionsProperty.Builder builder()

Returns:

a CfnInfrastructureConfiguration.InstanceMetadataOptionsProperty.Builder of CfnInfrastructureConfiguration.InstanceMetadataOptionsProperty