Builder
Properties
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.
A unique identifier for this 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.
Set to true
to disable rollback of the stack if stack creation failed. You can specify either DisableRollback
or OnFailure
, but not both.
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.
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).
A list of Parameter
structures that specify input parameters for the stack. For more information, see the Parameter data type.
The template resource types that you have permissions to work with for this create stack action, such as 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::<i>logical_ID</i>
(for a specific custom resource), AWS::<i>service_name</i>::*
(for all resources of a particular Amazon Web Services service), and AWS::<i>service_name</i>::<i>resource_logical_ID</i>
(for a specific Amazon Web Services resource).
When set to true
, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of Retain
.
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.
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
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 StackPolicyBody
or the StackPolicyURL
parameter, but not both.
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. You can specify either the StackPolicyBody
or the StackPolicyURL
parameter, but not both.
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.
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 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.
Functions
construct an aws.sdk.kotlin.services.cloudformation.model.RollbackConfiguration inside the given block