Package software.amazon.awscdk.services.ec2

Class CfnInstance.MetadataOptionsProperty.Builder

java.lang.Object

software.amazon.awscdk.services.ec2.CfnInstance.MetadataOptionsProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnInstance.MetadataOptionsProperty>

Enclosing interface:

CfnInstance.MetadataOptionsProperty

@Stability(Stable)
public static final class CfnInstance.MetadataOptionsProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnInstance.MetadataOptionsProperty>

A builder for CfnInstance.MetadataOptionsProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnInstance.MetadataOptionsProperty	build()	Builds the configured instance.
CfnInstance.MetadataOptionsProperty.Builder	httpEndpoint(String httpEndpoint)	Sets the value of CfnInstance.MetadataOptionsProperty.getHttpEndpoint()
CfnInstance.MetadataOptionsProperty.Builder	httpProtocolIpv6(String httpProtocolIpv6)	Sets the value of CfnInstance.MetadataOptionsProperty.getHttpProtocolIpv6()
CfnInstance.MetadataOptionsProperty.Builder	httpPutResponseHopLimit(Number httpPutResponseHopLimit)	Sets the value of CfnInstance.MetadataOptionsProperty.getHttpPutResponseHopLimit()
CfnInstance.MetadataOptionsProperty.Builder	httpTokens(String httpTokens)	Sets the value of CfnInstance.MetadataOptionsProperty.getHttpTokens()
CfnInstance.MetadataOptionsProperty.Builder	instanceMetadataTags(String instanceMetadataTags)	Sets the value of CfnInstance.MetadataOptionsProperty.getInstanceMetadataTags()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

httpEndpoint

@Stability(Stable)
public CfnInstance.MetadataOptionsProperty.Builder httpEndpoint(String httpEndpoint)

Sets the value of CfnInstance.MetadataOptionsProperty.getHttpEndpoint()

Parameters:

httpEndpoint - 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

Returns:

this

httpProtocolIpv6

@Stability(Stable)
public CfnInstance.MetadataOptionsProperty.Builder httpProtocolIpv6(String httpProtocolIpv6)

Sets the value of CfnInstance.MetadataOptionsProperty.getHttpProtocolIpv6()

Parameters:

httpProtocolIpv6 - Enables or disables the IPv6 endpoint for the instance metadata service. Default: disabled

Returns:

this

httpPutResponseHopLimit

@Stability(Stable)
public CfnInstance.MetadataOptionsProperty.Builder httpPutResponseHopLimit(Number httpPutResponseHopLimit)

Sets the value of CfnInstance.MetadataOptionsProperty.getHttpPutResponseHopLimit()

Parameters:

httpPutResponseHopLimit - The maximum number of hops that the metadata token can travel. Possible values: Integers from 1 to 64

Returns:

this

httpTokens

@Stability(Stable)
public CfnInstance.MetadataOptionsProperty.Builder httpTokens(String httpTokens)

Sets the value of CfnInstance.MetadataOptionsProperty.getHttpTokens()

Parameters:

httpTokens - 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 is v2.0 and the account level default is set to no-preference , the default is required .
• If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0 , but the account level default is set to V1 or V2 , the default is optional .

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 .

Returns:

this

instanceMetadataTags

@Stability(Stable)
public CfnInstance.MetadataOptionsProperty.Builder instanceMetadataTags(String instanceMetadataTags)

Sets the value of CfnInstance.MetadataOptionsProperty.getInstanceMetadataTags()

Parameters:

instanceMetadataTags - 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

Returns:

this

build

@Stability(Stable)
public CfnInstance.MetadataOptionsProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnInstance.MetadataOptionsProperty>

Returns:

a new instance of CfnInstance.MetadataOptionsProperty

Throws:

NullPointerException - if any required attribute was not provided