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.
Container for the parameters to the CreateStack operation. Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack through the DescribeStacks operation.
Namespace: Amazon.CloudFormation.Model
Assembly: AWSSDK.CloudFormation.dll
Version: 3.x.y.z
public class CreateStackRequest : AmazonCloudFormationRequest IAmazonWebServiceRequest
The CreateStackRequest type exposes the following members
Name | Description | |
---|---|---|
CreateStackRequest() |
Name | Type | Description | |
---|---|---|---|
Capabilities | System.Collections.Generic.List<System.String> |
Gets and sets the property Capabilities. In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.
Only one of the |
|
ClientRequestToken | System.String |
Gets and sets the property ClientRequestToken.
A unique identifier for this
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
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: |
|
DisableRollback | System.Boolean |
Gets and sets the property DisableRollback.
Set to
Default: |
|
EnableTerminationProtection | System.Boolean |
Gets and sets the property EnableTerminationProtection. Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted in the CloudFormation User Guide. Termination protection is deactivated on stacks by default. For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack. |
|
NotificationARNs | System.Collections.Generic.List<System.String> |
Gets and sets the property NotificationARNs. The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events. You can find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI). |
|
OnFailure | Amazon.CloudFormation.OnFailure |
Gets and sets the property OnFailure.
Determines what action will be taken if stack creation fails. This must be one of:
Default: |
|
Parameters | System.Collections.Generic.List<Amazon.CloudFormation.Model.Parameter> |
Gets and sets the property Parameters.
A list of |
|
ResourceTypes | System.Collections.Generic.List<System.String> |
Gets and sets the property ResourceTypes.
The template resource types that you have permissions to work with for this create
stack action, such as 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.
Only one of the |
|
RetainExceptOnCreate | System.Boolean |
Gets and sets the property RetainExceptOnCreate.
When set to
Default: |
|
RoleARN | System.String |
Gets and sets the property RoleARN. The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to create the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege. If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials. |
|
RollbackConfiguration | Amazon.CloudFormation.Model.RollbackConfiguration |
Gets and sets the property RollbackConfiguration. The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards. |
|
StackName | System.String |
Gets and sets the property StackName. The name that's associated with the stack. The name must be unique in the Region in which you are creating the stack. A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an alphabetical character and can't be longer than 128 characters. |
|
StackPolicyBody | System.String |
Gets and sets the property StackPolicyBody.
Structure containing the stack policy body. For more information, go to
Prevent Updates to Stack Resources in the CloudFormation User Guide. You
can specify either the |
|
StackPolicyURL | System.String |
Gets and sets the property StackPolicyURL.
Location of a file containing the stack policy. The URL must point to a policy (maximum
size: 16 KB) located in an S3 bucket in the same Region as the stack. The location
for an Amazon S3 bucket must start with |
|
Tags | System.Collections.Generic.List<Amazon.CloudFormation.Model.Tag> |
Gets and sets the property Tags. Key-value pairs to associate with this stack. CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified. |
|
TemplateBody | System.String |
Gets and sets the property TemplateBody. Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template anatomy in the CloudFormation User Guide.
Conditional: You must specify either the |
|
TemplateURL | System.String |
Gets and sets the property TemplateURL.
Location of file containing the template body. The URL must point to a template (max
size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document.
For more information, go to the Template
anatomy in the CloudFormation User Guide. The location for an Amazon S3
bucket must start with
Conditional: You must specify either the |
|
TimeoutInMinutes | System.Int32 |
Gets and sets the property TimeoutInMinutes.
The amount of time that can pass before the stack status becomes |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5