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 |
- data CloudFormation
- _InsufficientCapabilitiesException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _AlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- data Capability = CapabilityIAM
- data OnFailure
- data ResourceSignalStatus
- data ResourceStatus
- data StackStatus
- = SSCreateComplete
- | SSCreateFailed
- | SSCreateInProgress
- | SSDeleteComplete
- | SSDeleteFailed
- | SSDeleteInProgress
- | SSRollbackComplete
- | SSRollbackFailed
- | SSRollbackInProgress
- | SSUpdateComplete
- | SSUpdateCompleteCleanupInProgress
- | SSUpdateInProgress
- | SSUpdateRollbackComplete
- | SSUpdateRollbackCompleteCleanupInProgress
- | SSUpdateRollbackFailed
- | SSUpdateRollbackInProgress
- data Output
- output :: Output
- oOutputValue :: Lens' Output (Maybe Text)
- oOutputKey :: Lens' Output (Maybe Text)
- oDescription :: Lens' Output (Maybe Text)
- data Parameter
- parameter :: Parameter
- pParameterValue :: Lens' Parameter (Maybe Text)
- pParameterKey :: Lens' Parameter (Maybe Text)
- pUsePreviousValue :: Lens' Parameter (Maybe Bool)
- data ParameterConstraints
- parameterConstraints :: ParameterConstraints
- pcAllowedValues :: Lens' ParameterConstraints [Text]
- data ParameterDeclaration
- parameterDeclaration :: ParameterDeclaration
- pdParameterKey :: Lens' ParameterDeclaration (Maybe Text)
- pdParameterType :: Lens' ParameterDeclaration (Maybe Text)
- pdParameterConstraints :: Lens' ParameterDeclaration (Maybe ParameterConstraints)
- pdDefaultValue :: Lens' ParameterDeclaration (Maybe Text)
- pdNoEcho :: Lens' ParameterDeclaration (Maybe Bool)
- pdDescription :: Lens' ParameterDeclaration (Maybe Text)
- data Stack
- stack :: Text -> UTCTime -> StackStatus -> Stack
- sDisableRollback :: Lens' Stack (Maybe Bool)
- sLastUpdatedTime :: Lens' Stack (Maybe UTCTime)
- sNotificationARNs :: Lens' Stack [Text]
- sStackStatusReason :: Lens' Stack (Maybe Text)
- sOutputs :: Lens' Stack [Output]
- sParameters :: Lens' Stack [Parameter]
- sStackId :: Lens' Stack (Maybe Text)
- sCapabilities :: Lens' Stack [Capability]
- sDescription :: Lens' Stack (Maybe Text)
- sTags :: Lens' Stack [Tag]
- sTimeoutInMinutes :: Lens' Stack (Maybe Natural)
- sStackName :: Lens' Stack Text
- sCreationTime :: Lens' Stack UTCTime
- sStackStatus :: Lens' Stack StackStatus
- data StackEvent
- stackEvent :: Text -> Text -> Text -> UTCTime -> StackEvent
- seLogicalResourceId :: Lens' StackEvent (Maybe Text)
- seResourceStatusReason :: Lens' StackEvent (Maybe Text)
- seResourceType :: Lens' StackEvent (Maybe Text)
- sePhysicalResourceId :: Lens' StackEvent (Maybe Text)
- seResourceProperties :: Lens' StackEvent (Maybe Text)
- seResourceStatus :: Lens' StackEvent (Maybe ResourceStatus)
- seStackId :: Lens' StackEvent Text
- seEventId :: Lens' StackEvent Text
- seStackName :: Lens' StackEvent Text
- seTimestamp :: Lens' StackEvent UTCTime
- data StackResource
- stackResource :: Text -> Text -> UTCTime -> ResourceStatus -> StackResource
- srResourceStatusReason :: Lens' StackResource (Maybe Text)
- srPhysicalResourceId :: Lens' StackResource (Maybe Text)
- srStackId :: Lens' StackResource (Maybe Text)
- srDescription :: Lens' StackResource (Maybe Text)
- srStackName :: Lens' StackResource (Maybe Text)
- srLogicalResourceId :: Lens' StackResource Text
- srResourceType :: Lens' StackResource Text
- srTimestamp :: Lens' StackResource UTCTime
- srResourceStatus :: Lens' StackResource ResourceStatus
- data StackResourceDetail
- stackResourceDetail :: Text -> Text -> UTCTime -> ResourceStatus -> StackResourceDetail
- srdResourceStatusReason :: Lens' StackResourceDetail (Maybe Text)
- srdPhysicalResourceId :: Lens' StackResourceDetail (Maybe Text)
- srdMetadata :: Lens' StackResourceDetail (Maybe Text)
- srdStackId :: Lens' StackResourceDetail (Maybe Text)
- srdDescription :: Lens' StackResourceDetail (Maybe Text)
- srdStackName :: Lens' StackResourceDetail (Maybe Text)
- srdLogicalResourceId :: Lens' StackResourceDetail Text
- srdResourceType :: Lens' StackResourceDetail Text
- srdLastUpdatedTimestamp :: Lens' StackResourceDetail UTCTime
- srdResourceStatus :: Lens' StackResourceDetail ResourceStatus
- data StackResourceSummary
- stackResourceSummary :: Text -> Text -> UTCTime -> ResourceStatus -> StackResourceSummary
- srsResourceStatusReason :: Lens' StackResourceSummary (Maybe Text)
- srsPhysicalResourceId :: Lens' StackResourceSummary (Maybe Text)
- srsLogicalResourceId :: Lens' StackResourceSummary Text
- srsResourceType :: Lens' StackResourceSummary Text
- srsLastUpdatedTimestamp :: Lens' StackResourceSummary UTCTime
- srsResourceStatus :: Lens' StackResourceSummary ResourceStatus
- data StackSummary
- stackSummary :: Text -> UTCTime -> StackStatus -> StackSummary
- ssLastUpdatedTime :: Lens' StackSummary (Maybe UTCTime)
- ssTemplateDescription :: Lens' StackSummary (Maybe Text)
- ssStackStatusReason :: Lens' StackSummary (Maybe Text)
- ssDeletionTime :: Lens' StackSummary (Maybe UTCTime)
- ssStackId :: Lens' StackSummary (Maybe Text)
- ssStackName :: Lens' StackSummary Text
- ssCreationTime :: Lens' StackSummary UTCTime
- ssStackStatus :: Lens' StackSummary StackStatus
- data Tag
- tag :: Tag
- tagValue :: Lens' Tag (Maybe Text)
- tagKey :: Lens' Tag (Maybe Text)
- data TemplateParameter
- templateParameter :: TemplateParameter
- tpParameterKey :: Lens' TemplateParameter (Maybe Text)
- tpDefaultValue :: Lens' TemplateParameter (Maybe Text)
- tpNoEcho :: Lens' TemplateParameter (Maybe Bool)
- tpDescription :: Lens' TemplateParameter (Maybe Text)
Service
data CloudFormation Source
Version 2010-05-15
of the Amazon CloudFormation SDK.
Errors
_InsufficientCapabilitiesException :: AsError a => Getting (First ServiceError) a ServiceError Source
The template contains resources with capabilities that were not specified in the Capabilities parameter.
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source
Quota for the resource has already been reached.
_AlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source
Resource with the name requested already exists.
Capability
data Capability Source
OnFailure
ResourceSignalStatus
data ResourceSignalStatus Source
ResourceStatus
data ResourceStatus Source
CreateComplete | |
CreateFailed | |
CreateInProgress | |
DeleteComplete | |
DeleteFailed | |
DeleteInProgress | |
DeleteSkipped | |
UpdateComplete | |
UpdateFailed | |
UpdateInProgress |
StackStatus
data StackStatus Source
Output
The Output data type.
See: output
smart constructor.
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
The Parameter data type.
See: parameter
smart constructor.
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 :: 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
The Stack data type.
See: stack
smart constructor.
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 rollbackfalse
: 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.
sParameters :: Lens' Stack [Parameter] Source
A list of Parameter
structures.
sCapabilities :: Lens' Stack [Capability] Source
The capabilities allowed in the stack.
sDescription :: Lens' Stack (Maybe Text) Source
User defined description associated with the stack.
sTags :: Lens' Stack [Tag] Source
A list of Tag
s 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
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.
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.
seResourceStatusReason :: Lens' StackEvent (Maybe Text) Source
Success/failure message associated with 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.)
sePhysicalResourceId :: Lens' StackEvent (Maybe Text) Source
The name or unique identifier associated with the physical instance of 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.
:: Text | |
-> Text | |
-> UTCTime | |
-> ResourceStatus | |
-> 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:
srResourceStatusReason :: Lens' StackResource (Maybe Text) Source
Success/failure message associated with the resource.
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.
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.
:: Text | |
-> Text | |
-> UTCTime | |
-> ResourceStatus | |
-> 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:
srdResourceStatusReason :: Lens' StackResourceDetail (Maybe Text) Source
Success/failure message associated with the resource.
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.
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.
:: Text | |
-> Text | |
-> UTCTime | |
-> ResourceStatus | |
-> 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:
srsResourceStatusReason :: Lens' StackResourceSummary (Maybe Text) Source
Success/failure message associated with the resource.
srsPhysicalResourceId :: Lens' StackResourceSummary (Maybe Text) Source
The name or unique identifier that corresponds to a physical instance ID of 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.
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.
ssTemplateDescription :: Lens' StackSummary (Maybe Text) Source
The template description of the template used to create the stack.
ssStackStatusReason :: Lens' StackSummary (Maybe Text) Source
Success/Failure message associated with the stack status.
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
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.
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.