Safe Haskell	None
Language	Haskell2010

Network.AWS.CloudFormation.Types

Contents

Service
- Error
- XML
Tag
StackStatus
StackEvent
StackSummary
StackResourceDetail
ResourceStatus
TemplateParameter
ParameterDeclaration
StackResource
Output
StackResourceSummary
Capability
ResourceSignalStatus
Stack
OnFailure
Parameter

Synopsis

Service

data CloudFormation Source

Version 2010-05-15 of the Amazon CloudFormation service.

Instances

AWSService CloudFormation
type Er CloudFormation = RESTError
type Sg CloudFormation = V4

Error

data RESTError :: *

Instances

Eq RESTError
Show RESTError
Generic RESTError
FromXML RESTError
type Rep RESTError = D1 D1RESTError (C1 C1_0RESTError ((::) ((::) (S1 S1_0_0RESTError (Rec0 Text)) (S1 S1_0_1RESTError (Rec0 (Maybe ErrorType)))) ((:*:) (S1 S1_0_2RESTError (Rec0 Text)) (S1 S1_0_3RESTError (Rec0 Text)))))

XML

ns :: Text Source

Tag

data Tag Source

Instances

Eq Tag
Ord Tag
Show Tag
FromXML Tag
ToQuery Tag

tag :: Tag Source

Tag constructor.

The fields accessible through corresponding lenses are:

tagKey :: Maybe Text
tagValue :: Maybe Text

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:'.

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.

StackStatus

data StackStatus Source

Constructors

CreateComplete	CREATE_COMPLETE
CreateFailed	CREATE_FAILED
CreateInProgress	CREATE_IN_PROGRESS
DeleteComplete	DELETE_COMPLETE
DeleteFailed	DELETE_FAILED
DeleteInProgress	DELETE_IN_PROGRESS
RollbackComplete	ROLLBACK_COMPLETE
RollbackFailed	ROLLBACK_FAILED
RollbackInProgress	ROLLBACK_IN_PROGRESS
UpdateComplete	UPDATE_COMPLETE
UpdateCompleteCleanupInProgress	UPDATE_COMPLETE_CLEANUP_IN_PROGRESS
UpdateInProgress	UPDATE_IN_PROGRESS
UpdateRollbackComplete	UPDATE_ROLLBACK_COMPLETE
UpdateRollbackCompleteCleanupInProgress	UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS
UpdateRollbackFailed	UPDATE_ROLLBACK_FAILED
UpdateRollbackInProgress	UPDATE_ROLLBACK_IN_PROGRESS

StackEvent

data StackEvent Source

Instances

Eq StackEvent
Show StackEvent
FromXML StackEvent
ToQuery StackEvent

stackEvent Source

Arguments

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

StackEvent constructor.

The fields accessible through corresponding lenses are:

seEventId :: Text
seLogicalResourceId :: Maybe Text
sePhysicalResourceId :: Maybe Text
seResourceProperties :: Maybe Text
seResourceStatus :: Maybe ResourceStatus
seResourceStatusReason :: Maybe Text
seResourceType :: Maybe Text
seStackId :: Text
seStackName :: Text
seTimestamp :: UTCTime

seEventId :: Lens' StackEvent Text Source

The unique ID of this event.

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.

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.

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

seStackId :: Lens' StackEvent Text Source

The unique ID name of the instance of the stack.

seStackName :: Lens' StackEvent Text Source

The name associated with a stack.

seTimestamp :: Lens' StackEvent UTCTime Source

Time the status was updated.

StackSummary

data StackSummary Source

Instances

Eq StackSummary
Show StackSummary
FromXML StackSummary
ToQuery StackSummary

stackSummary Source

Arguments

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

StackSummary constructor.

The fields accessible through corresponding lenses are:

ssCreationTime :: UTCTime
ssDeletionTime :: Maybe UTCTime
ssLastUpdatedTime :: Maybe UTCTime
ssStackId :: Maybe Text
ssStackName :: Text
ssStackStatus :: StackStatus
ssStackStatusReason :: Maybe Text
ssTemplateDescription :: Maybe Text

ssCreationTime :: Lens' StackSummary UTCTime Source

The time the stack was created.

ssDeletionTime :: Lens' StackSummary (Maybe UTCTime) Source

The time the stack was deleted.

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.

ssStackId :: Lens' StackSummary (Maybe Text) Source

Unique stack identifier.

ssStackName :: Lens' StackSummary Text Source

The name associated with the stack.

ssStackStatus :: Lens' StackSummary StackStatus Source

The current status of the stack.

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.

StackResourceDetail

data StackResourceDetail Source

Instances

Eq StackResourceDetail
Show StackResourceDetail
FromXML StackResourceDetail
ToQuery StackResourceDetail

stackResourceDetail Source

Arguments

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

StackResourceDetail constructor.

The fields accessible through corresponding lenses are:

srdDescription :: Maybe Text
srdLastUpdatedTimestamp :: UTCTime
srdLogicalResourceId :: Text
srdMetadata :: Maybe Text
srdPhysicalResourceId :: Maybe Text
srdResourceStatus :: ResourceStatus
srdResourceStatusReason :: Maybe Text
srdResourceType :: Text
srdStackId :: Maybe Text
srdStackName :: Maybe Text

srdDescription :: Lens' StackResourceDetail (Maybe Text) Source

User defined description associated with the resource.

srdLastUpdatedTimestamp :: Lens' StackResourceDetail UTCTime Source

Time the status was updated.

srdLogicalResourceId :: Lens' StackResourceDetail Text Source

The logical name of the resource specified in the template.

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.

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.

srdResourceStatus :: Lens' StackResourceDetail ResourceStatus Source

Current status of the resource.

srdResourceStatusReason :: Lens' StackResourceDetail (Maybe Text) Source

Success/failure message associated with the resource.

srdResourceType :: Lens' StackResourceDetail Text Source

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

srdStackId :: Lens' StackResourceDetail (Maybe Text) Source

Unique identifier of the stack.

srdStackName :: Lens' StackResourceDetail (Maybe Text) Source

The name associated with the stack.

ResourceStatus

data ResourceStatus Source

Constructors

RSCreateComplete	CREATE_COMPLETE
RSCreateFailed	CREATE_FAILED
RSCreateInProgress	CREATE_IN_PROGRESS
RSDeleteComplete	DELETE_COMPLETE
RSDeleteFailed	DELETE_FAILED
RSDeleteInProgress	DELETE_IN_PROGRESS
RSDeleteSkipped	DELETE_SKIPPED
RSUpdateComplete	UPDATE_COMPLETE
RSUpdateFailed	UPDATE_FAILED
RSUpdateInProgress	UPDATE_IN_PROGRESS

TemplateParameter

data TemplateParameter Source

Instances

Eq TemplateParameter
Ord TemplateParameter
Show TemplateParameter
FromXML TemplateParameter
ToQuery TemplateParameter

templateParameter :: TemplateParameter Source

TemplateParameter constructor.

The fields accessible through corresponding lenses are:

tpDefaultValue :: Lens' TemplateParameter (Maybe Text) Source

The default value associated with the parameter.

tpDescription :: Lens' TemplateParameter (Maybe Text) Source

User defined description 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.

tpParameterKey :: Lens' TemplateParameter (Maybe Text) Source

The name associated with the parameter.

ParameterDeclaration

data ParameterDeclaration Source

Instances

Eq ParameterDeclaration
Ord ParameterDeclaration
Show ParameterDeclaration
FromXML ParameterDeclaration
ToQuery ParameterDeclaration

parameterDeclaration :: ParameterDeclaration Source

ParameterDeclaration constructor.

The fields accessible through corresponding lenses are:

pdDefaultValue :: Lens' ParameterDeclaration (Maybe Text) Source

The default value of the parameter.

pdDescription :: Lens' ParameterDeclaration (Maybe Text) Source

The description that is associate with 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.

pdParameterKey :: Lens' ParameterDeclaration (Maybe Text) Source

The name that is associated with the parameter.

pdParameterType :: Lens' ParameterDeclaration (Maybe Text) Source

The type of parameter.

StackResource

data StackResource Source

Instances

Eq StackResource
Show StackResource
FromXML StackResource
ToQuery StackResource

stackResource Source

Arguments

:: Text	`sr1LogicalResourceId`
-> Text	`sr1ResourceType`
-> UTCTime	`sr1Timestamp`
-> ResourceStatus	`sr1ResourceStatus`
-> StackResource

StackResource constructor.

The fields accessible through corresponding lenses are:

sr1Description :: Maybe Text
sr1LogicalResourceId :: Text
sr1PhysicalResourceId :: Maybe Text
sr1ResourceStatus :: ResourceStatus
sr1ResourceStatusReason :: Maybe Text
sr1ResourceType :: Text
sr1StackId :: Maybe Text
sr1StackName :: Maybe Text
sr1Timestamp :: UTCTime

sr1Description :: Lens' StackResource (Maybe Text) Source

User defined description associated with the resource.

sr1LogicalResourceId :: Lens' StackResource Text Source

The logical name of the resource specified in the template.

sr1PhysicalResourceId :: Lens' StackResource (Maybe Text) Source

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

sr1ResourceStatus :: Lens' StackResource ResourceStatus Source

Current status of the resource.

sr1ResourceStatusReason :: Lens' StackResource (Maybe Text) Source

Success/failure message associated with the resource.

sr1ResourceType :: Lens' StackResource Text Source

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

sr1StackId :: Lens' StackResource (Maybe Text) Source

Unique identifier of the stack.

sr1StackName :: Lens' StackResource (Maybe Text) Source

The name associated with the stack.

sr1Timestamp :: Lens' StackResource UTCTime Source

Time the status was updated.

Output

data Output Source

Instances

Eq Output
Ord Output
Show Output
FromXML Output
ToQuery Output

output :: Output Source

Output constructor.

The fields accessible through corresponding lenses are:

oDescription :: Maybe Text
oOutputKey :: Maybe Text
oOutputValue :: Maybe Text

oDescription :: Lens' Output (Maybe Text) Source

User defined description associated with the output.

oOutputKey :: Lens' Output (Maybe Text) Source

The key associated with the output.

oOutputValue :: Lens' Output (Maybe Text) Source

The value associated with the output.

StackResourceSummary

data StackResourceSummary Source

Instances

Eq StackResourceSummary
Show StackResourceSummary
FromXML StackResourceSummary
ToQuery StackResourceSummary

stackResourceSummary Source

Arguments

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

StackResourceSummary constructor.

The fields accessible through corresponding lenses are:

srsLastUpdatedTimestamp :: UTCTime
srsLogicalResourceId :: Text
srsPhysicalResourceId :: Maybe Text
srsResourceStatus :: ResourceStatus
srsResourceStatusReason :: Maybe Text
srsResourceType :: Text

srsLastUpdatedTimestamp :: Lens' StackResourceSummary UTCTime Source

Time the status was updated.

srsLogicalResourceId :: Lens' StackResourceSummary Text Source

The logical name of the resource specified in the template.

srsPhysicalResourceId :: Lens' StackResourceSummary (Maybe Text) Source

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

srsResourceStatus :: Lens' StackResourceSummary ResourceStatus Source

Current status of the resource.

srsResourceStatusReason :: Lens' StackResourceSummary (Maybe Text) Source

Success/failure message associated with the resource.

srsResourceType :: Lens' StackResourceSummary Text Source

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

Capability

data Capability Source

Constructors

CapabilityIam

CAPABILITY_IAM

ResourceSignalStatus

Stack

data Stack Source

Instances

Eq Stack
Show Stack
FromXML Stack
ToQuery Stack

stack Source

Arguments

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

Stack constructor.

The fields accessible through corresponding lenses are:

sCapabilities :: [Capability]
sCreationTime :: UTCTime
sDescription :: Maybe Text
sDisableRollback :: Maybe Bool
sLastUpdatedTime :: Maybe UTCTime
sNotificationARNs :: [Text]
sOutputs :: [Output]
sParameters :: [Parameter]
sStackId :: Maybe Text
sStackName :: Text
sStackStatus :: StackStatus
sStackStatusReason :: Maybe Text
sTags :: [Tag]
sTimeoutInMinutes :: Maybe Natural

sCapabilities :: Lens' Stack [Capability] Source

The capabilities allowed in the stack.

sCreationTime :: Lens' Stack UTCTime Source

Time at which the stack was created.

sDescription :: Lens' Stack (Maybe Text) Source

User defined description associated with the stack.

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.

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.

sStackName :: Lens' Stack Text Source

The name associated with the stack.

sStackStatus :: Lens' Stack StackStatus Source

Current status of the stack.

sStackStatusReason :: Lens' Stack (Maybe Text) Source

Success/failure message associated with the stack status.

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.

OnFailure

data OnFailure Source

Constructors

Delete'	DELETE
DoNothing	DO_NOTHING
Rollback	ROLLBACK

Parameter

data Parameter Source

Instances

Eq Parameter
Ord Parameter
Show Parameter
FromXML Parameter
ToQuery Parameter

parameter :: Parameter Source

Parameter constructor.

The fields accessible through corresponding lenses are:

pParameterKey :: Lens' Parameter (Maybe Text) Source

The key associated with the parameter.

pParameterValue :: Lens' Parameter (Maybe Text) Source

The value associated with the parameter.

pUsePreviousValue :: Lens' Parameter (Maybe Bool) Source

During a stack update, use the existing parameter value that is being used for the stack.

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

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

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

Enum ResourceSignalStatus
Eq ResourceSignalStatus
Ord ResourceSignalStatus
Show ResourceSignalStatus
Generic ResourceSignalStatus
Hashable ResourceSignalStatus
FromXML ResourceSignalStatus
ToQuery ResourceSignalStatus
ToHeader ResourceSignalStatus
ToByteString ResourceSignalStatus
FromText ResourceSignalStatus
ToText ResourceSignalStatus
type Rep ResourceSignalStatus

Enum OnFailure
Eq OnFailure
Ord OnFailure
Show OnFailure
Generic OnFailure
Hashable OnFailure
FromXML OnFailure
ToQuery OnFailure
ToHeader OnFailure
ToByteString OnFailure
FromText OnFailure
ToText OnFailure
type Rep OnFailure

Failure	FAILURE
Success	SUCCESS