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

Interface LaunchTemplateInstanceMetadataOptions.Builder

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

  • Method Details

    • state

      LaunchTemplateInstanceMetadataOptions.Builder state(String state)

      The state of the metadata option changes.

      pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.

      applied - The metadata options have been successfully applied on the instance.

      Parameters:
      state - The state of the metadata option changes.

      pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.

      applied - The metadata options have been successfully applied on the instance.

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

    • state

      LaunchTemplateInstanceMetadataOptions.Builder state(LaunchTemplateInstanceMetadataOptionsState state)

      The state of the metadata option changes.

      pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.

      applied - The metadata options have been successfully applied on the instance.

      Parameters:
      state - The state of the metadata option changes.

      pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.

      applied - The metadata options have been successfully applied on the instance.

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

    • httpTokens

      LaunchTemplateInstanceMetadataOptions.Builder httpTokens(String httpTokens)

      Indicates whether IMDSv2 is required.

      • optional - IMDSv2 is optional. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials.

      • required - IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.

      Parameters:
      httpTokens - Indicates whether IMDSv2 is required.

      • optional - IMDSv2 is optional. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials.

      • required - IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.

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

    • httpTokens

      LaunchTemplateInstanceMetadataOptions.Builder httpTokens(LaunchTemplateHttpTokensState httpTokens)

      Indicates whether IMDSv2 is required.

      • optional - IMDSv2 is optional. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials.

      • required - IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.

      Parameters:
      httpTokens - Indicates whether IMDSv2 is required.

      • optional - IMDSv2 is optional. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials.

      • required - IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.

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

    • httpPutResponseHopLimit

      LaunchTemplateInstanceMetadataOptions.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

      LaunchTemplateInstanceMetadataOptions.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

      LaunchTemplateInstanceMetadataOptions.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

      LaunchTemplateInstanceMetadataOptions.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

      LaunchTemplateInstanceMetadataOptions.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

      LaunchTemplateInstanceMetadataOptions.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

      LaunchTemplateInstanceMetadataOptions.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: