{-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE DuplicateRecordFields #-} {-# LANGUAGE NamedFieldPuns #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE StrictData #-} {-# LANGUAGE TypeFamilies #-} {-# LANGUAGE NoImplicitPrelude #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Amazonka.CloudFormation.CreateStack -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- 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 DescribeStacksoperation. module Amazonka.CloudFormation.CreateStack ( -- * Creating a Request CreateStack (..), newCreateStack, -- * Request Lenses createStack_capabilities, createStack_clientRequestToken, createStack_disableRollback, createStack_enableTerminationProtection, createStack_notificationARNs, createStack_onFailure, createStack_parameters, createStack_resourceTypes, createStack_roleARN, createStack_rollbackConfiguration, createStack_stackPolicyBody, createStack_stackPolicyURL, createStack_tags, createStack_templateBody, createStack_templateURL, createStack_timeoutInMinutes, createStack_stackName, -- * Destructuring the Response CreateStackResponse (..), newCreateStackResponse, -- * Response Lenses createStackResponse_stackId, createStackResponse_httpStatus, ) where import Amazonka.CloudFormation.Types import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import qualified Amazonka.Data as Data import qualified Amazonka.Prelude as Prelude import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response -- | The input for CreateStack action. -- -- /See:/ 'newCreateStack' smart constructor. data CreateStack = CreateStack' { -- | In some cases, you must explicitly acknowledge that your stack template -- contains certain capabilities in order for CloudFormation to create the -- stack. -- -- - @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. -- -- - If you have IAM resources, you can specify either capability. -- -- - If you have IAM resources with custom names, you /must/ specify -- @CAPABILITY_NAMED_IAM@. -- -- - If you don\'t specify either of these capabilities, -- CloudFormation returns an @InsufficientCapabilities@ error. -- -- If your stack template contains these resources, we recommend that -- you review all permissions associated with them and edit their -- permissions if necessary. -- -- - -- -- - -- -- - -- -- - -- -- - -- -- - -- -- - -- -- For more information, see -- . -- -- - @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 -- -- and -- -- 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. -- -- You should only create stacks directly from a stack template that -- contains macros if you know what processing the macro performs. -- -- Each macro relies on an underlying Lambda service function for -- processing stack templates. Be aware that the Lambda function owner -- can update the function operation without CloudFormation being -- notified. -- -- For more information, see -- . capabilities :: Prelude.Maybe [Capability], -- | 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. -- -- 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@. clientRequestToken :: Prelude.Maybe Prelude.Text, -- | 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@ disableRollback :: Prelude.Maybe Prelude.Bool, -- | 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 -- -- in the /CloudFormation User Guide/. Termination protection is -- deactivated on stacks by default. -- -- For -- , -- termination protection is set on the root stack and can\'t be changed -- directly on the nested stack. enableTerminationProtection :: Prelude.Maybe Prelude.Bool, -- | 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). notificationARNs :: Prelude.Maybe [Prelude.Text], -- | 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@ onFailure :: Prelude.Maybe OnFailure, -- | A list of @Parameter@ structures that specify input parameters for the -- stack. For more information, see the -- -- data type. parameters :: Prelude.Maybe [Parameter], -- | 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::@/@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 -- . resourceTypes :: Prelude.Maybe [Prelude.Text], -- | 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. roleARN :: Prelude.Maybe Prelude.Text, -- | The rollback triggers for CloudFormation to monitor during stack -- creation and updating operations, and for the specified monitoring -- period afterwards. rollbackConfiguration :: Prelude.Maybe RollbackConfiguration, -- | Structure containing the stack policy body. For more information, go to -- -- in the /CloudFormation User Guide/. You can specify either the -- @StackPolicyBody@ or the @StackPolicyURL@ parameter, but not both. stackPolicyBody :: Prelude.Maybe Prelude.Text, -- | 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. stackPolicyURL :: Prelude.Maybe Prelude.Text, -- | 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. tags :: Prelude.Maybe [Tag], -- | 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 -- -- in the CloudFormation User Guide. -- -- Conditional: You must specify either the @TemplateBody@ or the -- @TemplateURL@ parameter, but not both. templateBody :: Prelude.Maybe Prelude.Text, -- | 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 -- -- in the CloudFormation User Guide. -- -- Conditional: You must specify either the @TemplateBody@ or the -- @TemplateURL@ parameter, but not both. templateURL :: Prelude.Maybe Prelude.Text, -- | 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. timeoutInMinutes :: Prelude.Maybe Prelude.Natural, -- | 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. stackName :: Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'CreateStack' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'capabilities', 'createStack_capabilities' - In some cases, you must explicitly acknowledge that your stack template -- contains certain capabilities in order for CloudFormation to create the -- stack. -- -- - @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. -- -- - If you have IAM resources, you can specify either capability. -- -- - If you have IAM resources with custom names, you /must/ specify -- @CAPABILITY_NAMED_IAM@. -- -- - If you don\'t specify either of these capabilities, -- CloudFormation returns an @InsufficientCapabilities@ error. -- -- If your stack template contains these resources, we recommend that -- you review all permissions associated with them and edit their -- permissions if necessary. -- -- - -- -- - -- -- - -- -- - -- -- - -- -- - -- -- - -- -- For more information, see -- . -- -- - @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 -- -- and -- -- 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. -- -- You should only create stacks directly from a stack template that -- contains macros if you know what processing the macro performs. -- -- Each macro relies on an underlying Lambda service function for -- processing stack templates. Be aware that the Lambda function owner -- can update the function operation without CloudFormation being -- notified. -- -- For more information, see -- . -- -- 'clientRequestToken', 'createStack_clientRequestToken' - 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. -- -- 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@. -- -- 'disableRollback', 'createStack_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@ -- -- 'enableTerminationProtection', 'createStack_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 -- -- in the /CloudFormation User Guide/. Termination protection is -- deactivated on stacks by default. -- -- For -- , -- termination protection is set on the root stack and can\'t be changed -- directly on the nested stack. -- -- 'notificationARNs', 'createStack_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', 'createStack_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@ -- -- 'parameters', 'createStack_parameters' - A list of @Parameter@ structures that specify input parameters for the -- stack. For more information, see the -- -- data type. -- -- 'resourceTypes', 'createStack_resourceTypes' - 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::@/@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 -- . -- -- 'roleARN', 'createStack_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', 'createStack_rollbackConfiguration' - The rollback triggers for CloudFormation to monitor during stack -- creation and updating operations, and for the specified monitoring -- period afterwards. -- -- 'stackPolicyBody', 'createStack_stackPolicyBody' - Structure containing the stack policy body. For more information, go to -- -- in the /CloudFormation User Guide/. You can specify either the -- @StackPolicyBody@ or the @StackPolicyURL@ parameter, but not both. -- -- 'stackPolicyURL', 'createStack_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. You can specify either the @StackPolicyBody@ or the -- @StackPolicyURL@ parameter, but not both. -- -- 'tags', 'createStack_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', 'createStack_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 -- -- in the CloudFormation User Guide. -- -- Conditional: You must specify either the @TemplateBody@ or the -- @TemplateURL@ parameter, but not both. -- -- 'templateURL', 'createStack_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 -- -- in the CloudFormation User Guide. -- -- Conditional: You must specify either the @TemplateBody@ or the -- @TemplateURL@ parameter, but not both. -- -- 'timeoutInMinutes', 'createStack_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. -- -- 'stackName', 'createStack_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. newCreateStack :: -- | 'stackName' Prelude.Text -> CreateStack newCreateStack pStackName_ = CreateStack' { capabilities = Prelude.Nothing, clientRequestToken = Prelude.Nothing, disableRollback = Prelude.Nothing, enableTerminationProtection = Prelude.Nothing, notificationARNs = Prelude.Nothing, onFailure = Prelude.Nothing, parameters = Prelude.Nothing, resourceTypes = Prelude.Nothing, roleARN = Prelude.Nothing, rollbackConfiguration = Prelude.Nothing, stackPolicyBody = Prelude.Nothing, stackPolicyURL = Prelude.Nothing, tags = Prelude.Nothing, templateBody = Prelude.Nothing, templateURL = Prelude.Nothing, timeoutInMinutes = Prelude.Nothing, stackName = pStackName_ } -- | In some cases, you must explicitly acknowledge that your stack template -- contains certain capabilities in order for CloudFormation to create the -- stack. -- -- - @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. -- -- - If you have IAM resources, you can specify either capability. -- -- - If you have IAM resources with custom names, you /must/ specify -- @CAPABILITY_NAMED_IAM@. -- -- - If you don\'t specify either of these capabilities, -- CloudFormation returns an @InsufficientCapabilities@ error. -- -- If your stack template contains these resources, we recommend that -- you review all permissions associated with them and edit their -- permissions if necessary. -- -- - -- -- - -- -- - -- -- - -- -- - -- -- - -- -- - -- -- For more information, see -- . -- -- - @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 -- -- and -- -- 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. -- -- You should only create stacks directly from a stack template that -- contains macros if you know what processing the macro performs. -- -- Each macro relies on an underlying Lambda service function for -- processing stack templates. Be aware that the Lambda function owner -- can update the function operation without CloudFormation being -- notified. -- -- For more information, see -- . createStack_capabilities :: Lens.Lens' CreateStack (Prelude.Maybe [Capability]) createStack_capabilities = Lens.lens (\CreateStack' {capabilities} -> capabilities) (\s@CreateStack' {} a -> s {capabilities = a} :: CreateStack) Prelude.. Lens.mapping Lens.coerced -- | 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. -- -- 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@. createStack_clientRequestToken :: Lens.Lens' CreateStack (Prelude.Maybe Prelude.Text) createStack_clientRequestToken = Lens.lens (\CreateStack' {clientRequestToken} -> clientRequestToken) (\s@CreateStack' {} a -> s {clientRequestToken = a} :: CreateStack) -- | 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@ createStack_disableRollback :: Lens.Lens' CreateStack (Prelude.Maybe Prelude.Bool) createStack_disableRollback = Lens.lens (\CreateStack' {disableRollback} -> disableRollback) (\s@CreateStack' {} a -> s {disableRollback = a} :: CreateStack) -- | 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 -- -- in the /CloudFormation User Guide/. Termination protection is -- deactivated on stacks by default. -- -- For -- , -- termination protection is set on the root stack and can\'t be changed -- directly on the nested stack. createStack_enableTerminationProtection :: Lens.Lens' CreateStack (Prelude.Maybe Prelude.Bool) createStack_enableTerminationProtection = Lens.lens (\CreateStack' {enableTerminationProtection} -> enableTerminationProtection) (\s@CreateStack' {} a -> s {enableTerminationProtection = a} :: CreateStack) -- | 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). createStack_notificationARNs :: Lens.Lens' CreateStack (Prelude.Maybe [Prelude.Text]) createStack_notificationARNs = Lens.lens (\CreateStack' {notificationARNs} -> notificationARNs) (\s@CreateStack' {} a -> s {notificationARNs = a} :: CreateStack) Prelude.. Lens.mapping Lens.coerced -- | 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@ createStack_onFailure :: Lens.Lens' CreateStack (Prelude.Maybe OnFailure) createStack_onFailure = Lens.lens (\CreateStack' {onFailure} -> onFailure) (\s@CreateStack' {} a -> s {onFailure = a} :: CreateStack) -- | A list of @Parameter@ structures that specify input parameters for the -- stack. For more information, see the -- -- data type. createStack_parameters :: Lens.Lens' CreateStack (Prelude.Maybe [Parameter]) createStack_parameters = Lens.lens (\CreateStack' {parameters} -> parameters) (\s@CreateStack' {} a -> s {parameters = a} :: CreateStack) Prelude.. Lens.mapping Lens.coerced -- | 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::@/@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 -- . createStack_resourceTypes :: Lens.Lens' CreateStack (Prelude.Maybe [Prelude.Text]) createStack_resourceTypes = Lens.lens (\CreateStack' {resourceTypes} -> resourceTypes) (\s@CreateStack' {} a -> s {resourceTypes = a} :: CreateStack) Prelude.. Lens.mapping Lens.coerced -- | 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. createStack_roleARN :: Lens.Lens' CreateStack (Prelude.Maybe Prelude.Text) createStack_roleARN = Lens.lens (\CreateStack' {roleARN} -> roleARN) (\s@CreateStack' {} a -> s {roleARN = a} :: CreateStack) -- | The rollback triggers for CloudFormation to monitor during stack -- creation and updating operations, and for the specified monitoring -- period afterwards. createStack_rollbackConfiguration :: Lens.Lens' CreateStack (Prelude.Maybe RollbackConfiguration) createStack_rollbackConfiguration = Lens.lens (\CreateStack' {rollbackConfiguration} -> rollbackConfiguration) (\s@CreateStack' {} a -> s {rollbackConfiguration = a} :: CreateStack) -- | Structure containing the stack policy body. For more information, go to -- -- in the /CloudFormation User Guide/. You can specify either the -- @StackPolicyBody@ or the @StackPolicyURL@ parameter, but not both. createStack_stackPolicyBody :: Lens.Lens' CreateStack (Prelude.Maybe Prelude.Text) createStack_stackPolicyBody = Lens.lens (\CreateStack' {stackPolicyBody} -> stackPolicyBody) (\s@CreateStack' {} a -> s {stackPolicyBody = a} :: CreateStack) -- | 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. createStack_stackPolicyURL :: Lens.Lens' CreateStack (Prelude.Maybe Prelude.Text) createStack_stackPolicyURL = Lens.lens (\CreateStack' {stackPolicyURL} -> stackPolicyURL) (\s@CreateStack' {} a -> s {stackPolicyURL = a} :: CreateStack) -- | 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. createStack_tags :: Lens.Lens' CreateStack (Prelude.Maybe [Tag]) createStack_tags = Lens.lens (\CreateStack' {tags} -> tags) (\s@CreateStack' {} a -> s {tags = a} :: CreateStack) Prelude.. Lens.mapping Lens.coerced -- | 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 -- -- in the CloudFormation User Guide. -- -- Conditional: You must specify either the @TemplateBody@ or the -- @TemplateURL@ parameter, but not both. createStack_templateBody :: Lens.Lens' CreateStack (Prelude.Maybe Prelude.Text) createStack_templateBody = Lens.lens (\CreateStack' {templateBody} -> templateBody) (\s@CreateStack' {} a -> s {templateBody = a} :: CreateStack) -- | 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 -- -- in the CloudFormation User Guide. -- -- Conditional: You must specify either the @TemplateBody@ or the -- @TemplateURL@ parameter, but not both. createStack_templateURL :: Lens.Lens' CreateStack (Prelude.Maybe Prelude.Text) createStack_templateURL = Lens.lens (\CreateStack' {templateURL} -> templateURL) (\s@CreateStack' {} a -> s {templateURL = a} :: CreateStack) -- | 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. createStack_timeoutInMinutes :: Lens.Lens' CreateStack (Prelude.Maybe Prelude.Natural) createStack_timeoutInMinutes = Lens.lens (\CreateStack' {timeoutInMinutes} -> timeoutInMinutes) (\s@CreateStack' {} a -> s {timeoutInMinutes = a} :: CreateStack) -- | 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. createStack_stackName :: Lens.Lens' CreateStack Prelude.Text createStack_stackName = Lens.lens (\CreateStack' {stackName} -> stackName) (\s@CreateStack' {} a -> s {stackName = a} :: CreateStack) instance Core.AWSRequest CreateStack where type AWSResponse CreateStack = CreateStackResponse request overrides = Request.postQuery (overrides defaultService) response = Response.receiveXMLWrapper "CreateStackResult" ( \s h x -> CreateStackResponse' Prelude.<$> (x Data..@? "StackId") Prelude.<*> (Prelude.pure (Prelude.fromEnum s)) ) instance Prelude.Hashable CreateStack where hashWithSalt _salt CreateStack' {..} = _salt `Prelude.hashWithSalt` capabilities `Prelude.hashWithSalt` clientRequestToken `Prelude.hashWithSalt` disableRollback `Prelude.hashWithSalt` enableTerminationProtection `Prelude.hashWithSalt` notificationARNs `Prelude.hashWithSalt` onFailure `Prelude.hashWithSalt` parameters `Prelude.hashWithSalt` resourceTypes `Prelude.hashWithSalt` roleARN `Prelude.hashWithSalt` rollbackConfiguration `Prelude.hashWithSalt` stackPolicyBody `Prelude.hashWithSalt` stackPolicyURL `Prelude.hashWithSalt` tags `Prelude.hashWithSalt` templateBody `Prelude.hashWithSalt` templateURL `Prelude.hashWithSalt` timeoutInMinutes `Prelude.hashWithSalt` stackName instance Prelude.NFData CreateStack where rnf CreateStack' {..} = Prelude.rnf capabilities `Prelude.seq` Prelude.rnf clientRequestToken `Prelude.seq` Prelude.rnf disableRollback `Prelude.seq` Prelude.rnf enableTerminationProtection `Prelude.seq` Prelude.rnf notificationARNs `Prelude.seq` Prelude.rnf onFailure `Prelude.seq` Prelude.rnf parameters `Prelude.seq` Prelude.rnf resourceTypes `Prelude.seq` Prelude.rnf roleARN `Prelude.seq` Prelude.rnf rollbackConfiguration `Prelude.seq` Prelude.rnf stackPolicyBody `Prelude.seq` Prelude.rnf stackPolicyURL `Prelude.seq` Prelude.rnf tags `Prelude.seq` Prelude.rnf templateBody `Prelude.seq` Prelude.rnf templateURL `Prelude.seq` Prelude.rnf timeoutInMinutes `Prelude.seq` Prelude.rnf stackName instance Data.ToHeaders CreateStack where toHeaders = Prelude.const Prelude.mempty instance Data.ToPath CreateStack where toPath = Prelude.const "/" instance Data.ToQuery CreateStack where toQuery CreateStack' {..} = Prelude.mconcat [ "Action" Data.=: ("CreateStack" :: Prelude.ByteString), "Version" Data.=: ("2010-05-15" :: Prelude.ByteString), "Capabilities" Data.=: Data.toQuery (Data.toQueryList "member" Prelude.<$> capabilities), "ClientRequestToken" Data.=: clientRequestToken, "DisableRollback" Data.=: disableRollback, "EnableTerminationProtection" Data.=: enableTerminationProtection, "NotificationARNs" Data.=: Data.toQuery ( Data.toQueryList "member" Prelude.<$> notificationARNs ), "OnFailure" Data.=: onFailure, "Parameters" Data.=: Data.toQuery (Data.toQueryList "member" Prelude.<$> parameters), "ResourceTypes" Data.=: Data.toQuery ( Data.toQueryList "member" Prelude.<$> resourceTypes ), "RoleARN" Data.=: roleARN, "RollbackConfiguration" Data.=: rollbackConfiguration, "StackPolicyBody" Data.=: stackPolicyBody, "StackPolicyURL" Data.=: stackPolicyURL, "Tags" Data.=: Data.toQuery (Data.toQueryList "member" Prelude.<$> tags), "TemplateBody" Data.=: templateBody, "TemplateURL" Data.=: templateURL, "TimeoutInMinutes" Data.=: timeoutInMinutes, "StackName" Data.=: stackName ] -- | The output for a CreateStack action. -- -- /See:/ 'newCreateStackResponse' smart constructor. data CreateStackResponse = CreateStackResponse' { -- | Unique identifier of the stack. stackId :: Prelude.Maybe Prelude.Text, -- | The response's http status code. httpStatus :: Prelude.Int } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'CreateStackResponse' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'stackId', 'createStackResponse_stackId' - Unique identifier of the stack. -- -- 'httpStatus', 'createStackResponse_httpStatus' - The response's http status code. newCreateStackResponse :: -- | 'httpStatus' Prelude.Int -> CreateStackResponse newCreateStackResponse pHttpStatus_ = CreateStackResponse' { stackId = Prelude.Nothing, httpStatus = pHttpStatus_ } -- | Unique identifier of the stack. createStackResponse_stackId :: Lens.Lens' CreateStackResponse (Prelude.Maybe Prelude.Text) createStackResponse_stackId = Lens.lens (\CreateStackResponse' {stackId} -> stackId) (\s@CreateStackResponse' {} a -> s {stackId = a} :: CreateStackResponse) -- | The response's http status code. createStackResponse_httpStatus :: Lens.Lens' CreateStackResponse Prelude.Int createStackResponse_httpStatus = Lens.lens (\CreateStackResponse' {httpStatus} -> httpStatus) (\s@CreateStackResponse' {} a -> s {httpStatus = a} :: CreateStackResponse) instance Prelude.NFData CreateStackResponse where rnf CreateStackResponse' {..} = Prelude.rnf stackId `Prelude.seq` Prelude.rnf httpStatus