AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS CloudFormation CreateStackInstances API operation.

Syntax

New-CFNStackInstance
-StackSetName <String>
-DeploymentTargets_AccountFilterType <AccountFilterType>
-Account <String[]>
-DeploymentTargets_Account <String[]>
-DeploymentTargets_AccountsUrl <String>
-CallAs <CallAs>
-OperationId <String>
-OperationPreference <StackSetOperationPreferences>
-DeploymentTargets_OrganizationalUnitId <String[]>
-ParameterOverride <Parameter[]>
-StackInstanceRegion <String[]>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonCloudFormationConfig>

Description

Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region. You must specify at least one value for either Accounts or DeploymentTargets, and you must specify at least one value for Regions.

Parameters

-Account <String[]>
[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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAccounts
-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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonCloudFormationConfig>
Amazon.PowerShell.Cmdlets.CFN.AmazonCloudFormationClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeploymentTargets_Account <String[]>
The names of one or more Amazon Web Services accounts for which you want to deploy stack set updates.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDeploymentTargets_Accounts
-DeploymentTargets_AccountFilterType <AccountFilterType>
Limit deployment targets to individual accounts or include additional accounts with provided OUs.The following is a list of possible values for the AccountFilterType operation.
  • INTERSECTION: StackSets deploys to the accounts specified in Accounts parameter.
  • DIFFERENCE: StackSets excludes the accounts specified in Accounts parameter. This enables user to avoid certain accounts within an OU such as suspended accounts.
  • UNION: StackSets includes additional accounts deployment targets. This is the default value if AccountFilterType is not provided. This enables user to update an entire OU and individual accounts from a different OU in one request, which used to be two separate requests.
  • NONE: Deploys to all the accounts in specified organizational units (OU).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeploymentTargets_AccountsUrl <String>
Returns the value of the AccountsUrl property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeploymentTargets_OrganizationalUnitId <String[]>
The organization root ID or organizational unit (OU) IDs to which StackSets deploys.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDeploymentTargets_OrganizationalUnitIds
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OperationId <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OperationPreference <StackSetOperationPreferences>
Preferences for how CloudFormation performs this stack set operation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperationPreferences
-ParameterOverride <Parameter[]>
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 Amazon Web Services 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 can't 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 don't include the parameter in the list.
  • To leave all parameters set to their present values, don't specify this property at all.
During stack set updates, any parameter values overridden for a stack instance aren't 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameterOverrides
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the StackSetName parameter. The -PassThru parameter is deprecated, use -Select '^StackSetName' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'OperationId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFormation.Model.CreateStackInstancesResponse). Specifying the name of a property of type Amazon.CloudFormation.Model.CreateStackInstancesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StackInstanceRegion <String[]>
The names of one or more Amazon Web Services Regions where you want to create stack instances using the specified Amazon Web Services accounts.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-StackSetName <String>
The name or unique ID of the stack set that you want to create stack instances from.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

System.String or Amazon.CloudFormation.Model.CreateStackInstancesResponse
This cmdlet returns a System.String object. The service call response (type Amazon.CloudFormation.Model.CreateStackInstancesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z