com.amazonaws.services.cloudformation.model.CreateStackInstancesRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cloudformation Show documentation
/*
* Copyright 2012-2018 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 CreateStackInstancesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name or unique ID of the stack set that you want to create stack instances from.
*
*/
private String stackSetName;
/**
*
* The names of one or more AWS accounts that you want to create stack instances in the specified region(s) for.
*
*/
private com.amazonaws.internal.SdkInternalList accounts;
/**
*
* The names of one or more regions where you want to create stack instances using the specified AWS account(s).
*
*/
private com.amazonaws.internal.SdkInternalList regions;
/**
*
* A list of stack set parameters whose values you want to override in the selected stack instances.
*
*
* Any overridden parameter values will be applied to all stack instances in the specified accounts and regions.
* When specifying parameters and their values, be aware of how AWS CloudFormation sets parameter values during
* stack instance operations:
*
*
* -
*
* To override the current value for a parameter, include the parameter and specify its value.
*
*
* -
*
* To leave a parameter set to its present value, you can do one of the following:
*
*
* -
*
* Do not include the parameter in the list.
*
*
* -
*
* Include the parameter and specify UsePreviousValue as true. (You cannot specify both a
* value and set UsePreviousValue to true.)
*
*
*
*
* -
*
* To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do
* not include any parameters.
*
*
* -
*
* To leave all parameters set to their present values, do not specify this property at all.
*
*
*
*
* During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their
* overridden value.
*
*
* You can only override the parameter values that are specified in the stack set; to add or delete a
* parameter itself, use UpdateStackSet to update the stack set template.
*
*/
private com.amazonaws.internal.SdkInternalList parameterOverrides;
/**
*
* Preferences for how AWS CloudFormation performs this stack set operation.
*
*/
private StackSetOperationPreferences operationPreferences;
/**
*
* The unique identifier for this stack set operation.
*
*
* The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set
* operation only once, even if you retry the request multiple times. You might retry stack set operation requests
* to ensure that AWS CloudFormation successfully received them.
*
*
* If you don't specify an operation ID, the SDK generates one automatically.
*
*
* Repeating this stack set operation with a new operation ID retries all stack instances whose status is
* OUTDATED.
*
*/
private String operationId;
/**
*
* The name or unique ID of the stack set that you want to create stack instances from.
*
*
* @param stackSetName
* The name or unique ID of the stack set that you want to create stack instances from.
*/
public void setStackSetName(String stackSetName) {
this.stackSetName = stackSetName;
}
/**
*
* The name or unique ID of the stack set that you want to create stack instances from.
*
*
* @return The name or unique ID of the stack set that you want to create stack instances from.
*/
public String getStackSetName() {
return this.stackSetName;
}
/**
*
* The name or unique ID of the stack set that you want to create stack instances from.
*
*
* @param stackSetName
* The name or unique ID of the stack set that you want to create stack instances from.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateStackInstancesRequest withStackSetName(String stackSetName) {
setStackSetName(stackSetName);
return this;
}
/**
*
* The names of one or more AWS accounts that you want to create stack instances in the specified region(s) for.
*
*
* @return The names of one or more AWS accounts that you want to create stack instances in the specified region(s)
* for.
*/
public java.util.List getAccounts() {
if (accounts == null) {
accounts = new com.amazonaws.internal.SdkInternalList();
}
return accounts;
}
/**
*
* The names of one or more AWS accounts that you want to create stack instances in the specified region(s) for.
*
*
* @param accounts
* The names of one or more AWS accounts that you want to create stack instances in the specified region(s)
* for.
*/
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 AWS accounts that you want to create stack instances in the specified region(s) for.
*
*
* 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 AWS accounts that you want to create stack instances in the specified region(s)
* for.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateStackInstancesRequest 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 AWS accounts that you want to create stack instances in the specified region(s) for.
*
*
* @param accounts
* The names of one or more AWS accounts that you want to create stack instances in the specified region(s)
* for.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateStackInstancesRequest withAccounts(java.util.Collection accounts) {
setAccounts(accounts);
return this;
}
/**
*
* The names of one or more regions where you want to create stack instances using the specified AWS account(s).
*
*
* @return The names of one or more regions where you want to create stack instances using the specified AWS
* account(s).
*/
public java.util.List getRegions() {
if (regions == null) {
regions = new com.amazonaws.internal.SdkInternalList();
}
return regions;
}
/**
*
* The names of one or more regions where you want to create stack instances using the specified AWS account(s).
*
*
* @param regions
* The names of one or more regions where you want to create stack instances using the specified AWS
* account(s).
*/
public void setRegions(java.util.Collection regions) {
if (regions == null) {
this.regions = null;
return;
}
this.regions = new com.amazonaws.internal.SdkInternalList(regions);
}
/**
*
* The names of one or more regions where you want to create stack instances using the specified AWS account(s).
*
*
* 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 names of one or more regions where you want to create stack instances using the specified AWS
* account(s).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateStackInstancesRequest 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 names of one or more regions where you want to create stack instances using the specified AWS account(s).
*
*
* @param regions
* The names of one or more regions where you want to create stack instances using the specified AWS
* account(s).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateStackInstancesRequest withRegions(java.util.Collection regions) {
setRegions(regions);
return this;
}
/**
*
* A list of stack set parameters whose values you want to override in the selected stack instances.
*
*
* Any overridden parameter values will be applied to all stack instances in the specified accounts and regions.
* When specifying parameters and their values, be aware of how AWS CloudFormation sets parameter values during
* stack instance operations:
*
*
* -
*
* To override the current value for a parameter, include the parameter and specify its value.
*
*
* -
*
* To leave a parameter set to its present value, you can do one of the following:
*
*
* -
*
* Do not include the parameter in the list.
*
*
* -
*
* Include the parameter and specify UsePreviousValue as true. (You cannot specify both a
* value and set UsePreviousValue to true.)
*
*
*
*
* -
*
* To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do
* not include any parameters.
*
*
* -
*
* To leave all parameters set to their present values, do not specify this property at all.
*
*
*
*
* During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their
* overridden value.
*
*
* You can only override the parameter values that are specified in the stack set; to add or delete a
* parameter itself, use UpdateStackSet to update the stack set template.
*
*
* @return A list of stack set parameters whose values you want to override in the selected stack instances.
*
* Any overridden parameter values will be applied to all stack instances in the specified accounts and
* regions. When specifying parameters and their values, be aware of how AWS CloudFormation sets parameter
* values during stack instance operations:
*
*
* -
*
* To override the current value for a parameter, include the parameter and specify its value.
*
*
* -
*
* To leave a parameter set to its present value, you can do one of the following:
*
*
* -
*
* Do not include the parameter in the list.
*
*
* -
*
* Include the parameter and specify UsePreviousValue as true. (You cannot specify
* both a value and set UsePreviousValue to true.)
*
*
*
*
* -
*
* To set all overridden parameter back to the values specified in the stack set, specify a parameter list
* but do not include any parameters.
*
*
* -
*
* To leave all parameters set to their present values, do not specify this property at all.
*
*
*
*
* During stack set updates, any parameter values overridden for a stack instance are not updated, but
* retain their overridden value.
*
*
* You can only override the parameter values that are specified in the stack set; to add or delete a
* parameter itself, use UpdateStackSet to update the stack set template.
*/
public java.util.List getParameterOverrides() {
if (parameterOverrides == null) {
parameterOverrides = new com.amazonaws.internal.SdkInternalList();
}
return parameterOverrides;
}
/**
*
* A list of stack set parameters whose values you want to override in the selected stack instances.
*
*
* Any overridden parameter values will be applied to all stack instances in the specified accounts and regions.
* When specifying parameters and their values, be aware of how AWS CloudFormation sets parameter values during
* stack instance operations:
*
*
* -
*
* To override the current value for a parameter, include the parameter and specify its value.
*
*
* -
*
* To leave a parameter set to its present value, you can do one of the following:
*
*
* -
*
* Do not include the parameter in the list.
*
*
* -
*
* Include the parameter and specify UsePreviousValue as true. (You cannot specify both a
* value and set UsePreviousValue to true.)
*
*
*
*
* -
*
* To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do
* not include any parameters.
*
*
* -
*
* To leave all parameters set to their present values, do not specify this property at all.
*
*
*
*
* During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their
* overridden value.
*
*
* You can only override the parameter values that are specified in the stack set; to add or delete a
* parameter itself, use UpdateStackSet to update the stack set template.
*
*
* @param parameterOverrides
* A list of stack set parameters whose values you want to override in the selected stack instances.
*
* Any overridden parameter values will be applied to all stack instances in the specified accounts and
* regions. When specifying parameters and their values, be aware of how AWS CloudFormation sets parameter
* values during stack instance operations:
*
*
* -
*
* To override the current value for a parameter, include the parameter and specify its value.
*
*
* -
*
* To leave a parameter set to its present value, you can do one of the following:
*
*
* -
*
* Do not include the parameter in the list.
*
*
* -
*
* Include the parameter and specify UsePreviousValue as true. (You cannot specify
* both a value and set UsePreviousValue to true.)
*
*
*
*
* -
*
* To set all overridden parameter back to the values specified in the stack set, specify a parameter list
* but do not include any parameters.
*
*
* -
*
* To leave all parameters set to their present values, do not specify this property at all.
*
*
*
*
* During stack set updates, any parameter values overridden for a stack instance are not updated, but retain
* their overridden value.
*
*
* You can only override the parameter values that are specified in the stack set; to add or delete a
* parameter itself, use UpdateStackSet to update the stack set template.
*/
public void setParameterOverrides(java.util.Collection parameterOverrides) {
if (parameterOverrides == null) {
this.parameterOverrides = null;
return;
}
this.parameterOverrides = new com.amazonaws.internal.SdkInternalList(parameterOverrides);
}
/**
*
* A list of stack set parameters whose values you want to override in the selected stack instances.
*
*
* Any overridden parameter values will be applied to all stack instances in the specified accounts and regions.
* When specifying parameters and their values, be aware of how AWS CloudFormation sets parameter values during
* stack instance operations:
*
*
* -
*
* To override the current value for a parameter, include the parameter and specify its value.
*
*
* -
*
* To leave a parameter set to its present value, you can do one of the following:
*
*
* -
*
* Do not include the parameter in the list.
*
*
* -
*
* Include the parameter and specify UsePreviousValue as true. (You cannot specify both a
* value and set UsePreviousValue to true.)
*
*
*
*
* -
*
* To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do
* not include any parameters.
*
*
* -
*
* To leave all parameters set to their present values, do not specify this property at all.
*
*
*
*
* During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their
* overridden value.
*
*
* You can only override the parameter values that are specified in the stack set; to add or delete a
* parameter itself, use UpdateStackSet to update the stack set template.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setParameterOverrides(java.util.Collection)} or {@link #withParameterOverrides(java.util.Collection)} if
* you want to override the existing values.
*
*
* @param parameterOverrides
* A list of stack set parameters whose values you want to override in the selected stack instances.
*
* Any overridden parameter values will be applied to all stack instances in the specified accounts and
* regions. When specifying parameters and their values, be aware of how AWS CloudFormation sets parameter
* values during stack instance operations:
*
*
* -
*
* To override the current value for a parameter, include the parameter and specify its value.
*
*
* -
*
* To leave a parameter set to its present value, you can do one of the following:
*
*
* -
*
* Do not include the parameter in the list.
*
*
* -
*
* Include the parameter and specify UsePreviousValue as true. (You cannot specify
* both a value and set UsePreviousValue to true.)
*
*
*
*
* -
*
* To set all overridden parameter back to the values specified in the stack set, specify a parameter list
* but do not include any parameters.
*
*
* -
*
* To leave all parameters set to their present values, do not specify this property at all.
*
*
*
*
* During stack set updates, any parameter values overridden for a stack instance are not updated, but retain
* their overridden value.
*
*
* You can only override the parameter values that are specified in the stack set; to add or delete a
* parameter itself, use UpdateStackSet to update the stack set template.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateStackInstancesRequest withParameterOverrides(Parameter... parameterOverrides) {
if (this.parameterOverrides == null) {
setParameterOverrides(new com.amazonaws.internal.SdkInternalList(parameterOverrides.length));
}
for (Parameter ele : parameterOverrides) {
this.parameterOverrides.add(ele);
}
return this;
}
/**
*
* A list of stack set parameters whose values you want to override in the selected stack instances.
*
*
* Any overridden parameter values will be applied to all stack instances in the specified accounts and regions.
* When specifying parameters and their values, be aware of how AWS CloudFormation sets parameter values during
* stack instance operations:
*
*
* -
*
* To override the current value for a parameter, include the parameter and specify its value.
*
*
* -
*
* To leave a parameter set to its present value, you can do one of the following:
*
*
* -
*
* Do not include the parameter in the list.
*
*
* -
*
* Include the parameter and specify UsePreviousValue as true. (You cannot specify both a
* value and set UsePreviousValue to true.)
*
*
*
*
* -
*
* To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do
* not include any parameters.
*
*
* -
*
* To leave all parameters set to their present values, do not specify this property at all.
*
*
*
*
* During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their
* overridden value.
*
*
* You can only override the parameter values that are specified in the stack set; to add or delete a
* parameter itself, use UpdateStackSet to update the stack set template.
*
*
* @param parameterOverrides
* A list of stack set parameters whose values you want to override in the selected stack instances.
*
* Any overridden parameter values will be applied to all stack instances in the specified accounts and
* regions. When specifying parameters and their values, be aware of how AWS CloudFormation sets parameter
* values during stack instance operations:
*
*
* -
*
* To override the current value for a parameter, include the parameter and specify its value.
*
*
* -
*
* To leave a parameter set to its present value, you can do one of the following:
*
*
* -
*
* Do not include the parameter in the list.
*
*
* -
*
* Include the parameter and specify UsePreviousValue as true. (You cannot specify
* both a value and set UsePreviousValue to true.)
*
*
*
*
* -
*
* To set all overridden parameter back to the values specified in the stack set, specify a parameter list
* but do not include any parameters.
*
*
* -
*
* To leave all parameters set to their present values, do not specify this property at all.
*
*
*
*
* During stack set updates, any parameter values overridden for a stack instance are not updated, but retain
* their overridden value.
*
*
* You can only override the parameter values that are specified in the stack set; to add or delete a
* parameter itself, use UpdateStackSet to update the stack set template.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateStackInstancesRequest withParameterOverrides(java.util.Collection parameterOverrides) {
setParameterOverrides(parameterOverrides);
return this;
}
/**
*
* Preferences for how AWS CloudFormation performs this stack set operation.
*
*
* @param operationPreferences
* Preferences for how AWS CloudFormation performs this stack set operation.
*/
public void setOperationPreferences(StackSetOperationPreferences operationPreferences) {
this.operationPreferences = operationPreferences;
}
/**
*
* Preferences for how AWS CloudFormation performs this stack set operation.
*
*
* @return Preferences for how AWS CloudFormation performs this stack set operation.
*/
public StackSetOperationPreferences getOperationPreferences() {
return this.operationPreferences;
}
/**
*
* Preferences for how AWS CloudFormation performs this stack set operation.
*
*
* @param operationPreferences
* Preferences for how AWS CloudFormation performs this stack set operation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateStackInstancesRequest withOperationPreferences(StackSetOperationPreferences operationPreferences) {
setOperationPreferences(operationPreferences);
return this;
}
/**
*
* The unique identifier for this stack set operation.
*
*
* The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set
* operation only once, even if you retry the request multiple times. You might retry stack set operation requests
* to ensure that AWS CloudFormation successfully received them.
*
*
* If you don't specify an operation ID, the SDK generates one automatically.
*
*
* 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.
*
* The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the
* stack set operation only once, even if you retry the request multiple times. You might retry stack set
* operation requests to ensure that AWS CloudFormation successfully received them.
*
*
* If you don't specify an operation ID, the SDK generates one automatically.
*
*
* 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.
*
*
* The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set
* operation only once, even if you retry the request multiple times. You might retry stack set operation requests
* to ensure that AWS CloudFormation successfully received them.
*
*
* If you don't specify an operation ID, the SDK generates one automatically.
*
*
* 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.
*
* The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the
* stack set operation only once, even if you retry the request multiple times. You might retry stack set
* operation requests to ensure that AWS CloudFormation successfully received them.
*
*
* If you don't specify an operation ID, the SDK generates one automatically.
*
*
* 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.
*
*
* The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set
* operation only once, even if you retry the request multiple times. You might retry stack set operation requests
* to ensure that AWS CloudFormation successfully received them.
*
*
* If you don't specify an operation ID, the SDK generates one automatically.
*
*
* 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.
*
* The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the
* stack set operation only once, even if you retry the request multiple times. You might retry stack set
* operation requests to ensure that AWS CloudFormation successfully received them.
*
*
* If you don't specify an operation ID, the SDK generates one automatically.
*
*
* 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 CreateStackInstancesRequest withOperationId(String operationId) {
setOperationId(operationId);
return this;
}
/**
* Returns a string representation of this object; useful for testing and debugging.
*
* @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 (getRegions() != null)
sb.append("Regions: ").append(getRegions()).append(",");
if (getParameterOverrides() != null)
sb.append("ParameterOverrides: ").append(getParameterOverrides()).append(",");
if (getOperationPreferences() != null)
sb.append("OperationPreferences: ").append(getOperationPreferences()).append(",");
if (getOperationId() != null)
sb.append("OperationId: ").append(getOperationId());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateStackInstancesRequest == false)
return false;
CreateStackInstancesRequest other = (CreateStackInstancesRequest) 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.getRegions() == null ^ this.getRegions() == null)
return false;
if (other.getRegions() != null && other.getRegions().equals(this.getRegions()) == false)
return false;
if (other.getParameterOverrides() == null ^ this.getParameterOverrides() == null)
return false;
if (other.getParameterOverrides() != null && other.getParameterOverrides().equals(this.getParameterOverrides()) == 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.getOperationId() == null ^ this.getOperationId() == null)
return false;
if (other.getOperationId() != null && other.getOperationId().equals(this.getOperationId()) == 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 + ((getRegions() == null) ? 0 : getRegions().hashCode());
hashCode = prime * hashCode + ((getParameterOverrides() == null) ? 0 : getParameterOverrides().hashCode());
hashCode = prime * hashCode + ((getOperationPreferences() == null) ? 0 : getOperationPreferences().hashCode());
hashCode = prime * hashCode + ((getOperationId() == null) ? 0 : getOperationId().hashCode());
return hashCode;
}
@Override
public CreateStackInstancesRequest clone() {
return (CreateStackInstancesRequest) super.clone();
}
}