Package software.amazon.awssdk.services.lightsail.model

Interface UpdateInstanceMetadataOptionsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<UpdateInstanceMetadataOptionsRequest.Builder,UpdateInstanceMetadataOptionsRequest>, LightsailRequest.Builder, SdkBuilder<UpdateInstanceMetadataOptionsRequest.Builder,UpdateInstanceMetadataOptionsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdateInstanceMetadataOptionsRequest
public static interface UpdateInstanceMetadataOptionsRequest.Builder extends LightsailRequest.Builder, SdkPojo, CopyableBuilder<UpdateInstanceMetadataOptionsRequest.Builder,UpdateInstanceMetadataOptionsRequest>

  • Method Details

    • instanceName

      UpdateInstanceMetadataOptionsRequest.Builder instanceName(String instanceName)

      The name of the instance for which to update metadata parameters.

      Parameters:
      instanceName - The name of the instance for which to update metadata parameters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • httpTokens

      UpdateInstanceMetadataOptionsRequest.Builder httpTokens(String httpTokens)

      The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional.

      If the state is optional, you can choose whether to retrieve instance metadata with a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials by using a valid signed token, the version 2.0 role credentials are returned.

      If the state is required, you must send a signed token header with all instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The version 1.0 credentials are not available.

      Parameters:
      httpTokens - The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional.

      If the state is optional, you can choose whether to retrieve instance metadata with a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials by using a valid signed token, the version 2.0 role credentials are returned.

      If the state is required, you must send a signed token header with all instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The version 1.0 credentials are not available.

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

    • httpTokens

      UpdateInstanceMetadataOptionsRequest.Builder httpTokens(HttpTokens httpTokens)

      The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional.

      If the state is optional, you can choose whether to retrieve instance metadata with a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials by using a valid signed token, the version 2.0 role credentials are returned.

      If the state is required, you must send a signed token header with all instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The version 1.0 credentials are not available.

      Parameters:
      httpTokens - The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional.

      If the state is optional, you can choose whether to retrieve instance metadata with a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials by using a valid signed token, the version 2.0 role credentials are returned.

      If the state is required, you must send a signed token header with all instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The version 1.0 credentials are not available.

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

    • httpEndpoint

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

    • httpEndpoint

      UpdateInstanceMetadataOptionsRequest.Builder httpEndpoint(HttpEndpoint 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:

    • httpPutResponseHopLimit

      UpdateInstanceMetadataOptionsRequest.Builder httpPutResponseHopLimit(Integer httpPutResponseHopLimit)

      The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance metadata requests can travel farther. If no parameter is specified, the existing state is maintained.

      Parameters:
      httpPutResponseHopLimit - The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance metadata requests can travel farther. If no parameter is specified, the existing state is maintained.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • httpProtocolIpv6

      UpdateInstanceMetadataOptionsRequest.Builder httpProtocolIpv6(String httpProtocolIpv6)

      Enables or disables the IPv6 endpoint for the instance metadata service. This setting applies only when the HTTP metadata endpoint is enabled.

      This parameter is available only for instances in the Europe (Stockholm) Amazon Web Services Region ( eu-north-1).

      Parameters:
      httpProtocolIpv6 - Enables or disables the IPv6 endpoint for the instance metadata service. This setting applies only when the HTTP metadata endpoint is enabled.

      This parameter is available only for instances in the Europe (Stockholm) Amazon Web Services Region ( eu-north-1).

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

    • httpProtocolIpv6

      UpdateInstanceMetadataOptionsRequest.Builder httpProtocolIpv6(HttpProtocolIpv6 httpProtocolIpv6)

      Enables or disables the IPv6 endpoint for the instance metadata service. This setting applies only when the HTTP metadata endpoint is enabled.

      This parameter is available only for instances in the Europe (Stockholm) Amazon Web Services Region ( eu-north-1).

      Parameters:
      httpProtocolIpv6 - Enables or disables the IPv6 endpoint for the instance metadata service. This setting applies only when the HTTP metadata endpoint is enabled.

      This parameter is available only for instances in the Europe (Stockholm) Amazon Web Services Region ( eu-north-1).

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

    • overrideConfiguration

      UpdateInstanceMetadataOptionsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdateInstanceMetadataOptionsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.