* The metadata options for the instance. *
* * @see AWS * API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class InstanceMetadataOptions implements Serializable, Cloneable, StructuredPojo { /** ** The state of the metadata option changes. *
** The following states are possible: *
*
* pending - The metadata options are being updated. The instance is not yet ready to process metadata
* traffic with the new selection.
*
* applied - The metadata options have been successfully applied to the instance.
*
* The state of token usage for your instance metadata requests. *
*
* If the state is optional, you can choose whether to retrieve instance metadata with a signed token
* header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role
* credentials are returned. If you retrieve the IAM role credentials by using a valid signed token, the version 2.0
* role credentials are returned.
*
* If the state is required, you must send a signed token header with all instance metadata retrieval
* requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The
* version 1.0 credentials are not available.
*
* Not all instance blueprints in Lightsail support version 2.0 credentials. Use the MetadataNoToken
* instance metric to track the number of calls to the instance metadata service that are using version 1.0
* credentials. For more information, see Viewing instance metrics in Amazon Lightsail in the Amazon Lightsail Developer Guide.
*
* Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled. *
*
* If the value is disabled, you cannot access your instance metadata.
*
* The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance * metadata requests can travel farther. *
*/ private Integer httpPutResponseHopLimit; /** ** Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled. *
*/ private String httpProtocolIpv6; /** ** The state of the metadata option changes. *
** The following states are possible: *
*
* pending - The metadata options are being updated. The instance is not yet ready to process metadata
* traffic with the new selection.
*
* applied - The metadata options have been successfully applied to the instance.
*
* The following states are possible: *
*
* pending - The metadata options are being updated. The instance is not yet ready to process
* metadata traffic with the new selection.
*
* applied - The metadata options have been successfully applied to the instance.
*
* The state of the metadata option changes. *
** The following states are possible: *
*
* pending - The metadata options are being updated. The instance is not yet ready to process metadata
* traffic with the new selection.
*
* applied - The metadata options have been successfully applied to the instance.
*
* The following states are possible: *
*
* pending - The metadata options are being updated. The instance is not yet ready to process
* metadata traffic with the new selection.
*
* applied - The metadata options have been successfully applied to the instance.
*
* The state of the metadata option changes. *
** The following states are possible: *
*
* pending - The metadata options are being updated. The instance is not yet ready to process metadata
* traffic with the new selection.
*
* applied - The metadata options have been successfully applied to the instance.
*
* The following states are possible: *
*
* pending - The metadata options are being updated. The instance is not yet ready to process
* metadata traffic with the new selection.
*
* applied - The metadata options have been successfully applied to the instance.
*
* The state of the metadata option changes. *
** The following states are possible: *
*
* pending - The metadata options are being updated. The instance is not yet ready to process metadata
* traffic with the new selection.
*
* applied - The metadata options have been successfully applied to the instance.
*
* The following states are possible: *
*
* pending - The metadata options are being updated. The instance is not yet ready to process
* metadata traffic with the new selection.
*
* applied - The metadata options have been successfully applied to the instance.
*
* The state of token usage for your instance metadata requests. *
*
* If the state is optional, you can choose whether to retrieve instance metadata with a signed token
* header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role
* credentials are returned. If you retrieve the IAM role credentials by using a valid signed token, the version 2.0
* role credentials are returned.
*
* If the state is required, you must send a signed token header with all instance metadata retrieval
* requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The
* version 1.0 credentials are not available.
*
* Not all instance blueprints in Lightsail support version 2.0 credentials. Use the MetadataNoToken
* instance metric to track the number of calls to the instance metadata service that are using version 1.0
* credentials. For more information, see Viewing instance metrics in Amazon Lightsail in the Amazon Lightsail Developer Guide.
*
* If the state is optional, you can choose whether to retrieve instance metadata with a signed
* token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0
* role credentials are returned. If you retrieve the IAM role credentials by using a valid signed token, the
* version 2.0 role credentials are returned.
*
* If the state is required, you must send a signed token header with all instance metadata
* retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0
* credentials. The version 1.0 credentials are not available.
*
* Not all instance blueprints in Lightsail support version 2.0 credentials. Use the
* MetadataNoToken instance metric to track the number of calls to the instance metadata service
* that are using version 1.0 credentials. For more information, see Viewing instance metrics in Amazon Lightsail in the Amazon Lightsail Developer Guide.
*
* The state of token usage for your instance metadata requests. *
*
* If the state is optional, you can choose whether to retrieve instance metadata with a signed token
* header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role
* credentials are returned. If you retrieve the IAM role credentials by using a valid signed token, the version 2.0
* role credentials are returned.
*
* If the state is required, you must send a signed token header with all instance metadata retrieval
* requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The
* version 1.0 credentials are not available.
*
* Not all instance blueprints in Lightsail support version 2.0 credentials. Use the MetadataNoToken
* instance metric to track the number of calls to the instance metadata service that are using version 1.0
* credentials. For more information, see Viewing instance metrics in Amazon Lightsail in the Amazon Lightsail Developer Guide.
*
* If the state is optional, you can choose whether to retrieve instance metadata with a signed
* token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0
* role credentials are returned. If you retrieve the IAM role credentials by using a valid signed token,
* the version 2.0 role credentials are returned.
*
* If the state is required, you must send a signed token header with all instance metadata
* retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0
* credentials. The version 1.0 credentials are not available.
*
* Not all instance blueprints in Lightsail support version 2.0 credentials. Use the
* MetadataNoToken instance metric to track the number of calls to the instance metadata
* service that are using version 1.0 credentials. For more information, see Viewing instance metrics in Amazon Lightsail in the Amazon Lightsail Developer Guide.
*
* The state of token usage for your instance metadata requests. *
*
* If the state is optional, you can choose whether to retrieve instance metadata with a signed token
* header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role
* credentials are returned. If you retrieve the IAM role credentials by using a valid signed token, the version 2.0
* role credentials are returned.
*
* If the state is required, you must send a signed token header with all instance metadata retrieval
* requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The
* version 1.0 credentials are not available.
*
* Not all instance blueprints in Lightsail support version 2.0 credentials. Use the MetadataNoToken
* instance metric to track the number of calls to the instance metadata service that are using version 1.0
* credentials. For more information, see Viewing instance metrics in Amazon Lightsail in the Amazon Lightsail Developer Guide.
*
* If the state is optional, you can choose whether to retrieve instance metadata with a signed
* token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0
* role credentials are returned. If you retrieve the IAM role credentials by using a valid signed token, the
* version 2.0 role credentials are returned.
*
* If the state is required, you must send a signed token header with all instance metadata
* retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0
* credentials. The version 1.0 credentials are not available.
*
* Not all instance blueprints in Lightsail support version 2.0 credentials. Use the
* MetadataNoToken instance metric to track the number of calls to the instance metadata service
* that are using version 1.0 credentials. For more information, see Viewing instance metrics in Amazon Lightsail in the Amazon Lightsail Developer Guide.
*
* The state of token usage for your instance metadata requests. *
*
* If the state is optional, you can choose whether to retrieve instance metadata with a signed token
* header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role
* credentials are returned. If you retrieve the IAM role credentials by using a valid signed token, the version 2.0
* role credentials are returned.
*
* If the state is required, you must send a signed token header with all instance metadata retrieval
* requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The
* version 1.0 credentials are not available.
*
* Not all instance blueprints in Lightsail support version 2.0 credentials. Use the MetadataNoToken
* instance metric to track the number of calls to the instance metadata service that are using version 1.0
* credentials. For more information, see Viewing instance metrics in Amazon Lightsail in the Amazon Lightsail Developer Guide.
*
* If the state is optional, you can choose whether to retrieve instance metadata with a signed
* token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0
* role credentials are returned. If you retrieve the IAM role credentials by using a valid signed token, the
* version 2.0 role credentials are returned.
*
* If the state is required, you must send a signed token header with all instance metadata
* retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0
* credentials. The version 1.0 credentials are not available.
*
* Not all instance blueprints in Lightsail support version 2.0 credentials. Use the
* MetadataNoToken instance metric to track the number of calls to the instance metadata service
* that are using version 1.0 credentials. For more information, see Viewing instance metrics in Amazon Lightsail in the Amazon Lightsail Developer Guide.
*
* 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 HttpEndpoint
*/
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 HttpEndpoint
*/
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 HttpEndpoint
*/
public InstanceMetadataOptions 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 HttpEndpoint
*/
public InstanceMetadataOptions withHttpEndpoint(HttpEndpoint httpEndpoint) {
this.httpEndpoint = httpEndpoint.toString();
return this;
}
/**
*
* The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance * metadata requests can travel farther. *
* * @param httpPutResponseHopLimit * The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the * instance metadata requests can travel farther. */ public void setHttpPutResponseHopLimit(Integer httpPutResponseHopLimit) { this.httpPutResponseHopLimit = httpPutResponseHopLimit; } /** ** The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance * metadata requests can travel farther. *
* * @return The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the * instance metadata requests can travel farther. */ public Integer getHttpPutResponseHopLimit() { return this.httpPutResponseHopLimit; } /** ** The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance * metadata requests can travel farther. *
* * @param httpPutResponseHopLimit * The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the * instance metadata requests can travel farther. * @return Returns a reference to this object so that method calls can be chained together. */ public InstanceMetadataOptions withHttpPutResponseHopLimit(Integer httpPutResponseHopLimit) { setHttpPutResponseHopLimit(httpPutResponseHopLimit); 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 HttpProtocolIpv6 */ 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 HttpProtocolIpv6 */ 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 HttpProtocolIpv6 */ public InstanceMetadataOptions 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 HttpProtocolIpv6 */ public InstanceMetadataOptions withHttpProtocolIpv6(HttpProtocolIpv6 httpProtocolIpv6) { this.httpProtocolIpv6 = httpProtocolIpv6.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 (getHttpEndpoint() != null) sb.append("HttpEndpoint: ").append(getHttpEndpoint()).append(","); if (getHttpPutResponseHopLimit() != null) sb.append("HttpPutResponseHopLimit: ").append(getHttpPutResponseHopLimit()).append(","); if (getHttpProtocolIpv6() != null) sb.append("HttpProtocolIpv6: ").append(getHttpProtocolIpv6()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof InstanceMetadataOptions == false) return false; InstanceMetadataOptions other = (InstanceMetadataOptions) 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.getHttpEndpoint() == null ^ this.getHttpEndpoint() == null) return false; if (other.getHttpEndpoint() != null && other.getHttpEndpoint().equals(this.getHttpEndpoint()) == 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.getHttpProtocolIpv6() == null ^ this.getHttpProtocolIpv6() == null) return false; if (other.getHttpProtocolIpv6() != null && other.getHttpProtocolIpv6().equals(this.getHttpProtocolIpv6()) == 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 + ((getHttpEndpoint() == null) ? 0 : getHttpEndpoint().hashCode()); hashCode = prime * hashCode + ((getHttpPutResponseHopLimit() == null) ? 0 : getHttpPutResponseHopLimit().hashCode()); hashCode = prime * hashCode + ((getHttpProtocolIpv6() == null) ? 0 : getHttpProtocolIpv6().hashCode()); return hashCode; } @Override public InstanceMetadataOptions clone() { try { return (InstanceMetadataOptions) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } @com.amazonaws.annotation.SdkInternalApi @Override public void marshall(ProtocolMarshaller protocolMarshaller) { com.amazonaws.services.lightsail.model.transform.InstanceMetadataOptionsMarshaller.getInstance().marshall(this, protocolMarshaller); } }