Network.AWS.CloudFormation.CreateStack

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.

Creating a Request

createStack

Arguments

:: Text

csStackName

-> CreateStack

Creates a value of CreateStack with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• csDisableRollback - 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
• csNotificationARNs - 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).
• csStackPolicyBody - Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources in the AWS CloudFormation User Guide . You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.
• csParameters - A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.
• csStackPolicyURL - 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.
• csTemplateBody - 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 AWS CloudFormation User Guide. Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
• csTemplateURL - Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to the Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
• csCapabilities - A list of values that you must specify before AWS CloudFormation can create certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter. The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM . The following resources require you to specify this parameter: AWS::IAM::AccessKey , AWS::IAM::Group , AWS::IAM::InstanceProfile , AWS::IAM::Policy , AWS::IAM::Role , AWS::IAM::User , and AWS::IAM::UserToGroupAddition . If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. 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 this parameter, this action returns an InsufficientCapabilities error. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates .
• csOnFailure - 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
• csResourceTypes - 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 AWS resource), Custom::* (for all custom resources), Custom::logical_ID (for a specific custom resource), AWS::service_name ::* (for all resources of a particular AWS service), and AWS::service_name ::resource_logical_ID (for a specific AWS resource). If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management .
• csTags - Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 10 tags can be specified.
• csTimeoutInMinutes - 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.
• csRoleARN - The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to create the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS 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, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
• csStackName - The name that is associated with the stack. The name must be unique in the region in which you are creating the stack.

data CreateStack

The input for CreateStack action.

See: createStack smart constructor.

Instances

Eq CreateStack

Methods

(==) :: CreateStack -> CreateStack -> Bool

(/=) :: CreateStack -> CreateStack -> Bool

Data CreateStack

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateStack -> c CreateStack

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateStack

toConstr :: CreateStack -> Constr

dataTypeOf :: CreateStack -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateStack)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateStack)

gmapT :: (forall b. Data b => b -> b) -> CreateStack -> CreateStack

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateStack -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateStack -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateStack -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateStack -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateStack -> m CreateStack

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateStack -> m CreateStack

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateStack -> m CreateStack

Read CreateStack

Methods

readsPrec :: Int -> ReadS CreateStack

readList :: ReadS [CreateStack]

readPrec :: ReadPrec CreateStack

readListPrec :: ReadPrec [CreateStack]

Show CreateStack

Methods

showsPrec :: Int -> CreateStack -> ShowS

show :: CreateStack -> String

showList :: [CreateStack] -> ShowS

Generic CreateStack

Associated Types

type Rep CreateStack :: * -> *

Methods

from :: CreateStack -> Rep CreateStack x

to :: Rep CreateStack x -> CreateStack

Hashable CreateStack

Methods

hashWithSalt :: Int -> CreateStack -> Int

hash :: CreateStack -> Int

NFData CreateStack

Methods

rnf :: CreateStack -> ()

AWSRequest CreateStack

Associated Types

type Rs CreateStack :: *

Methods

request :: CreateStack -> Request CreateStack

response :: MonadResource m => Logger -> Service -> Proxy * CreateStack -> ClientResponse -> m (Response CreateStack)

ToPath CreateStack

Methods

toPath :: CreateStack -> ByteString

ToHeaders CreateStack

Methods

toHeaders :: CreateStack -> [Header]

ToQuery CreateStack

Methods

toQuery :: CreateStack -> QueryString

type Rep CreateStack

type Rep CreateStack = D1 (MetaData "CreateStack" "Network.AWS.CloudFormation.CreateStack" "amazonka-cloudformation-1.4.5-G0stfcEaDzC4JoYZoVvUrE" False) (C1 (MetaCons "CreateStack'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_csDisableRollback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) ((:*:) (S1 (MetaSel (Just Symbol "_csNotificationARNs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_csStackPolicyBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_csParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Parameter]))) (S1 (MetaSel (Just Symbol "_csStackPolicyURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_csTemplateBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_csTemplateURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_csCapabilities") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Capability]))) ((:*:) (S1 (MetaSel (Just Symbol "_csOnFailure") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe OnFailure))) (S1 (MetaSel (Just Symbol "_csResourceTypes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_csTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Tag]))) (S1 (MetaSel (Just Symbol "_csTimeoutInMinutes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)))) ((:*:) (S1 (MetaSel (Just Symbol "_csRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_csStackName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))))

type Rs CreateStack

type Rs CreateStack = CreateStackResponse

Request Lenses

csDisableRollback :: Lens' CreateStack (Maybe Bool)

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

csNotificationARNs :: Lens' CreateStack [Text]

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).

csStackPolicyBody :: Lens' CreateStack (Maybe Text)

Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources in the AWS CloudFormation User Guide . You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

csParameters :: Lens' CreateStack [Parameter]

A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.

csStackPolicyURL :: Lens' CreateStack (Maybe 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.

csTemplateBody :: Lens' CreateStack (Maybe Text)

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 AWS CloudFormation User Guide. Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

csTemplateURL :: Lens' CreateStack (Maybe Text)

Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to the Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

csCapabilities :: Lens' CreateStack [Capability]

A list of values that you must specify before AWS CloudFormation can create certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter. The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM . The following resources require you to specify this parameter: AWS::IAM::AccessKey , AWS::IAM::Group , AWS::IAM::InstanceProfile , AWS::IAM::Policy , AWS::IAM::Role , AWS::IAM::User , and AWS::IAM::UserToGroupAddition . If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. 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 this parameter, this action returns an InsufficientCapabilities error. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates .

csOnFailure :: Lens' CreateStack (Maybe 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

csResourceTypes :: Lens' CreateStack [Text]

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 AWS resource), Custom::* (for all custom resources), Custom::logical_ID (for a specific custom resource), AWS::service_name ::* (for all resources of a particular AWS service), and AWS::service_name ::resource_logical_ID (for a specific AWS resource). If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management .

csTags :: Lens' CreateStack [Tag]

Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 10 tags can be specified.

csTimeoutInMinutes :: Lens' CreateStack (Maybe Natural)

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.

csRoleARN :: Lens' CreateStack (Maybe Text)

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to create the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS 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, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.

csStackName :: Lens' CreateStack Text

The name that is associated with the stack. The name must be unique in the region in which you are creating the stack.

Destructuring the Response

createStackResponse

Arguments

:: Int

csrsResponseStatus

-> CreateStackResponse

Creates a value of CreateStackResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• csrsStackId - Unique identifier of the stack.
• csrsResponseStatus - -- | The response status code.

data CreateStackResponse

The output for a CreateStack action.

See: createStackResponse smart constructor.

Instances

Eq CreateStackResponse

Methods

(==) :: CreateStackResponse -> CreateStackResponse -> Bool

(/=) :: CreateStackResponse -> CreateStackResponse -> Bool

Data CreateStackResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateStackResponse -> c CreateStackResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateStackResponse

toConstr :: CreateStackResponse -> Constr

dataTypeOf :: CreateStackResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateStackResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateStackResponse)

gmapT :: (forall b. Data b => b -> b) -> CreateStackResponse -> CreateStackResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateStackResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateStackResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateStackResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateStackResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateStackResponse -> m CreateStackResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateStackResponse -> m CreateStackResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateStackResponse -> m CreateStackResponse

Read CreateStackResponse

Methods

readsPrec :: Int -> ReadS CreateStackResponse

readList :: ReadS [CreateStackResponse]

readPrec :: ReadPrec CreateStackResponse

readListPrec :: ReadPrec [CreateStackResponse]

Show CreateStackResponse

Methods

showsPrec :: Int -> CreateStackResponse -> ShowS

show :: CreateStackResponse -> String

showList :: [CreateStackResponse] -> ShowS

Generic CreateStackResponse

Associated Types

type Rep CreateStackResponse :: * -> *

Methods

from :: CreateStackResponse -> Rep CreateStackResponse x

to :: Rep CreateStackResponse x -> CreateStackResponse

NFData CreateStackResponse

Methods

rnf :: CreateStackResponse -> ()

type Rep CreateStackResponse

type Rep CreateStackResponse = D1 (MetaData "CreateStackResponse" "Network.AWS.CloudFormation.CreateStack" "amazonka-cloudformation-1.4.5-G0stfcEaDzC4JoYZoVvUrE" False) (C1 (MetaCons "CreateStackResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_csrsStackId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_csrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

csrsStackId :: Lens' CreateStackResponse (Maybe Text)

Unique identifier of the stack.

csrsResponseStatus :: Lens' CreateStackResponse Int

• - | The response status code.