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

Interface InstanceMetadataOptionsRequest.Builder

    • Method Detail

      • httpTokens

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

        Default: If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, the default is required.

        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.

        Default: If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, the default is required.

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

      • httpTokens

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

        Default: If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, the default is required.

        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.

        Default: If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, the default is required.

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

      • httpPutResponseHopLimit

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

        InstanceMetadataOptionsRequest.Builder httpEndpoint​(String 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

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

      • httpEndpoint

        InstanceMetadataOptionsRequest.Builder httpEndpoint​(InstanceMetadataEndpointState 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

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