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

Class InstanceMetadataDefaultsResponse

java.lang.Object
software.amazon.awssdk.services.ec2.model.InstanceMetadataDefaultsResponse
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<InstanceMetadataDefaultsResponse.Builder,InstanceMetadataDefaultsResponse>
@Generated("software.amazon.awssdk:codegen") public final class InstanceMetadataDefaultsResponse extends Object implements SdkPojo, Serializable, ToCopyableBuilder<InstanceMetadataDefaultsResponse.Builder,InstanceMetadataDefaultsResponse>

The default instance metadata service (IMDS) settings that were set at the account level in the specified Amazon Web Services
 Region.

See Also:

  • Method Details

    • httpTokens

      public final HttpTokensState 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 HttpTokensState.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 HttpTokensState.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.

      Returns:
      The maximum number of hops that the metadata token can travel.

    • httpEndpoint

      public final InstanceMetadataEndpointState httpEndpoint()

      Indicates whether the IMDS endpoint for an instance is enabled or disabled. 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 InstanceMetadataEndpointState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from httpEndpointAsString().

      Returns:
      Indicates whether the IMDS endpoint for an instance is enabled or disabled. When disabled, the instance metadata can't be accessed.
      See Also:

    • httpEndpointAsString

      public final String httpEndpointAsString()

      Indicates whether the IMDS endpoint for an instance is enabled or disabled. 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 InstanceMetadataEndpointState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from httpEndpointAsString().

      Returns:
      Indicates whether the IMDS endpoint for an instance is enabled or disabled. When disabled, the instance metadata can't be accessed.
      See Also:

    • instanceMetadataTags

      public final InstanceMetadataTagsState instanceMetadataTags()

      Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see View tags for your EC2 instances using 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 InstanceMetadataTagsState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceMetadataTagsAsString().

      Returns:
      Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see View tags for your EC2 instances using instance metadata in the Amazon EC2 User Guide.
      See Also:

    • instanceMetadataTagsAsString

      public final String instanceMetadataTagsAsString()

      Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see View tags for your EC2 instances using 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 InstanceMetadataTagsState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceMetadataTagsAsString().

      Returns:
      Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see View tags for your EC2 instances using instance metadata in the Amazon EC2 User Guide.
      See Also:

    • managedBy

      public final ManagedBy managedBy()

      The entity that manages the IMDS default settings. Possible values include:

      • account - The IMDS default settings are managed by the account.

      • declarative-policy - The IMDS default settings are managed by a declarative policy and can't be modified by the account.

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

      Returns:
      The entity that manages the IMDS default settings. Possible values include:

      • account - The IMDS default settings are managed by the account.

      • declarative-policy - The IMDS default settings are managed by a declarative policy and can't be modified by the account.

      See Also:

    • managedByAsString

      public final String managedByAsString()

      The entity that manages the IMDS default settings. Possible values include:

      • account - The IMDS default settings are managed by the account.

      • declarative-policy - The IMDS default settings are managed by a declarative policy and can't be modified by the account.

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

      Returns:
      The entity that manages the IMDS default settings. Possible values include:

      • account - The IMDS default settings are managed by the account.

      • declarative-policy - The IMDS default settings are managed by a declarative policy and can't be modified by the account.

      See Also:

    • managedExceptionMessage

      public final String managedExceptionMessage()

      The customized exception message that is specified in the declarative policy.

      Returns:
      The customized exception message that is specified in the declarative policy.

    • httpTokensEnforced

      public final HttpTokensEnforcedState httpTokensEnforced()

      Indicates whether to enforce the requirement of IMDSv2 on an instance at the time of launch. When enforcement is enabled, the instance can't launch unless IMDSv2 (HttpTokens) is set to required.

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

      Returns:
      Indicates whether to enforce the requirement of IMDSv2 on an instance at the time of launch. When enforcement is enabled, the instance can't launch unless IMDSv2 (HttpTokens) is set to required.
      See Also:

    • httpTokensEnforcedAsString

      public final String httpTokensEnforcedAsString()

      Indicates whether to enforce the requirement of IMDSv2 on an instance at the time of launch. When enforcement is enabled, the instance can't launch unless IMDSv2 (HttpTokens) is set to required.

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

      Returns:
      Indicates whether to enforce the requirement of IMDSv2 on an instance at the time of launch. When enforcement is enabled, the instance can't launch unless IMDSv2 (HttpTokens) is set to required.
      See Also:

    • toBuilder

      public InstanceMetadataDefaultsResponse.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<InstanceMetadataDefaultsResponse.Builder,InstanceMetadataDefaultsResponse>

    • builder

      public static InstanceMetadataDefaultsResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

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

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo