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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
InstanceMetadataDefaultsResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static InstanceMetadataDefaultsResponse.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
InstanceMetadataEndpointState
httpEndpoint()
Indicates whether the IMDS endpoint for an instance is enabled or disabled.String
httpEndpointAsString()
Indicates whether the IMDS endpoint for an instance is enabled or disabled.Integer
httpPutResponseHopLimit()
The maximum number of hops that the metadata token can travel.HttpTokensState
httpTokens()
Indicates whether IMDSv2 is required.String
httpTokensAsString()
Indicates whether IMDSv2 is required.InstanceMetadataTagsState
instanceMetadataTags()
Indicates whether access to instance tags from the instance metadata is enabled or disabled.String
instanceMetadataTagsAsString()
Indicates whether access to instance tags from the instance metadata is enabled or disabled.ManagedBy
managedBy()
The entity that manages the IMDS default settings.String
managedByAsString()
The entity that manages the IMDS default settings.String
managedExceptionMessage()
The customized exception message that is specified in the declarative policy.Map<String,SdkField<?>>
sdkFieldNameToField()
List<SdkField<?>>
sdkFields()
static Class<? extends InstanceMetadataDefaultsResponse.Builder>
serializableBuilderClass()
InstanceMetadataDefaultsResponse.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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 returnHttpTokensState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhttpTokensAsString()
.- 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:
HttpTokensState
-
-
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 returnHttpTokensState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhttpTokensAsString()
.- 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:
HttpTokensState
-
-
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 returnInstanceMetadataEndpointState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhttpEndpointAsString()
.- Returns:
- Indicates whether the IMDS endpoint for an instance is enabled or disabled. When disabled, the instance metadata can't be accessed.
- See Also:
InstanceMetadataEndpointState
-
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 returnInstanceMetadataEndpointState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhttpEndpointAsString()
.- Returns:
- Indicates whether the IMDS endpoint for an instance is enabled or disabled. When disabled, the instance metadata can't be accessed.
- See Also:
InstanceMetadataEndpointState
-
instanceMetadataTags
public final InstanceMetadataTagsState instanceMetadataTags()
Indicates whether access to instance tags from the instance metadata is enabled or disabled. 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 returnInstanceMetadataTagsState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceMetadataTagsAsString()
.- Returns:
- Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see Work with instance tags using the instance metadata in the Amazon EC2 User Guide.
- See Also:
InstanceMetadataTagsState
-
instanceMetadataTagsAsString
public final String instanceMetadataTagsAsString()
Indicates whether access to instance tags from the instance metadata is enabled or disabled. 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 returnInstanceMetadataTagsState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceMetadataTagsAsString()
.- Returns:
- Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see Work with instance tags using the instance metadata in the Amazon EC2 User Guide.
- See Also:
InstanceMetadataTagsState
-
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 returnManagedBy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommanagedByAsString()
.- 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:
ManagedBy
-
-
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 returnManagedBy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommanagedByAsString()
.- 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:
ManagedBy
-
-
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.
-
toBuilder
public InstanceMetadataDefaultsResponse.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<InstanceMetadataDefaultsResponse.Builder,InstanceMetadataDefaultsResponse>
-
builder
public static InstanceMetadataDefaultsResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends InstanceMetadataDefaultsResponse.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
-
-