Package software.amazon.awssdk.services.ec2.model

Interface LaunchTemplateInstanceMetadataOptionsRequest.Builder

All Superinterfaces:
Buildable, CopyableBuilder<LaunchTemplateInstanceMetadataOptionsRequest.Builder,LaunchTemplateInstanceMetadataOptionsRequest>, SdkBuilder<LaunchTemplateInstanceMetadataOptionsRequest.Builder,LaunchTemplateInstanceMetadataOptionsRequest>, SdkPojo
Enclosing class:
LaunchTemplateInstanceMetadataOptionsRequest
public static interface LaunchTemplateInstanceMetadataOptionsRequest.Builder extends SdkPojo, CopyableBuilder<LaunchTemplateInstanceMetadataOptionsRequest.Builder,LaunchTemplateInstanceMetadataOptionsRequest>

  • Method Details

    • httpTokens

      LaunchTemplateInstanceMetadataOptionsRequest.Builder httpTokens(String httpTokens)

      IMDSv2 uses token-backed sessions. 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

      Parameters:
      httpTokens - IMDSv2 uses token-backed sessions. 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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • httpTokens

      LaunchTemplateInstanceMetadataOptionsRequest.Builder httpTokens(LaunchTemplateHttpTokensState httpTokens)

      IMDSv2 uses token-backed sessions. 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

      Parameters:
      httpTokens - IMDSv2 uses token-backed sessions. 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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • httpPutResponseHopLimit

      LaunchTemplateInstanceMetadataOptionsRequest.Builder httpPutResponseHopLimit(Integer httpPutResponseHopLimit)

      The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.

      Default: 1

      Possible values: Integers from 1 to 64

      Parameters:
      httpPutResponseHopLimit - The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.

      Default: 1

      Possible values: Integers from 1 to 64

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • httpEndpoint

      LaunchTemplateInstanceMetadataOptionsRequest.Builder httpEndpoint(String httpEndpoint)

      Enables or disables the HTTP metadata endpoint on your instances. 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.

      Parameters:
      httpEndpoint - Enables or disables the HTTP metadata endpoint on your instances. 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • httpEndpoint

      LaunchTemplateInstanceMetadataOptionsRequest.Builder httpEndpoint(LaunchTemplateInstanceMetadataEndpointState httpEndpoint)

      Enables or disables the HTTP metadata endpoint on your instances. 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.

      Parameters:
      httpEndpoint - Enables or disables the HTTP metadata endpoint on your instances. 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • httpProtocolIpv6

      LaunchTemplateInstanceMetadataOptionsRequest.Builder httpProtocolIpv6(String httpProtocolIpv6)

      Enables or disables the IPv6 endpoint for the instance metadata service.

      Default: disabled

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

      Default: disabled

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • httpProtocolIpv6

      LaunchTemplateInstanceMetadataOptionsRequest.Builder httpProtocolIpv6(LaunchTemplateInstanceMetadataProtocolIpv6 httpProtocolIpv6)

      Enables or disables the IPv6 endpoint for the instance metadata service.

      Default: disabled

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

      Default: disabled

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • instanceMetadataTags

      LaunchTemplateInstanceMetadataOptionsRequest.Builder instanceMetadataTags(String 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

      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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • instanceMetadataTags

      LaunchTemplateInstanceMetadataOptionsRequest.Builder instanceMetadataTags(LaunchTemplateInstanceMetadataTagsState 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

      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:
      Returns a reference to this object so that method calls can be chained together.
      See Also: