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 |
- Service Configuration
- Errors
- Waiters
- Operations
- DeleteStack
- UpdateStack
- GetTemplateSummary
- ListChangeSets
- ListStackResources (Paginated)
- GetStackPolicy
- DescribeStacks (Paginated)
- CreateChangeSet
- ExecuteChangeSet
- ContinueUpdateRollback
- ValidateTemplate
- CancelUpdateStack
- DescribeStackEvents (Paginated)
- SignalResource
- SetStackPolicy
- ListImports
- ListStacks (Paginated)
- DescribeAccountLimits
- DescribeStackResources
- CreateStack
- EstimateTemplateCost
- DeleteChangeSet
- ListExports
- GetTemplate
- DescribeChangeSet
- DescribeStackResource
- Types
- Capability
- ChangeAction
- ChangeSetStatus
- ChangeSetType
- ChangeSource
- ChangeType
- EvaluationType
- ExecutionStatus
- OnFailure
- Replacement
- RequiresRecreation
- ResourceAttribute
- ResourceSignalStatus
- ResourceStatus
- StackStatus
- TemplateStage
- AccountLimit
- Change
- ChangeSetSummary
- Export
- Output
- Parameter
- ParameterConstraints
- ParameterDeclaration
- ResourceChange
- ResourceChangeDetail
- ResourceTargetDefinition
- Stack
- StackEvent
- StackResource
- StackResourceDetail
- StackResourceSummary
- StackSummary
- Tag
- TemplateParameter
AWS CloudFormation
AWS CloudFormation allows you to create and manage AWS infrastructure deployments predictably and repeatedly. You can use AWS CloudFormation to leverage AWS products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly-reliable, highly scalable, cost-effective applications without creating or 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 AWS CloudFormation, see the AWS 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://docs.aws.amazon.com/ .
- cloudFormation :: Service
- _ChangeSetNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidChangeSetStatusException :: AsError a => Getting (First ServiceError) a ServiceError
- _InsufficientCapabilitiesException :: AsError a => Getting (First ServiceError) a ServiceError
- _AlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- stackCreateComplete :: Wait DescribeStacks
- stackUpdateComplete :: Wait DescribeStacks
- stackExists :: Wait DescribeStacks
- stackDeleteComplete :: Wait DescribeStacks
- changeSetCreateComplete :: Wait DescribeChangeSet
- module Network.AWS.CloudFormation.DeleteStack
- module Network.AWS.CloudFormation.UpdateStack
- module Network.AWS.CloudFormation.GetTemplateSummary
- module Network.AWS.CloudFormation.ListChangeSets
- module Network.AWS.CloudFormation.ListStackResources
- module Network.AWS.CloudFormation.GetStackPolicy
- module Network.AWS.CloudFormation.DescribeStacks
- module Network.AWS.CloudFormation.CreateChangeSet
- module Network.AWS.CloudFormation.ExecuteChangeSet
- module Network.AWS.CloudFormation.ContinueUpdateRollback
- module Network.AWS.CloudFormation.ValidateTemplate
- module Network.AWS.CloudFormation.CancelUpdateStack
- module Network.AWS.CloudFormation.DescribeStackEvents
- module Network.AWS.CloudFormation.SignalResource
- module Network.AWS.CloudFormation.SetStackPolicy
- module Network.AWS.CloudFormation.ListImports
- module Network.AWS.CloudFormation.ListStacks
- module Network.AWS.CloudFormation.DescribeAccountLimits
- module Network.AWS.CloudFormation.DescribeStackResources
- module Network.AWS.CloudFormation.CreateStack
- module Network.AWS.CloudFormation.EstimateTemplateCost
- module Network.AWS.CloudFormation.DeleteChangeSet
- module Network.AWS.CloudFormation.ListExports
- module Network.AWS.CloudFormation.GetTemplate
- module Network.AWS.CloudFormation.DescribeChangeSet
- module Network.AWS.CloudFormation.DescribeStackResource
- data Capability
- data ChangeAction
- data ChangeSetStatus
- data ChangeSetType
- data ChangeSource
- data ChangeType = Resource
- data EvaluationType
- data ExecutionStatus
- data OnFailure
- data Replacement
- = Conditional
- | False'
- | True'
- data RequiresRecreation
- = Always
- | Conditionally
- | Never
- data ResourceAttribute
- data ResourceSignalStatus
- data ResourceStatus
- data StackStatus
- = SSCreateComplete
- | SSCreateFailed
- | SSCreateInProgress
- | SSDeleteComplete
- | SSDeleteFailed
- | SSDeleteInProgress
- | SSReviewInProgress
- | SSRollbackComplete
- | SSRollbackFailed
- | SSRollbackInProgress
- | SSUpdateComplete
- | SSUpdateCompleteCleanupInProgress
- | SSUpdateInProgress
- | SSUpdateRollbackComplete
- | SSUpdateRollbackCompleteCleanupInProgress
- | SSUpdateRollbackFailed
- | SSUpdateRollbackInProgress
- data TemplateStage
- data AccountLimit
- accountLimit :: AccountLimit
- alValue :: Lens' AccountLimit (Maybe Int)
- alName :: Lens' AccountLimit (Maybe Text)
- data Change
- change :: Change
- cResourceChange :: Lens' Change (Maybe ResourceChange)
- cType :: Lens' Change (Maybe ChangeType)
- data ChangeSetSummary
- changeSetSummary :: ChangeSetSummary
- cssCreationTime :: Lens' ChangeSetSummary (Maybe UTCTime)
- cssStatus :: Lens' ChangeSetSummary (Maybe ChangeSetStatus)
- cssChangeSetName :: Lens' ChangeSetSummary (Maybe Text)
- cssExecutionStatus :: Lens' ChangeSetSummary (Maybe ExecutionStatus)
- cssChangeSetId :: Lens' ChangeSetSummary (Maybe Text)
- cssStatusReason :: Lens' ChangeSetSummary (Maybe Text)
- cssStackId :: Lens' ChangeSetSummary (Maybe Text)
- cssDescription :: Lens' ChangeSetSummary (Maybe Text)
- cssStackName :: Lens' ChangeSetSummary (Maybe Text)
- data Export
- export' :: Export
- eValue :: Lens' Export (Maybe Text)
- eExportingStackId :: Lens' Export (Maybe Text)
- eName :: Lens' Export (Maybe Text)
- 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 ResourceChange
- resourceChange :: ResourceChange
- rcLogicalResourceId :: Lens' ResourceChange (Maybe Text)
- rcPhysicalResourceId :: Lens' ResourceChange (Maybe Text)
- rcResourceType :: Lens' ResourceChange (Maybe Text)
- rcAction :: Lens' ResourceChange (Maybe ChangeAction)
- rcScope :: Lens' ResourceChange [ResourceAttribute]
- rcDetails :: Lens' ResourceChange [ResourceChangeDetail]
- rcReplacement :: Lens' ResourceChange (Maybe Replacement)
- data ResourceChangeDetail
- resourceChangeDetail :: ResourceChangeDetail
- rcdCausingEntity :: Lens' ResourceChangeDetail (Maybe Text)
- rcdChangeSource :: Lens' ResourceChangeDetail (Maybe ChangeSource)
- rcdEvaluation :: Lens' ResourceChangeDetail (Maybe EvaluationType)
- rcdTarget :: Lens' ResourceChangeDetail (Maybe ResourceTargetDefinition)
- data ResourceTargetDefinition
- resourceTargetDefinition :: ResourceTargetDefinition
- rtdAttribute :: Lens' ResourceTargetDefinition (Maybe ResourceAttribute)
- rtdRequiresRecreation :: Lens' ResourceTargetDefinition (Maybe RequiresRecreation)
- rtdName :: Lens' ResourceTargetDefinition (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)
- sChangeSetId :: Lens' Stack (Maybe Text)
- sOutputs :: Lens' Stack [Output]
- sParameters :: Lens' Stack [Parameter]
- sStackId :: Lens' Stack (Maybe Text)
- sDescription :: Lens' Stack (Maybe Text)
- sCapabilities :: Lens' Stack [Capability]
- sTags :: Lens' Stack [Tag]
- sTimeoutInMinutes :: Lens' Stack (Maybe Natural)
- sRoleARN :: Lens' Stack (Maybe Text)
- 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)
- sePhysicalResourceId :: Lens' StackEvent (Maybe Text)
- seResourceType :: Lens' StackEvent (Maybe Text)
- seResourceStatusReason :: 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
- srPhysicalResourceId :: Lens' StackResource (Maybe Text)
- srResourceStatusReason :: 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
- srdPhysicalResourceId :: Lens' StackResourceDetail (Maybe Text)
- srdResourceStatusReason :: 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
- srsPhysicalResourceId :: Lens' StackResourceSummary (Maybe Text)
- srsResourceStatusReason :: 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)
- ssStackStatusReason :: Lens' StackSummary (Maybe Text)
- ssTemplateDescription :: 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 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
.
ChangeSetNotFoundException
_ChangeSetNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the ListChangeSets
action.
InvalidChangeSetStatusException
_InvalidChangeSetStatusException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified change set cannot be used to update the stack. For example, the change set status might be CREATE_IN_PROGRESS
or the stack status might be UPDATE_IN_PROGRESS
.
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.
StackCreateComplete
stackCreateComplete :: Wait DescribeStacks Source #
Polls DescribeStacks
every 30 seconds until a successful state is reached. An error is returned after 120 failed checks.
StackUpdateComplete
stackUpdateComplete :: Wait DescribeStacks Source #
Polls DescribeStacks
every 30 seconds until a successful state is reached. An error is returned after 120 failed checks.
StackExists
stackExists :: Wait DescribeStacks Source #
Polls DescribeStacks
every 5 seconds until a successful state is reached. An error is returned after 20 failed checks.
StackDeleteComplete
stackDeleteComplete :: Wait DescribeStacks Source #
Polls DescribeStacks
every 30 seconds until a successful state is reached. An error is returned after 120 failed checks.
ChangeSetCreateComplete
changeSetCreateComplete :: Wait DescribeChangeSet Source #
Polls DescribeChangeSet
every 30 seconds until a successful state is reached. An error is returned after 120 failed checks.
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
UpdateStack
GetTemplateSummary
ListChangeSets
ListStackResources (Paginated)
GetStackPolicy
DescribeStacks (Paginated)
CreateChangeSet
ExecuteChangeSet
ContinueUpdateRollback
ValidateTemplate
CancelUpdateStack
DescribeStackEvents (Paginated)
SignalResource
SetStackPolicy
ListImports
ListStacks (Paginated)
DescribeAccountLimits
DescribeStackResources
CreateStack
EstimateTemplateCost
DeleteChangeSet
ListExports
GetTemplate
DescribeChangeSet
DescribeStackResource
Types
Capability
data Capability Source #
ChangeAction
data ChangeAction Source #
ChangeSetStatus
data ChangeSetStatus Source #
ChangeSetType
data ChangeSetType Source #
ChangeSource
data ChangeSource Source #
ChangeType
data ChangeType Source #
EvaluationType
data EvaluationType Source #
ExecutionStatus
data ExecutionStatus Source #
OnFailure
Replacement
data Replacement Source #
RequiresRecreation
data RequiresRecreation Source #
ResourceAttribute
data ResourceAttribute Source #
ResourceSignalStatus
data ResourceSignalStatus Source #
ResourceStatus
data ResourceStatus Source #
CreateComplete | |
CreateFailed | |
CreateInProgress | |
DeleteComplete | |
DeleteFailed | |
DeleteInProgress | |
DeleteSkipped | |
UpdateComplete | |
UpdateFailed | |
UpdateInProgress |
StackStatus
data StackStatus Source #
TemplateStage
data TemplateStage Source #
AccountLimit
data AccountLimit Source #
The AccountLimit data type.
See: accountLimit
smart constructor.
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 :: 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
.
Change
The Change
structure describes the changes AWS CloudFormation will perform if you execute the change set.
See: change
smart constructor.
Creates a value of Change
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cResourceChange
- AResourceChange
structure that describes the resource and action that AWS CloudFormation will perform.cType
- The type of entity that AWS CloudFormation changes. Currently, the only entity type isResource
.
cResourceChange :: Lens' Change (Maybe ResourceChange) Source #
A ResourceChange
structure that describes the resource and action that AWS CloudFormation will perform.
cType :: Lens' Change (Maybe ChangeType) Source #
The type of entity that AWS CloudFormation changes. Currently, the only entity type is Resource
.
ChangeSetSummary
data ChangeSetSummary Source #
The ChangeSetSummary
structure describes a change set, its status, and the stack with which it's associated.
See: changeSetSummary
smart constructor.
changeSetSummary :: ChangeSetSummary Source #
Creates a value of ChangeSetSummary
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cssCreationTime
- The start time when the change set was created, in UTC.cssStatus
- The state of the change set, such asCREATE_IN_PROGRESS
,CREATE_COMPLETE
, orFAILED
.cssChangeSetName
- The name of the change set.cssExecutionStatus
- If the change set execution status isAVAILABLE
, you can execute the change set. If you can’t execute the change set, the status indicates why. For example, a change set might be in anUNAVAILABLE
state because AWS CloudFormation is still creating it or in anOBSOLETE
state because the stack was already updated.cssChangeSetId
- The ID of the change set.cssStatusReason
- A description of the change set's status. For example, if your change set is in theFAILED
state, AWS CloudFormation shows the error message.cssStackId
- The ID of the stack with which the change set is associated.cssDescription
- Descriptive information about the change set.cssStackName
- The name of the stack with which the change set is associated.
cssCreationTime :: Lens' ChangeSetSummary (Maybe UTCTime) Source #
The start time when the change set was created, in UTC.
cssStatus :: Lens' ChangeSetSummary (Maybe ChangeSetStatus) Source #
The state of the change set, such as CREATE_IN_PROGRESS
, CREATE_COMPLETE
, or FAILED
.
cssChangeSetName :: Lens' ChangeSetSummary (Maybe Text) Source #
The name of the change set.
cssExecutionStatus :: Lens' ChangeSetSummary (Maybe ExecutionStatus) Source #
If the change set execution status is AVAILABLE
, you can execute the change set. If you can’t execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE
state because AWS CloudFormation is still creating it or in an OBSOLETE
state because the stack was already updated.
cssChangeSetId :: Lens' ChangeSetSummary (Maybe Text) Source #
The ID of the change set.
cssStatusReason :: Lens' ChangeSetSummary (Maybe Text) Source #
A description of the change set's status. For example, if your change set is in the FAILED
state, AWS CloudFormation shows the error message.
cssStackId :: Lens' ChangeSetSummary (Maybe Text) Source #
The ID of the stack with which the change set is associated.
cssDescription :: Lens' ChangeSetSummary (Maybe Text) Source #
Descriptive information about the change set.
cssStackName :: Lens' ChangeSetSummary (Maybe Text) Source #
The name of the stack with which the change set is associated.
Export
The Export
structure describes the exported output values for a stack.
See: export'
smart constructor.
Creates a value of Export
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eValue
- The value of the exported output, such as a resource physical ID. This value is defined in theExport
field in the associated stack'sOutputs
section.eExportingStackId
- The stack that contains the exported output name and value.eName
- The name of exported output value. Use this name and theFn::ImportValue
function to import the associated value into other stacks. The name is defined in theExport
field in the associated stack'sOutputs
section.
eValue :: Lens' Export (Maybe Text) Source #
The value of the exported output, such as a resource physical ID. This value is defined in the Export
field in the associated stack's Outputs
section.
eExportingStackId :: Lens' Export (Maybe Text) Source #
The stack that contains the exported output name and value.
eName :: Lens' Export (Maybe Text) Source #
The name of exported output value. Use this name and the Fn::ImportValue
function to import the associated value into other stacks. The name is defined in the Export
field in the associated stack's Outputs
section.
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
- The value associated with the output.oOutputKey
- The key associated with the output.oDescription
- User defined description 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.
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
- The value associated with the parameter.pParameterKey
- 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
- During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specifytrue
, do not specify a parameter value.
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
- A list of values that are permitted for a parameter.
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
- The name that is associated with the parameter.pdParameterType
- The type of parameter.pdParameterConstraints
- The criteria that AWS CloudFormation uses to validate parameter values.pdDefaultValue
- The default value of the parameter.pdNoEcho
- Flag that indicates whether the parameter value is shown as plain text in logs and in the AWS Management Console.pdDescription
- The description that is associate with the parameter.
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.
ResourceChange
data ResourceChange Source #
The ResourceChange
structure describes the resource and the action that AWS CloudFormation will perform on it if you execute this change set.
See: resourceChange
smart constructor.
resourceChange :: ResourceChange Source #
Creates a value of ResourceChange
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rcLogicalResourceId
- The resource's logical ID, which is defined in the stack's template.rcPhysicalResourceId
- The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they haven't been created.rcResourceType
- The type of AWS CloudFormation resource, such asAWS::S3::Bucket
.rcAction
- The action that AWS CloudFormation takes on the resource, such asAdd
(adds a new resource),Modify
(changes a resource), orRemove
(deletes a resource).rcScope
- For theModify
action, indicates which resource attribute is triggering this update, such as a change in the resource attribute'sMetadata
,Properties
, orTags
.rcDetails
- For theModify
action, a list ofResourceChangeDetail
structures that describes the changes that AWS CloudFormation will make to the resource.rcReplacement
- For theModify
action, indicates whether AWS CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of theRequiresRecreation
property in theResourceTargetDefinition
structure. For example, if theRequiresRecreation
field isAlways
and theEvaluation
field isStatic
,Replacement
isTrue
. If theRequiresRecreation
field isAlways
and theEvaluation
field isDynamic
,Replacement
isConditionally
. If you have multiple changes with differentRequiresRecreation
values, theReplacement
value depends on the change with the most impact. ARequiresRecreation
value ofAlways
has the most impact, followed byConditionally
, and thenNever
.
rcLogicalResourceId :: Lens' ResourceChange (Maybe Text) Source #
The resource's logical ID, which is defined in the stack's template.
rcPhysicalResourceId :: Lens' ResourceChange (Maybe Text) Source #
The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they haven't been created.
rcResourceType :: Lens' ResourceChange (Maybe Text) Source #
The type of AWS CloudFormation resource, such as AWS::S3::Bucket
.
rcAction :: Lens' ResourceChange (Maybe ChangeAction) Source #
The action that AWS CloudFormation takes on the resource, such as Add
(adds a new resource), Modify
(changes a resource), or Remove
(deletes a resource).
rcScope :: Lens' ResourceChange [ResourceAttribute] Source #
For the Modify
action, indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata
, Properties
, or Tags
.
rcDetails :: Lens' ResourceChange [ResourceChangeDetail] Source #
For the Modify
action, a list of ResourceChangeDetail
structures that describes the changes that AWS CloudFormation will make to the resource.
rcReplacement :: Lens' ResourceChange (Maybe Replacement) Source #
For the Modify
action, indicates whether AWS CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of the RequiresRecreation
property in the ResourceTargetDefinition
structure. For example, if the RequiresRecreation
field is Always
and the Evaluation
field is Static
, Replacement
is True
. If the RequiresRecreation
field is Always
and the Evaluation
field is Dynamic
, Replacement
is Conditionally
. If you have multiple changes with different RequiresRecreation
values, the Replacement
value depends on the change with the most impact. A RequiresRecreation
value of Always
has the most impact, followed by Conditionally
, and then Never
.
ResourceChangeDetail
data ResourceChangeDetail Source #
For a resource with Modify
as the action, the ResourceChange
structure describes the changes AWS CloudFormation will make to that resource.
See: resourceChangeDetail
smart constructor.
resourceChangeDetail :: ResourceChangeDetail Source #
Creates a value of ResourceChangeDetail
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rcdCausingEntity
- The identity of the entity that triggered this change. This entity is a member of the group that is specified by theChangeSource
field. For example, if you modified the value of theKeyPairName
parameter, theCausingEntity
is the name of the parameter (KeyPairName
). If theChangeSource
value isDirectModification
, no value is given forCausingEntity
.rcdChangeSource
- The group to which theCausingEntity
value belongs. There are five entity groups: *ResourceReference
entities areRef
intrinsic functions that refer to resources in the template, such as{ Ref : MyEC2InstanceResource }
. *ParameterReference
entities areRef
intrinsic functions that get template parameter values, such as{ Ref : MyPasswordParameter }
. *ResourceAttribute
entities areFn::GetAtt
intrinsic functions that get resource attribute values, such as{ Fn::GetAtt : [ MyEC2InstanceResource, PublicDnsName ] }
. *DirectModification
entities are changes that are made directly to the template. *Automatic
entities areAWS::CloudFormation::Stack
resource types, which are also known as nested stacks. If you made no changes to theAWS::CloudFormation::Stack
resource, AWS CloudFormation sets theChangeSource
toAutomatic
because the nested stack's template might have changed. Changes to a nested stack's template aren't visible to AWS CloudFormation until you run an update on the parent stack.rcdEvaluation
- Indicates whether AWS CloudFormation can determine the target value, and whether the target value will change before you execute a change set. ForStatic
evaluations, AWS CloudFormation can determine that the target value will change, and its value. For example, if you directly modify theInstanceType
property of an EC2 instance, AWS CloudFormation knows that this property value will change, and its value, so this is aStatic
evaluation. ForDynamic
evaluations, cannot determine the target value because it depends on the result of an intrinsic function, such as aRef
orFn::GetAtt
intrinsic function, when the stack is updated. For example, if your template includes a reference to a resource that is conditionally recreated, the value of the reference (the physical ID of the resource) might change, depending on if the resource is recreated. If the resource is recreated, it will have a new physical ID, so all references to that resource will also be updated.rcdTarget
- AResourceTargetDefinition
structure that describes the field that AWS CloudFormation will change and whether the resource will be recreated.
rcdCausingEntity :: Lens' ResourceChangeDetail (Maybe Text) Source #
The identity of the entity that triggered this change. This entity is a member of the group that is specified by the ChangeSource
field. For example, if you modified the value of the KeyPairName
parameter, the CausingEntity
is the name of the parameter (KeyPairName
). If the ChangeSource
value is DirectModification
, no value is given for CausingEntity
.
rcdChangeSource :: Lens' ResourceChangeDetail (Maybe ChangeSource) Source #
The group to which the CausingEntity
value belongs. There are five entity groups: * ResourceReference
entities are Ref
intrinsic functions that refer to resources in the template, such as { Ref : MyEC2InstanceResource }
. * ParameterReference
entities are Ref
intrinsic functions that get template parameter values, such as { Ref : MyPasswordParameter }
. * ResourceAttribute
entities are Fn::GetAtt
intrinsic functions that get resource attribute values, such as { Fn::GetAtt : [ MyEC2InstanceResource, PublicDnsName ] }
. * DirectModification
entities are changes that are made directly to the template. * Automatic
entities are AWS::CloudFormation::Stack
resource types, which are also known as nested stacks. If you made no changes to the AWS::CloudFormation::Stack
resource, AWS CloudFormation sets the ChangeSource
to Automatic
because the nested stack's template might have changed. Changes to a nested stack's template aren't visible to AWS CloudFormation until you run an update on the parent stack.
rcdEvaluation :: Lens' ResourceChangeDetail (Maybe EvaluationType) Source #
Indicates whether AWS CloudFormation can determine the target value, and whether the target value will change before you execute a change set. For Static
evaluations, AWS CloudFormation can determine that the target value will change, and its value. For example, if you directly modify the InstanceType
property of an EC2 instance, AWS CloudFormation knows that this property value will change, and its value, so this is a Static
evaluation. For Dynamic
evaluations, cannot determine the target value because it depends on the result of an intrinsic function, such as a Ref
or Fn::GetAtt
intrinsic function, when the stack is updated. For example, if your template includes a reference to a resource that is conditionally recreated, the value of the reference (the physical ID of the resource) might change, depending on if the resource is recreated. If the resource is recreated, it will have a new physical ID, so all references to that resource will also be updated.
rcdTarget :: Lens' ResourceChangeDetail (Maybe ResourceTargetDefinition) Source #
A ResourceTargetDefinition
structure that describes the field that AWS CloudFormation will change and whether the resource will be recreated.
ResourceTargetDefinition
data ResourceTargetDefinition Source #
The field that AWS CloudFormation will change, such as the name of a resource's property, and whether the resource will be recreated.
See: resourceTargetDefinition
smart constructor.
resourceTargetDefinition :: ResourceTargetDefinition Source #
Creates a value of ResourceTargetDefinition
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rtdAttribute
- Indicates which resource attribute is triggering this update, such as a change in the resource attribute'sMetadata
,Properties
, orTags
.rtdRequiresRecreation
- If theAttribute
value isProperties
, indicates whether a change to this property causes the resource to be recreated. The value can beNever
,Always
, orConditionally
. To determine the conditions for aConditionally
recreation, see the update behavior for that property in the AWS CloudFormation User Guide.rtdName
- If theAttribute
value isProperties
, the name of the property. For all other attributes, the value is null.
rtdAttribute :: Lens' ResourceTargetDefinition (Maybe ResourceAttribute) Source #
Indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata
, Properties
, or Tags
.
rtdRequiresRecreation :: Lens' ResourceTargetDefinition (Maybe RequiresRecreation) Source #
If the Attribute
value is Properties
, indicates whether a change to this property causes the resource to be recreated. The value can be Never
, Always
, or Conditionally
. To determine the conditions for a Conditionally
recreation, see the update behavior for that property in the AWS CloudFormation User Guide.
rtdName :: Lens' ResourceTargetDefinition (Maybe Text) Source #
If the Attribute
value is Properties
, the name of the property. For all other attributes, the value is null.
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
- Boolean to enable or disable rollback on stack creation failures: *true
: disable rollback *false
: enable rollbacksLastUpdatedTime
- The time the stack was last updated. This field will only be returned if the stack has been updated at least once.sNotificationARNs
- SNS topic ARNs to which stack related events are published.sStackStatusReason
- Success/failure message associated with the stack status.sChangeSetId
- The unique ID of the change set.sOutputs
- A list of output structures.sParameters
- A list ofParameter
structures.sStackId
- Unique identifier of the stack.sDescription
- A user-defined description associated with the stack.sCapabilities
- The capabilities allowed in the stack.sTags
- A list ofTag
s that specify information about the stack.sTimeoutInMinutes
- The amount of time within which stack creation should complete.sRoleARN
- The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that is associated with the stack. During a stack operation, AWS CloudFormation uses this role's credentials to make calls on your behalf.sStackName
- The name associated with the stack.sCreationTime
- The time at which the stack was created.sStackStatus
- Current status of 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.
sStackStatusReason :: Lens' Stack (Maybe Text) Source #
Success/failure message associated with the stack status.
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.
sTimeoutInMinutes :: Lens' Stack (Maybe Natural) Source #
The amount of time within which stack creation should complete.
sRoleARN :: Lens' Stack (Maybe Text) Source #
The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that is associated with the stack. During a stack operation, AWS CloudFormation uses this role's credentials to make calls on your behalf.
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
- The logical name of the resource specified in the template.sePhysicalResourceId
- The name or unique identifier associated with the physical instance of the resource.seResourceType
- Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)seResourceStatusReason
- Success/failure message associated with the resource.seResourceProperties
- BLOB of the properties used to create the resource.seResourceStatus
- Current status of the resource.seStackId
- The unique ID name of the instance of the stack.seEventId
- The unique ID of this event.seStackName
- The name associated with a stack.seTimestamp
- Time the status was updated.
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.
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:
srPhysicalResourceId
- The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.srResourceStatusReason
- Success/failure message associated with the resource.srStackId
- Unique identifier of the stack.srDescription
- User defined description associated with the resource.srStackName
- The name associated with the stack.srLogicalResourceId
- The logical name of the resource specified in the template.srResourceType
- Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)srTimestamp
- Time the status was updated.srResourceStatus
- Current status of 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.
srResourceStatusReason :: Lens' StackResource (Maybe Text) Source #
Success/failure message associated with the resource.
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:
srdPhysicalResourceId
- The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.srdResourceStatusReason
- Success/failure message associated with the resource.srdMetadata
- The content of theMetadata
attribute declared for the resource. For more information, see Metadata Attribute in the AWS CloudFormation User Guide.srdStackId
- Unique identifier of the stack.srdDescription
- User defined description associated with the resource.srdStackName
- The name associated with the stack.srdLogicalResourceId
- The logical name of the resource specified in the template.srdResourceType
- Type of resource. ((For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)srdLastUpdatedTimestamp
- Time the status was updated.srdResourceStatus
- Current status of 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.
srdResourceStatusReason :: Lens' StackResourceDetail (Maybe Text) Source #
Success/failure message associated with the resource.
srdMetadata :: Lens' StackResourceDetail (Maybe Text) Source #
The 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:
srsPhysicalResourceId
- The name or unique identifier that corresponds to a physical instance ID of the resource.srsResourceStatusReason
- Success/failure message associated with the resource.srsLogicalResourceId
- The logical name of the resource specified in the template.srsResourceType
- Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)srsLastUpdatedTimestamp
- Time the status was updated.srsResourceStatus
- Current status of the resource.
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.
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
- The time the stack was last updated. This field will only be returned if the stack has been updated at least once.ssStackStatusReason
- Success/Failure message associated with the stack status.ssTemplateDescription
- The template description of the template used to create the stack.ssDeletionTime
- The time the stack was deleted.ssStackId
- Unique stack identifier.ssStackName
- The name associated with the stack.ssCreationTime
- The time the stack was created.ssStackStatus
- The current status of the stack.
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.
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 enables you to specify a key-value pair that can be used to store information about an AWS CloudFormation stack.
See: tag
smart constructor.
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
- Required . A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.tagKey
- 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.
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
- The name associated with the parameter.tpDefaultValue
- The default value associated with the parameter.tpNoEcho
- Flag indicating whether the parameter should be displayed as plain text in logs and UIs.tpDescription
- User defined description associated with the parameter.
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.