Copyright	(c) 2013-2015 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

Contents

Service Configuration
Errors
Waiters
Operations
Types

Description

AWS CloudFormation

AWS CloudFormation enables you to create and manage AWS infrastructure deployments predictably and repeatedly. AWS CloudFormation helps you leverage AWS products such as Amazon EC2, EBS, Amazon SNS, ELB, and Auto Scaling to build highly-reliable, highly scalable, cost effective applications without worrying about creating and configuring the underlying AWS infrastructure.

With AWS CloudFormation, you declare all of your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. AWS CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you.

For more information about this product, go to the CloudFormation Product Page.

Amazon CloudFormation makes use of other AWS products. If you need additional technical information about a specific AWS product, you can find the product's technical documentation at http://aws.amazon.com/documentation/.

See: AWS API Reference

Synopsis

Service Configuration

cloudFormation :: Service Source

API version '2010-05-15' of the Amazon CloudFormation SDK configuration.

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by CloudFormation.

InsufficientCapabilitiesException

_InsufficientCapabilitiesException :: AsError a => Getting (First ServiceError) a ServiceError Source

The template contains resources with capabilities that were not specified in the Capabilities parameter.

AlreadyExistsException

_AlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source

Resource with the name requested already exists.

LimitExceededException

_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source

Quota for the resource has already been reached.

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

DeleteStack

module Network.AWS.CloudFormation.DeleteStack

UpdateStack

module Network.AWS.CloudFormation.UpdateStack

GetTemplateSummary

module Network.AWS.CloudFormation.GetTemplateSummary

ListStackResources (Paginated)

module Network.AWS.CloudFormation.ListStackResources

GetStackPolicy

module Network.AWS.CloudFormation.GetStackPolicy

DescribeStacks (Paginated)

module Network.AWS.CloudFormation.DescribeStacks

ValidateTemplate

module Network.AWS.CloudFormation.ValidateTemplate

CancelUpdateStack

module Network.AWS.CloudFormation.CancelUpdateStack

DescribeStackEvents (Paginated)

module Network.AWS.CloudFormation.DescribeStackEvents

SignalResource

module Network.AWS.CloudFormation.SignalResource

SetStackPolicy

module Network.AWS.CloudFormation.SetStackPolicy

ListStacks (Paginated)

module Network.AWS.CloudFormation.ListStacks

DescribeAccountLimits

module Network.AWS.CloudFormation.DescribeAccountLimits

DescribeStackResources

module Network.AWS.CloudFormation.DescribeStackResources

CreateStack

module Network.AWS.CloudFormation.CreateStack

EstimateTemplateCost

module Network.AWS.CloudFormation.EstimateTemplateCost

GetTemplate

module Network.AWS.CloudFormation.GetTemplate

DescribeStackResource

module Network.AWS.CloudFormation.DescribeStackResource

Types

Capability

OnFailure

ResourceSignalStatus

ResourceStatus

StackStatus

AccountLimit

data AccountLimit Source

The AccountLimit data type.

See: accountLimit smart constructor.

Instances

Eq AccountLimit Source
Data AccountLimit Source
Read AccountLimit Source
Show AccountLimit Source
Generic AccountLimit Source
FromXML AccountLimit Source
type Rep AccountLimit Source

accountLimit :: AccountLimit Source

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

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

alValue
alName

alValue :: Lens' AccountLimit (Maybe Int) Source

The value that is associated with the account limit name.

alName :: Lens' AccountLimit (Maybe Text) Source

The name of the account limit. Currently, the only account limit is StackLimit.

Output

data Output Source

The Output data type.

See: output smart constructor.

Instances

Eq Output Source
Data Output Source
Read Output Source
Show Output Source
Generic Output Source
FromXML Output Source
type Rep Output Source

output :: Output Source

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

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

oOutputValue :: Lens' Output (Maybe Text) Source

The value associated with the output.

oOutputKey :: Lens' Output (Maybe Text) Source

The key associated with the output.

oDescription :: Lens' Output (Maybe Text) Source

User defined description associated with the output.

Parameter

data Parameter Source

The Parameter data type.

See: parameter smart constructor.

parameter :: Parameter Source

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

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

pParameterValue :: Lens' Parameter (Maybe Text) Source

The value associated with the parameter.

pParameterKey :: Lens' Parameter (Maybe Text) Source

The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.

pUsePreviousValue :: Lens' Parameter (Maybe Bool) Source

During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true, do not specify a parameter value.

ParameterConstraints

data ParameterConstraints Source

A set of criteria that AWS CloudFormation uses to validate parameter values. Although other constraints might be defined in the stack template, AWS CloudFormation returns only the AllowedValues property.

See: parameterConstraints smart constructor.

parameterConstraints :: ParameterConstraints Source

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

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

pcAllowedValues

pcAllowedValues :: Lens' ParameterConstraints [Text] Source

A list of values that are permitted for a parameter.

ParameterDeclaration

data ParameterDeclaration Source

The ParameterDeclaration data type.

See: parameterDeclaration smart constructor.

parameterDeclaration :: ParameterDeclaration Source

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

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

pdParameterKey :: Lens' ParameterDeclaration (Maybe Text) Source

The name that is associated with the parameter.

pdParameterType :: Lens' ParameterDeclaration (Maybe Text) Source

The type of parameter.

pdParameterConstraints :: Lens' ParameterDeclaration (Maybe ParameterConstraints) Source

The criteria that AWS CloudFormation uses to validate parameter values.

pdDefaultValue :: Lens' ParameterDeclaration (Maybe Text) Source

The default value of the parameter.

pdNoEcho :: Lens' ParameterDeclaration (Maybe Bool) Source

Flag that indicates whether the parameter value is shown as plain text in logs and in the AWS Management Console.

pdDescription :: Lens' ParameterDeclaration (Maybe Text) Source

The description that is associate with the parameter.

Stack

data Stack Source

The Stack data type.

See: stack smart constructor.

Instances

Eq Stack Source
Data Stack Source
Read Stack Source
Show Stack Source
Generic Stack Source
FromXML Stack Source
type Rep Stack Source

stack Source

Arguments

:: Text	`sStackName`
-> UTCTime	`sCreationTime`
-> StackStatus	`sStackStatus`
-> Stack

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

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

sDisableRollback :: Lens' Stack (Maybe Bool) Source

Boolean to enable or disable rollback on stack creation failures:

true: disable rollback
false: enable rollback

sLastUpdatedTime :: Lens' Stack (Maybe UTCTime) Source

The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

sNotificationARNs :: Lens' Stack [Text] Source

SNS topic ARNs to which stack related events are published.

sStackStatusReason :: Lens' Stack (Maybe Text) Source

Success/failure message associated with the stack status.

sOutputs :: Lens' Stack [Output] Source

A list of output structures.

sParameters :: Lens' Stack [Parameter] Source

A list of Parameter structures.

sStackId :: Lens' Stack (Maybe Text) Source

Unique identifier of the stack.

sDescription :: Lens' Stack (Maybe Text) Source

A user-defined description associated with the stack.

sCapabilities :: Lens' Stack [Capability] Source

The capabilities allowed in the stack.

sTags :: Lens' Stack [Tag] Source

A list of Tags that specify cost allocation information for the stack.

sTimeoutInMinutes :: Lens' Stack (Maybe Natural) Source

The amount of time within which stack creation should complete.

sStackName :: Lens' Stack Text Source

The name associated with the stack.

sCreationTime :: Lens' Stack UTCTime Source

The time at which the stack was created.

sStackStatus :: Lens' Stack StackStatus Source

Current status of the stack.

StackEvent

data StackEvent Source

The StackEvent data type.

See: stackEvent smart constructor.

Instances

Eq StackEvent Source
Data StackEvent Source
Read StackEvent Source
Show StackEvent Source
Generic StackEvent Source
FromXML StackEvent Source
type Rep StackEvent Source

stackEvent Source

Arguments

:: Text	`seStackId`
-> Text	`seEventId`
-> Text	`seStackName`
-> UTCTime	`seTimestamp`
-> StackEvent

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

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

seLogicalResourceId :: Lens' StackEvent (Maybe Text) Source

The logical name of the resource specified in the template.

sePhysicalResourceId :: Lens' StackEvent (Maybe Text) Source

The name or unique identifier associated with the physical instance of the resource.

seResourceType :: Lens' StackEvent (Maybe Text) Source

Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)

seResourceStatusReason :: Lens' StackEvent (Maybe Text) Source

Success/failure message associated with the resource.

seResourceProperties :: Lens' StackEvent (Maybe Text) Source

BLOB of the properties used to create the resource.

seResourceStatus :: Lens' StackEvent (Maybe ResourceStatus) Source

Current status of the resource.

seStackId :: Lens' StackEvent Text Source

The unique ID name of the instance of the stack.

seEventId :: Lens' StackEvent Text Source

The unique ID of this event.

seStackName :: Lens' StackEvent Text Source

The name associated with a stack.

seTimestamp :: Lens' StackEvent UTCTime Source

Time the status was updated.

StackResource

data StackResource Source

The StackResource data type.

See: stackResource smart constructor.

stackResource Source

Arguments

:: Text	`srLogicalResourceId`
-> Text	`srResourceType`
-> UTCTime	`srTimestamp`
-> ResourceStatus	`srResourceStatus`
-> StackResource

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

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

srPhysicalResourceId :: Lens' StackResource (Maybe Text) Source

The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.

srResourceStatusReason :: Lens' StackResource (Maybe Text) Source

Success/failure message associated with the resource.

srStackId :: Lens' StackResource (Maybe Text) Source

Unique identifier of the stack.

srDescription :: Lens' StackResource (Maybe Text) Source

User defined description associated with the resource.

srStackName :: Lens' StackResource (Maybe Text) Source

The name associated with the stack.

srLogicalResourceId :: Lens' StackResource Text Source

The logical name of the resource specified in the template.

srResourceType :: Lens' StackResource Text Source

Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)

srTimestamp :: Lens' StackResource UTCTime Source

Time the status was updated.

srResourceStatus :: Lens' StackResource ResourceStatus Source

Current status of the resource.

StackResourceDetail

data StackResourceDetail Source

Contains detailed information about the specified stack resource.

See: stackResourceDetail smart constructor.

stackResourceDetail Source

Arguments

:: Text	`srdLogicalResourceId`
-> Text	`srdResourceType`
-> UTCTime	`srdLastUpdatedTimestamp`
-> ResourceStatus	`srdResourceStatus`
-> StackResourceDetail

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

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

srdPhysicalResourceId :: Lens' StackResourceDetail (Maybe Text) Source

The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.

srdResourceStatusReason :: Lens' StackResourceDetail (Maybe Text) Source

Success/failure message associated with the resource.

srdMetadata :: Lens' StackResourceDetail (Maybe Text) Source

The JSON format content of the Metadata attribute declared for the resource. For more information, see Metadata Attribute in the AWS CloudFormation User Guide.

srdStackId :: Lens' StackResourceDetail (Maybe Text) Source

Unique identifier of the stack.

srdDescription :: Lens' StackResourceDetail (Maybe Text) Source

User defined description associated with the resource.

srdStackName :: Lens' StackResourceDetail (Maybe Text) Source

The name associated with the stack.

srdLogicalResourceId :: Lens' StackResourceDetail Text Source

The logical name of the resource specified in the template.

srdResourceType :: Lens' StackResourceDetail Text Source

Type of resource. ((For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)

srdLastUpdatedTimestamp :: Lens' StackResourceDetail UTCTime Source

Time the status was updated.

srdResourceStatus :: Lens' StackResourceDetail ResourceStatus Source

Current status of the resource.

StackResourceSummary

data StackResourceSummary Source

Contains high-level information about the specified stack resource.

See: stackResourceSummary smart constructor.

stackResourceSummary Source

Arguments

:: Text	`srsLogicalResourceId`
-> Text	`srsResourceType`
-> UTCTime	`srsLastUpdatedTimestamp`
-> ResourceStatus	`srsResourceStatus`
-> StackResourceSummary

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

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

srsPhysicalResourceId :: Lens' StackResourceSummary (Maybe Text) Source

The name or unique identifier that corresponds to a physical instance ID of the resource.

srsResourceStatusReason :: Lens' StackResourceSummary (Maybe Text) Source

Success/failure message associated with the resource.

srsLogicalResourceId :: Lens' StackResourceSummary Text Source

The logical name of the resource specified in the template.

srsResourceType :: Lens' StackResourceSummary Text Source

Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)

srsLastUpdatedTimestamp :: Lens' StackResourceSummary UTCTime Source

Time the status was updated.

srsResourceStatus :: Lens' StackResourceSummary ResourceStatus Source

Current status of the resource.

StackSummary

data StackSummary Source

The StackSummary Data Type

See: stackSummary smart constructor.

Instances

Eq StackSummary Source
Data StackSummary Source
Read StackSummary Source
Show StackSummary Source
Generic StackSummary Source
FromXML StackSummary Source
type Rep StackSummary Source

stackSummary Source

Arguments

:: Text	`ssStackName`
-> UTCTime	`ssCreationTime`
-> StackStatus	`ssStackStatus`
-> StackSummary

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

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

ssLastUpdatedTime :: Lens' StackSummary (Maybe UTCTime) Source

The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

ssStackStatusReason :: Lens' StackSummary (Maybe Text) Source

Success/Failure message associated with the stack status.

ssTemplateDescription :: Lens' StackSummary (Maybe Text) Source

The template description of the template used to create the stack.

ssDeletionTime :: Lens' StackSummary (Maybe UTCTime) Source

The time the stack was deleted.

ssStackId :: Lens' StackSummary (Maybe Text) Source

Unique stack identifier.

ssStackName :: Lens' StackSummary Text Source

The name associated with the stack.

ssCreationTime :: Lens' StackSummary UTCTime Source

The time the stack was created.

ssStackStatus :: Lens' StackSummary StackStatus Source

The current status of the stack.

Tag

data Tag Source

The Tag type is used by CreateStack in the Tags parameter. It allows you to specify a key/value pair that can be used to store information related to cost allocation for an AWS CloudFormation stack.

See: tag smart constructor.

Instances

Eq Tag Source
Data Tag Source
Read Tag Source
Show Tag Source
Generic Tag Source
FromXML Tag Source
ToQuery Tag Source
type Rep Tag Source

tag :: Tag Source

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

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

tagValue
tagKey

tagValue :: Lens' Tag (Maybe Text) Source

Required. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.

tagKey :: Lens' Tag (Maybe Text) Source

Required. A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (AWS) have the reserved prefix: 'aws:'.

TemplateParameter

data TemplateParameter Source

The TemplateParameter data type.

See: templateParameter smart constructor.

templateParameter :: TemplateParameter Source

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

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

tpParameterKey :: Lens' TemplateParameter (Maybe Text) Source

The name associated with the parameter.

tpDefaultValue :: Lens' TemplateParameter (Maybe Text) Source

The default value associated with the parameter.

tpNoEcho :: Lens' TemplateParameter (Maybe Bool) Source

Flag indicating whether the parameter should be displayed as plain text in logs and UIs.

tpDescription :: Lens' TemplateParameter (Maybe Text) Source

User defined description associated with the parameter.

Enum Capability Source
Eq Capability Source
Data Capability Source
Ord Capability Source
Read Capability Source
Show Capability Source
Generic Capability Source
Hashable Capability Source
ToHeader Capability Source
FromXML Capability Source
ToQuery Capability Source
ToByteString Capability Source
FromText Capability Source
ToText Capability Source
type Rep Capability Source

Enum OnFailure Source
Eq OnFailure Source
Data OnFailure Source
Ord OnFailure Source
Read OnFailure Source
Show OnFailure Source
Generic OnFailure Source
Hashable OnFailure Source
ToHeader OnFailure Source
ToQuery OnFailure Source
ToByteString OnFailure Source
FromText OnFailure Source
ToText OnFailure Source
type Rep OnFailure Source

Enum ResourceSignalStatus Source
Eq ResourceSignalStatus Source
Data ResourceSignalStatus Source
Ord ResourceSignalStatus Source
Read ResourceSignalStatus Source
Show ResourceSignalStatus Source
Generic ResourceSignalStatus Source
Hashable ResourceSignalStatus Source
ToHeader ResourceSignalStatus Source
ToQuery ResourceSignalStatus Source
ToByteString ResourceSignalStatus Source
FromText ResourceSignalStatus Source
ToText ResourceSignalStatus Source
type Rep ResourceSignalStatus Source

CreateComplete
CreateFailed
CreateInProgress
DeleteComplete
DeleteFailed
DeleteInProgress
DeleteSkipped
UpdateComplete
UpdateFailed
UpdateInProgress

Enum ResourceStatus Source
Eq ResourceStatus Source
Data ResourceStatus Source
Ord ResourceStatus Source
Read ResourceStatus Source
Show ResourceStatus Source
Generic ResourceStatus Source
Hashable ResourceStatus Source
ToHeader ResourceStatus Source
FromXML ResourceStatus Source
ToQuery ResourceStatus Source
ToByteString ResourceStatus Source
FromText ResourceStatus Source
ToText ResourceStatus Source
type Rep ResourceStatus Source

SSCreateComplete
SSCreateFailed
SSCreateInProgress
SSDeleteComplete
SSDeleteFailed
SSDeleteInProgress
SSRollbackComplete
SSRollbackFailed
SSRollbackInProgress
SSUpdateComplete
SSUpdateCompleteCleanupInProgress
SSUpdateInProgress
SSUpdateRollbackComplete
SSUpdateRollbackCompleteCleanupInProgress
SSUpdateRollbackFailed
SSUpdateRollbackInProgress

Enum StackStatus Source
Eq StackStatus Source
Data StackStatus Source
Ord StackStatus Source
Read StackStatus Source
Show StackStatus Source
Generic StackStatus Source
Hashable StackStatus Source
ToHeader StackStatus Source
FromXML StackStatus Source
ToQuery StackStatus Source
ToByteString StackStatus Source
FromText StackStatus Source
ToText StackStatus Source
type Rep StackStatus Source

Eq Parameter Source
Data Parameter Source
Read Parameter Source
Show Parameter Source
Generic Parameter Source
FromXML Parameter Source
ToQuery Parameter Source
type Rep Parameter Source

Eq ParameterConstraints Source
Data ParameterConstraints Source
Read ParameterConstraints Source
Show ParameterConstraints Source
Generic ParameterConstraints Source
FromXML ParameterConstraints Source
type Rep ParameterConstraints Source

Eq ParameterDeclaration Source
Data ParameterDeclaration Source
Read ParameterDeclaration Source
Show ParameterDeclaration Source
Generic ParameterDeclaration Source
FromXML ParameterDeclaration Source
type Rep ParameterDeclaration Source

Eq StackResource Source
Data StackResource Source
Read StackResource Source
Show StackResource Source
Generic StackResource Source
FromXML StackResource Source
type Rep StackResource Source

Eq StackResourceDetail Source
Data StackResourceDetail Source
Read StackResourceDetail Source
Show StackResourceDetail Source
Generic StackResourceDetail Source
FromXML StackResourceDetail Source
type Rep StackResourceDetail Source

Eq StackResourceSummary Source
Data StackResourceSummary Source
Read StackResourceSummary Source
Show StackResourceSummary Source
Generic StackResourceSummary Source
FromXML StackResourceSummary Source
type Rep StackResourceSummary Source

Eq TemplateParameter Source
Data TemplateParameter Source
Read TemplateParameter Source
Show TemplateParameter Source
Generic TemplateParameter Source
FromXML TemplateParameter Source
type Rep TemplateParameter Source