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

Interface InstanceMetadataOptionsResponse.Builder

    • Method Detail

      • state

        InstanceMetadataOptionsResponse.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:
        InstanceMetadataOptionsState, InstanceMetadataOptionsState

      • state

        InstanceMetadataOptionsResponse.Builder state​(InstanceMetadataOptionsState 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:
        InstanceMetadataOptionsState, InstanceMetadataOptionsState

      • httpTokens

        InstanceMetadataOptionsResponse.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:
        HttpTokensState, HttpTokensState

      • httpTokens

        InstanceMetadataOptionsResponse.Builder httpTokens​(HttpTokensState 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:
        HttpTokensState, HttpTokensState

      • httpPutResponseHopLimit

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

        InstanceMetadataOptionsResponse.Builder httpEndpoint​(String httpEndpoint)

        Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.

        If the value is disabled, you cannot access your instance metadata.

        Parameters:
        httpEndpoint - Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.

        If the value is disabled, you cannot access your instance metadata.

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

      • httpProtocolIpv6

        InstanceMetadataOptionsResponse.Builder httpProtocolIpv6​(String httpProtocolIpv6)

        Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.

        Default: disabled

        Parameters:
        httpProtocolIpv6 - Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.

        Default: disabled

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