com.amazonaws.services.cloudformation.model.DeleteStackInstancesRequest Maven / Gradle / Ivy
/*
* 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.cloudformation.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DeleteStackInstancesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name or unique ID of the stack set that you want to delete stack instances for.
*
*/
private String stackSetName;
/**
*
* [Self-managed permissions] The names of the Amazon Web Services accounts that you want to delete stack instances
* for.
*
*
* You can specify Accounts or DeploymentTargets, but not both.
*
*/
private com.amazonaws.internal.SdkInternalList accounts;
/**
*
* [Service-managed permissions] The Organizations accounts from which to delete stack instances.
*
*
* You can specify Accounts or DeploymentTargets, but not both.
*
*/
private DeploymentTargets deploymentTargets;
/**
*
* The Amazon Web Services Regions where you want to delete stack set instances.
*
*/
private com.amazonaws.internal.SdkInternalList regions;
/**
*
* Preferences for how CloudFormation performs this stack set operation.
*
*/
private StackSetOperationPreferences operationPreferences;
/**
*
* Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a
* retained stack or add an existing, saved stack to a new stack set.
*
*
* For more information, see Stack set operation options.
*
*/
private Boolean retainStacks;
/**
*
* The unique identifier for this stack set operation.
*
*
* If you don't specify an operation ID, the SDK generates one automatically.
*
*
* The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set
* operation only once, even if you retry the request multiple times. You can retry stack set operation requests to
* ensure that CloudFormation successfully received them.
*
*
* Repeating this stack set operation with a new operation ID retries all stack instances whose status is
* OUTDATED.
*
*/
private String operationId;
/**
*
* [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's
* management account or as a delegated administrator in a member account.
*
*
* By default, SELF is specified. Use SELF for stack sets with self-managed permissions.
*
*
* -
*
* If you are signed in to the management account, specify SELF.
*
*
* -
*
* If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
*
*
* Your Amazon Web Services account must be registered as a delegated administrator in the management account. For
* more information, see Register a delegated administrator in the CloudFormation User Guide.
*
*
*
*/
private String callAs;
/**
*
* The name or unique ID of the stack set that you want to delete stack instances for.
*
*
* @param stackSetName
* The name or unique ID of the stack set that you want to delete stack instances for.
*/
public void setStackSetName(String stackSetName) {
this.stackSetName = stackSetName;
}
/**
*
* The name or unique ID of the stack set that you want to delete stack instances for.
*
*
* @return The name or unique ID of the stack set that you want to delete stack instances for.
*/
public String getStackSetName() {
return this.stackSetName;
}
/**
*
* The name or unique ID of the stack set that you want to delete stack instances for.
*
*
* @param stackSetName
* The name or unique ID of the stack set that you want to delete stack instances for.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeleteStackInstancesRequest withStackSetName(String stackSetName) {
setStackSetName(stackSetName);
return this;
}
/**
*
* [Self-managed permissions] The names of the Amazon Web Services accounts that you want to delete stack instances
* for.
*
*
* You can specify Accounts or DeploymentTargets, but not both.
*
*
* @return [Self-managed permissions] The names of the Amazon Web Services accounts that you want to delete stack
* instances for.
*
* You can specify Accounts or DeploymentTargets, but not both.
*/
public java.util.List getAccounts() {
if (accounts == null) {
accounts = new com.amazonaws.internal.SdkInternalList();
}
return accounts;
}
/**
*
* [Self-managed permissions] The names of the Amazon Web Services accounts that you want to delete stack instances
* for.
*
*
* You can specify Accounts or DeploymentTargets, but not both.
*
*
* @param accounts
* [Self-managed permissions] The names of the Amazon Web Services accounts that you want to delete stack
* instances for.
*
* You can specify Accounts or DeploymentTargets, but not both.
*/
public void setAccounts(java.util.Collection accounts) {
if (accounts == null) {
this.accounts = null;
return;
}
this.accounts = new com.amazonaws.internal.SdkInternalList(accounts);
}
/**
*
* [Self-managed permissions] The names of the Amazon Web Services accounts that you want to delete stack instances
* for.
*
*
* You can specify Accounts or DeploymentTargets, but not both.
*
*
* 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
* [Self-managed permissions] The names of the Amazon Web Services accounts that you want to delete stack
* instances for.
*
* You can specify Accounts or DeploymentTargets, but not both.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeleteStackInstancesRequest 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;
}
/**
*
* [Self-managed permissions] The names of the Amazon Web Services accounts that you want to delete stack instances
* for.
*
*
* You can specify Accounts or DeploymentTargets, but not both.
*
*
* @param accounts
* [Self-managed permissions] The names of the Amazon Web Services accounts that you want to delete stack
* instances for.
*
* You can specify Accounts or DeploymentTargets, but not both.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeleteStackInstancesRequest withAccounts(java.util.Collection accounts) {
setAccounts(accounts);
return this;
}
/**
*
* [Service-managed permissions] The Organizations accounts from which to delete stack instances.
*
*
* You can specify Accounts or DeploymentTargets, but not both.
*
*
* @param deploymentTargets
* [Service-managed permissions] The Organizations accounts from which to delete stack instances.
*
* You can specify Accounts or DeploymentTargets, but not both.
*/
public void setDeploymentTargets(DeploymentTargets deploymentTargets) {
this.deploymentTargets = deploymentTargets;
}
/**
*
* [Service-managed permissions] The Organizations accounts from which to delete stack instances.
*
*
* You can specify Accounts or DeploymentTargets, but not both.
*
*
* @return [Service-managed permissions] The Organizations accounts from which to delete stack instances.
*
* You can specify Accounts or DeploymentTargets, but not both.
*/
public DeploymentTargets getDeploymentTargets() {
return this.deploymentTargets;
}
/**
*
* [Service-managed permissions] The Organizations accounts from which to delete stack instances.
*
*
* You can specify Accounts or DeploymentTargets, but not both.
*
*
* @param deploymentTargets
* [Service-managed permissions] The Organizations accounts from which to delete stack instances.
*
* You can specify Accounts or DeploymentTargets, but not both.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeleteStackInstancesRequest withDeploymentTargets(DeploymentTargets deploymentTargets) {
setDeploymentTargets(deploymentTargets);
return this;
}
/**
*
* The Amazon Web Services Regions where you want to delete stack set instances.
*
*
* @return The Amazon Web Services Regions where you want to delete stack set instances.
*/
public java.util.List getRegions() {
if (regions == null) {
regions = new com.amazonaws.internal.SdkInternalList();
}
return regions;
}
/**
*
* The Amazon Web Services Regions where you want to delete stack set instances.
*
*
* @param regions
* The Amazon Web Services Regions where you want to delete stack set instances.
*/
public void setRegions(java.util.Collection regions) {
if (regions == null) {
this.regions = null;
return;
}
this.regions = new com.amazonaws.internal.SdkInternalList(regions);
}
/**
*
* The Amazon Web Services Regions where you want to delete stack set instances.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setRegions(java.util.Collection)} or {@link #withRegions(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param regions
* The Amazon Web Services Regions where you want to delete stack set instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeleteStackInstancesRequest withRegions(String... regions) {
if (this.regions == null) {
setRegions(new com.amazonaws.internal.SdkInternalList(regions.length));
}
for (String ele : regions) {
this.regions.add(ele);
}
return this;
}
/**
*
* The Amazon Web Services Regions where you want to delete stack set instances.
*
*
* @param regions
* The Amazon Web Services Regions where you want to delete stack set instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeleteStackInstancesRequest withRegions(java.util.Collection regions) {
setRegions(regions);
return this;
}
/**
*
* Preferences for how CloudFormation performs this stack set operation.
*
*
* @param operationPreferences
* Preferences for how CloudFormation performs this stack set operation.
*/
public void setOperationPreferences(StackSetOperationPreferences operationPreferences) {
this.operationPreferences = operationPreferences;
}
/**
*
* Preferences for how CloudFormation performs this stack set operation.
*
*
* @return Preferences for how CloudFormation performs this stack set operation.
*/
public StackSetOperationPreferences getOperationPreferences() {
return this.operationPreferences;
}
/**
*
* Preferences for how CloudFormation performs this stack set operation.
*
*
* @param operationPreferences
* Preferences for how CloudFormation performs this stack set operation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeleteStackInstancesRequest withOperationPreferences(StackSetOperationPreferences operationPreferences) {
setOperationPreferences(operationPreferences);
return this;
}
/**
*
* Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a
* retained stack or add an existing, saved stack to a new stack set.
*
*
* For more information, see Stack set operation options.
*
*
* @param retainStacks
* Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't
* reassociate a retained stack or add an existing, saved stack to a new stack set.
*
* For more information, see Stack set operation options.
*/
public void setRetainStacks(Boolean retainStacks) {
this.retainStacks = retainStacks;
}
/**
*
* Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a
* retained stack or add an existing, saved stack to a new stack set.
*
*
* For more information, see Stack set operation options.
*
*
* @return Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't
* reassociate a retained stack or add an existing, saved stack to a new stack set.
*
* For more information, see Stack set operation options.
*/
public Boolean getRetainStacks() {
return this.retainStacks;
}
/**
*
* Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a
* retained stack or add an existing, saved stack to a new stack set.
*
*
* For more information, see Stack set operation options.
*
*
* @param retainStacks
* Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't
* reassociate a retained stack or add an existing, saved stack to a new stack set.
*
* For more information, see Stack set operation options.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeleteStackInstancesRequest withRetainStacks(Boolean retainStacks) {
setRetainStacks(retainStacks);
return this;
}
/**
*
* Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a
* retained stack or add an existing, saved stack to a new stack set.
*
*
* For more information, see Stack set operation options.
*
*
* @return Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't
* reassociate a retained stack or add an existing, saved stack to a new stack set.
*
* For more information, see Stack set operation options.
*/
public Boolean isRetainStacks() {
return this.retainStacks;
}
/**
*
* The unique identifier for this stack set operation.
*
*
* If you don't specify an operation ID, the SDK generates one automatically.
*
*
* The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set
* operation only once, even if you retry the request multiple times. You can retry stack set operation requests to
* ensure that CloudFormation successfully received them.
*
*
* Repeating this stack set operation with a new operation ID retries all stack instances whose status is
* OUTDATED.
*
*
* @param operationId
* The unique identifier for this stack set operation.
*
* If you don't specify an operation ID, the SDK generates one automatically.
*
*
* The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack
* set operation only once, even if you retry the request multiple times. You can retry stack set operation
* requests to ensure that CloudFormation successfully received them.
*
*
* Repeating this stack set operation with a new operation ID retries all stack instances whose status is
* OUTDATED.
*/
public void setOperationId(String operationId) {
this.operationId = operationId;
}
/**
*
* The unique identifier for this stack set operation.
*
*
* If you don't specify an operation ID, the SDK generates one automatically.
*
*
* The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set
* operation only once, even if you retry the request multiple times. You can retry stack set operation requests to
* ensure that CloudFormation successfully received them.
*
*
* Repeating this stack set operation with a new operation ID retries all stack instances whose status is
* OUTDATED.
*
*
* @return The unique identifier for this stack set operation.
*
* If you don't specify an operation ID, the SDK generates one automatically.
*
*
* The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack
* set operation only once, even if you retry the request multiple times. You can retry stack set operation
* requests to ensure that CloudFormation successfully received them.
*
*
* Repeating this stack set operation with a new operation ID retries all stack instances whose status is
* OUTDATED.
*/
public String getOperationId() {
return this.operationId;
}
/**
*
* The unique identifier for this stack set operation.
*
*
* If you don't specify an operation ID, the SDK generates one automatically.
*
*
* The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set
* operation only once, even if you retry the request multiple times. You can retry stack set operation requests to
* ensure that CloudFormation successfully received them.
*
*
* Repeating this stack set operation with a new operation ID retries all stack instances whose status is
* OUTDATED.
*
*
* @param operationId
* The unique identifier for this stack set operation.
*
* If you don't specify an operation ID, the SDK generates one automatically.
*
*
* The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack
* set operation only once, even if you retry the request multiple times. You can retry stack set operation
* requests to ensure that CloudFormation successfully received them.
*
*
* Repeating this stack set operation with a new operation ID retries all stack instances whose status is
* OUTDATED.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeleteStackInstancesRequest withOperationId(String operationId) {
setOperationId(operationId);
return this;
}
/**
*
* [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's
* management account or as a delegated administrator in a member account.
*
*
* By default, SELF is specified. Use SELF for stack sets with self-managed permissions.
*
*
* -
*
* If you are signed in to the management account, specify SELF.
*
*
* -
*
* If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
*
*
* Your Amazon Web Services account must be registered as a delegated administrator in the management account. For
* more information, see Register a delegated administrator in the CloudFormation User Guide.
*
*
*
*
* @param callAs
* [Service-managed permissions] Specifies whether you are acting as an account administrator in the
* organization's management account or as a delegated administrator in a member account.
*
* By default, SELF is specified. Use SELF for stack sets with self-managed
* permissions.
*
*
* -
*
* If you are signed in to the management account, specify SELF.
*
*
* -
*
* If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
*
*
* Your Amazon Web Services account must be registered as a delegated administrator in the management
* account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
*
*
* @see CallAs
*/
public void setCallAs(String callAs) {
this.callAs = callAs;
}
/**
*
* [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's
* management account or as a delegated administrator in a member account.
*
*
* By default, SELF is specified. Use SELF for stack sets with self-managed permissions.
*
*
* -
*
* If you are signed in to the management account, specify SELF.
*
*
* -
*
* If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
*
*
* Your Amazon Web Services account must be registered as a delegated administrator in the management account. For
* more information, see Register a delegated administrator in the CloudFormation User Guide.
*
*
*
*
* @return [Service-managed permissions] Specifies whether you are acting as an account administrator in the
* organization's management account or as a delegated administrator in a member account.
*
* By default, SELF is specified. Use SELF for stack sets with self-managed
* permissions.
*
*
* -
*
* If you are signed in to the management account, specify SELF.
*
*
* -
*
* If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
*
*
* Your Amazon Web Services account must be registered as a delegated administrator in the management
* account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
*
*
* @see CallAs
*/
public String getCallAs() {
return this.callAs;
}
/**
*
* [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's
* management account or as a delegated administrator in a member account.
*
*
* By default, SELF is specified. Use SELF for stack sets with self-managed permissions.
*
*
* -
*
* If you are signed in to the management account, specify SELF.
*
*
* -
*
* If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
*
*
* Your Amazon Web Services account must be registered as a delegated administrator in the management account. For
* more information, see Register a delegated administrator in the CloudFormation User Guide.
*
*
*
*
* @param callAs
* [Service-managed permissions] Specifies whether you are acting as an account administrator in the
* organization's management account or as a delegated administrator in a member account.
*
* By default, SELF is specified. Use SELF for stack sets with self-managed
* permissions.
*
*
* -
*
* If you are signed in to the management account, specify SELF.
*
*
* -
*
* If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
*
*
* Your Amazon Web Services account must be registered as a delegated administrator in the management
* account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see CallAs
*/
public DeleteStackInstancesRequest withCallAs(String callAs) {
setCallAs(callAs);
return this;
}
/**
*
* [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's
* management account or as a delegated administrator in a member account.
*
*
* By default, SELF is specified. Use SELF for stack sets with self-managed permissions.
*
*
* -
*
* If you are signed in to the management account, specify SELF.
*
*
* -
*
* If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
*
*
* Your Amazon Web Services account must be registered as a delegated administrator in the management account. For
* more information, see Register a delegated administrator in the CloudFormation User Guide.
*
*
*
*
* @param callAs
* [Service-managed permissions] Specifies whether you are acting as an account administrator in the
* organization's management account or as a delegated administrator in a member account.
*
* By default, SELF is specified. Use SELF for stack sets with self-managed
* permissions.
*
*
* -
*
* If you are signed in to the management account, specify SELF.
*
*
* -
*
* If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
*
*
* Your Amazon Web Services account must be registered as a delegated administrator in the management
* account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see CallAs
*/
public DeleteStackInstancesRequest withCallAs(CallAs callAs) {
this.callAs = callAs.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 (getStackSetName() != null)
sb.append("StackSetName: ").append(getStackSetName()).append(",");
if (getAccounts() != null)
sb.append("Accounts: ").append(getAccounts()).append(",");
if (getDeploymentTargets() != null)
sb.append("DeploymentTargets: ").append(getDeploymentTargets()).append(",");
if (getRegions() != null)
sb.append("Regions: ").append(getRegions()).append(",");
if (getOperationPreferences() != null)
sb.append("OperationPreferences: ").append(getOperationPreferences()).append(",");
if (getRetainStacks() != null)
sb.append("RetainStacks: ").append(getRetainStacks()).append(",");
if (getOperationId() != null)
sb.append("OperationId: ").append(getOperationId()).append(",");
if (getCallAs() != null)
sb.append("CallAs: ").append(getCallAs());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DeleteStackInstancesRequest == false)
return false;
DeleteStackInstancesRequest other = (DeleteStackInstancesRequest) obj;
if (other.getStackSetName() == null ^ this.getStackSetName() == null)
return false;
if (other.getStackSetName() != null && other.getStackSetName().equals(this.getStackSetName()) == false)
return false;
if (other.getAccounts() == null ^ this.getAccounts() == null)
return false;
if (other.getAccounts() != null && other.getAccounts().equals(this.getAccounts()) == false)
return false;
if (other.getDeploymentTargets() == null ^ this.getDeploymentTargets() == null)
return false;
if (other.getDeploymentTargets() != null && other.getDeploymentTargets().equals(this.getDeploymentTargets()) == false)
return false;
if (other.getRegions() == null ^ this.getRegions() == null)
return false;
if (other.getRegions() != null && other.getRegions().equals(this.getRegions()) == false)
return false;
if (other.getOperationPreferences() == null ^ this.getOperationPreferences() == null)
return false;
if (other.getOperationPreferences() != null && other.getOperationPreferences().equals(this.getOperationPreferences()) == false)
return false;
if (other.getRetainStacks() == null ^ this.getRetainStacks() == null)
return false;
if (other.getRetainStacks() != null && other.getRetainStacks().equals(this.getRetainStacks()) == false)
return false;
if (other.getOperationId() == null ^ this.getOperationId() == null)
return false;
if (other.getOperationId() != null && other.getOperationId().equals(this.getOperationId()) == false)
return false;
if (other.getCallAs() == null ^ this.getCallAs() == null)
return false;
if (other.getCallAs() != null && other.getCallAs().equals(this.getCallAs()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getStackSetName() == null) ? 0 : getStackSetName().hashCode());
hashCode = prime * hashCode + ((getAccounts() == null) ? 0 : getAccounts().hashCode());
hashCode = prime * hashCode + ((getDeploymentTargets() == null) ? 0 : getDeploymentTargets().hashCode());
hashCode = prime * hashCode + ((getRegions() == null) ? 0 : getRegions().hashCode());
hashCode = prime * hashCode + ((getOperationPreferences() == null) ? 0 : getOperationPreferences().hashCode());
hashCode = prime * hashCode + ((getRetainStacks() == null) ? 0 : getRetainStacks().hashCode());
hashCode = prime * hashCode + ((getOperationId() == null) ? 0 : getOperationId().hashCode());
hashCode = prime * hashCode + ((getCallAs() == null) ? 0 : getCallAs().hashCode());
return hashCode;
}
@Override
public DeleteStackInstancesRequest clone() {
return (DeleteStackInstancesRequest) super.clone();
}
}