AWS SDK for .NET Documentation
CreateStackRequest Class
AmazonAmazon.CloudFormation.ModelCreateStackRequest Did this page help you?   Yes   No    Tell us about it...
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 via the DescribeStacks API.

NOTE: Currently, the limit for stacks is 20 stacks per account per region.

Declaration Syntax
C#
public class CreateStackRequest : AmazonWebServiceRequest
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
CreateStackRequest()()()()
Initializes a new instance of the CreateStackRequest class

Capabilities
The list of capabilities that you want to allow in the stack. If your template contains certain resources, you must specify the CAPABILITY_IAM value for this parameter; otherwise, this action returns an InsufficientCapabilities error. The following resources require you to specify the capabilities parameter: AWS::CloudFormation::Stack, AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition.

DisableRollback
Set to true to disable rollback of the stack if stack creation failed. You can specify either DisableRollback or OnFailure, but not both. Default: false

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
NotificationARNs
The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic ARNs using the SNS console or your Command Line Interface (CLI).

Constraints:

Length
0 - 5


OnFailure
Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either OnFailure or DisableRollback, but not both. Default: ROLLBACK

Constraints:

Allowed Values
DO_NOTHING, ROLLBACK, DELETE


Parameters
A list of Parameter structures that specify input parameters for the stack.

StackName
The name associated with the stack. The name must be unique within your AWS account.
Note:
Must contain only alphanumeric characters (case sensitive) and start with an alpha character. Maximum length of the name is 255 characters.

StackPolicyBody
Structure containing the stack policy body. (For more information, go to Prevent Updates to Stack Resources in the AWS CloudFormation User Guide.) If you pass StackPolicyBody and StackPolicyURL, only StackPolicyBody is used.

Constraints:

Length
1 - 16384


StackPolicyURL
Location of a file containing the stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. If you pass StackPolicyBody and StackPolicyURL, only StackPolicyBody is used.

Constraints:

Length
1 - 1350


Tags
A set of user-defined Tags to associate with this stack, represented by key/value pairs. Tags defined for the stack are propagated to EC2 resources that are created as part of the stack. A maximum number of 10 tags can be specified.

TemplateBody
Structure containing the template body. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.) Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only TemplateBody is used.

Constraints:

Length
1 -


TemplateURL
Location of file containing the template body. The URL must point to a template (max size: 307,200 bytes) located in an S3 bucket in the same region as the stack. For more information, go to the Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

Constraints:

Length
1 - 1024


TimeoutInMinutes
The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback is not set or is set to false, the stack will be rolled back.

Constraints:

Range
1 -


ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
WithCapabilities(array<String>[]()[][]) Obsolete.
Adds elements to the Capabilities collection

WithCapabilities(IEnumerable<(Of <<'(String>)>>)) Obsolete.
Adds elements to the Capabilities collection

WithDisableRollback(Boolean) Obsolete.
Sets the DisableRollback property

WithNotificationARNs(array<String>[]()[][]) Obsolete.
Adds elements to the NotificationARNs collection

WithNotificationARNs(IEnumerable<(Of <<'(String>)>>)) Obsolete.
Adds elements to the NotificationARNs collection

WithOnFailure(String) Obsolete.
Sets the OnFailure property

WithParameters(array<Parameter>[]()[][]) Obsolete.
Adds elements to the Parameters collection

WithParameters(IEnumerable<(Of <<'(Parameter>)>>)) Obsolete.
Adds elements to the Parameters collection

WithStackName(String) Obsolete.
Sets the StackName property

WithStackPolicyBody(String) Obsolete.
Sets the StackPolicyBody property

WithStackPolicyURL(String) Obsolete.
Sets the StackPolicyURL property

WithTags(array<Tag>[]()[][]) Obsolete.
Adds elements to the Tags collection

WithTags(IEnumerable<(Of <<'(Tag>)>>)) Obsolete.
Adds elements to the Tags collection

WithTemplateBody(String) Obsolete.
Sets the TemplateBody property

WithTemplateURL(String) Obsolete.
Sets the TemplateURL property

WithTimeoutInMinutes(Int32) Obsolete.
Sets the TimeoutInMinutes property

Inheritance Hierarchy
Object
AmazonWebServiceRequest
 CreateStackRequest
See Also

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)