com.amazonaws.services.cloudformation.model

Class CreateStackInstancesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudformation.model.CreateStackInstancesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateStackInstancesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateStackInstancesRequest()

Method Summary

Modifier and Type	Method and Description
CreateStackInstancesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<String>	getAccounts() [Self-managed permissions] The names of one or more AWS accounts that you want to create stack instances in the specified Region(s) for.
DeploymentTargets	getDeploymentTargets() [Service-managed permissions] The AWS Organizations accounts for which to create stack instances in the specified Regions.
String	getOperationId() The unique identifier for this stack set operation.
StackSetOperationPreferences	getOperationPreferences() Preferences for how AWS CloudFormation performs this stack set operation.
List<Parameter>	getParameterOverrides() A list of stack set parameters whose values you want to override in the selected stack instances.
List<String>	getRegions() The names of one or more Regions where you want to create stack instances using the specified AWS account(s).
String	getStackSetName() The name or unique ID of the stack set that you want to create stack instances from.
int	hashCode()
void	setAccounts(Collection<String> accounts) [Self-managed permissions] The names of one or more AWS accounts that you want to create stack instances in the specified Region(s) for.
void	setDeploymentTargets(DeploymentTargets deploymentTargets) [Service-managed permissions] The AWS Organizations accounts for which to create stack instances in the specified Regions.
void	setOperationId(String operationId) The unique identifier for this stack set operation.
void	setOperationPreferences(StackSetOperationPreferences operationPreferences) Preferences for how AWS CloudFormation performs this stack set operation.
void	setParameterOverrides(Collection<Parameter> parameterOverrides) A list of stack set parameters whose values you want to override in the selected stack instances.
void	setRegions(Collection<String> regions) The names of one or more Regions where you want to create stack instances using the specified AWS account(s).
void	setStackSetName(String stackSetName) The name or unique ID of the stack set that you want to create stack instances from.
String	toString() Returns a string representation of this object.
CreateStackInstancesRequest	withAccounts(Collection<String> accounts) [Self-managed permissions] The names of one or more AWS accounts that you want to create stack instances in the specified Region(s) for.
CreateStackInstancesRequest	withAccounts(String... accounts) [Self-managed permissions] The names of one or more AWS accounts that you want to create stack instances in the specified Region(s) for.
CreateStackInstancesRequest	withDeploymentTargets(DeploymentTargets deploymentTargets) [Service-managed permissions] The AWS Organizations accounts for which to create stack instances in the specified Regions.
CreateStackInstancesRequest	withOperationId(String operationId) The unique identifier for this stack set operation.
CreateStackInstancesRequest	withOperationPreferences(StackSetOperationPreferences operationPreferences) Preferences for how AWS CloudFormation performs this stack set operation.
CreateStackInstancesRequest	withParameterOverrides(Collection<Parameter> parameterOverrides) A list of stack set parameters whose values you want to override in the selected stack instances.
CreateStackInstancesRequest	withParameterOverrides(Parameter... parameterOverrides) A list of stack set parameters whose values you want to override in the selected stack instances.
CreateStackInstancesRequest	withRegions(Collection<String> regions) The names of one or more Regions where you want to create stack instances using the specified AWS account(s).
CreateStackInstancesRequest	withRegions(String... regions) The names of one or more Regions where you want to create stack instances using the specified AWS account(s).
CreateStackInstancesRequest	withStackSetName(String stackSetName) The name or unique ID of the stack set that you want to create stack instances from.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateStackInstancesRequest

public CreateStackInstancesRequest()

Method Detail

setStackSetName

public void setStackSetName(String stackSetName)

The name or unique ID of the stack set that you want to create stack instances from.

Parameters:

stackSetName - The name or unique ID of the stack set that you want to create stack instances from.

getStackSetName

public String getStackSetName()

The name or unique ID of the stack set that you want to create stack instances from.

Returns:

The name or unique ID of the stack set that you want to create stack instances from.

withStackSetName

public CreateStackInstancesRequest withStackSetName(String stackSetName)

The name or unique ID of the stack set that you want to create stack instances from.

Parameters:

stackSetName - The name or unique ID of the stack set that you want to create stack instances from.

Returns:

Returns a reference to this object so that method calls can be chained together.

getAccounts

public List<String> getAccounts()

[Self-managed permissions] The names of one or more AWS accounts that you want to create stack instances in the specified Region(s) for.

You can specify Accounts or DeploymentTargets, but not both.

Returns:

[Self-managed permissions] The names of one or more AWS accounts that you want to create stack instances in the specified Region(s) for.

You can specify Accounts or DeploymentTargets, but not both.

setAccounts

public void setAccounts(Collection<String> accounts)

[Self-managed permissions] The names of one or more AWS accounts that you want to create stack instances in the specified Region(s) for.

You can specify Accounts or DeploymentTargets, but not both.

Parameters:

accounts - [Self-managed permissions] The names of one or more AWS accounts that you want to create stack instances in the specified Region(s) for.

You can specify Accounts or DeploymentTargets, but not both.

withAccounts

public CreateStackInstancesRequest withAccounts(String... accounts)

[Self-managed permissions] The names of one or more AWS accounts that you want to create stack instances in the specified Region(s) for.

You can specify Accounts or DeploymentTargets, but not both.

NOTE: This method appends the values to the existing list (if any). Use setAccounts(java.util.Collection) or withAccounts(java.util.Collection) if you want to override the existing values.

Parameters:

accounts - [Self-managed permissions] The names of one or more AWS accounts that you want to create stack instances in the specified Region(s) for.

You can specify Accounts or DeploymentTargets, but not both.

Returns:

Returns a reference to this object so that method calls can be chained together.

withAccounts

public CreateStackInstancesRequest withAccounts(Collection<String> accounts)

[Self-managed permissions] The names of one or more AWS accounts that you want to create stack instances in the specified Region(s) for.

You can specify Accounts or DeploymentTargets, but not both.

Parameters:

accounts - [Self-managed permissions] The names of one or more AWS accounts that you want to create stack instances in the specified Region(s) for.

You can specify Accounts or DeploymentTargets, but not both.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDeploymentTargets

public void setDeploymentTargets(DeploymentTargets deploymentTargets)

[Service-managed permissions] The AWS Organizations accounts for which to create stack instances in the specified Regions.

You can specify Accounts or DeploymentTargets, but not both.

Parameters:

deploymentTargets - [Service-managed permissions] The AWS Organizations accounts for which to create stack instances in the specified Regions.

You can specify Accounts or DeploymentTargets, but not both.

getDeploymentTargets

public DeploymentTargets getDeploymentTargets()

[Service-managed permissions] The AWS Organizations accounts for which to create stack instances in the specified Regions.

You can specify Accounts or DeploymentTargets, but not both.

Returns:

[Service-managed permissions] The AWS Organizations accounts for which to create stack instances in the specified Regions.

You can specify Accounts or DeploymentTargets, but not both.

withDeploymentTargets

public CreateStackInstancesRequest withDeploymentTargets(DeploymentTargets deploymentTargets)

[Service-managed permissions] The AWS Organizations accounts for which to create stack instances in the specified Regions.

You can specify Accounts or DeploymentTargets, but not both.

Parameters:

deploymentTargets - [Service-managed permissions] The AWS Organizations accounts for which to create stack instances in the specified Regions.

You can specify Accounts or DeploymentTargets, but not both.

Returns:

Returns a reference to this object so that method calls can be chained together.

getRegions

public List<String> getRegions()

The names of one or more Regions where you want to create stack instances using the specified AWS account(s).

Returns:

The names of one or more Regions where you want to create stack instances using the specified AWS account(s).

setRegions

public void setRegions(Collection<String> regions)

The names of one or more Regions where you want to create stack instances using the specified AWS account(s).

Parameters:

regions - The names of one or more Regions where you want to create stack instances using the specified AWS account(s).

withRegions

public CreateStackInstancesRequest withRegions(String... 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 setRegions(java.util.Collection) or withRegions(java.util.Collection) if you want to override the existing values.

Parameters:

regions - The names of one or more Regions where you want to create stack instances using the specified AWS account(s).

Returns:

Returns a reference to this object so that method calls can be chained together.

withRegions

public CreateStackInstancesRequest withRegions(Collection<String> regions)

The names of one or more Regions where you want to create stack instances using the specified AWS account(s).

Parameters:

regions - The names of one or more Regions where you want to create stack instances using the specified AWS account(s).

Returns:

Returns a reference to this object so that method calls can be chained together.

getParameterOverrides

public List<Parameter> getParameterOverrides()

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.

Returns:

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.

setParameterOverrides

public void setParameterOverrides(Collection<Parameter> 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.

Parameters:

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.

withParameterOverrides

public CreateStackInstancesRequest withParameterOverrides(Parameter... 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 setParameterOverrides(java.util.Collection) or withParameterOverrides(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withParameterOverrides

public CreateStackInstancesRequest withParameterOverrides(Collection<Parameter> 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setOperationPreferences

public void setOperationPreferences(StackSetOperationPreferences operationPreferences)

Preferences for how AWS CloudFormation performs this stack set operation.

Parameters:

operationPreferences - Preferences for how AWS CloudFormation performs this stack set operation.

getOperationPreferences

public StackSetOperationPreferences getOperationPreferences()

Preferences for how AWS CloudFormation performs this stack set operation.

Returns:

Preferences for how AWS CloudFormation performs this stack set operation.

withOperationPreferences

public CreateStackInstancesRequest withOperationPreferences(StackSetOperationPreferences operationPreferences)

Preferences for how AWS CloudFormation performs this stack set operation.

Parameters:

operationPreferences - Preferences for how AWS CloudFormation performs this stack set operation.

Returns:

Returns a reference to this object so that method calls can be chained together.

setOperationId

public void setOperationId(String 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.

Parameters:

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.

getOperationId

public String getOperationId()

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.

Returns:

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.

withOperationId

public CreateStackInstancesRequest withOperationId(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateStackInstancesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()