com.amazonaws.services.ec2.model.CreateIpamRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2019-2024 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.CreateIpamRequestMarshaller;
/**
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateIpamRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest {
/**
*
* A description for the IPAM.
*
*/
private String description;
/**
*
* The operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed
* to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you
* select as operating Regions.
*
*
* For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM
* User Guide.
*
*/
private com.amazonaws.internal.SdkInternalList operatingRegions;
/**
*
* The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value
* as the filter value. For example, to find all resources that have a tag with the key Owner and the
* value TeamA, specify tag:Owner for the filter name and TeamA for the
* filter value.
*
*/
private com.amazonaws.internal.SdkInternalList tagSpecifications;
/**
*
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
* information, see Ensuring
* idempotency.
*
*/
private String clientToken;
/**
*
* IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each
* tier and the costs associated with the tiers, see Amazon VPC pricing
* > IPAM tab.
*
*/
private String tier;
/**
*
* A description for the IPAM.
*
*
* @param description
* A description for the IPAM.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* A description for the IPAM.
*
*
* @return A description for the IPAM.
*/
public String getDescription() {
return this.description;
}
/**
*
* A description for the IPAM.
*
*
* @param description
* A description for the IPAM.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateIpamRequest withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* The operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed
* to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you
* select as operating Regions.
*
*
* For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM
* User Guide.
*
*
* @return The operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is
* allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services
* Regions you select as operating Regions.
*
* For more information about operating Regions, see Create an IPAM in the Amazon
* VPC IPAM User Guide.
*/
public java.util.List getOperatingRegions() {
if (operatingRegions == null) {
operatingRegions = new com.amazonaws.internal.SdkInternalList();
}
return operatingRegions;
}
/**
*
* The operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed
* to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you
* select as operating Regions.
*
*
* For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM
* User Guide.
*
*
* @param operatingRegions
* The operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is
* allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services
* Regions you select as operating Regions.
*
* For more information about operating Regions, see Create an IPAM in the Amazon
* VPC IPAM User Guide.
*/
public void setOperatingRegions(java.util.Collection operatingRegions) {
if (operatingRegions == null) {
this.operatingRegions = null;
return;
}
this.operatingRegions = new com.amazonaws.internal.SdkInternalList(operatingRegions);
}
/**
*
* The operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed
* to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you
* select as operating Regions.
*
*
* For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM
* User Guide.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setOperatingRegions(java.util.Collection)} or {@link #withOperatingRegions(java.util.Collection)} if you
* want to override the existing values.
*
*
* @param operatingRegions
* The operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is
* allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services
* Regions you select as operating Regions.
*
* For more information about operating Regions, see Create an IPAM in the Amazon
* VPC IPAM User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateIpamRequest withOperatingRegions(AddIpamOperatingRegion... operatingRegions) {
if (this.operatingRegions == null) {
setOperatingRegions(new com.amazonaws.internal.SdkInternalList(operatingRegions.length));
}
for (AddIpamOperatingRegion ele : operatingRegions) {
this.operatingRegions.add(ele);
}
return this;
}
/**
*
* The operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed
* to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you
* select as operating Regions.
*
*
* For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM
* User Guide.
*
*
* @param operatingRegions
* The operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is
* allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services
* Regions you select as operating Regions.
*
* For more information about operating Regions, see Create an IPAM in the Amazon
* VPC IPAM User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateIpamRequest withOperatingRegions(java.util.Collection operatingRegions) {
setOperatingRegions(operatingRegions);
return this;
}
/**
*
* The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value
* as the filter value. For example, to find all resources that have a tag with the key Owner and the
* value TeamA, specify tag:Owner for the filter name and TeamA for the
* filter value.
*
*
* @return The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the
* tag value as the filter value. For example, to find all resources that have a tag with the key
* Owner and the value TeamA, specify tag:Owner for the filter name
* and TeamA for the filter value.
*/
public java.util.List getTagSpecifications() {
if (tagSpecifications == null) {
tagSpecifications = new com.amazonaws.internal.SdkInternalList();
}
return tagSpecifications;
}
/**
*
* The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value
* as the filter value. For example, to find all resources that have a tag with the key Owner and the
* value TeamA, specify tag:Owner for the filter name and TeamA for the
* filter value.
*
*
* @param tagSpecifications
* The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the
* tag value as the filter value. For example, to find all resources that have a tag with the key
* Owner and the value TeamA, specify tag:Owner for the filter name
* and TeamA for the filter value.
*/
public void setTagSpecifications(java.util.Collection tagSpecifications) {
if (tagSpecifications == null) {
this.tagSpecifications = null;
return;
}
this.tagSpecifications = new com.amazonaws.internal.SdkInternalList(tagSpecifications);
}
/**
*
* The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value
* as the filter value. For example, to find all resources that have a tag with the key Owner and the
* value TeamA, specify tag:Owner for the filter name and TeamA for the
* filter value.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTagSpecifications(java.util.Collection)} or {@link #withTagSpecifications(java.util.Collection)} if
* you want to override the existing values.
*
*
* @param tagSpecifications
* The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the
* tag value as the filter value. For example, to find all resources that have a tag with the key
* Owner and the value TeamA, specify tag:Owner for the filter name
* and TeamA for the filter value.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateIpamRequest withTagSpecifications(TagSpecification... tagSpecifications) {
if (this.tagSpecifications == null) {
setTagSpecifications(new com.amazonaws.internal.SdkInternalList(tagSpecifications.length));
}
for (TagSpecification ele : tagSpecifications) {
this.tagSpecifications.add(ele);
}
return this;
}
/**
*
* The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value
* as the filter value. For example, to find all resources that have a tag with the key Owner and the
* value TeamA, specify tag:Owner for the filter name and TeamA for the
* filter value.
*
*
* @param tagSpecifications
* The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the
* tag value as the filter value. For example, to find all resources that have a tag with the key
* Owner and the value TeamA, specify tag:Owner for the filter name
* and TeamA for the filter value.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateIpamRequest withTagSpecifications(java.util.Collection tagSpecifications) {
setTagSpecifications(tagSpecifications);
return this;
}
/**
*
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
* information, see Ensuring
* idempotency.
*
*
* @param clientToken
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
* information, see Ensuring idempotency.
*/
public void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
/**
*
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
* information, see Ensuring
* idempotency.
*
*
* @return A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
* information, see Ensuring idempotency.
*/
public String getClientToken() {
return this.clientToken;
}
/**
*
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
* information, see Ensuring
* idempotency.
*
*
* @param clientToken
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
* information, see Ensuring idempotency.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateIpamRequest withClientToken(String clientToken) {
setClientToken(clientToken);
return this;
}
/**
*
* IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each
* tier and the costs associated with the tiers, see Amazon VPC pricing
* > IPAM tab.
*
*
* @param tier
* IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in
* each tier and the costs associated with the tiers, see Amazon
* VPC pricing > IPAM tab.
* @see IpamTier
*/
public void setTier(String tier) {
this.tier = tier;
}
/**
*
* IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each
* tier and the costs associated with the tiers, see Amazon VPC pricing
* > IPAM tab.
*
*
* @return IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in
* each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.
* @see IpamTier
*/
public String getTier() {
return this.tier;
}
/**
*
* IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each
* tier and the costs associated with the tiers, see Amazon VPC pricing
* > IPAM tab.
*
*
* @param tier
* IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in
* each tier and the costs associated with the tiers, see Amazon
* VPC pricing > IPAM tab.
* @return Returns a reference to this object so that method calls can be chained together.
* @see IpamTier
*/
public CreateIpamRequest withTier(String tier) {
setTier(tier);
return this;
}
/**
*
* IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each
* tier and the costs associated with the tiers, see Amazon VPC pricing
* > IPAM tab.
*
*
* @param tier
* IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in
* each tier and the costs associated with the tiers, see Amazon
* VPC pricing > IPAM tab.
* @return Returns a reference to this object so that method calls can be chained together.
* @see IpamTier
*/
public CreateIpamRequest withTier(IpamTier tier) {
this.tier = tier.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 CreateIpamRequestMarshaller().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 (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getOperatingRegions() != null)
sb.append("OperatingRegions: ").append(getOperatingRegions()).append(",");
if (getTagSpecifications() != null)
sb.append("TagSpecifications: ").append(getTagSpecifications()).append(",");
if (getClientToken() != null)
sb.append("ClientToken: ").append(getClientToken()).append(",");
if (getTier() != null)
sb.append("Tier: ").append(getTier());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateIpamRequest == false)
return false;
CreateIpamRequest other = (CreateIpamRequest) obj;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getOperatingRegions() == null ^ this.getOperatingRegions() == null)
return false;
if (other.getOperatingRegions() != null && other.getOperatingRegions().equals(this.getOperatingRegions()) == false)
return false;
if (other.getTagSpecifications() == null ^ this.getTagSpecifications() == null)
return false;
if (other.getTagSpecifications() != null && other.getTagSpecifications().equals(this.getTagSpecifications()) == false)
return false;
if (other.getClientToken() == null ^ this.getClientToken() == null)
return false;
if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == false)
return false;
if (other.getTier() == null ^ this.getTier() == null)
return false;
if (other.getTier() != null && other.getTier().equals(this.getTier()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getOperatingRegions() == null) ? 0 : getOperatingRegions().hashCode());
hashCode = prime * hashCode + ((getTagSpecifications() == null) ? 0 : getTagSpecifications().hashCode());
hashCode = prime * hashCode + ((getClientToken() == null) ? 0 : getClientToken().hashCode());
hashCode = prime * hashCode + ((getTier() == null) ? 0 : getTier().hashCode());
return hashCode;
}
@Override
public CreateIpamRequest clone() {
return (CreateIpamRequest) super.clone();
}
}