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

Interface ModifyInstanceMetadataOptionsRequest.Builder

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

  • Method Details

    • 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)

      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 and the account level default is set to no-preference, the default is required.

      • If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, but the account level default is set to V1 or V2, the default is optional.

      The default value can also be affected by other combinations of parameters. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.

      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 and the account level default is set to no-preference, the default is required.

      • If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, but the account level default is set to V1 or V2, the default is optional.

      The default value can also be affected by other combinations of parameters. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.

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

    • httpTokens

      ModifyInstanceMetadataOptionsRequest.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 and the account level default is set to no-preference, the default is required.

      • If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, but the account level default is set to V1 or V2, the default is optional.

      The default value can also be affected by other combinations of parameters. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.

      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 and the account level default is set to no-preference, the default is required.

      • If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, but the account level default is set to V1 or V2, the default is optional.

      The default value can also be affected by other combinations of parameters. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.

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

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

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

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

    • httpProtocolIpv6

      ModifyInstanceMetadataOptionsRequest.Builder httpProtocolIpv6(InstanceMetadataProtocolState 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:

    • instanceMetadataTags

      ModifyInstanceMetadataOptionsRequest.Builder instanceMetadataTags(String instanceMetadataTags)

      Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.

      Parameters:
      instanceMetadataTags - Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • instanceMetadataTags

      ModifyInstanceMetadataOptionsRequest.Builder instanceMetadataTags(InstanceMetadataTagsState instanceMetadataTags)

      Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.

      Parameters:
      instanceMetadataTags - Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

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

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