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

Interface ModifyInstanceMetadataOptionsRequest.Builder

    • Method Detail

      • instanceId

        ModifyInstanceMetadataOptionsRequest.Builder instanceId​(String instanceId)

        The ID of the instance.

        Parameters:
        instanceId - The ID of the instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • httpTokens

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

      • httpTokens

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

      • httpPutResponseHopLimit

        ModifyInstanceMetadataOptionsRequest.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. If no parameter is specified, the existing state is maintained.

        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. If no parameter is specified, the existing state is maintained.

        Possible values: Integers from 1 to 64

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

      • httpEndpoint

        ModifyInstanceMetadataOptionsRequest.Builder httpEndpoint​(String httpEndpoint)

        Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.

        If you specify a value of disabled, you cannot access your instance metadata.

        Parameters:
        httpEndpoint - Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.

        If you specify a value of 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

      • httpEndpoint

        ModifyInstanceMetadataOptionsRequest.Builder httpEndpoint​(InstanceMetadataEndpointState httpEndpoint)

        Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.

        If you specify a value of disabled, you cannot access your instance metadata.

        Parameters:
        httpEndpoint - Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.

        If you specify a value of 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

      • dryRun

        ModifyInstanceMetadataOptionsRequest.Builder dryRun​(Boolean dryRun)

        Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

        Parameters:
        dryRun - Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • httpProtocolIpv6

        ModifyInstanceMetadataOptionsRequest.Builder httpProtocolIpv6​(String httpProtocolIpv6)

        Enables or disables the IPv6 endpoint for the instance metadata service. Applies only if you enabled the HTTP metadata endpoint.

        Parameters:
        httpProtocolIpv6 - Enables or disables the IPv6 endpoint for the instance metadata service. Applies only if you enabled the HTTP metadata endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        InstanceMetadataProtocolState, InstanceMetadataProtocolState