/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.ec2.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; import com.amazonaws.Request; import com.amazonaws.services.ec2.model.transform.ModifyInstanceMetadataOptionsRequestMarshaller; /** * */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class ModifyInstanceMetadataOptionsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest { /** *

* The ID of the instance. *

*/ private String instanceId; /** *

* IMDSv2 uses token-backed sessions. Set the use of HTTP tokens to optional (in other words, set the * use of IMDSv2 to optional) or required (in other words, set the use of IMDSv2 to * required). *

* *

* Default: optional *

*/ private String httpTokens; /** *

* The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further * instance metadata requests can travel. If no parameter is specified, the existing state is maintained. *

*

* Possible values: Integers from 1 to 64 *

*/ private Integer httpPutResponseHopLimit; /** *

* Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the * existing state is maintained. *

*

* If you specify a value of disabled, you cannot access your instance metadata. *

*/ private String httpEndpoint; /** *

* Enables or disables the IPv6 endpoint for the instance metadata service. Applies only if you enabled the HTTP * metadata endpoint. *

*/ private String httpProtocolIpv6; /** *

* Set to enabled to allow access to instance tags from the instance metadata. Set to * disabled to turn off access to instance tags from the instance metadata. For more information, see * Work with * instance tags using the instance metadata. *

*

* Default: disabled *

*/ private String instanceMetadataTags; /** *

* The ID of the instance. *

* * @param instanceId * The ID of the instance. */ public void setInstanceId(String instanceId) { this.instanceId = instanceId; } /** *

* The ID of the instance. *

* * @return The ID of the instance. */ public String getInstanceId() { return this.instanceId; } /** *

* The ID of the instance. *

* * @param instanceId * The ID of the instance. * @return Returns a reference to this object so that method calls can be chained together. */ public ModifyInstanceMetadataOptionsRequest withInstanceId(String instanceId) { setInstanceId(instanceId); return this; } /** *

* IMDSv2 uses token-backed sessions. Set the use of HTTP tokens to optional (in other words, set the * use of IMDSv2 to optional) or required (in other words, set the use of IMDSv2 to * required). *

* *

* Default: optional *

* * @param httpTokens * IMDSv2 uses token-backed sessions. Set the use of HTTP tokens to optional (in other words, * set the use of IMDSv2 to optional) or required (in other words, set the use of * IMDSv2 to required).

* *

* Default: optional * @see HttpTokensState */ public void setHttpTokens(String httpTokens) { this.httpTokens = httpTokens; } /** *

* IMDSv2 uses token-backed sessions. Set the use of HTTP tokens to optional (in other words, set the * use of IMDSv2 to optional) or required (in other words, set the use of IMDSv2 to * required). *

* *

* Default: optional *

* * @return IMDSv2 uses token-backed sessions. Set the use of HTTP tokens to optional (in other words, * set the use of IMDSv2 to optional) or required (in other words, set the use of * IMDSv2 to required).

* *

* Default: optional * @see HttpTokensState */ public String getHttpTokens() { return this.httpTokens; } /** *

* IMDSv2 uses token-backed sessions. Set the use of HTTP tokens to optional (in other words, set the * use of IMDSv2 to optional) or required (in other words, set the use of IMDSv2 to * required). *

* *

* Default: optional *

* * @param httpTokens * IMDSv2 uses token-backed sessions. Set the use of HTTP tokens to optional (in other words, * set the use of IMDSv2 to optional) or required (in other words, set the use of * IMDSv2 to required).

* *

* Default: optional * @return Returns a reference to this object so that method calls can be chained together. * @see HttpTokensState */ public ModifyInstanceMetadataOptionsRequest withHttpTokens(String httpTokens) { setHttpTokens(httpTokens); return this; } /** *

* IMDSv2 uses token-backed sessions. Set the use of HTTP tokens to optional (in other words, set the * use of IMDSv2 to optional) or required (in other words, set the use of IMDSv2 to * required). *

* *

* Default: optional *

* * @param httpTokens * IMDSv2 uses token-backed sessions. Set the use of HTTP tokens to optional (in other words, * set the use of IMDSv2 to optional) or required (in other words, set the use of * IMDSv2 to required).

* *

* Default: optional * @return Returns a reference to this object so that method calls can be chained together. * @see HttpTokensState */ public ModifyInstanceMetadataOptionsRequest 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. If no parameter is specified, the existing state is maintained. *

*

* 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. If no parameter is specified, the existing state is maintained.

*

* 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. If no parameter is specified, the existing state is maintained. *

*

* 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. If no parameter is specified, the existing state is * maintained.

*

* 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. If no parameter is specified, the existing state is maintained. *

*

* 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. If no parameter is specified, the existing state is maintained.

*

* Possible values: Integers from 1 to 64 * @return Returns a reference to this object so that method calls can be chained together. */ public ModifyInstanceMetadataOptionsRequest withHttpPutResponseHopLimit(Integer httpPutResponseHopLimit) { setHttpPutResponseHopLimit(httpPutResponseHopLimit); return this; } /** *

* Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the * existing state is maintained. *

*

* If you specify a value of disabled, you cannot access your instance metadata. *

* * @param httpEndpoint * Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the * existing state is maintained.

*

* If you specify a value of disabled, you cannot access your instance metadata. * @see InstanceMetadataEndpointState */ public void setHttpEndpoint(String httpEndpoint) { this.httpEndpoint = httpEndpoint; } /** *

* Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the * existing state is maintained. *

*

* If you specify a value of disabled, you cannot access your instance metadata. *

* * @return Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the * existing state is maintained.

*

* If you specify a value of disabled, you cannot access your instance metadata. * @see InstanceMetadataEndpointState */ public String getHttpEndpoint() { return this.httpEndpoint; } /** *

* Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the * existing state is maintained. *

*

* If you specify a value of disabled, you cannot access your instance metadata. *

* * @param httpEndpoint * Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the * existing state is maintained.

*

* If you specify a value of 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 ModifyInstanceMetadataOptionsRequest withHttpEndpoint(String httpEndpoint) { setHttpEndpoint(httpEndpoint); return this; } /** *

* Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the * existing state is maintained. *

*

* If you specify a value of disabled, you cannot access your instance metadata. *

* * @param httpEndpoint * Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the * existing state is maintained.

*

* If you specify a value of 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 ModifyInstanceMetadataOptionsRequest withHttpEndpoint(InstanceMetadataEndpointState httpEndpoint) { this.httpEndpoint = httpEndpoint.toString(); return this; } /** *

* Enables or disables the IPv6 endpoint for the instance metadata service. Applies only if you enabled the HTTP * metadata endpoint. *

* * @param httpProtocolIpv6 * Enables or disables the IPv6 endpoint for the instance metadata service. Applies only if you enabled the * HTTP metadata endpoint. * @see InstanceMetadataProtocolState */ public void setHttpProtocolIpv6(String httpProtocolIpv6) { this.httpProtocolIpv6 = httpProtocolIpv6; } /** *

* Enables or disables the IPv6 endpoint for the instance metadata service. Applies only if you enabled the HTTP * metadata endpoint. *

* * @return Enables or disables the IPv6 endpoint for the instance metadata service. Applies only if you enabled the * HTTP metadata endpoint. * @see InstanceMetadataProtocolState */ public String getHttpProtocolIpv6() { return this.httpProtocolIpv6; } /** *

* Enables or disables the IPv6 endpoint for the instance metadata service. Applies only if you enabled the HTTP * metadata endpoint. *

* * @param httpProtocolIpv6 * Enables or disables the IPv6 endpoint for the instance metadata service. Applies only if you enabled the * HTTP metadata endpoint. * @return Returns a reference to this object so that method calls can be chained together. * @see InstanceMetadataProtocolState */ public ModifyInstanceMetadataOptionsRequest withHttpProtocolIpv6(String httpProtocolIpv6) { setHttpProtocolIpv6(httpProtocolIpv6); return this; } /** *

* Enables or disables the IPv6 endpoint for the instance metadata service. Applies only if you enabled the HTTP * metadata endpoint. *

* * @param httpProtocolIpv6 * Enables or disables the IPv6 endpoint for the instance metadata service. Applies only if you enabled the * HTTP metadata endpoint. * @return Returns a reference to this object so that method calls can be chained together. * @see InstanceMetadataProtocolState */ public ModifyInstanceMetadataOptionsRequest withHttpProtocolIpv6(InstanceMetadataProtocolState httpProtocolIpv6) { this.httpProtocolIpv6 = httpProtocolIpv6.toString(); return this; } /** *

* Set to enabled to allow access to instance tags from the instance metadata. Set to * disabled to turn off access to instance tags from the instance metadata. For more information, see * Work with * instance tags using the instance metadata. *

*

* Default: disabled *

* * @param instanceMetadataTags * Set to enabled to allow access to instance tags from the instance metadata. Set to * disabled to turn off access to instance tags from the instance metadata. For more * information, see Work * with instance tags using the instance metadata.

*

* Default: disabled * @see InstanceMetadataTagsState */ public void setInstanceMetadataTags(String instanceMetadataTags) { this.instanceMetadataTags = instanceMetadataTags; } /** *

* Set to enabled to allow access to instance tags from the instance metadata. Set to * disabled to turn off access to instance tags from the instance metadata. For more information, see * Work with * instance tags using the instance metadata. *

*

* Default: disabled *

* * @return Set to enabled to allow access to instance tags from the instance metadata. Set to * disabled to turn off access to instance tags from the instance metadata. For more * information, see Work * with instance tags using the instance metadata.

*

* Default: disabled * @see InstanceMetadataTagsState */ public String getInstanceMetadataTags() { return this.instanceMetadataTags; } /** *

* Set to enabled to allow access to instance tags from the instance metadata. Set to * disabled to turn off access to instance tags from the instance metadata. For more information, see * Work with * instance tags using the instance metadata. *

*

* Default: disabled *

* * @param instanceMetadataTags * Set to enabled to allow access to instance tags from the instance metadata. Set to * disabled to turn off access to instance tags from the instance metadata. For more * information, see Work * with instance tags using the instance metadata.

*

* Default: disabled * @return Returns a reference to this object so that method calls can be chained together. * @see InstanceMetadataTagsState */ public ModifyInstanceMetadataOptionsRequest withInstanceMetadataTags(String instanceMetadataTags) { setInstanceMetadataTags(instanceMetadataTags); return this; } /** *

* Set to enabled to allow access to instance tags from the instance metadata. Set to * disabled to turn off access to instance tags from the instance metadata. For more information, see * Work with * instance tags using the instance metadata. *

*

* Default: disabled *

* * @param instanceMetadataTags * Set to enabled to allow access to instance tags from the instance metadata. Set to * disabled to turn off access to instance tags from the instance metadata. For more * information, see Work * with instance tags using the instance metadata.

*

* Default: disabled * @return Returns a reference to this object so that method calls can be chained together. * @see InstanceMetadataTagsState */ public ModifyInstanceMetadataOptionsRequest withInstanceMetadataTags(InstanceMetadataTagsState instanceMetadataTags) { this.instanceMetadataTags = instanceMetadataTags.toString(); return this; } /** * This method is intended for internal use only. Returns the marshaled request configured with additional * parameters to enable operation dry-run. */ @Override public Request getDryRunRequest() { Request request = new ModifyInstanceMetadataOptionsRequestMarshaller().marshall(this); request.addParameter("DryRun", Boolean.toString(true)); return request; } /** * 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 (getInstanceId() != null) sb.append("InstanceId: ").append(getInstanceId()).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 ModifyInstanceMetadataOptionsRequest == false) return false; ModifyInstanceMetadataOptionsRequest other = (ModifyInstanceMetadataOptionsRequest) obj; if (other.getInstanceId() == null ^ this.getInstanceId() == null) return false; if (other.getInstanceId() != null && other.getInstanceId().equals(this.getInstanceId()) == 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 + ((getInstanceId() == null) ? 0 : getInstanceId().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 ModifyInstanceMetadataOptionsRequest clone() { return (ModifyInstanceMetadataOptionsRequest) super.clone(); } }