@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateStackInstancesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateStackInstancesRequest() |
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 Amazon Web Services accounts that you want to create stack
instances in the specified Region(s) for.
|
String |
getCallAs()
[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.
|
DeploymentTargets |
getDeploymentTargets()
[Service-managed permissions] The 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 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 Amazon Web Services
accounts.
|
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 Amazon Web Services accounts that you want to create stack
instances in the specified Region(s) for.
|
void |
setCallAs(String 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.
|
void |
setDeploymentTargets(DeploymentTargets deploymentTargets)
[Service-managed permissions] The 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 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 Amazon Web Services
accounts.
|
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 Amazon Web Services 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 Amazon Web Services accounts that you want to create stack
instances in the specified Region(s) for.
|
CreateStackInstancesRequest |
withCallAs(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.
|
CreateStackInstancesRequest |
withCallAs(String 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.
|
CreateStackInstancesRequest |
withDeploymentTargets(DeploymentTargets deploymentTargets)
[Service-managed permissions] The 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 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 Amazon Web Services
accounts.
|
CreateStackInstancesRequest |
withRegions(String... regions)
The names of one or more Regions where you want to create stack instances using the specified Amazon Web Services
accounts.
|
CreateStackInstancesRequest |
withStackSetName(String stackSetName)
The name or unique ID of the stack set that you want to create stack instances from.
|
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
public void setStackSetName(String stackSetName)
The name or unique ID of the stack set that you want to create stack instances from.
stackSetName
- The name or unique ID of the stack set that you want to create stack instances from.public String getStackSetName()
The name or unique ID of the stack set that you want to create stack instances from.
public CreateStackInstancesRequest withStackSetName(String stackSetName)
The name or unique ID of the stack set that you want to create stack instances from.
stackSetName
- The name or unique ID of the stack set that you want to create stack instances from.public List<String> getAccounts()
[Self-managed permissions] The names of one or more Amazon Web Services accounts that you want to create stack instances in the specified Region(s) for.
You can specify Accounts
or DeploymentTargets
, but not both.
You can specify Accounts
or DeploymentTargets
, but not both.
public void setAccounts(Collection<String> accounts)
[Self-managed permissions] The names of one or more Amazon Web Services accounts that you want to create stack instances in the specified Region(s) for.
You can specify Accounts
or DeploymentTargets
, but not both.
accounts
- [Self-managed permissions] The names of one or more Amazon Web Services accounts that you want to create
stack instances in the specified Region(s) for.
You can specify Accounts
or DeploymentTargets
, but not both.
public CreateStackInstancesRequest withAccounts(String... accounts)
[Self-managed permissions] The names of one or more Amazon Web Services 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.
accounts
- [Self-managed permissions] The names of one or more Amazon Web Services accounts that you want to create
stack instances in the specified Region(s) for.
You can specify Accounts
or DeploymentTargets
, but not both.
public CreateStackInstancesRequest withAccounts(Collection<String> accounts)
[Self-managed permissions] The names of one or more Amazon Web Services accounts that you want to create stack instances in the specified Region(s) for.
You can specify Accounts
or DeploymentTargets
, but not both.
accounts
- [Self-managed permissions] The names of one or more Amazon Web Services accounts that you want to create
stack instances in the specified Region(s) for.
You can specify Accounts
or DeploymentTargets
, but not both.
public void setDeploymentTargets(DeploymentTargets deploymentTargets)
[Service-managed permissions] The Organizations accounts for which to create stack instances in the specified Regions.
You can specify Accounts
or DeploymentTargets
, but not both.
deploymentTargets
- [Service-managed permissions] The Organizations accounts for which to create stack instances in the
specified Regions.
You can specify Accounts
or DeploymentTargets
, but not both.
public DeploymentTargets getDeploymentTargets()
[Service-managed permissions] The Organizations accounts for which to create stack instances in the specified Regions.
You can specify Accounts
or DeploymentTargets
, but not both.
You can specify Accounts
or DeploymentTargets
, but not both.
public CreateStackInstancesRequest withDeploymentTargets(DeploymentTargets deploymentTargets)
[Service-managed permissions] The Organizations accounts for which to create stack instances in the specified Regions.
You can specify Accounts
or DeploymentTargets
, but not both.
deploymentTargets
- [Service-managed permissions] The Organizations accounts for which to create stack instances in the
specified Regions.
You can specify Accounts
or DeploymentTargets
, but not both.
public List<String> getRegions()
The names of one or more Regions where you want to create stack instances using the specified Amazon Web Services accounts.
public void setRegions(Collection<String> regions)
The names of one or more Regions where you want to create stack instances using the specified Amazon Web Services accounts.
regions
- The names of one or more Regions where you want to create stack instances using the specified Amazon Web
Services accounts.public CreateStackInstancesRequest withRegions(String... regions)
The names of one or more Regions where you want to create stack instances using the specified Amazon Web Services accounts.
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.
regions
- The names of one or more Regions where you want to create stack instances using the specified Amazon Web
Services accounts.public CreateStackInstancesRequest withRegions(Collection<String> regions)
The names of one or more Regions where you want to create stack instances using the specified Amazon Web Services accounts.
regions
- The names of one or more Regions where you want to create stack instances using the specified Amazon Web
Services accounts.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 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 an overridden parameter set to its present value, include the parameter and specify
UsePreviousValue
as true
. (You cannot specify both a value and set
UsePreviousValue
to true
.)
To set an overridden parameter back to the value specified in the stack set, specify a parameter list but do not include the parameter in the list.
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.
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 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 an overridden parameter set to its present value, include the parameter and specify
UsePreviousValue
as true
. (You cannot specify both a value and set
UsePreviousValue
to true
.)
To set an overridden parameter back to the value specified in the stack set, specify a parameter list but do not include the parameter in the list.
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(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 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 an overridden parameter set to its present value, include the parameter and specify
UsePreviousValue
as true
. (You cannot specify both a value and set
UsePreviousValue
to true
.)
To set an overridden parameter back to the value specified in the stack set, specify a parameter list but do not include the parameter in the list.
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.
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 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 an overridden parameter set to its present value, include the parameter and specify
UsePreviousValue
as true
. (You cannot specify both a value and set
UsePreviousValue
to true
.)
To set an overridden parameter back to the value specified in the stack set, specify a parameter list but do not include the parameter in the list.
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 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 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 an overridden parameter set to its present value, include the parameter and specify
UsePreviousValue
as true
. (You cannot specify both a value and set
UsePreviousValue
to true
.)
To set an overridden parameter back to the value specified in the stack set, specify a parameter list but do not include the parameter in the list.
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.
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 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 an overridden parameter set to its present value, include the parameter and specify
UsePreviousValue
as true
. (You cannot specify both a value and set
UsePreviousValue
to true
.)
To set an overridden parameter back to the value specified in the stack set, specify a parameter list but do not include the parameter in the list.
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 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 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 an overridden parameter set to its present value, include the parameter and specify
UsePreviousValue
as true
. (You cannot specify both a value and set
UsePreviousValue
to true
.)
To set an overridden parameter back to the value specified in the stack set, specify a parameter list but do not include the parameter in the list.
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.
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 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 an overridden parameter set to its present value, include the parameter and specify
UsePreviousValue
as true
. (You cannot specify both a value and set
UsePreviousValue
to true
.)
To set an overridden parameter back to the value specified in the stack set, specify a parameter list but do not include the parameter in the list.
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 setOperationPreferences(StackSetOperationPreferences operationPreferences)
Preferences for how CloudFormation performs this stack set operation.
operationPreferences
- Preferences for how CloudFormation performs this stack set operation.public StackSetOperationPreferences getOperationPreferences()
Preferences for how CloudFormation performs this stack set operation.
public CreateStackInstancesRequest withOperationPreferences(StackSetOperationPreferences operationPreferences)
Preferences for how CloudFormation performs this stack set operation.
operationPreferences
- Preferences for how CloudFormation performs this stack set operation.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 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 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
.
operationId
- The unique identifier for this stack set operation.
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 might retry stack set operation requests to ensure that 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()
The unique identifier for this stack set operation.
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 might retry stack set operation requests to ensure that 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
.
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 might retry stack set operation requests to ensure that 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 CreateStackInstancesRequest withOperationId(String operationId)
The unique identifier for this stack set operation.
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 might retry stack set operation requests to ensure that 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
.
operationId
- The unique identifier for this stack set operation.
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 might retry stack set operation requests to ensure that 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 setCallAs(String 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.
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.
CallAs
public String getCallAs()
[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.
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.
CallAs
public CreateStackInstancesRequest withCallAs(String 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.
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.
CallAs
public CreateStackInstancesRequest withCallAs(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.
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.
CallAs
public String toString()
toString
in class Object
Object.toString()
public CreateStackInstancesRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()