| Copyright | (c) 2013-2016 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.CloudFormation.CreateStack
Description
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.
- createStack :: Text -> CreateStack
- data CreateStack
- csDisableRollback :: Lens' CreateStack (Maybe Bool)
- csNotificationARNs :: Lens' CreateStack [Text]
- csStackPolicyBody :: Lens' CreateStack (Maybe Text)
- csParameters :: Lens' CreateStack [Parameter]
- csStackPolicyURL :: Lens' CreateStack (Maybe Text)
- csTemplateBody :: Lens' CreateStack (Maybe Text)
- csTemplateURL :: Lens' CreateStack (Maybe Text)
- csCapabilities :: Lens' CreateStack [Capability]
- csOnFailure :: Lens' CreateStack (Maybe OnFailure)
- csResourceTypes :: Lens' CreateStack [Text]
- csTags :: Lens' CreateStack [Tag]
- csTimeoutInMinutes :: Lens' CreateStack (Maybe Natural)
- csStackName :: Lens' CreateStack Text
- createStackResponse :: Int -> CreateStackResponse
- data CreateStackResponse
- csrsStackId :: Lens' CreateStackResponse (Maybe Text)
- csrsResponseStatus :: Lens' CreateStackResponse Int
Creating a Request
Arguments
| :: Text | |
| -> 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:
data CreateStack Source #
The input for CreateStack action.
See: createStack smart constructor.
Instances
Request Lenses
csDisableRollback :: Lens' CreateStack (Maybe Bool) Source #
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] Source #
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) Source #
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.
csStackPolicyURL :: Lens' CreateStack (Maybe Text) Source #
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. You can specify either the StackPolicyBody or the
StackPolicyURL parameter, but not both.
csTemplateBody :: Lens' CreateStack (Maybe Text) Source #
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) Source #
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] Source #
A list of capabilities 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.
Currently, the only valid value is CAPABILITY_IAM, which is required
for the following resources:
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 your template contains any of the listed resources and
you don't specify this parameter, this action returns an
InsufficientCapabilities error.
csOnFailure :: Lens' CreateStack (Maybe OnFailure) Source #
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] Source #
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] Source #
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) Source #
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.
csStackName :: Lens' CreateStack Text Source #
The name that is 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 alphabetic character and cannot be longer than 128 characters.
Destructuring the Response
Arguments
| :: Int | |
| -> 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:
data CreateStackResponse Source #
The output for a CreateStack action.
See: createStackResponse smart constructor.
Response Lenses
csrsStackId :: Lens' CreateStackResponse (Maybe Text) Source #
Unique identifier of the stack.
csrsResponseStatus :: Lens' CreateStackResponse Int Source #
The response status code.