Class ModifyInstanceMetadataDefaultsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.ec2.model.Ec2Request
software.amazon.awssdk.services.ec2.model.ModifyInstanceMetadataDefaultsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ModifyInstanceMetadataDefaultsRequest.Builder,ModifyInstanceMetadataDefaultsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ModifyInstanceMetadataDefaultsRequest extends Ec2Request implements ToCopyableBuilder<ModifyInstanceMetadataDefaultsRequest.Builder,ModifyInstanceMetadataDefaultsRequest>

  • Method Details

    • httpTokens

      public final MetadataDefaultHttpTokensState httpTokens()

      Indicates whether IMDSv2 is required.

      • optional – IMDSv2 is optional, which means that you can use either IMDSv2 or IMDSv1.

      • required – IMDSv2 is required, which means that IMDSv1 is disabled, and you must use IMDSv2.

      If the service returns an enum value that is not available in the current SDK version, httpTokens will return MetadataDefaultHttpTokensState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from httpTokensAsString().

      Returns:
      Indicates whether IMDSv2 is required.

      • optional – IMDSv2 is optional, which means that you can use either IMDSv2 or IMDSv1.

      • required – IMDSv2 is required, which means that IMDSv1 is disabled, and you must use IMDSv2.

      See Also:

    • httpTokensAsString

      public final String httpTokensAsString()

      Indicates whether IMDSv2 is required.

      • optional – IMDSv2 is optional, which means that you can use either IMDSv2 or IMDSv1.

      • required – IMDSv2 is required, which means that IMDSv1 is disabled, and you must use IMDSv2.

      If the service returns an enum value that is not available in the current SDK version, httpTokens will return MetadataDefaultHttpTokensState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from httpTokensAsString().

      Returns:
      Indicates whether IMDSv2 is required.

      • optional – IMDSv2 is optional, which means that you can use either IMDSv2 or IMDSv1.

      • required – IMDSv2 is required, which means that IMDSv1 is disabled, and you must use IMDSv2.

      See Also:

    • httpPutResponseHopLimit

      public final Integer httpPutResponseHopLimit()

      The maximum number of hops that the metadata token can travel. To indicate no preference, specify -1 .

      Possible values: Integers from 1 to 64, and -1 to indicate no preference

      Returns:
      The maximum number of hops that the metadata token can travel. To indicate no preference, specify -1.

      Possible values: Integers from 1 to 64, and -1 to indicate no preference

    • httpEndpoint

      public final DefaultInstanceMetadataEndpointState httpEndpoint()

      Enables or disables the IMDS endpoint on an instance. When disabled, the instance metadata can't be accessed.

      If the service returns an enum value that is not available in the current SDK version, httpEndpoint will return DefaultInstanceMetadataEndpointState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from httpEndpointAsString().

      Returns:
      Enables or disables the IMDS endpoint on an instance. When disabled, the instance metadata can't be accessed.
      See Also:

    • httpEndpointAsString

      public final String httpEndpointAsString()

      Enables or disables the IMDS endpoint on an instance. When disabled, the instance metadata can't be accessed.

      If the service returns an enum value that is not available in the current SDK version, httpEndpoint will return DefaultInstanceMetadataEndpointState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from httpEndpointAsString().

      Returns:
      Enables or disables the IMDS endpoint on an instance. When disabled, the instance metadata can't be accessed.
      See Also:

    • instanceMetadataTags

      public final DefaultInstanceMetadataTagsState instanceMetadataTags()

      Enables or disables access to an instance's tags from the instance metadata. For more information, see Work with instance tags using the instance metadata in the Amazon EC2 User Guide.

      If the service returns an enum value that is not available in the current SDK version, instanceMetadataTags will return DefaultInstanceMetadataTagsState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceMetadataTagsAsString().

      Returns:
      Enables or disables access to an instance's tags from the instance metadata. For more information, see Work with instance tags using the instance metadata in the Amazon EC2 User Guide.
      See Also:

    • instanceMetadataTagsAsString

      public final String instanceMetadataTagsAsString()

      Enables or disables access to an instance's tags from the instance metadata. For more information, see Work with instance tags using the instance metadata in the Amazon EC2 User Guide.

      If the service returns an enum value that is not available in the current SDK version, instanceMetadataTags will return DefaultInstanceMetadataTagsState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceMetadataTagsAsString().

      Returns:
      Enables or disables access to an instance's tags from the instance metadata. For more information, see Work with instance tags using the instance metadata in the Amazon EC2 User Guide.
      See Also:

    • dryRun

      public final Boolean dryRun()

      Checks whether you have the required permissions for the operation, 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:
      Checks whether you have the required permissions for the operation, 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.

    • toBuilder

      public ModifyInstanceMetadataDefaultsRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ModifyInstanceMetadataDefaultsRequest.Builder,ModifyInstanceMetadataDefaultsRequest>
      Specified by:
      toBuilder in class Ec2Request
      Returns:
      a builder for type T

    • builder

      public static ModifyInstanceMetadataDefaultsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ModifyInstanceMetadataDefaultsRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.