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.
New-CFNStack-StackName <String>-Capability <String[]>-ClientRequestToken <String>-DisableRollback <Boolean>-EnableTerminationProtection <Boolean>-RollbackConfiguration_MonitoringTimeInMinute <Int32>-NotificationARNs <String[]>-OnFailure <OnFailure>-Parameter <Parameter[]>-ResourceType <String[]>-RoleARN <String>-RollbackConfiguration_RollbackTrigger <RollbackTrigger[]>-StackPolicyBody <String>-StackPolicyURL <String>-Tag <Tag[]>-TemplateBody <String>-TemplateURL <String>-TimeoutInMinutes <Int32>-Select <String>-PassThru <SwitchParameter>-Force <SwitchParameter>
CAPABILITY_IAM
and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.The following IAM resources require you to specify either the CAPABILITY_IAM
or CAPABILITY_NAMED_IAM
capability.CAPABILITY_NAMED_IAM
.InsufficientCapabilities
error.CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability.Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Capabilities |
CreateStack
request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to create a stack with the same name. You might retry CreateStack
requests to ensure that CloudFormation successfully received them.All events initiated by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack
operation with the token token1
, then all the StackEvents
generated by that operation will have ClientRequestToken
set as token1
.In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002
. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
true
to disable rollback of the stack if stack creation failed. You can specify either DisableRollback
or OnFailure
, but not both.Default: false
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
DO_NOTHING
, ROLLBACK
, or DELETE
. You can specify either OnFailure
or DisableRollback
, but not both.Default: ROLLBACK
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Parameter
structures that specify input parameters for the stack. For more information, see the Parameter data type. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Parameters |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
AWS::EC2::Instance
, AWS::EC2::*
, or Custom::MyCustomInstance
. Use the following syntax to describe template resource types: AWS::*
(for all Amazon Web Services resources), Custom::*
(for all custom resources), Custom::logical_ID
(for a specific custom resource), AWS::service_name::*
(for all resources of a particular Amazon Web Services service), and AWS::service_name::resource_logical_ID
(for a specific Amazon Web Services resource).If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ResourceTypes |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | RollbackConfiguration_MonitoringTimeInMinutes |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | RollbackConfiguration_RollbackTriggers |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | True |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
StackPolicyBody
or the StackPolicyURL
parameter, but not both. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
StackPolicyBody
or the StackPolicyURL
parameter, but not both. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Tags |
TemplateBody
or the TemplateURL
parameter, but not both. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
TemplateBody
or the TemplateURL
parameter, but not both. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
DisableRollback
is not set or is set to false
, the stack will be rolled back. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AK |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AWSProfilesLocation, ProfilesLocation |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | StoredCredentials, AWSProfileName |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | RegionToCall |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SK, SecretAccessKey |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ST |
New-CFNStack -StackName "myStack" `
-TemplateBody "{TEMPLATE CONTENT HERE}" `
-Parameter @( @{ ParameterKey="PK1"; ParameterValue="PV1" }, @{ ParameterKey="PK2"; ParameterValue="PV2" }) `
-DisableRollback $true
Creates a new stack with the specified name. The template is parsed from the supplied content with customization parameters ('PK1' and 'PK2' represent the names of parameters declared in the template content, 'PV1' and 'PV2' represent the values for those parameters. The customization parameters can also be specified using 'Key' and 'Value' instead of 'ParameterKey' and 'ParameterValue'. If creation of the stack fails, it will not be rolled back.
$p1 = New-Object -Type Amazon.CloudFormation.Model.Parameter
$p1.ParameterKey = "PK1"
$p1.ParameterValue = "PV1"
$p2 = New-Object -Type Amazon.CloudFormation.Model.Parameter
$p2.ParameterKey = "PK2"
$p2.ParameterValue = "PV2"
New-CFNStack -StackName "myStack" `
-TemplateBody "{TEMPLATE CONTENT HERE}" `
-Parameter @( $p1, $p2 ) `
-OnFailure "ROLLBACK"
Creates a new stack with the specified name. The template is parsed from the supplied content with customization parameters ('PK1' and 'PK2' represent the names of parameters declared in the template content, 'PV1' and 'PV2' represent the values for those parameters. The customization parameters can also be specified using 'Key' and 'Value' instead of 'ParameterKey' and 'ParameterValue'. If creation of the stack fails, it will be rolled back.
New-CFNStack -StackName "myStack" `
-TemplateURL https://s3.amazonaws.com/mytemplates/templatefile.template `
-Parameter @{ ParameterKey="PK1"; ParameterValue="PV1" }
Creates a new stack with the specified name. The template is obtained from the Amazon S3 URL with customization parameters ('PK1' represents the name of a parameter declared in the template content, 'PV1' represents the value for the parameter. The customization parameters can also be specified using 'Key' and 'Value' instead of 'ParameterKey' and 'ParameterValue'. If creation of the stack fails, it will be rolled back (same as specifying -DisableRollback $false).
New-CFNStack -StackName "myStack" `
-TemplateURL https://s3.amazonaws.com/mytemplates/templatefile.template `
-Parameter @{ ParameterKey="PK1"; ParameterValue="PV1" } `
-NotificationARN @( "arn1", "arn2" )
Creates a new stack with the specified name. The template is obtained from the Amazon S3 URL with customization parameters ('PK1' represents the name of a parameter declared in the template content, 'PV1' represents the value for the parameter. The customization parameters can also be specified using 'Key' and 'Value' instead of 'ParameterKey' and 'ParameterValue'. If creation of the stack fails, it will be rolled back (same as specifying -DisableRollback $false). The specified notification AENs will receive published stack-related events.
AWS Tools for PowerShell: 2.x.y.z