com.amazonaws.services.cloudformation.model.DeploymentTargets Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cloudformation 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.cloudformation.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* [Service-managed permissions] The Organizations accounts to which StackSets deploys. StackSets doesn't deploy stack
* instances to the organization management account, even if the organization management account is in your organization
* or in an OU in your organization.
*
*
* For update operations, you can specify either Accounts or OrganizationalUnitIds. For create
* and delete operations, specify OrganizationalUnitIds.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DeploymentTargets implements Serializable, Cloneable {
/**
*
* The names of one or more Amazon Web Services accounts for which you want to deploy stack set updates.
*
*/
private com.amazonaws.internal.SdkInternalList accounts;
/**
*
* Returns the value of the AccountsUrl property.
*
*/
private String accountsUrl;
/**
*
* The organization root ID or organizational unit (OU) IDs to which StackSets deploys.
*
*/
private com.amazonaws.internal.SdkInternalList organizationalUnitIds;
/**
*
* Limit deployment targets to individual accounts or include additional accounts with provided OUs.
*
*
* The following is a list of possible values for the AccountFilterType operation.
*
*
* -
*
* INTERSECTION: StackSets deploys to the accounts specified in Accounts parameter.
*
*
* -
*
* DIFFERENCE: StackSets excludes the accounts specified in Accounts parameter. This
* enables user to avoid certain accounts within an OU such as suspended accounts.
*
*
* -
*
* UNION: StackSets includes additional accounts deployment targets.
*
*
* This is the default value if AccountFilterType is not provided. This enables user to update an
* entire OU and individual accounts from a different OU in one request, which used to be two separate requests.
*
*
* -
*
* NONE: Deploys to all the accounts in specified organizational units (OU).
*
*
*
*/
private String accountFilterType;
/**
*
* The names of one or more Amazon Web Services accounts for which you want to deploy stack set updates.
*
*
* @return The names of one or more Amazon Web Services accounts for which you want to deploy stack set updates.
*/
public java.util.List getAccounts() {
if (accounts == null) {
accounts = new com.amazonaws.internal.SdkInternalList();
}
return accounts;
}
/**
*
* The names of one or more Amazon Web Services accounts for which you want to deploy stack set updates.
*
*
* @param accounts
* The names of one or more Amazon Web Services accounts for which you want to deploy stack set updates.
*/
public void setAccounts(java.util.Collection accounts) {
if (accounts == null) {
this.accounts = null;
return;
}
this.accounts = new com.amazonaws.internal.SdkInternalList(accounts);
}
/**
*
* The names of one or more Amazon Web Services accounts for which you want to deploy stack set updates.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setAccounts(java.util.Collection)} or {@link #withAccounts(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param accounts
* The names of one or more Amazon Web Services accounts for which you want to deploy stack set updates.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeploymentTargets withAccounts(String... accounts) {
if (this.accounts == null) {
setAccounts(new com.amazonaws.internal.SdkInternalList(accounts.length));
}
for (String ele : accounts) {
this.accounts.add(ele);
}
return this;
}
/**
*
* The names of one or more Amazon Web Services accounts for which you want to deploy stack set updates.
*
*
* @param accounts
* The names of one or more Amazon Web Services accounts for which you want to deploy stack set updates.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeploymentTargets withAccounts(java.util.Collection accounts) {
setAccounts(accounts);
return this;
}
/**
*
* Returns the value of the AccountsUrl property.
*
*
* @param accountsUrl
* Returns the value of the AccountsUrl property.
*/
public void setAccountsUrl(String accountsUrl) {
this.accountsUrl = accountsUrl;
}
/**
*
* Returns the value of the AccountsUrl property.
*
*
* @return Returns the value of the AccountsUrl property.
*/
public String getAccountsUrl() {
return this.accountsUrl;
}
/**
*
* Returns the value of the AccountsUrl property.
*
*
* @param accountsUrl
* Returns the value of the AccountsUrl property.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeploymentTargets withAccountsUrl(String accountsUrl) {
setAccountsUrl(accountsUrl);
return this;
}
/**
*
* The organization root ID or organizational unit (OU) IDs to which StackSets deploys.
*
*
* @return The organization root ID or organizational unit (OU) IDs to which StackSets deploys.
*/
public java.util.List getOrganizationalUnitIds() {
if (organizationalUnitIds == null) {
organizationalUnitIds = new com.amazonaws.internal.SdkInternalList();
}
return organizationalUnitIds;
}
/**
*
* The organization root ID or organizational unit (OU) IDs to which StackSets deploys.
*
*
* @param organizationalUnitIds
* The organization root ID or organizational unit (OU) IDs to which StackSets deploys.
*/
public void setOrganizationalUnitIds(java.util.Collection organizationalUnitIds) {
if (organizationalUnitIds == null) {
this.organizationalUnitIds = null;
return;
}
this.organizationalUnitIds = new com.amazonaws.internal.SdkInternalList(organizationalUnitIds);
}
/**
*
* The organization root ID or organizational unit (OU) IDs to which StackSets deploys.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setOrganizationalUnitIds(java.util.Collection)} or
* {@link #withOrganizationalUnitIds(java.util.Collection)} if you want to override the existing values.
*
*
* @param organizationalUnitIds
* The organization root ID or organizational unit (OU) IDs to which StackSets deploys.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeploymentTargets withOrganizationalUnitIds(String... organizationalUnitIds) {
if (this.organizationalUnitIds == null) {
setOrganizationalUnitIds(new com.amazonaws.internal.SdkInternalList(organizationalUnitIds.length));
}
for (String ele : organizationalUnitIds) {
this.organizationalUnitIds.add(ele);
}
return this;
}
/**
*
* The organization root ID or organizational unit (OU) IDs to which StackSets deploys.
*
*
* @param organizationalUnitIds
* The organization root ID or organizational unit (OU) IDs to which StackSets deploys.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeploymentTargets withOrganizationalUnitIds(java.util.Collection organizationalUnitIds) {
setOrganizationalUnitIds(organizationalUnitIds);
return this;
}
/**
*
* Limit deployment targets to individual accounts or include additional accounts with provided OUs.
*
*
* The following is a list of possible values for the AccountFilterType operation.
*
*
* -
*
* INTERSECTION: StackSets deploys to the accounts specified in Accounts parameter.
*
*
* -
*
* DIFFERENCE: StackSets excludes the accounts specified in Accounts parameter. This
* enables user to avoid certain accounts within an OU such as suspended accounts.
*
*
* -
*
* UNION: StackSets includes additional accounts deployment targets.
*
*
* This is the default value if AccountFilterType is not provided. This enables user to update an
* entire OU and individual accounts from a different OU in one request, which used to be two separate requests.
*
*
* -
*
* NONE: Deploys to all the accounts in specified organizational units (OU).
*
*
*
*
* @param accountFilterType
* Limit deployment targets to individual accounts or include additional accounts with provided OUs.
*
* The following is a list of possible values for the AccountFilterType operation.
*
*
* -
*
* INTERSECTION: StackSets deploys to the accounts specified in Accounts parameter.
*
*
* -
*
* DIFFERENCE: StackSets excludes the accounts specified in Accounts parameter.
* This enables user to avoid certain accounts within an OU such as suspended accounts.
*
*
* -
*
* UNION: StackSets includes additional accounts deployment targets.
*
*
* This is the default value if AccountFilterType is not provided. This enables user to update
* an entire OU and individual accounts from a different OU in one request, which used to be two separate
* requests.
*
*
* -
*
* NONE: Deploys to all the accounts in specified organizational units (OU).
*
*
* @see AccountFilterType
*/
public void setAccountFilterType(String accountFilterType) {
this.accountFilterType = accountFilterType;
}
/**
*
* Limit deployment targets to individual accounts or include additional accounts with provided OUs.
*
*
* The following is a list of possible values for the AccountFilterType operation.
*
*
* -
*
* INTERSECTION: StackSets deploys to the accounts specified in Accounts parameter.
*
*
* -
*
* DIFFERENCE: StackSets excludes the accounts specified in Accounts parameter. This
* enables user to avoid certain accounts within an OU such as suspended accounts.
*
*
* -
*
* UNION: StackSets includes additional accounts deployment targets.
*
*
* This is the default value if AccountFilterType is not provided. This enables user to update an
* entire OU and individual accounts from a different OU in one request, which used to be two separate requests.
*
*
* -
*
* NONE: Deploys to all the accounts in specified organizational units (OU).
*
*
*
*
* @return Limit deployment targets to individual accounts or include additional accounts with provided OUs.
*
* The following is a list of possible values for the AccountFilterType operation.
*
*
* -
*
* INTERSECTION: StackSets deploys to the accounts specified in Accounts
* parameter.
*
*
* -
*
* DIFFERENCE: StackSets excludes the accounts specified in Accounts parameter.
* This enables user to avoid certain accounts within an OU such as suspended accounts.
*
*
* -
*
* UNION: StackSets includes additional accounts deployment targets.
*
*
* This is the default value if AccountFilterType is not provided. This enables user to update
* an entire OU and individual accounts from a different OU in one request, which used to be two separate
* requests.
*
*
* -
*
* NONE: Deploys to all the accounts in specified organizational units (OU).
*
*
* @see AccountFilterType
*/
public String getAccountFilterType() {
return this.accountFilterType;
}
/**
*
* Limit deployment targets to individual accounts or include additional accounts with provided OUs.
*
*
* The following is a list of possible values for the AccountFilterType operation.
*
*
* -
*
* INTERSECTION: StackSets deploys to the accounts specified in Accounts parameter.
*
*
* -
*
* DIFFERENCE: StackSets excludes the accounts specified in Accounts parameter. This
* enables user to avoid certain accounts within an OU such as suspended accounts.
*
*
* -
*
* UNION: StackSets includes additional accounts deployment targets.
*
*
* This is the default value if AccountFilterType is not provided. This enables user to update an
* entire OU and individual accounts from a different OU in one request, which used to be two separate requests.
*
*
* -
*
* NONE: Deploys to all the accounts in specified organizational units (OU).
*
*
*
*
* @param accountFilterType
* Limit deployment targets to individual accounts or include additional accounts with provided OUs.
*
* The following is a list of possible values for the AccountFilterType operation.
*
*
* -
*
* INTERSECTION: StackSets deploys to the accounts specified in Accounts parameter.
*
*
* -
*
* DIFFERENCE: StackSets excludes the accounts specified in Accounts parameter.
* This enables user to avoid certain accounts within an OU such as suspended accounts.
*
*
* -
*
* UNION: StackSets includes additional accounts deployment targets.
*
*
* This is the default value if AccountFilterType is not provided. This enables user to update
* an entire OU and individual accounts from a different OU in one request, which used to be two separate
* requests.
*
*
* -
*
* NONE: Deploys to all the accounts in specified organizational units (OU).
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see AccountFilterType
*/
public DeploymentTargets withAccountFilterType(String accountFilterType) {
setAccountFilterType(accountFilterType);
return this;
}
/**
*
* Limit deployment targets to individual accounts or include additional accounts with provided OUs.
*
*
* The following is a list of possible values for the AccountFilterType operation.
*
*
* -
*
* INTERSECTION: StackSets deploys to the accounts specified in Accounts parameter.
*
*
* -
*
* DIFFERENCE: StackSets excludes the accounts specified in Accounts parameter. This
* enables user to avoid certain accounts within an OU such as suspended accounts.
*
*
* -
*
* UNION: StackSets includes additional accounts deployment targets.
*
*
* This is the default value if AccountFilterType is not provided. This enables user to update an
* entire OU and individual accounts from a different OU in one request, which used to be two separate requests.
*
*
* -
*
* NONE: Deploys to all the accounts in specified organizational units (OU).
*
*
*
*
* @param accountFilterType
* Limit deployment targets to individual accounts or include additional accounts with provided OUs.
*
* The following is a list of possible values for the AccountFilterType operation.
*
*
* -
*
* INTERSECTION: StackSets deploys to the accounts specified in Accounts parameter.
*
*
* -
*
* DIFFERENCE: StackSets excludes the accounts specified in Accounts parameter.
* This enables user to avoid certain accounts within an OU such as suspended accounts.
*
*
* -
*
* UNION: StackSets includes additional accounts deployment targets.
*
*
* This is the default value if AccountFilterType is not provided. This enables user to update
* an entire OU and individual accounts from a different OU in one request, which used to be two separate
* requests.
*
*
* -
*
* NONE: Deploys to all the accounts in specified organizational units (OU).
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see AccountFilterType
*/
public DeploymentTargets withAccountFilterType(AccountFilterType accountFilterType) {
this.accountFilterType = accountFilterType.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 (getAccounts() != null)
sb.append("Accounts: ").append(getAccounts()).append(",");
if (getAccountsUrl() != null)
sb.append("AccountsUrl: ").append(getAccountsUrl()).append(",");
if (getOrganizationalUnitIds() != null)
sb.append("OrganizationalUnitIds: ").append(getOrganizationalUnitIds()).append(",");
if (getAccountFilterType() != null)
sb.append("AccountFilterType: ").append(getAccountFilterType());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DeploymentTargets == false)
return false;
DeploymentTargets other = (DeploymentTargets) obj;
if (other.getAccounts() == null ^ this.getAccounts() == null)
return false;
if (other.getAccounts() != null && other.getAccounts().equals(this.getAccounts()) == false)
return false;
if (other.getAccountsUrl() == null ^ this.getAccountsUrl() == null)
return false;
if (other.getAccountsUrl() != null && other.getAccountsUrl().equals(this.getAccountsUrl()) == false)
return false;
if (other.getOrganizationalUnitIds() == null ^ this.getOrganizationalUnitIds() == null)
return false;
if (other.getOrganizationalUnitIds() != null && other.getOrganizationalUnitIds().equals(this.getOrganizationalUnitIds()) == false)
return false;
if (other.getAccountFilterType() == null ^ this.getAccountFilterType() == null)
return false;
if (other.getAccountFilterType() != null && other.getAccountFilterType().equals(this.getAccountFilterType()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAccounts() == null) ? 0 : getAccounts().hashCode());
hashCode = prime * hashCode + ((getAccountsUrl() == null) ? 0 : getAccountsUrl().hashCode());
hashCode = prime * hashCode + ((getOrganizationalUnitIds() == null) ? 0 : getOrganizationalUnitIds().hashCode());
hashCode = prime * hashCode + ((getAccountFilterType() == null) ? 0 : getAccountFilterType().hashCode());
return hashCode;
}
@Override
public DeploymentTargets clone() {
try {
return (DeploymentTargets) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}