* The metadata options for the instance. *
* * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class InstanceMetadataOptionsResponse implements Serializable, Cloneable { /** ** The state of the metadata option changes. *
*
* pending - The metadata options are being updated and the instance is not ready to process metadata
* traffic with the new selection.
*
* applied - The metadata options have been successfully applied on the instance.
*
* IMDSv2 uses token-backed sessions. Indicates whether the use of HTTP tokens is optional (in other
* words, indicates whether the use of IMDSv2 is optional) or required (in other words,
* indicates whether the use of IMDSv2 is required).
*
* optional - When IMDSv2 is optional, you can choose to retrieve instance metadata with or without a
* session token in your request. If you retrieve the IAM role credentials without a token, the IMDSv1 role
* credentials are returned. If you retrieve the IAM role credentials using a valid session token, the IMDSv2 role
* credentials are returned.
*
* required - When IMDSv2 is required, you must send a session token with any instance metadata
* retrieval requests. In this state, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1
* credentials are not available.
*
* Default: optional
*
* The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further * instance metadata requests can travel. *
** Default: 1 *
** Possible values: Integers from 1 to 64 *
*/ private Integer httpPutResponseHopLimit; /** ** Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled. *
*
* If the value is disabled, you cannot access your instance metadata.
*
* Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled. *
*/ private String httpProtocolIpv6; /** ** 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. *
*/ private String instanceMetadataTags; /** ** The state of the metadata option changes. *
*
* pending - The metadata options are being updated and the instance is not ready to process metadata
* traffic with the new selection.
*
* applied - The metadata options have been successfully applied on the instance.
*
* pending - The metadata options are being updated and the instance is not ready to process
* metadata traffic with the new selection.
*
* applied - The metadata options have been successfully applied on the instance.
* @see InstanceMetadataOptionsState
*/
public void setState(String state) {
this.state = state;
}
/**
*
* The state of the metadata option changes. *
*
* pending - The metadata options are being updated and the instance is not ready to process metadata
* traffic with the new selection.
*
* applied - The metadata options have been successfully applied on the instance.
*
* pending - The metadata options are being updated and the instance is not ready to process
* metadata traffic with the new selection.
*
* applied - The metadata options have been successfully applied on the instance.
* @see InstanceMetadataOptionsState
*/
public String getState() {
return this.state;
}
/**
*
* The state of the metadata option changes. *
*
* pending - The metadata options are being updated and the instance is not ready to process metadata
* traffic with the new selection.
*
* applied - The metadata options have been successfully applied on the instance.
*
* pending - The metadata options are being updated and the instance is not ready to process
* metadata traffic with the new selection.
*
* applied - The metadata options have been successfully applied on the instance.
* @return Returns a reference to this object so that method calls can be chained together.
* @see InstanceMetadataOptionsState
*/
public InstanceMetadataOptionsResponse withState(String state) {
setState(state);
return this;
}
/**
*
* The state of the metadata option changes. *
*
* pending - The metadata options are being updated and the instance is not ready to process metadata
* traffic with the new selection.
*
* applied - The metadata options have been successfully applied on the instance.
*
* pending - The metadata options are being updated and the instance is not ready to process
* metadata traffic with the new selection.
*
* applied - The metadata options have been successfully applied on the instance.
* @return Returns a reference to this object so that method calls can be chained together.
* @see InstanceMetadataOptionsState
*/
public InstanceMetadataOptionsResponse withState(InstanceMetadataOptionsState state) {
this.state = state.toString();
return this;
}
/**
*
* IMDSv2 uses token-backed sessions. Indicates whether the use of HTTP tokens is optional (in other
* words, indicates whether the use of IMDSv2 is optional) or required (in other words,
* indicates whether the use of IMDSv2 is required).
*
* optional - When IMDSv2 is optional, you can choose to retrieve instance metadata with or without a
* session token in your request. If you retrieve the IAM role credentials without a token, the IMDSv1 role
* credentials are returned. If you retrieve the IAM role credentials using a valid session token, the IMDSv2 role
* credentials are returned.
*
* required - When IMDSv2 is required, you must send a session token with any instance metadata
* retrieval requests. In this state, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1
* credentials are not available.
*
* Default: optional
*
optional (in
* other words, indicates whether the use of IMDSv2 is optional) or required (in
* other words, indicates whether the use of IMDSv2 is required).
*
* optional - When IMDSv2 is optional, you can choose to retrieve instance metadata with or
* without a session token in your request. If you retrieve the IAM role credentials without a token, the
* IMDSv1 role credentials are returned. If you retrieve the IAM role credentials using a valid session
* token, the IMDSv2 role credentials are returned.
*
* required - When IMDSv2 is required, you must send a session token with any instance metadata
* retrieval requests. In this state, retrieving the IAM role credentials always returns IMDSv2 credentials;
* IMDSv1 credentials are not available.
*
* Default: optional
* @see HttpTokensState
*/
public void setHttpTokens(String httpTokens) {
this.httpTokens = httpTokens;
}
/**
*
* IMDSv2 uses token-backed sessions. Indicates whether the use of HTTP tokens is optional (in other
* words, indicates whether the use of IMDSv2 is optional) or required (in other words,
* indicates whether the use of IMDSv2 is required).
*
* optional - When IMDSv2 is optional, you can choose to retrieve instance metadata with or without a
* session token in your request. If you retrieve the IAM role credentials without a token, the IMDSv1 role
* credentials are returned. If you retrieve the IAM role credentials using a valid session token, the IMDSv2 role
* credentials are returned.
*
* required - When IMDSv2 is required, you must send a session token with any instance metadata
* retrieval requests. In this state, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1
* credentials are not available.
*
* Default: optional
*
optional (in
* other words, indicates whether the use of IMDSv2 is optional) or required (in
* other words, indicates whether the use of IMDSv2 is required).
*
* optional - When IMDSv2 is optional, you can choose to retrieve instance metadata with or
* without a session token in your request. If you retrieve the IAM role credentials without a token, the
* IMDSv1 role credentials are returned. If you retrieve the IAM role credentials using a valid session
* token, the IMDSv2 role credentials are returned.
*
* required - When IMDSv2 is required, you must send a session token with any instance metadata
* retrieval requests. In this state, retrieving the IAM role credentials always returns IMDSv2 credentials;
* IMDSv1 credentials are not available.
*
* Default: optional
* @see HttpTokensState
*/
public String getHttpTokens() {
return this.httpTokens;
}
/**
*
* IMDSv2 uses token-backed sessions. Indicates whether the use of HTTP tokens is optional (in other
* words, indicates whether the use of IMDSv2 is optional) or required (in other words,
* indicates whether the use of IMDSv2 is required).
*
* optional - When IMDSv2 is optional, you can choose to retrieve instance metadata with or without a
* session token in your request. If you retrieve the IAM role credentials without a token, the IMDSv1 role
* credentials are returned. If you retrieve the IAM role credentials using a valid session token, the IMDSv2 role
* credentials are returned.
*
* required - When IMDSv2 is required, you must send a session token with any instance metadata
* retrieval requests. In this state, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1
* credentials are not available.
*
* Default: optional
*
optional (in
* other words, indicates whether the use of IMDSv2 is optional) or required (in
* other words, indicates whether the use of IMDSv2 is required).
*
* optional - When IMDSv2 is optional, you can choose to retrieve instance metadata with or
* without a session token in your request. If you retrieve the IAM role credentials without a token, the
* IMDSv1 role credentials are returned. If you retrieve the IAM role credentials using a valid session
* token, the IMDSv2 role credentials are returned.
*
* required - When IMDSv2 is required, you must send a session token with any instance metadata
* retrieval requests. In this state, retrieving the IAM role credentials always returns IMDSv2 credentials;
* IMDSv1 credentials are not available.
*
* Default: optional
* @return Returns a reference to this object so that method calls can be chained together.
* @see HttpTokensState
*/
public InstanceMetadataOptionsResponse withHttpTokens(String httpTokens) {
setHttpTokens(httpTokens);
return this;
}
/**
*
* IMDSv2 uses token-backed sessions. Indicates whether the use of HTTP tokens is optional (in other
* words, indicates whether the use of IMDSv2 is optional) or required (in other words,
* indicates whether the use of IMDSv2 is required).
*
* optional - When IMDSv2 is optional, you can choose to retrieve instance metadata with or without a
* session token in your request. If you retrieve the IAM role credentials without a token, the IMDSv1 role
* credentials are returned. If you retrieve the IAM role credentials using a valid session token, the IMDSv2 role
* credentials are returned.
*
* required - When IMDSv2 is required, you must send a session token with any instance metadata
* retrieval requests. In this state, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1
* credentials are not available.
*
* Default: optional
*
optional (in
* other words, indicates whether the use of IMDSv2 is optional) or required (in
* other words, indicates whether the use of IMDSv2 is required).
*
* optional - When IMDSv2 is optional, you can choose to retrieve instance metadata with or
* without a session token in your request. If you retrieve the IAM role credentials without a token, the
* IMDSv1 role credentials are returned. If you retrieve the IAM role credentials using a valid session
* token, the IMDSv2 role credentials are returned.
*
* required - When IMDSv2 is required, you must send a session token with any instance metadata
* retrieval requests. In this state, retrieving the IAM role credentials always returns IMDSv2 credentials;
* IMDSv1 credentials are not available.
*
* Default: optional
* @return Returns a reference to this object so that method calls can be chained together.
* @see HttpTokensState
*/
public InstanceMetadataOptionsResponse withHttpTokens(HttpTokensState httpTokens) {
this.httpTokens = httpTokens.toString();
return this;
}
/**
*
* The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further * instance metadata requests can travel. *
** Default: 1 *
** Possible values: Integers from 1 to 64 *
* * @param httpPutResponseHopLimit * The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further * instance metadata requests can travel. ** Default: 1 *
** Possible values: Integers from 1 to 64 */ public void setHttpPutResponseHopLimit(Integer httpPutResponseHopLimit) { this.httpPutResponseHopLimit = httpPutResponseHopLimit; } /** *
* The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further * instance metadata requests can travel. *
** Default: 1 *
** Possible values: Integers from 1 to 64 *
* * @return The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the * further instance metadata requests can travel. ** Default: 1 *
** Possible values: Integers from 1 to 64 */ public Integer getHttpPutResponseHopLimit() { return this.httpPutResponseHopLimit; } /** *
* The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further * instance metadata requests can travel. *
** Default: 1 *
** Possible values: Integers from 1 to 64 *
* * @param httpPutResponseHopLimit * The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further * instance metadata requests can travel. ** Default: 1 *
** Possible values: Integers from 1 to 64 * @return Returns a reference to this object so that method calls can be chained together. */ public InstanceMetadataOptionsResponse withHttpPutResponseHopLimit(Integer httpPutResponseHopLimit) { setHttpPutResponseHopLimit(httpPutResponseHopLimit); return this; } /** *
* Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled. *
*
* If the value is disabled, you cannot access your instance metadata.
*
* If the value is disabled, you cannot access your instance metadata.
* @see InstanceMetadataEndpointState
*/
public void setHttpEndpoint(String httpEndpoint) {
this.httpEndpoint = httpEndpoint;
}
/**
*
* Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled. *
*
* If the value is disabled, you cannot access your instance metadata.
*
* If the value is disabled, you cannot access your instance metadata.
* @see InstanceMetadataEndpointState
*/
public String getHttpEndpoint() {
return this.httpEndpoint;
}
/**
*
* Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled. *
*
* If the value is disabled, you cannot access your instance metadata.
*
* If the value is disabled, you cannot access your instance metadata.
* @return Returns a reference to this object so that method calls can be chained together.
* @see InstanceMetadataEndpointState
*/
public InstanceMetadataOptionsResponse withHttpEndpoint(String httpEndpoint) {
setHttpEndpoint(httpEndpoint);
return this;
}
/**
*
* Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled. *
*
* If the value is disabled, you cannot access your instance metadata.
*
* If the value is disabled, you cannot access your instance metadata.
* @return Returns a reference to this object so that method calls can be chained together.
* @see InstanceMetadataEndpointState
*/
public InstanceMetadataOptionsResponse withHttpEndpoint(InstanceMetadataEndpointState httpEndpoint) {
this.httpEndpoint = httpEndpoint.toString();
return this;
}
/**
*
* Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled. *
* * @param httpProtocolIpv6 * Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled. * @see InstanceMetadataProtocolState */ public void setHttpProtocolIpv6(String httpProtocolIpv6) { this.httpProtocolIpv6 = httpProtocolIpv6; } /** ** Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled. *
* * @return Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled. * @see InstanceMetadataProtocolState */ public String getHttpProtocolIpv6() { return this.httpProtocolIpv6; } /** ** Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled. *
* * @param httpProtocolIpv6 * Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled. * @return Returns a reference to this object so that method calls can be chained together. * @see InstanceMetadataProtocolState */ public InstanceMetadataOptionsResponse withHttpProtocolIpv6(String httpProtocolIpv6) { setHttpProtocolIpv6(httpProtocolIpv6); return this; } /** ** Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled. *
* * @param httpProtocolIpv6 * Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled. * @return Returns a reference to this object so that method calls can be chained together. * @see InstanceMetadataProtocolState */ public InstanceMetadataOptionsResponse withHttpProtocolIpv6(InstanceMetadataProtocolState httpProtocolIpv6) { this.httpProtocolIpv6 = httpProtocolIpv6.toString(); return this; } /** ** 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. *
* * @param 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. * @see InstanceMetadataTagsState */ public void setInstanceMetadataTags(String instanceMetadataTags) { this.instanceMetadataTags = 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. *
* * @return 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. * @see InstanceMetadataTagsState */ public String getInstanceMetadataTags() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. * @see InstanceMetadataTagsState */ public InstanceMetadataOptionsResponse withInstanceMetadataTags(String instanceMetadataTags) { setInstanceMetadataTags(instanceMetadataTags); return this; } /** ** 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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. * @see InstanceMetadataTagsState */ public InstanceMetadataOptionsResponse withInstanceMetadataTags(InstanceMetadataTagsState instanceMetadataTags) { this.instanceMetadataTags = instanceMetadataTags.toString(); return this; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getState() != null) sb.append("State: ").append(getState()).append(","); if (getHttpTokens() != null) sb.append("HttpTokens: ").append(getHttpTokens()).append(","); if (getHttpPutResponseHopLimit() != null) sb.append("HttpPutResponseHopLimit: ").append(getHttpPutResponseHopLimit()).append(","); if (getHttpEndpoint() != null) sb.append("HttpEndpoint: ").append(getHttpEndpoint()).append(","); if (getHttpProtocolIpv6() != null) sb.append("HttpProtocolIpv6: ").append(getHttpProtocolIpv6()).append(","); if (getInstanceMetadataTags() != null) sb.append("InstanceMetadataTags: ").append(getInstanceMetadataTags()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof InstanceMetadataOptionsResponse == false) return false; InstanceMetadataOptionsResponse other = (InstanceMetadataOptionsResponse) obj; if (other.getState() == null ^ this.getState() == null) return false; if (other.getState() != null && other.getState().equals(this.getState()) == false) return false; if (other.getHttpTokens() == null ^ this.getHttpTokens() == null) return false; if (other.getHttpTokens() != null && other.getHttpTokens().equals(this.getHttpTokens()) == false) return false; if (other.getHttpPutResponseHopLimit() == null ^ this.getHttpPutResponseHopLimit() == null) return false; if (other.getHttpPutResponseHopLimit() != null && other.getHttpPutResponseHopLimit().equals(this.getHttpPutResponseHopLimit()) == false) return false; if (other.getHttpEndpoint() == null ^ this.getHttpEndpoint() == null) return false; if (other.getHttpEndpoint() != null && other.getHttpEndpoint().equals(this.getHttpEndpoint()) == false) return false; if (other.getHttpProtocolIpv6() == null ^ this.getHttpProtocolIpv6() == null) return false; if (other.getHttpProtocolIpv6() != null && other.getHttpProtocolIpv6().equals(this.getHttpProtocolIpv6()) == false) return false; if (other.getInstanceMetadataTags() == null ^ this.getInstanceMetadataTags() == null) return false; if (other.getInstanceMetadataTags() != null && other.getInstanceMetadataTags().equals(this.getInstanceMetadataTags()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getState() == null) ? 0 : getState().hashCode()); hashCode = prime * hashCode + ((getHttpTokens() == null) ? 0 : getHttpTokens().hashCode()); hashCode = prime * hashCode + ((getHttpPutResponseHopLimit() == null) ? 0 : getHttpPutResponseHopLimit().hashCode()); hashCode = prime * hashCode + ((getHttpEndpoint() == null) ? 0 : getHttpEndpoint().hashCode()); hashCode = prime * hashCode + ((getHttpProtocolIpv6() == null) ? 0 : getHttpProtocolIpv6().hashCode()); hashCode = prime * hashCode + ((getInstanceMetadataTags() == null) ? 0 : getInstanceMetadataTags().hashCode()); return hashCode; } @Override public InstanceMetadataOptionsResponse clone() { try { return (InstanceMetadataOptionsResponse) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } }