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

Interface LaunchTemplateInstanceMetadataOptions.Builder

    • Method Detail

      • 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:
        LaunchTemplateInstanceMetadataOptionsState, LaunchTemplateInstanceMetadataOptionsState

      • httpTokens

        LaunchTemplateInstanceMetadataOptions.Builder httpTokens​(String httpTokens)

        Indicates whether IMDSv2 is optional or 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 - Indicates whether IMDSv2 is optional or 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:
        LaunchTemplateHttpTokensState, LaunchTemplateHttpTokensState

      • httpTokens

        LaunchTemplateInstanceMetadataOptions.Builder httpTokens​(LaunchTemplateHttpTokensState httpTokens)

        Indicates whether IMDSv2 is optional or 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 - Indicates whether IMDSv2 is optional or 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:
        LaunchTemplateHttpTokensState, LaunchTemplateHttpTokensState

      • 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:
        LaunchTemplateInstanceMetadataEndpointState, LaunchTemplateInstanceMetadataEndpointState