Ec2Config.java

/*
 * Copyright 2017-2022 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.datasync.model;

import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;

/**
 * <p>
 * The subnet and security groups that DataSync uses to access your Amazon EFS file system.
 * </p>
 * 
 * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/Ec2Config" target="_top">AWS API
 *      Documentation</a>
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Ec2Config implements Serializable, Cloneable, StructuredPojo {

    /**
     * <p>
     * Specifies the ARN of a subnet where DataSync creates the <a
     * href="https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces"
     * >network interfaces</a> for managing traffic during your transfer.
     * </p>
     * <p>
     * The subnet must be located:
     * </p>
     * <ul>
     * <li>
     * <p>
     * In the same virtual private cloud (VPC) as the Amazon EFS file system.
     * </p>
     * </li>
     * <li>
     * <p>
     * In the same Availability Zone as at least one mount target for the Amazon EFS file system.
     * </p>
     * </li>
     * </ul>
     * <note>
     * <p>
     * You don't need to specify a subnet that includes a file system mount target.
     * </p>
     * </note>
     */
    private String subnetArn;
    /**
     * <p>
     * Specifies the Amazon Resource Names (ARNs) of the security groups associated with an Amazon EFS file system's
     * mount target.
     * </p>
     */
    private java.util.List<String> securityGroupArns;

    /**
     * <p>
     * Specifies the ARN of a subnet where DataSync creates the <a
     * href="https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces"
     * >network interfaces</a> for managing traffic during your transfer.
     * </p>
     * <p>
     * The subnet must be located:
     * </p>
     * <ul>
     * <li>
     * <p>
     * In the same virtual private cloud (VPC) as the Amazon EFS file system.
     * </p>
     * </li>
     * <li>
     * <p>
     * In the same Availability Zone as at least one mount target for the Amazon EFS file system.
     * </p>
     * </li>
     * </ul>
     * <note>
     * <p>
     * You don't need to specify a subnet that includes a file system mount target.
     * </p>
     * </note>
     * 
     * @param subnetArn
     *        Specifies the ARN of a subnet where DataSync creates the <a href=
     *        "https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces"
     *        >network interfaces</a> for managing traffic during your transfer.</p>
     *        <p>
     *        The subnet must be located:
     *        </p>
     *        <ul>
     *        <li>
     *        <p>
     *        In the same virtual private cloud (VPC) as the Amazon EFS file system.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        In the same Availability Zone as at least one mount target for the Amazon EFS file system.
     *        </p>
     *        </li>
     *        </ul>
     *        <note>
     *        <p>
     *        You don't need to specify a subnet that includes a file system mount target.
     *        </p>
     */

    public void setSubnetArn(String subnetArn) {
        this.subnetArn = subnetArn;
    }

    /**
     * <p>
     * Specifies the ARN of a subnet where DataSync creates the <a
     * href="https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces"
     * >network interfaces</a> for managing traffic during your transfer.
     * </p>
     * <p>
     * The subnet must be located:
     * </p>
     * <ul>
     * <li>
     * <p>
     * In the same virtual private cloud (VPC) as the Amazon EFS file system.
     * </p>
     * </li>
     * <li>
     * <p>
     * In the same Availability Zone as at least one mount target for the Amazon EFS file system.
     * </p>
     * </li>
     * </ul>
     * <note>
     * <p>
     * You don't need to specify a subnet that includes a file system mount target.
     * </p>
     * </note>
     * 
     * @return Specifies the ARN of a subnet where DataSync creates the <a
     *         href="https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces"
     *         >network interfaces</a> for managing traffic during your transfer.</p>
     *         <p>
     *         The subnet must be located:
     *         </p>
     *         <ul>
     *         <li>
     *         <p>
     *         In the same virtual private cloud (VPC) as the Amazon EFS file system.
     *         </p>
     *         </li>
     *         <li>
     *         <p>
     *         In the same Availability Zone as at least one mount target for the Amazon EFS file system.
     *         </p>
     *         </li>
     *         </ul>
     *         <note>
     *         <p>
     *         You don't need to specify a subnet that includes a file system mount target.
     *         </p>
     */

    public String getSubnetArn() {
        return this.subnetArn;
    }

    /**
     * <p>
     * Specifies the ARN of a subnet where DataSync creates the <a
     * href="https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces"
     * >network interfaces</a> for managing traffic during your transfer.
     * </p>
     * <p>
     * The subnet must be located:
     * </p>
     * <ul>
     * <li>
     * <p>
     * In the same virtual private cloud (VPC) as the Amazon EFS file system.
     * </p>
     * </li>
     * <li>
     * <p>
     * In the same Availability Zone as at least one mount target for the Amazon EFS file system.
     * </p>
     * </li>
     * </ul>
     * <note>
     * <p>
     * You don't need to specify a subnet that includes a file system mount target.
     * </p>
     * </note>
     * 
     * @param subnetArn
     *        Specifies the ARN of a subnet where DataSync creates the <a href=
     *        "https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces"
     *        >network interfaces</a> for managing traffic during your transfer.</p>
     *        <p>
     *        The subnet must be located:
     *        </p>
     *        <ul>
     *        <li>
     *        <p>
     *        In the same virtual private cloud (VPC) as the Amazon EFS file system.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        In the same Availability Zone as at least one mount target for the Amazon EFS file system.
     *        </p>
     *        </li>
     *        </ul>
     *        <note>
     *        <p>
     *        You don't need to specify a subnet that includes a file system mount target.
     *        </p>
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public Ec2Config withSubnetArn(String subnetArn) {
        setSubnetArn(subnetArn);
        return this;
    }

    /**
     * <p>
     * Specifies the Amazon Resource Names (ARNs) of the security groups associated with an Amazon EFS file system's
     * mount target.
     * </p>
     * 
     * @return Specifies the Amazon Resource Names (ARNs) of the security groups associated with an Amazon EFS file
     *         system's mount target.
     */

    public java.util.List<String> getSecurityGroupArns() {
        return securityGroupArns;
    }

    /**
     * <p>
     * Specifies the Amazon Resource Names (ARNs) of the security groups associated with an Amazon EFS file system's
     * mount target.
     * </p>
     * 
     * @param securityGroupArns
     *        Specifies the Amazon Resource Names (ARNs) of the security groups associated with an Amazon EFS file
     *        system's mount target.
     */

    public void setSecurityGroupArns(java.util.Collection<String> securityGroupArns) {
        if (securityGroupArns == null) {
            this.securityGroupArns = null;
            return;
        }

        this.securityGroupArns = new java.util.ArrayList<String>(securityGroupArns);
    }

    /**
     * <p>
     * Specifies the Amazon Resource Names (ARNs) of the security groups associated with an Amazon EFS file system's
     * mount target.
     * </p>
     * <p>
     * <b>NOTE:</b> This method appends the values to the existing list (if any). Use
     * {@link #setSecurityGroupArns(java.util.Collection)} or {@link #withSecurityGroupArns(java.util.Collection)} if
     * you want to override the existing values.
     * </p>
     * 
     * @param securityGroupArns
     *        Specifies the Amazon Resource Names (ARNs) of the security groups associated with an Amazon EFS file
     *        system's mount target.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public Ec2Config withSecurityGroupArns(String... securityGroupArns) {
        if (this.securityGroupArns == null) {
            setSecurityGroupArns(new java.util.ArrayList<String>(securityGroupArns.length));
        }
        for (String ele : securityGroupArns) {
            this.securityGroupArns.add(ele);
        }
        return this;
    }

    /**
     * <p>
     * Specifies the Amazon Resource Names (ARNs) of the security groups associated with an Amazon EFS file system's
     * mount target.
     * </p>
     * 
     * @param securityGroupArns
     *        Specifies the Amazon Resource Names (ARNs) of the security groups associated with an Amazon EFS file
     *        system's mount target.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public Ec2Config withSecurityGroupArns(java.util.Collection<String> securityGroupArns) {
        setSecurityGroupArns(securityGroupArns);
        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 (getSubnetArn() != null)
            sb.append("SubnetArn: ").append(getSubnetArn()).append(",");
        if (getSecurityGroupArns() != null)
            sb.append("SecurityGroupArns: ").append(getSecurityGroupArns());
        sb.append("}");
        return sb.toString();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;

        if (obj instanceof Ec2Config == false)
            return false;
        Ec2Config other = (Ec2Config) obj;
        if (other.getSubnetArn() == null ^ this.getSubnetArn() == null)
            return false;
        if (other.getSubnetArn() != null && other.getSubnetArn().equals(this.getSubnetArn()) == false)
            return false;
        if (other.getSecurityGroupArns() == null ^ this.getSecurityGroupArns() == null)
            return false;
        if (other.getSecurityGroupArns() != null && other.getSecurityGroupArns().equals(this.getSecurityGroupArns()) == false)
            return false;
        return true;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;

        hashCode = prime * hashCode + ((getSubnetArn() == null) ? 0 : getSubnetArn().hashCode());
        hashCode = prime * hashCode + ((getSecurityGroupArns() == null) ? 0 : getSecurityGroupArns().hashCode());
        return hashCode;
    }

    @Override
    public Ec2Config clone() {
        try {
            return (Ec2Config) 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.datasync.model.transform.Ec2ConfigMarshaller.getInstance().marshall(this, protocolMarshaller);
    }
}