| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.CloudFormation
Contents
- Service Configuration
- Errors
- AlreadyExistsException
- CFNRegistryException
- ChangeSetNotFoundException
- CreatedButModifiedException
- InsufficientCapabilitiesException
- InvalidChangeSetStatusException
- InvalidOperationException
- InvalidStateTransitionException
- LimitExceededException
- NameAlreadyExistsException
- OperationIdAlreadyExistsException
- OperationInProgressException
- OperationNotFoundException
- OperationStatusCheckFailedException
- StackInstanceNotFoundException
- StackNotFoundException
- StackSetNotEmptyException
- StackSetNotFoundException
- StaleRequestException
- TokenAlreadyExistsException
- TypeConfigurationNotFoundException
- TypeNotFoundException
- Waiters
- Operations
- ActivateType
- BatchDescribeTypeConfigurations
- CancelUpdateStack
- ContinueUpdateRollback
- CreateChangeSet
- CreateStack
- CreateStackInstances
- CreateStackSet
- DeactivateType
- DeleteChangeSet
- DeleteStack
- DeleteStackInstances
- DeleteStackSet
- DeregisterType
- DescribeAccountLimits (Paginated)
- DescribeChangeSet (Paginated)
- DescribeChangeSetHooks
- DescribePublisher
- DescribeStackDriftDetectionStatus
- DescribeStackEvents (Paginated)
- DescribeStackInstance
- DescribeStackResource
- DescribeStackResourceDrifts
- DescribeStackResources
- DescribeStackSet
- DescribeStackSetOperation
- DescribeStacks (Paginated)
- DescribeType
- DescribeTypeRegistration
- DetectStackDrift
- DetectStackResourceDrift
- DetectStackSetDrift
- EstimateTemplateCost
- ExecuteChangeSet
- GetStackPolicy
- GetTemplate
- GetTemplateSummary
- ImportStacksToStackSet
- ListChangeSets (Paginated)
- ListExports (Paginated)
- ListImports (Paginated)
- ListStackInstances (Paginated)
- ListStackResources (Paginated)
- ListStackSetOperationResults (Paginated)
- ListStackSetOperations (Paginated)
- ListStackSets (Paginated)
- ListStacks (Paginated)
- ListTypeRegistrations
- ListTypeVersions
- ListTypes (Paginated)
- PublishType
- RecordHandlerProgress
- RegisterPublisher
- RegisterType
- RollbackStack
- SetStackPolicy
- SetTypeConfiguration
- SetTypeDefaultVersion
- SignalResource
- StopStackSetOperation
- TestType
- UpdateStack
- UpdateStackInstances
- UpdateStackSet
- UpdateTerminationProtection
- ValidateTemplate
- Types
- AccountFilterType
- AccountGateStatus
- CallAs
- Capability
- Category
- ChangeAction
- ChangeSetHooksStatus
- ChangeSetStatus
- ChangeSetType
- ChangeSource
- ChangeType
- DeprecatedStatus
- DifferenceType
- EvaluationType
- ExecutionStatus
- HandlerErrorCode
- HookFailureMode
- HookInvocationPoint
- HookStatus
- HookTargetType
- IdentityProvider
- OnFailure
- OperationResultFilterName
- OperationStatus
- PermissionModels
- ProvisioningType
- PublisherStatus
- RegionConcurrencyType
- RegistrationStatus
- RegistryType
- Replacement
- RequiresRecreation
- ResourceAttribute
- ResourceSignalStatus
- ResourceStatus
- StackDriftDetectionStatus
- StackDriftStatus
- StackInstanceDetailedStatus
- StackInstanceFilterName
- StackInstanceStatus
- StackResourceDriftStatus
- StackSetDriftDetectionStatus
- StackSetDriftStatus
- StackSetOperationAction
- StackSetOperationResultStatus
- StackSetOperationStatus
- StackSetStatus
- StackStatus
- TemplateStage
- ThirdPartyType
- TypeTestsStatus
- VersionBump
- Visibility
- AccountGateResult
- AccountLimit
- AutoDeployment
- BatchDescribeTypeConfigurationsError
- Change
- ChangeSetHook
- ChangeSetHookResourceTargetDetails
- ChangeSetHookTargetDetails
- ChangeSetSummary
- DeploymentTargets
- Export
- LoggingConfig
- ManagedExecution
- ModuleInfo
- OperationResultFilter
- Output
- Parameter
- ParameterConstraints
- ParameterDeclaration
- PhysicalResourceIdContextKeyValuePair
- PropertyDifference
- RequiredActivatedType
- ResourceChange
- ResourceChangeDetail
- ResourceIdentifierSummary
- ResourceTargetDefinition
- ResourceToImport
- RollbackConfiguration
- RollbackTrigger
- Stack
- StackDriftInformation
- StackDriftInformationSummary
- StackEvent
- StackInstance
- StackInstanceComprehensiveStatus
- StackInstanceFilter
- StackInstanceSummary
- StackResource
- StackResourceDetail
- StackResourceDrift
- StackResourceDriftInformation
- StackResourceDriftInformationSummary
- StackResourceSummary
- StackSet
- StackSetDriftDetectionDetails
- StackSetOperation
- StackSetOperationPreferences
- StackSetOperationResultSummary
- StackSetOperationStatusDetails
- StackSetOperationSummary
- StackSetSummary
- StackSummary
- Tag
- TemplateParameter
- TypeConfigurationDetails
- TypeConfigurationIdentifier
- TypeFilters
- TypeSummary
- TypeVersionSummary
Description
Derived from API version 2010-05-15 of the AWS service descriptions, licensed under Apache 2.0.
CloudFormation
CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably and repeatedly. You can use CloudFormation to leverage Amazon Web Services 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 Amazon Web Services infrastructure.
With CloudFormation, you declare all your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you.
For more information about CloudFormation, see the CloudFormation product page.
CloudFormation makes use of other Amazon Web Services products. If you need additional technical information about a specific Amazon Web Services product, you can find the product's technical documentation at docs.aws.amazon.com .
Synopsis
- defaultService :: Service
- _AlreadyExistsException :: AsError a => Fold a ServiceError
- _CFNRegistryException :: AsError a => Fold a ServiceError
- _ChangeSetNotFoundException :: AsError a => Fold a ServiceError
- _CreatedButModifiedException :: AsError a => Fold a ServiceError
- _InsufficientCapabilitiesException :: AsError a => Fold a ServiceError
- _InvalidChangeSetStatusException :: AsError a => Fold a ServiceError
- _InvalidOperationException :: AsError a => Fold a ServiceError
- _InvalidStateTransitionException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _NameAlreadyExistsException :: AsError a => Fold a ServiceError
- _OperationIdAlreadyExistsException :: AsError a => Fold a ServiceError
- _OperationInProgressException :: AsError a => Fold a ServiceError
- _OperationNotFoundException :: AsError a => Fold a ServiceError
- _OperationStatusCheckFailedException :: AsError a => Fold a ServiceError
- _StackInstanceNotFoundException :: AsError a => Fold a ServiceError
- _StackNotFoundException :: AsError a => Fold a ServiceError
- _StackSetNotEmptyException :: AsError a => Fold a ServiceError
- _StackSetNotFoundException :: AsError a => Fold a ServiceError
- _StaleRequestException :: AsError a => Fold a ServiceError
- _TokenAlreadyExistsException :: AsError a => Fold a ServiceError
- _TypeConfigurationNotFoundException :: AsError a => Fold a ServiceError
- _TypeNotFoundException :: AsError a => Fold a ServiceError
- newChangeSetCreateComplete :: Wait DescribeChangeSet
- newStackCreateComplete :: Wait DescribeStacks
- newStackDeleteComplete :: Wait DescribeStacks
- newStackExists :: Wait DescribeStacks
- newStackImportComplete :: Wait DescribeStacks
- newStackRollbackComplete :: Wait DescribeStacks
- newStackUpdateComplete :: Wait DescribeStacks
- newTypeRegistrationComplete :: Wait DescribeTypeRegistration
- data ActivateType = ActivateType' (Maybe Bool) (Maybe Text) (Maybe LoggingConfig) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe ThirdPartyType) (Maybe Text) (Maybe Text) (Maybe VersionBump)
- newActivateType :: ActivateType
- data ActivateTypeResponse = ActivateTypeResponse' (Maybe Text) Int
- newActivateTypeResponse :: Int -> ActivateTypeResponse
- data BatchDescribeTypeConfigurations = BatchDescribeTypeConfigurations' (NonEmpty TypeConfigurationIdentifier)
- newBatchDescribeTypeConfigurations :: NonEmpty TypeConfigurationIdentifier -> BatchDescribeTypeConfigurations
- data BatchDescribeTypeConfigurationsResponse = BatchDescribeTypeConfigurationsResponse' (Maybe [BatchDescribeTypeConfigurationsError]) (Maybe [TypeConfigurationDetails]) (Maybe [TypeConfigurationIdentifier]) Int
- newBatchDescribeTypeConfigurationsResponse :: Int -> BatchDescribeTypeConfigurationsResponse
- data CancelUpdateStack = CancelUpdateStack' (Maybe Text) Text
- newCancelUpdateStack :: Text -> CancelUpdateStack
- data CancelUpdateStackResponse = CancelUpdateStackResponse' {
- newCancelUpdateStackResponse :: CancelUpdateStackResponse
- data ContinueUpdateRollback = ContinueUpdateRollback' (Maybe Text) (Maybe [Text]) (Maybe Text) Text
- newContinueUpdateRollback :: Text -> ContinueUpdateRollback
- data ContinueUpdateRollbackResponse = ContinueUpdateRollbackResponse' Int
- newContinueUpdateRollbackResponse :: Int -> ContinueUpdateRollbackResponse
- data CreateChangeSet = CreateChangeSet' (Maybe [Capability]) (Maybe ChangeSetType) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe [Parameter]) (Maybe [Text]) (Maybe [ResourceToImport]) (Maybe Text) (Maybe RollbackConfiguration) (Maybe [Tag]) (Maybe Text) (Maybe Text) (Maybe Bool) Text Text
- newCreateChangeSet :: Text -> Text -> CreateChangeSet
- data CreateChangeSetResponse = CreateChangeSetResponse' (Maybe Text) (Maybe Text) Int
- newCreateChangeSetResponse :: Int -> CreateChangeSetResponse
- data CreateStack = CreateStack' (Maybe [Capability]) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe [Text]) (Maybe OnFailure) (Maybe [Parameter]) (Maybe [Text]) (Maybe Text) (Maybe RollbackConfiguration) (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe Text) (Maybe Text) (Maybe Natural) Text
- newCreateStack :: Text -> CreateStack
- data CreateStackResponse = CreateStackResponse' (Maybe Text) Int
- newCreateStackResponse :: Int -> CreateStackResponse
- data CreateStackInstances = CreateStackInstances' (Maybe [Text]) (Maybe CallAs) (Maybe DeploymentTargets) (Maybe Text) (Maybe StackSetOperationPreferences) (Maybe [Parameter]) Text [Text]
- newCreateStackInstances :: Text -> CreateStackInstances
- data CreateStackInstancesResponse = CreateStackInstancesResponse' (Maybe Text) Int
- newCreateStackInstancesResponse :: Int -> CreateStackInstancesResponse
- data CreateStackSet = CreateStackSet' (Maybe Text) (Maybe AutoDeployment) (Maybe CallAs) (Maybe [Capability]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ManagedExecution) (Maybe [Parameter]) (Maybe PermissionModels) (Maybe Text) (Maybe [Tag]) (Maybe Text) (Maybe Text) Text
- newCreateStackSet :: Text -> CreateStackSet
- data CreateStackSetResponse = CreateStackSetResponse' (Maybe Text) Int
- newCreateStackSetResponse :: Int -> CreateStackSetResponse
- data DeactivateType = DeactivateType' (Maybe Text) (Maybe ThirdPartyType) (Maybe Text)
- newDeactivateType :: DeactivateType
- data DeactivateTypeResponse = DeactivateTypeResponse' Int
- newDeactivateTypeResponse :: Int -> DeactivateTypeResponse
- data DeleteChangeSet = DeleteChangeSet' (Maybe Text) Text
- newDeleteChangeSet :: Text -> DeleteChangeSet
- data DeleteChangeSetResponse = DeleteChangeSetResponse' Int
- newDeleteChangeSetResponse :: Int -> DeleteChangeSetResponse
- data DeleteStack = DeleteStack' (Maybe Text) (Maybe [Text]) (Maybe Text) Text
- newDeleteStack :: Text -> DeleteStack
- data DeleteStackResponse = DeleteStackResponse' {
- newDeleteStackResponse :: DeleteStackResponse
- data DeleteStackInstances = DeleteStackInstances' (Maybe [Text]) (Maybe CallAs) (Maybe DeploymentTargets) (Maybe Text) (Maybe StackSetOperationPreferences) Text [Text] Bool
- newDeleteStackInstances :: Text -> Bool -> DeleteStackInstances
- data DeleteStackInstancesResponse = DeleteStackInstancesResponse' (Maybe Text) Int
- newDeleteStackInstancesResponse :: Int -> DeleteStackInstancesResponse
- data DeleteStackSet = DeleteStackSet' (Maybe CallAs) Text
- newDeleteStackSet :: Text -> DeleteStackSet
- data DeleteStackSetResponse = DeleteStackSetResponse' Int
- newDeleteStackSetResponse :: Int -> DeleteStackSetResponse
- data DeregisterType = DeregisterType' (Maybe Text) (Maybe RegistryType) (Maybe Text) (Maybe Text)
- newDeregisterType :: DeregisterType
- data DeregisterTypeResponse = DeregisterTypeResponse' Int
- newDeregisterTypeResponse :: Int -> DeregisterTypeResponse
- data DescribeAccountLimits = DescribeAccountLimits' (Maybe Text)
- newDescribeAccountLimits :: DescribeAccountLimits
- data DescribeAccountLimitsResponse = DescribeAccountLimitsResponse' (Maybe [AccountLimit]) (Maybe Text) Int
- newDescribeAccountLimitsResponse :: Int -> DescribeAccountLimitsResponse
- data DescribeChangeSet = DescribeChangeSet' (Maybe Text) (Maybe Text) Text
- newDescribeChangeSet :: Text -> DescribeChangeSet
- data DescribeChangeSetResponse = DescribeChangeSetResponse' (Maybe [Capability]) (Maybe Text) (Maybe Text) (Maybe [Change]) (Maybe ISO8601) (Maybe Text) (Maybe ExecutionStatus) (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe [Parameter]) (Maybe Text) (Maybe RollbackConfiguration) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Tag]) Int ChangeSetStatus
- newDescribeChangeSetResponse :: Int -> ChangeSetStatus -> DescribeChangeSetResponse
- data DescribeChangeSetHooks = DescribeChangeSetHooks' (Maybe Text) (Maybe Text) (Maybe Text) Text
- newDescribeChangeSetHooks :: Text -> DescribeChangeSetHooks
- data DescribeChangeSetHooksResponse = DescribeChangeSetHooksResponse' (Maybe Text) (Maybe Text) (Maybe [ChangeSetHook]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ChangeSetHooksStatus) Int
- newDescribeChangeSetHooksResponse :: Int -> DescribeChangeSetHooksResponse
- data DescribePublisher = DescribePublisher' (Maybe Text)
- newDescribePublisher :: DescribePublisher
- data DescribePublisherResponse = DescribePublisherResponse' (Maybe IdentityProvider) (Maybe Text) (Maybe Text) (Maybe PublisherStatus) Int
- newDescribePublisherResponse :: Int -> DescribePublisherResponse
- data DescribeStackDriftDetectionStatus = DescribeStackDriftDetectionStatus' Text
- newDescribeStackDriftDetectionStatus :: Text -> DescribeStackDriftDetectionStatus
- data DescribeStackDriftDetectionStatusResponse = DescribeStackDriftDetectionStatusResponse' (Maybe Text) (Maybe Int) (Maybe StackDriftStatus) Int Text Text StackDriftDetectionStatus ISO8601
- newDescribeStackDriftDetectionStatusResponse :: Int -> Text -> Text -> StackDriftDetectionStatus -> UTCTime -> DescribeStackDriftDetectionStatusResponse
- data DescribeStackEvents = DescribeStackEvents' (Maybe Text) (Maybe Text)
- newDescribeStackEvents :: DescribeStackEvents
- data DescribeStackEventsResponse = DescribeStackEventsResponse' (Maybe Text) (Maybe [StackEvent]) Int
- newDescribeStackEventsResponse :: Int -> DescribeStackEventsResponse
- data DescribeStackInstance = DescribeStackInstance' (Maybe CallAs) Text Text Text
- newDescribeStackInstance :: Text -> Text -> Text -> DescribeStackInstance
- data DescribeStackInstanceResponse = DescribeStackInstanceResponse' (Maybe StackInstance) Int
- newDescribeStackInstanceResponse :: Int -> DescribeStackInstanceResponse
- data DescribeStackResource = DescribeStackResource' Text Text
- newDescribeStackResource :: Text -> Text -> DescribeStackResource
- data DescribeStackResourceResponse = DescribeStackResourceResponse' (Maybe StackResourceDetail) Int
- newDescribeStackResourceResponse :: Int -> DescribeStackResourceResponse
- data DescribeStackResourceDrifts = DescribeStackResourceDrifts' (Maybe Natural) (Maybe Text) (Maybe (NonEmpty StackResourceDriftStatus)) Text
- newDescribeStackResourceDrifts :: Text -> DescribeStackResourceDrifts
- data DescribeStackResourceDriftsResponse = DescribeStackResourceDriftsResponse' (Maybe Text) Int [StackResourceDrift]
- newDescribeStackResourceDriftsResponse :: Int -> DescribeStackResourceDriftsResponse
- data DescribeStackResources = DescribeStackResources' (Maybe Text) (Maybe Text) (Maybe Text)
- newDescribeStackResources :: DescribeStackResources
- data DescribeStackResourcesResponse = DescribeStackResourcesResponse' (Maybe [StackResource]) Int
- newDescribeStackResourcesResponse :: Int -> DescribeStackResourcesResponse
- data DescribeStackSet = DescribeStackSet' (Maybe CallAs) Text
- newDescribeStackSet :: Text -> DescribeStackSet
- data DescribeStackSetResponse = DescribeStackSetResponse' (Maybe StackSet) Int
- newDescribeStackSetResponse :: Int -> DescribeStackSetResponse
- data DescribeStackSetOperation = DescribeStackSetOperation' (Maybe CallAs) Text Text
- newDescribeStackSetOperation :: Text -> Text -> DescribeStackSetOperation
- data DescribeStackSetOperationResponse = DescribeStackSetOperationResponse' (Maybe StackSetOperation) Int
- newDescribeStackSetOperationResponse :: Int -> DescribeStackSetOperationResponse
- data DescribeStacks = DescribeStacks' (Maybe Text) (Maybe Text)
- newDescribeStacks :: DescribeStacks
- data DescribeStacksResponse = DescribeStacksResponse' (Maybe Text) (Maybe [Stack]) Int
- newDescribeStacksResponse :: Int -> DescribeStacksResponse
- data DescribeType = DescribeType' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RegistryType) (Maybe Text) (Maybe Text)
- newDescribeType :: DescribeType
- data DescribeTypeResponse = DescribeTypeResponse' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe DeprecatedStatus) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe ISO8601) (Maybe Text) (Maybe LoggingConfig) (Maybe Text) (Maybe Text) (Maybe ProvisioningType) (Maybe Text) (Maybe Text) (Maybe [RequiredActivatedType]) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe RegistryType) (Maybe Text) (Maybe TypeTestsStatus) (Maybe Text) (Maybe Visibility) Int
- newDescribeTypeResponse :: Int -> DescribeTypeResponse
- data DescribeTypeRegistration = DescribeTypeRegistration' Text
- newDescribeTypeRegistration :: Text -> DescribeTypeRegistration
- data DescribeTypeRegistrationResponse = DescribeTypeRegistrationResponse' (Maybe Text) (Maybe RegistrationStatus) (Maybe Text) (Maybe Text) Int
- newDescribeTypeRegistrationResponse :: Int -> DescribeTypeRegistrationResponse
- data DetectStackDrift = DetectStackDrift' (Maybe (NonEmpty Text)) Text
- newDetectStackDrift :: Text -> DetectStackDrift
- data DetectStackDriftResponse = DetectStackDriftResponse' Int Text
- newDetectStackDriftResponse :: Int -> Text -> DetectStackDriftResponse
- data DetectStackResourceDrift = DetectStackResourceDrift' Text Text
- newDetectStackResourceDrift :: Text -> Text -> DetectStackResourceDrift
- data DetectStackResourceDriftResponse = DetectStackResourceDriftResponse' Int StackResourceDrift
- newDetectStackResourceDriftResponse :: Int -> StackResourceDrift -> DetectStackResourceDriftResponse
- data DetectStackSetDrift = DetectStackSetDrift' (Maybe CallAs) (Maybe Text) (Maybe StackSetOperationPreferences) Text
- newDetectStackSetDrift :: Text -> DetectStackSetDrift
- data DetectStackSetDriftResponse = DetectStackSetDriftResponse' (Maybe Text) Int
- newDetectStackSetDriftResponse :: Int -> DetectStackSetDriftResponse
- data EstimateTemplateCost = EstimateTemplateCost' (Maybe [Parameter]) (Maybe Text) (Maybe Text)
- newEstimateTemplateCost :: EstimateTemplateCost
- data EstimateTemplateCostResponse = EstimateTemplateCostResponse' (Maybe Text) Int
- newEstimateTemplateCostResponse :: Int -> EstimateTemplateCostResponse
- data ExecuteChangeSet = ExecuteChangeSet' (Maybe Text) (Maybe Bool) (Maybe Text) Text
- newExecuteChangeSet :: Text -> ExecuteChangeSet
- data ExecuteChangeSetResponse = ExecuteChangeSetResponse' Int
- newExecuteChangeSetResponse :: Int -> ExecuteChangeSetResponse
- data GetStackPolicy = GetStackPolicy' Text
- newGetStackPolicy :: Text -> GetStackPolicy
- data GetStackPolicyResponse = GetStackPolicyResponse' (Maybe Text) Int
- newGetStackPolicyResponse :: Int -> GetStackPolicyResponse
- data GetTemplate = GetTemplate' (Maybe Text) (Maybe Text) (Maybe TemplateStage)
- newGetTemplate :: GetTemplate
- data GetTemplateResponse = GetTemplateResponse' (Maybe [TemplateStage]) (Maybe Text) Int
- newGetTemplateResponse :: Int -> GetTemplateResponse
- data GetTemplateSummary = GetTemplateSummary' (Maybe CallAs) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newGetTemplateSummary :: GetTemplateSummary
- data GetTemplateSummaryResponse = GetTemplateSummaryResponse' (Maybe [Capability]) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe [ParameterDeclaration]) (Maybe [ResourceIdentifierSummary]) (Maybe [Text]) (Maybe Text) Int
- newGetTemplateSummaryResponse :: Int -> GetTemplateSummaryResponse
- data ImportStacksToStackSet = ImportStacksToStackSet' (Maybe CallAs) (Maybe Text) (Maybe StackSetOperationPreferences) (Maybe [Text]) (Maybe [Text]) (Maybe Text) Text
- newImportStacksToStackSet :: Text -> ImportStacksToStackSet
- data ImportStacksToStackSetResponse = ImportStacksToStackSetResponse' (Maybe Text) Int
- newImportStacksToStackSetResponse :: Int -> ImportStacksToStackSetResponse
- data ListChangeSets = ListChangeSets' (Maybe Text) Text
- newListChangeSets :: Text -> ListChangeSets
- data ListChangeSetsResponse = ListChangeSetsResponse' (Maybe Text) (Maybe [ChangeSetSummary]) Int
- newListChangeSetsResponse :: Int -> ListChangeSetsResponse
- data ListExports = ListExports' (Maybe Text)
- newListExports :: ListExports
- data ListExportsResponse = ListExportsResponse' (Maybe [Export]) (Maybe Text) Int
- newListExportsResponse :: Int -> ListExportsResponse
- data ListImports = ListImports' (Maybe Text) Text
- newListImports :: Text -> ListImports
- data ListImportsResponse = ListImportsResponse' (Maybe [Text]) (Maybe Text) Int
- newListImportsResponse :: Int -> ListImportsResponse
- data ListStackInstances = ListStackInstances' (Maybe CallAs) (Maybe [StackInstanceFilter]) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) Text
- newListStackInstances :: Text -> ListStackInstances
- data ListStackInstancesResponse = ListStackInstancesResponse' (Maybe Text) (Maybe [StackInstanceSummary]) Int
- newListStackInstancesResponse :: Int -> ListStackInstancesResponse
- data ListStackResources = ListStackResources' (Maybe Text) Text
- newListStackResources :: Text -> ListStackResources
- data ListStackResourcesResponse = ListStackResourcesResponse' (Maybe Text) (Maybe [StackResourceSummary]) Int
- newListStackResourcesResponse :: Int -> ListStackResourcesResponse
- data ListStackSetOperationResults = ListStackSetOperationResults' (Maybe CallAs) (Maybe [OperationResultFilter]) (Maybe Natural) (Maybe Text) Text Text
- newListStackSetOperationResults :: Text -> Text -> ListStackSetOperationResults
- data ListStackSetOperationResultsResponse = ListStackSetOperationResultsResponse' (Maybe Text) (Maybe [StackSetOperationResultSummary]) Int
- newListStackSetOperationResultsResponse :: Int -> ListStackSetOperationResultsResponse
- data ListStackSetOperations = ListStackSetOperations' (Maybe CallAs) (Maybe Natural) (Maybe Text) Text
- newListStackSetOperations :: Text -> ListStackSetOperations
- data ListStackSetOperationsResponse = ListStackSetOperationsResponse' (Maybe Text) (Maybe [StackSetOperationSummary]) Int
- newListStackSetOperationsResponse :: Int -> ListStackSetOperationsResponse
- data ListStackSets = ListStackSets' (Maybe CallAs) (Maybe Natural) (Maybe Text) (Maybe StackSetStatus)
- newListStackSets :: ListStackSets
- data ListStackSetsResponse = ListStackSetsResponse' (Maybe Text) (Maybe [StackSetSummary]) Int
- newListStackSetsResponse :: Int -> ListStackSetsResponse
- data ListStacks = ListStacks' (Maybe Text) (Maybe [StackStatus])
- newListStacks :: ListStacks
- data ListStacksResponse = ListStacksResponse' (Maybe Text) (Maybe [StackSummary]) Int
- newListStacksResponse :: Int -> ListStacksResponse
- data ListTypeRegistrations = ListTypeRegistrations' (Maybe Natural) (Maybe Text) (Maybe RegistrationStatus) (Maybe RegistryType) (Maybe Text) (Maybe Text)
- newListTypeRegistrations :: ListTypeRegistrations
- data ListTypeRegistrationsResponse = ListTypeRegistrationsResponse' (Maybe Text) (Maybe [Text]) Int
- newListTypeRegistrationsResponse :: Int -> ListTypeRegistrationsResponse
- data ListTypeVersions = ListTypeVersions' (Maybe Text) (Maybe DeprecatedStatus) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe RegistryType) (Maybe Text)
- newListTypeVersions :: ListTypeVersions
- data ListTypeVersionsResponse = ListTypeVersionsResponse' (Maybe Text) (Maybe [TypeVersionSummary]) Int
- newListTypeVersionsResponse :: Int -> ListTypeVersionsResponse
- data ListTypes = ListTypes' (Maybe DeprecatedStatus) (Maybe TypeFilters) (Maybe Natural) (Maybe Text) (Maybe ProvisioningType) (Maybe RegistryType) (Maybe Visibility)
- newListTypes :: ListTypes
- data ListTypesResponse = ListTypesResponse' (Maybe Text) (Maybe [TypeSummary]) Int
- newListTypesResponse :: Int -> ListTypesResponse
- data PublishType = PublishType' (Maybe Text) (Maybe Text) (Maybe ThirdPartyType) (Maybe Text)
- newPublishType :: PublishType
- data PublishTypeResponse = PublishTypeResponse' (Maybe Text) Int
- newPublishTypeResponse :: Int -> PublishTypeResponse
- data RecordHandlerProgress = RecordHandlerProgress' (Maybe Text) (Maybe OperationStatus) (Maybe HandlerErrorCode) (Maybe Text) (Maybe Text) Text OperationStatus
- newRecordHandlerProgress :: Text -> OperationStatus -> RecordHandlerProgress
- data RecordHandlerProgressResponse = RecordHandlerProgressResponse' Int
- newRecordHandlerProgressResponse :: Int -> RecordHandlerProgressResponse
- data RegisterPublisher = RegisterPublisher' (Maybe Bool) (Maybe Text)
- newRegisterPublisher :: RegisterPublisher
- data RegisterPublisherResponse = RegisterPublisherResponse' (Maybe Text) Int
- newRegisterPublisherResponse :: Int -> RegisterPublisherResponse
- data RegisterType = RegisterType' (Maybe Text) (Maybe Text) (Maybe LoggingConfig) (Maybe RegistryType) Text Text
- newRegisterType :: Text -> Text -> RegisterType
- data RegisterTypeResponse = RegisterTypeResponse' (Maybe Text) Int
- newRegisterTypeResponse :: Int -> RegisterTypeResponse
- data RollbackStack = RollbackStack' (Maybe Text) (Maybe Text) Text
- newRollbackStack :: Text -> RollbackStack
- data RollbackStackResponse = RollbackStackResponse' (Maybe Text) Int
- newRollbackStackResponse :: Int -> RollbackStackResponse
- data SetStackPolicy = SetStackPolicy' (Maybe Text) (Maybe Text) Text
- newSetStackPolicy :: Text -> SetStackPolicy
- data SetStackPolicyResponse = SetStackPolicyResponse' {
- newSetStackPolicyResponse :: SetStackPolicyResponse
- data SetTypeConfiguration = SetTypeConfiguration' (Maybe Text) (Maybe ThirdPartyType) (Maybe Text) (Maybe Text) Text
- newSetTypeConfiguration :: Text -> SetTypeConfiguration
- data SetTypeConfigurationResponse = SetTypeConfigurationResponse' (Maybe Text) Int
- newSetTypeConfigurationResponse :: Int -> SetTypeConfigurationResponse
- data SetTypeDefaultVersion = SetTypeDefaultVersion' (Maybe Text) (Maybe RegistryType) (Maybe Text) (Maybe Text)
- newSetTypeDefaultVersion :: SetTypeDefaultVersion
- data SetTypeDefaultVersionResponse = SetTypeDefaultVersionResponse' Int
- newSetTypeDefaultVersionResponse :: Int -> SetTypeDefaultVersionResponse
- data SignalResource = SignalResource' Text Text Text ResourceSignalStatus
- newSignalResource :: Text -> Text -> Text -> ResourceSignalStatus -> SignalResource
- data SignalResourceResponse = SignalResourceResponse' {
- newSignalResourceResponse :: SignalResourceResponse
- data StopStackSetOperation = StopStackSetOperation' (Maybe CallAs) Text Text
- newStopStackSetOperation :: Text -> Text -> StopStackSetOperation
- data StopStackSetOperationResponse = StopStackSetOperationResponse' Int
- newStopStackSetOperationResponse :: Int -> StopStackSetOperationResponse
- data TestType = TestType' (Maybe Text) (Maybe Text) (Maybe ThirdPartyType) (Maybe Text) (Maybe Text)
- newTestType :: TestType
- data TestTypeResponse = TestTypeResponse' (Maybe Text) Int
- newTestTypeResponse :: Int -> TestTypeResponse
- data UpdateStack = UpdateStack' (Maybe [Capability]) (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe [Parameter]) (Maybe [Text]) (Maybe Text) (Maybe RollbackConfiguration) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe Text) (Maybe Text) (Maybe Bool) Text
- newUpdateStack :: Text -> UpdateStack
- data UpdateStackResponse = UpdateStackResponse' (Maybe Text) Int
- newUpdateStackResponse :: Int -> UpdateStackResponse
- data UpdateStackInstances = UpdateStackInstances' (Maybe [Text]) (Maybe CallAs) (Maybe DeploymentTargets) (Maybe Text) (Maybe StackSetOperationPreferences) (Maybe [Parameter]) Text [Text]
- newUpdateStackInstances :: Text -> UpdateStackInstances
- data UpdateStackInstancesResponse = UpdateStackInstancesResponse' (Maybe Text) Int
- newUpdateStackInstancesResponse :: Int -> UpdateStackInstancesResponse
- data UpdateStackSet = UpdateStackSet' (Maybe [Text]) (Maybe Text) (Maybe AutoDeployment) (Maybe CallAs) (Maybe [Capability]) (Maybe DeploymentTargets) (Maybe Text) (Maybe Text) (Maybe ManagedExecution) (Maybe Text) (Maybe StackSetOperationPreferences) (Maybe [Parameter]) (Maybe PermissionModels) (Maybe [Text]) (Maybe [Tag]) (Maybe Text) (Maybe Text) (Maybe Bool) Text
- newUpdateStackSet :: Text -> UpdateStackSet
- data UpdateStackSetResponse = UpdateStackSetResponse' (Maybe Text) Int
- newUpdateStackSetResponse :: Int -> UpdateStackSetResponse
- data UpdateTerminationProtection = UpdateTerminationProtection' Bool Text
- newUpdateTerminationProtection :: Bool -> Text -> UpdateTerminationProtection
- data UpdateTerminationProtectionResponse = UpdateTerminationProtectionResponse' (Maybe Text) Int
- newUpdateTerminationProtectionResponse :: Int -> UpdateTerminationProtectionResponse
- data ValidateTemplate = ValidateTemplate' (Maybe Text) (Maybe Text)
- newValidateTemplate :: ValidateTemplate
- data ValidateTemplateResponse = ValidateTemplateResponse' (Maybe [Capability]) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe [TemplateParameter]) Int
- newValidateTemplateResponse :: Int -> ValidateTemplateResponse
- newtype AccountFilterType where
- AccountFilterType' { }
- pattern AccountFilterType_DIFFERENCE :: AccountFilterType
- pattern AccountFilterType_INTERSECTION :: AccountFilterType
- pattern AccountFilterType_NONE :: AccountFilterType
- pattern AccountFilterType_UNION :: AccountFilterType
- newtype AccountGateStatus where
- AccountGateStatus' { }
- pattern AccountGateStatus_FAILED :: AccountGateStatus
- pattern AccountGateStatus_SKIPPED :: AccountGateStatus
- pattern AccountGateStatus_SUCCEEDED :: AccountGateStatus
- newtype CallAs where
- CallAs' {
- fromCallAs :: Text
- pattern CallAs_DELEGATED_ADMIN :: CallAs
- pattern CallAs_SELF :: CallAs
- CallAs' {
- newtype Capability where
- Capability' { }
- pattern Capability_CAPABILITY_AUTO_EXPAND :: Capability
- pattern Capability_CAPABILITY_IAM :: Capability
- pattern Capability_CAPABILITY_NAMED_IAM :: Capability
- newtype Category where
- Category' {
- fromCategory :: Text
- pattern Category_ACTIVATED :: Category
- pattern Category_AWS_TYPES :: Category
- pattern Category_REGISTERED :: Category
- pattern Category_THIRD_PARTY :: Category
- Category' {
- newtype ChangeAction where
- ChangeAction' { }
- pattern ChangeAction_Add :: ChangeAction
- pattern ChangeAction_Dynamic :: ChangeAction
- pattern ChangeAction_Import :: ChangeAction
- pattern ChangeAction_Modify :: ChangeAction
- pattern ChangeAction_Remove :: ChangeAction
- newtype ChangeSetHooksStatus where
- newtype ChangeSetStatus where
- ChangeSetStatus' { }
- pattern ChangeSetStatus_CREATE_COMPLETE :: ChangeSetStatus
- pattern ChangeSetStatus_CREATE_IN_PROGRESS :: ChangeSetStatus
- pattern ChangeSetStatus_CREATE_PENDING :: ChangeSetStatus
- pattern ChangeSetStatus_DELETE_COMPLETE :: ChangeSetStatus
- pattern ChangeSetStatus_DELETE_FAILED :: ChangeSetStatus
- pattern ChangeSetStatus_DELETE_IN_PROGRESS :: ChangeSetStatus
- pattern ChangeSetStatus_DELETE_PENDING :: ChangeSetStatus
- pattern ChangeSetStatus_FAILED :: ChangeSetStatus
- newtype ChangeSetType where
- ChangeSetType' { }
- pattern ChangeSetType_CREATE :: ChangeSetType
- pattern ChangeSetType_IMPORT :: ChangeSetType
- pattern ChangeSetType_UPDATE :: ChangeSetType
- newtype ChangeSource where
- ChangeSource' { }
- pattern ChangeSource_Automatic :: ChangeSource
- pattern ChangeSource_DirectModification :: ChangeSource
- pattern ChangeSource_ParameterReference :: ChangeSource
- pattern ChangeSource_ResourceAttribute :: ChangeSource
- pattern ChangeSource_ResourceReference :: ChangeSource
- newtype ChangeType where
- ChangeType' { }
- pattern ChangeType_Resource :: ChangeType
- newtype DeprecatedStatus where
- DeprecatedStatus' { }
- pattern DeprecatedStatus_DEPRECATED :: DeprecatedStatus
- pattern DeprecatedStatus_LIVE :: DeprecatedStatus
- newtype DifferenceType where
- DifferenceType' { }
- pattern DifferenceType_ADD :: DifferenceType
- pattern DifferenceType_NOT_EQUAL :: DifferenceType
- pattern DifferenceType_REMOVE :: DifferenceType
- newtype EvaluationType where
- EvaluationType' { }
- pattern EvaluationType_Dynamic :: EvaluationType
- pattern EvaluationType_Static :: EvaluationType
- newtype ExecutionStatus where
- ExecutionStatus' { }
- pattern ExecutionStatus_AVAILABLE :: ExecutionStatus
- pattern ExecutionStatus_EXECUTE_COMPLETE :: ExecutionStatus
- pattern ExecutionStatus_EXECUTE_FAILED :: ExecutionStatus
- pattern ExecutionStatus_EXECUTE_IN_PROGRESS :: ExecutionStatus
- pattern ExecutionStatus_OBSOLETE :: ExecutionStatus
- pattern ExecutionStatus_UNAVAILABLE :: ExecutionStatus
- newtype HandlerErrorCode where
- HandlerErrorCode' { }
- pattern HandlerErrorCode_AccessDenied :: HandlerErrorCode
- pattern HandlerErrorCode_AlreadyExists :: HandlerErrorCode
- pattern HandlerErrorCode_GeneralServiceException :: HandlerErrorCode
- pattern HandlerErrorCode_HandlerInternalFailure :: HandlerErrorCode
- pattern HandlerErrorCode_InternalFailure :: HandlerErrorCode
- pattern HandlerErrorCode_InvalidCredentials :: HandlerErrorCode
- pattern HandlerErrorCode_InvalidRequest :: HandlerErrorCode
- pattern HandlerErrorCode_InvalidTypeConfiguration :: HandlerErrorCode
- pattern HandlerErrorCode_NetworkFailure :: HandlerErrorCode
- pattern HandlerErrorCode_NonCompliant :: HandlerErrorCode
- pattern HandlerErrorCode_NotFound :: HandlerErrorCode
- pattern HandlerErrorCode_NotStabilized :: HandlerErrorCode
- pattern HandlerErrorCode_NotUpdatable :: HandlerErrorCode
- pattern HandlerErrorCode_ResourceConflict :: HandlerErrorCode
- pattern HandlerErrorCode_ServiceInternalError :: HandlerErrorCode
- pattern HandlerErrorCode_ServiceLimitExceeded :: HandlerErrorCode
- pattern HandlerErrorCode_Throttling :: HandlerErrorCode
- pattern HandlerErrorCode_Unknown :: HandlerErrorCode
- pattern HandlerErrorCode_UnsupportedTarget :: HandlerErrorCode
- newtype HookFailureMode where
- HookFailureMode' { }
- pattern HookFailureMode_FAIL :: HookFailureMode
- pattern HookFailureMode_WARN :: HookFailureMode
- newtype HookInvocationPoint where
- newtype HookStatus where
- HookStatus' { }
- pattern HookStatus_HOOK_COMPLETE_FAILED :: HookStatus
- pattern HookStatus_HOOK_COMPLETE_SUCCEEDED :: HookStatus
- pattern HookStatus_HOOK_FAILED :: HookStatus
- pattern HookStatus_HOOK_IN_PROGRESS :: HookStatus
- newtype HookTargetType where
- HookTargetType' { }
- pattern HookTargetType_RESOURCE :: HookTargetType
- newtype IdentityProvider where
- IdentityProvider' { }
- pattern IdentityProvider_AWS_Marketplace :: IdentityProvider
- pattern IdentityProvider_Bitbucket :: IdentityProvider
- pattern IdentityProvider_GitHub :: IdentityProvider
- newtype OnFailure where
- OnFailure' { }
- pattern OnFailure_DELETE :: OnFailure
- pattern OnFailure_DO_NOTHING :: OnFailure
- pattern OnFailure_ROLLBACK :: OnFailure
- newtype OperationResultFilterName where
- newtype OperationStatus where
- OperationStatus' { }
- pattern OperationStatus_FAILED :: OperationStatus
- pattern OperationStatus_IN_PROGRESS :: OperationStatus
- pattern OperationStatus_PENDING :: OperationStatus
- pattern OperationStatus_SUCCESS :: OperationStatus
- newtype PermissionModels where
- newtype ProvisioningType where
- ProvisioningType' { }
- pattern ProvisioningType_FULLY_MUTABLE :: ProvisioningType
- pattern ProvisioningType_IMMUTABLE :: ProvisioningType
- pattern ProvisioningType_NON_PROVISIONABLE :: ProvisioningType
- newtype PublisherStatus where
- PublisherStatus' { }
- pattern PublisherStatus_UNVERIFIED :: PublisherStatus
- pattern PublisherStatus_VERIFIED :: PublisherStatus
- newtype RegionConcurrencyType where
- newtype RegistrationStatus where
- newtype RegistryType where
- RegistryType' { }
- pattern RegistryType_HOOK :: RegistryType
- pattern RegistryType_MODULE :: RegistryType
- pattern RegistryType_RESOURCE :: RegistryType
- newtype Replacement where
- Replacement' { }
- pattern Replacement_Conditional :: Replacement
- pattern Replacement_False :: Replacement
- pattern Replacement_True :: Replacement
- newtype RequiresRecreation where
- RequiresRecreation' { }
- pattern RequiresRecreation_Always :: RequiresRecreation
- pattern RequiresRecreation_Conditionally :: RequiresRecreation
- pattern RequiresRecreation_Never :: RequiresRecreation
- newtype ResourceAttribute where
- ResourceAttribute' { }
- pattern ResourceAttribute_CreationPolicy :: ResourceAttribute
- pattern ResourceAttribute_DeletionPolicy :: ResourceAttribute
- pattern ResourceAttribute_Metadata :: ResourceAttribute
- pattern ResourceAttribute_Properties :: ResourceAttribute
- pattern ResourceAttribute_Tags :: ResourceAttribute
- pattern ResourceAttribute_UpdatePolicy :: ResourceAttribute
- newtype ResourceSignalStatus where
- newtype ResourceStatus where
- ResourceStatus' { }
- pattern ResourceStatus_CREATE_COMPLETE :: ResourceStatus
- pattern ResourceStatus_CREATE_FAILED :: ResourceStatus
- pattern ResourceStatus_CREATE_IN_PROGRESS :: ResourceStatus
- pattern ResourceStatus_DELETE_COMPLETE :: ResourceStatus
- pattern ResourceStatus_DELETE_FAILED :: ResourceStatus
- pattern ResourceStatus_DELETE_IN_PROGRESS :: ResourceStatus
- pattern ResourceStatus_DELETE_SKIPPED :: ResourceStatus
- pattern ResourceStatus_IMPORT_COMPLETE :: ResourceStatus
- pattern ResourceStatus_IMPORT_FAILED :: ResourceStatus
- pattern ResourceStatus_IMPORT_IN_PROGRESS :: ResourceStatus
- pattern ResourceStatus_IMPORT_ROLLBACK_COMPLETE :: ResourceStatus
- pattern ResourceStatus_IMPORT_ROLLBACK_FAILED :: ResourceStatus
- pattern ResourceStatus_IMPORT_ROLLBACK_IN_PROGRESS :: ResourceStatus
- pattern ResourceStatus_ROLLBACK_COMPLETE :: ResourceStatus
- pattern ResourceStatus_ROLLBACK_FAILED :: ResourceStatus
- pattern ResourceStatus_ROLLBACK_IN_PROGRESS :: ResourceStatus
- pattern ResourceStatus_UPDATE_COMPLETE :: ResourceStatus
- pattern ResourceStatus_UPDATE_FAILED :: ResourceStatus
- pattern ResourceStatus_UPDATE_IN_PROGRESS :: ResourceStatus
- pattern ResourceStatus_UPDATE_ROLLBACK_COMPLETE :: ResourceStatus
- pattern ResourceStatus_UPDATE_ROLLBACK_FAILED :: ResourceStatus
- pattern ResourceStatus_UPDATE_ROLLBACK_IN_PROGRESS :: ResourceStatus
- newtype StackDriftDetectionStatus where
- newtype StackDriftStatus where
- StackDriftStatus' { }
- pattern StackDriftStatus_DRIFTED :: StackDriftStatus
- pattern StackDriftStatus_IN_SYNC :: StackDriftStatus
- pattern StackDriftStatus_NOT_CHECKED :: StackDriftStatus
- pattern StackDriftStatus_UNKNOWN :: StackDriftStatus
- newtype StackInstanceDetailedStatus where
- StackInstanceDetailedStatus' { }
- pattern StackInstanceDetailedStatus_CANCELLED :: StackInstanceDetailedStatus
- pattern StackInstanceDetailedStatus_FAILED :: StackInstanceDetailedStatus
- pattern StackInstanceDetailedStatus_INOPERABLE :: StackInstanceDetailedStatus
- pattern StackInstanceDetailedStatus_PENDING :: StackInstanceDetailedStatus
- pattern StackInstanceDetailedStatus_RUNNING :: StackInstanceDetailedStatus
- pattern StackInstanceDetailedStatus_SUCCEEDED :: StackInstanceDetailedStatus
- newtype StackInstanceFilterName where
- newtype StackInstanceStatus where
- newtype StackResourceDriftStatus where
- StackResourceDriftStatus' { }
- pattern StackResourceDriftStatus_DELETED :: StackResourceDriftStatus
- pattern StackResourceDriftStatus_IN_SYNC :: StackResourceDriftStatus
- pattern StackResourceDriftStatus_MODIFIED :: StackResourceDriftStatus
- pattern StackResourceDriftStatus_NOT_CHECKED :: StackResourceDriftStatus
- newtype StackSetDriftDetectionStatus where
- StackSetDriftDetectionStatus' { }
- pattern StackSetDriftDetectionStatus_COMPLETED :: StackSetDriftDetectionStatus
- pattern StackSetDriftDetectionStatus_FAILED :: StackSetDriftDetectionStatus
- pattern StackSetDriftDetectionStatus_IN_PROGRESS :: StackSetDriftDetectionStatus
- pattern StackSetDriftDetectionStatus_PARTIAL_SUCCESS :: StackSetDriftDetectionStatus
- pattern StackSetDriftDetectionStatus_STOPPED :: StackSetDriftDetectionStatus
- newtype StackSetDriftStatus where
- newtype StackSetOperationAction where
- newtype StackSetOperationResultStatus where
- StackSetOperationResultStatus' { }
- pattern StackSetOperationResultStatus_CANCELLED :: StackSetOperationResultStatus
- pattern StackSetOperationResultStatus_FAILED :: StackSetOperationResultStatus
- pattern StackSetOperationResultStatus_PENDING :: StackSetOperationResultStatus
- pattern StackSetOperationResultStatus_RUNNING :: StackSetOperationResultStatus
- pattern StackSetOperationResultStatus_SUCCEEDED :: StackSetOperationResultStatus
- newtype StackSetOperationStatus where
- StackSetOperationStatus' { }
- pattern StackSetOperationStatus_FAILED :: StackSetOperationStatus
- pattern StackSetOperationStatus_QUEUED :: StackSetOperationStatus
- pattern StackSetOperationStatus_RUNNING :: StackSetOperationStatus
- pattern StackSetOperationStatus_STOPPED :: StackSetOperationStatus
- pattern StackSetOperationStatus_STOPPING :: StackSetOperationStatus
- pattern StackSetOperationStatus_SUCCEEDED :: StackSetOperationStatus
- newtype StackSetStatus where
- StackSetStatus' { }
- pattern StackSetStatus_ACTIVE :: StackSetStatus
- pattern StackSetStatus_DELETED :: StackSetStatus
- newtype StackStatus where
- StackStatus' { }
- pattern StackStatus_CREATE_COMPLETE :: StackStatus
- pattern StackStatus_CREATE_FAILED :: StackStatus
- pattern StackStatus_CREATE_IN_PROGRESS :: StackStatus
- pattern StackStatus_DELETE_COMPLETE :: StackStatus
- pattern StackStatus_DELETE_FAILED :: StackStatus
- pattern StackStatus_DELETE_IN_PROGRESS :: StackStatus
- pattern StackStatus_IMPORT_COMPLETE :: StackStatus
- pattern StackStatus_IMPORT_IN_PROGRESS :: StackStatus
- pattern StackStatus_IMPORT_ROLLBACK_COMPLETE :: StackStatus
- pattern StackStatus_IMPORT_ROLLBACK_FAILED :: StackStatus
- pattern StackStatus_IMPORT_ROLLBACK_IN_PROGRESS :: StackStatus
- pattern StackStatus_REVIEW_IN_PROGRESS :: StackStatus
- pattern StackStatus_ROLLBACK_COMPLETE :: StackStatus
- pattern StackStatus_ROLLBACK_FAILED :: StackStatus
- pattern StackStatus_ROLLBACK_IN_PROGRESS :: StackStatus
- pattern StackStatus_UPDATE_COMPLETE :: StackStatus
- pattern StackStatus_UPDATE_COMPLETE_CLEANUP_IN_PROGRESS :: StackStatus
- pattern StackStatus_UPDATE_FAILED :: StackStatus
- pattern StackStatus_UPDATE_IN_PROGRESS :: StackStatus
- pattern StackStatus_UPDATE_ROLLBACK_COMPLETE :: StackStatus
- pattern StackStatus_UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS :: StackStatus
- pattern StackStatus_UPDATE_ROLLBACK_FAILED :: StackStatus
- pattern StackStatus_UPDATE_ROLLBACK_IN_PROGRESS :: StackStatus
- newtype TemplateStage where
- TemplateStage' { }
- pattern TemplateStage_Original :: TemplateStage
- pattern TemplateStage_Processed :: TemplateStage
- newtype ThirdPartyType where
- ThirdPartyType' { }
- pattern ThirdPartyType_HOOK :: ThirdPartyType
- pattern ThirdPartyType_MODULE :: ThirdPartyType
- pattern ThirdPartyType_RESOURCE :: ThirdPartyType
- newtype TypeTestsStatus where
- TypeTestsStatus' { }
- pattern TypeTestsStatus_FAILED :: TypeTestsStatus
- pattern TypeTestsStatus_IN_PROGRESS :: TypeTestsStatus
- pattern TypeTestsStatus_NOT_TESTED :: TypeTestsStatus
- pattern TypeTestsStatus_PASSED :: TypeTestsStatus
- newtype VersionBump where
- VersionBump' { }
- pattern VersionBump_MAJOR :: VersionBump
- pattern VersionBump_MINOR :: VersionBump
- newtype Visibility where
- Visibility' { }
- pattern Visibility_PRIVATE :: Visibility
- pattern Visibility_PUBLIC :: Visibility
- data AccountGateResult = AccountGateResult' (Maybe AccountGateStatus) (Maybe Text)
- newAccountGateResult :: AccountGateResult
- data AccountLimit = AccountLimit' (Maybe Text) (Maybe Int)
- newAccountLimit :: AccountLimit
- data AutoDeployment = AutoDeployment' (Maybe Bool) (Maybe Bool)
- newAutoDeployment :: AutoDeployment
- data BatchDescribeTypeConfigurationsError = BatchDescribeTypeConfigurationsError' (Maybe Text) (Maybe Text) (Maybe TypeConfigurationIdentifier)
- newBatchDescribeTypeConfigurationsError :: BatchDescribeTypeConfigurationsError
- data Change = Change' (Maybe Natural) (Maybe ResourceChange) (Maybe ChangeType)
- newChange :: Change
- data ChangeSetHook = ChangeSetHook' (Maybe HookFailureMode) (Maybe HookInvocationPoint) (Maybe ChangeSetHookTargetDetails) (Maybe Text) (Maybe Text) (Maybe Text)
- newChangeSetHook :: ChangeSetHook
- data ChangeSetHookResourceTargetDetails = ChangeSetHookResourceTargetDetails' (Maybe Text) (Maybe ChangeAction) (Maybe Text)
- newChangeSetHookResourceTargetDetails :: ChangeSetHookResourceTargetDetails
- data ChangeSetHookTargetDetails = ChangeSetHookTargetDetails' (Maybe ChangeSetHookResourceTargetDetails) (Maybe HookTargetType)
- newChangeSetHookTargetDetails :: ChangeSetHookTargetDetails
- data ChangeSetSummary = ChangeSetSummary' (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe ExecutionStatus) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ChangeSetStatus) (Maybe Text)
- newChangeSetSummary :: ChangeSetSummary
- data DeploymentTargets = DeploymentTargets' (Maybe AccountFilterType) (Maybe [Text]) (Maybe Text) (Maybe [Text])
- newDeploymentTargets :: DeploymentTargets
- data Export = Export' (Maybe Text) (Maybe Text) (Maybe Text)
- newExport :: Export
- data LoggingConfig = LoggingConfig' Text Text
- newLoggingConfig :: Text -> Text -> LoggingConfig
- data ManagedExecution = ManagedExecution' (Maybe Bool)
- newManagedExecution :: ManagedExecution
- data ModuleInfo = ModuleInfo' (Maybe Text) (Maybe Text)
- newModuleInfo :: ModuleInfo
- data OperationResultFilter = OperationResultFilter' (Maybe OperationResultFilterName) (Maybe Text)
- newOperationResultFilter :: OperationResultFilter
- data Output = Output' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newOutput :: Output
- data Parameter = Parameter' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool)
- newParameter :: Parameter
- data ParameterConstraints = ParameterConstraints' (Maybe [Text])
- newParameterConstraints :: ParameterConstraints
- data ParameterDeclaration = ParameterDeclaration' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe ParameterConstraints) (Maybe Text) (Maybe Text)
- newParameterDeclaration :: ParameterDeclaration
- data PhysicalResourceIdContextKeyValuePair = PhysicalResourceIdContextKeyValuePair' Text Text
- newPhysicalResourceIdContextKeyValuePair :: Text -> Text -> PhysicalResourceIdContextKeyValuePair
- data PropertyDifference = PropertyDifference' Text Text Text DifferenceType
- newPropertyDifference :: Text -> Text -> Text -> DifferenceType -> PropertyDifference
- data RequiredActivatedType = RequiredActivatedType' (Maybe Text) (Maybe Text) (Maybe [Natural]) (Maybe Text)
- newRequiredActivatedType :: RequiredActivatedType
- data ResourceChange = ResourceChange' (Maybe ChangeAction) (Maybe Text) (Maybe [ResourceChangeDetail]) (Maybe Text) (Maybe ModuleInfo) (Maybe Text) (Maybe Replacement) (Maybe Text) (Maybe [ResourceAttribute])
- newResourceChange :: ResourceChange
- data ResourceChangeDetail = ResourceChangeDetail' (Maybe Text) (Maybe ChangeSource) (Maybe EvaluationType) (Maybe ResourceTargetDefinition)
- newResourceChangeDetail :: ResourceChangeDetail
- data ResourceIdentifierSummary = ResourceIdentifierSummary' (Maybe (NonEmpty Text)) (Maybe [Text]) (Maybe Text)
- newResourceIdentifierSummary :: ResourceIdentifierSummary
- data ResourceTargetDefinition = ResourceTargetDefinition' (Maybe ResourceAttribute) (Maybe Text) (Maybe RequiresRecreation)
- newResourceTargetDefinition :: ResourceTargetDefinition
- data ResourceToImport = ResourceToImport' Text Text (HashMap Text Text)
- newResourceToImport :: Text -> Text -> ResourceToImport
- data RollbackConfiguration = RollbackConfiguration' (Maybe Natural) (Maybe [RollbackTrigger])
- newRollbackConfiguration :: RollbackConfiguration
- data RollbackTrigger = RollbackTrigger' Text Text
- newRollbackTrigger :: Text -> Text -> RollbackTrigger
- data Stack = Stack' (Maybe [Capability]) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe Bool) (Maybe StackDriftInformation) (Maybe Bool) (Maybe ISO8601) (Maybe [Text]) (Maybe [Output]) (Maybe [Parameter]) (Maybe Text) (Maybe Text) (Maybe RollbackConfiguration) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe Natural) Text ISO8601 StackStatus
- newStack :: Text -> UTCTime -> StackStatus -> Stack
- data StackDriftInformation = StackDriftInformation' (Maybe ISO8601) StackDriftStatus
- newStackDriftInformation :: StackDriftStatus -> StackDriftInformation
- data StackDriftInformationSummary = StackDriftInformationSummary' (Maybe ISO8601) StackDriftStatus
- newStackDriftInformationSummary :: StackDriftStatus -> StackDriftInformationSummary
- data StackEvent = StackEvent' (Maybe Text) (Maybe HookFailureMode) (Maybe HookInvocationPoint) (Maybe HookStatus) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ResourceStatus) (Maybe Text) (Maybe Text) Text Text Text ISO8601
- newStackEvent :: Text -> Text -> Text -> UTCTime -> StackEvent
- data StackInstance = StackInstance' (Maybe Text) (Maybe StackDriftStatus) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe [Parameter]) (Maybe Text) (Maybe Text) (Maybe StackInstanceComprehensiveStatus) (Maybe Text) (Maybe StackInstanceStatus) (Maybe Text)
- newStackInstance :: StackInstance
- data StackInstanceComprehensiveStatus = StackInstanceComprehensiveStatus' (Maybe StackInstanceDetailedStatus)
- newStackInstanceComprehensiveStatus :: StackInstanceComprehensiveStatus
- data StackInstanceFilter = StackInstanceFilter' (Maybe StackInstanceFilterName) (Maybe Text)
- newStackInstanceFilter :: StackInstanceFilter
- data StackInstanceSummary = StackInstanceSummary' (Maybe Text) (Maybe StackDriftStatus) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe StackInstanceComprehensiveStatus) (Maybe Text) (Maybe StackInstanceStatus) (Maybe Text)
- newStackInstanceSummary :: StackInstanceSummary
- data StackResource = StackResource' (Maybe Text) (Maybe StackResourceDriftInformation) (Maybe ModuleInfo) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text Text ISO8601 ResourceStatus
- newStackResource :: Text -> Text -> UTCTime -> ResourceStatus -> StackResource
- data StackResourceDetail = StackResourceDetail' (Maybe Text) (Maybe StackResourceDriftInformation) (Maybe Text) (Maybe ModuleInfo) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text Text ISO8601 ResourceStatus
- newStackResourceDetail :: Text -> Text -> UTCTime -> ResourceStatus -> StackResourceDetail
- data StackResourceDrift = StackResourceDrift' (Maybe Text) (Maybe Text) (Maybe ModuleInfo) (Maybe Text) (Maybe [PhysicalResourceIdContextKeyValuePair]) (Maybe [PropertyDifference]) Text Text Text StackResourceDriftStatus ISO8601
- newStackResourceDrift :: Text -> Text -> Text -> StackResourceDriftStatus -> UTCTime -> StackResourceDrift
- data StackResourceDriftInformation = StackResourceDriftInformation' (Maybe ISO8601) StackResourceDriftStatus
- newStackResourceDriftInformation :: StackResourceDriftStatus -> StackResourceDriftInformation
- data StackResourceDriftInformationSummary = StackResourceDriftInformationSummary' (Maybe ISO8601) StackResourceDriftStatus
- newStackResourceDriftInformationSummary :: StackResourceDriftStatus -> StackResourceDriftInformationSummary
- data StackResourceSummary = StackResourceSummary' (Maybe StackResourceDriftInformationSummary) (Maybe ModuleInfo) (Maybe Text) (Maybe Text) Text Text ISO8601 ResourceStatus
- newStackResourceSummary :: Text -> Text -> UTCTime -> ResourceStatus -> StackResourceSummary
- data StackSet = StackSet' (Maybe Text) (Maybe AutoDeployment) (Maybe [Capability]) (Maybe Text) (Maybe Text) (Maybe ManagedExecution) (Maybe [Text]) (Maybe [Parameter]) (Maybe PermissionModels) (Maybe Text) (Maybe StackSetDriftDetectionDetails) (Maybe Text) (Maybe Text) (Maybe StackSetStatus) (Maybe [Tag]) (Maybe Text)
- newStackSet :: StackSet
- data StackSetDriftDetectionDetails = StackSetDriftDetectionDetails' (Maybe StackSetDriftDetectionStatus) (Maybe StackSetDriftStatus) (Maybe Natural) (Maybe Natural) (Maybe Natural) (Maybe Natural) (Maybe ISO8601) (Maybe Natural)
- newStackSetDriftDetectionDetails :: StackSetDriftDetectionDetails
- data StackSetOperation = StackSetOperation' (Maybe StackSetOperationAction) (Maybe Text) (Maybe ISO8601) (Maybe DeploymentTargets) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe StackSetOperationPreferences) (Maybe Bool) (Maybe StackSetDriftDetectionDetails) (Maybe Text) (Maybe StackSetOperationStatus) (Maybe StackSetOperationStatusDetails) (Maybe Text)
- newStackSetOperation :: StackSetOperation
- data StackSetOperationPreferences = StackSetOperationPreferences' (Maybe Natural) (Maybe Natural) (Maybe Natural) (Maybe Natural) (Maybe RegionConcurrencyType) (Maybe [Text])
- newStackSetOperationPreferences :: StackSetOperationPreferences
- data StackSetOperationResultSummary = StackSetOperationResultSummary' (Maybe Text) (Maybe AccountGateResult) (Maybe Text) (Maybe Text) (Maybe StackSetOperationResultStatus) (Maybe Text)
- newStackSetOperationResultSummary :: StackSetOperationResultSummary
- data StackSetOperationStatusDetails = StackSetOperationStatusDetails' (Maybe Natural)
- newStackSetOperationStatusDetails :: StackSetOperationStatusDetails
- data StackSetOperationSummary = StackSetOperationSummary' (Maybe StackSetOperationAction) (Maybe ISO8601) (Maybe ISO8601) (Maybe Text) (Maybe StackSetOperationPreferences) (Maybe StackSetOperationStatus) (Maybe StackSetOperationStatusDetails) (Maybe Text)
- newStackSetOperationSummary :: StackSetOperationSummary
- data StackSetSummary = StackSetSummary' (Maybe AutoDeployment) (Maybe Text) (Maybe StackDriftStatus) (Maybe ISO8601) (Maybe ManagedExecution) (Maybe PermissionModels) (Maybe Text) (Maybe Text) (Maybe StackSetStatus)
- newStackSetSummary :: StackSetSummary
- data StackSummary = StackSummary' (Maybe ISO8601) (Maybe StackDriftInformationSummary) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text ISO8601 StackStatus
- newStackSummary :: Text -> UTCTime -> StackStatus -> StackSummary
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
- data TemplateParameter = TemplateParameter' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text)
- newTemplateParameter :: TemplateParameter
- data TypeConfigurationDetails = TypeConfigurationDetails' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe ISO8601) (Maybe Text) (Maybe Text)
- newTypeConfigurationDetails :: TypeConfigurationDetails
- data TypeConfigurationIdentifier = TypeConfigurationIdentifier' (Maybe ThirdPartyType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newTypeConfigurationIdentifier :: TypeConfigurationIdentifier
- data TypeFilters = TypeFilters' (Maybe Category) (Maybe Text) (Maybe Text)
- newTypeFilters :: TypeFilters
- data TypeSummary = TypeSummary' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe IdentityProvider) (Maybe Text) (Maybe RegistryType) (Maybe Text) (Maybe Text)
- newTypeSummary :: TypeSummary
- data TypeVersionSummary = TypeVersionSummary' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe ISO8601) (Maybe RegistryType) (Maybe Text) (Maybe Text)
- newTypeVersionSummary :: TypeVersionSummary
Service Configuration
defaultService :: 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.
AlreadyExistsException
_AlreadyExistsException :: AsError a => Fold a ServiceError Source #
The resource with the name requested already exists.
CFNRegistryException
_CFNRegistryException :: AsError a => Fold a ServiceError Source #
An error occurred during a CloudFormation registry operation.
ChangeSetNotFoundException
_ChangeSetNotFoundException :: AsError a => Fold a ServiceError Source #
The specified change set name or ID doesn't exit. To view valid change
sets for a stack, use the ListChangeSets operation.
CreatedButModifiedException
_CreatedButModifiedException :: AsError a => Fold a ServiceError Source #
The specified resource exists, but has been changed.
InsufficientCapabilitiesException
_InsufficientCapabilitiesException :: AsError a => Fold a ServiceError Source #
The template contains resources with capabilities that weren't specified in the Capabilities parameter.
InvalidChangeSetStatusException
_InvalidChangeSetStatusException :: AsError a => Fold a ServiceError Source #
The specified change set can't 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.
InvalidOperationException
_InvalidOperationException :: AsError a => Fold a ServiceError Source #
The specified operation isn't valid.
InvalidStateTransitionException
_InvalidStateTransitionException :: AsError a => Fold a ServiceError Source #
Error reserved for use by the CloudFormation CLI. CloudFormation doesn't return this error to users.
LimitExceededException
_LimitExceededException :: AsError a => Fold a ServiceError Source #
The quota for the resource has already been reached.
For information about resource and stack limitations, see CloudFormation quotas in the CloudFormation User Guide.
NameAlreadyExistsException
_NameAlreadyExistsException :: AsError a => Fold a ServiceError Source #
The specified name is already in use.
OperationIdAlreadyExistsException
_OperationIdAlreadyExistsException :: AsError a => Fold a ServiceError Source #
The specified operation ID already exists.
OperationInProgressException
_OperationInProgressException :: AsError a => Fold a ServiceError Source #
Another operation is currently in progress for this stack set. Only one operation can be performed for a stack set at a given time.
OperationNotFoundException
_OperationNotFoundException :: AsError a => Fold a ServiceError Source #
The specified ID refers to an operation that doesn't exist.
OperationStatusCheckFailedException
_OperationStatusCheckFailedException :: AsError a => Fold a ServiceError Source #
Error reserved for use by the CloudFormation CLI. CloudFormation doesn't return this error to users.
StackInstanceNotFoundException
_StackInstanceNotFoundException :: AsError a => Fold a ServiceError Source #
The specified stack instance doesn't exist.
StackNotFoundException
_StackNotFoundException :: AsError a => Fold a ServiceError Source #
The specified stack ARN doesn't exist or stack doesn't exist corresponding to the ARN in input.
StackSetNotEmptyException
_StackSetNotEmptyException :: AsError a => Fold a ServiceError Source #
You can't yet delete this stack set, because it still contains one or more stack instances. Delete all stack instances from the stack set before deleting the stack set.
StackSetNotFoundException
_StackSetNotFoundException :: AsError a => Fold a ServiceError Source #
The specified stack set doesn't exist.
StaleRequestException
_StaleRequestException :: AsError a => Fold a ServiceError Source #
Another operation has been performed on this stack set since the specified operation was performed.
TokenAlreadyExistsException
_TokenAlreadyExistsException :: AsError a => Fold a ServiceError Source #
A client request token already exists.
TypeConfigurationNotFoundException
_TypeConfigurationNotFoundException :: AsError a => Fold a ServiceError Source #
The specified extension configuration can't be found.
TypeNotFoundException
_TypeNotFoundException :: AsError a => Fold a ServiceError Source #
The specified extension doesn't exist in the CloudFormation registry.
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.
ChangeSetCreateComplete
newChangeSetCreateComplete :: Wait DescribeChangeSet Source #
Polls DescribeChangeSet every 30 seconds until a successful state is reached. An error is returned after 120 failed checks.
StackCreateComplete
newStackCreateComplete :: Wait DescribeStacks Source #
Polls DescribeStacks every 30 seconds until a successful state is reached. An error is returned after 120 failed checks.
StackDeleteComplete
newStackDeleteComplete :: Wait DescribeStacks Source #
Polls DescribeStacks every 30 seconds until a successful state is reached. An error is returned after 120 failed checks.
StackExists
newStackExists :: Wait DescribeStacks Source #
Polls DescribeStacks every 5 seconds until a successful state is reached. An error is returned after 20 failed checks.
StackImportComplete
newStackImportComplete :: Wait DescribeStacks Source #
Polls DescribeStacks every 30 seconds until a successful state is reached. An error is returned after 120 failed checks.
StackRollbackComplete
newStackRollbackComplete :: Wait DescribeStacks Source #
Polls DescribeStacks every 30 seconds until a successful state is reached. An error is returned after 120 failed checks.
StackUpdateComplete
newStackUpdateComplete :: Wait DescribeStacks Source #
Polls DescribeStacks every 30 seconds until a successful state is reached. An error is returned after 120 failed checks.
TypeRegistrationComplete
newTypeRegistrationComplete :: Wait DescribeTypeRegistration Source #
Polls DescribeTypeRegistration 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.
ActivateType
data ActivateType Source #
See: newActivateType smart constructor.
Constructors
| ActivateType' (Maybe Bool) (Maybe Text) (Maybe LoggingConfig) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe ThirdPartyType) (Maybe Text) (Maybe Text) (Maybe VersionBump) |
Instances
newActivateType :: ActivateType Source #
Create a value of ActivateType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:autoUpdate:ActivateType', activateType_autoUpdate - Whether to automatically update the extension in this account and region
when a new minor version is published by the extension publisher.
Major versions released by the publisher must be manually updated.
The default is true.
$sel:executionRoleArn:ActivateType', activateType_executionRoleArn - The name of the IAM execution role to use to activate the extension.
$sel:loggingConfig:ActivateType', activateType_loggingConfig - Undocumented member.
$sel:majorVersion:ActivateType', activateType_majorVersion - The major version of this extension you want to activate, if multiple
major versions are available. The default is the latest major version.
CloudFormation uses the latest available minor version of the major
version selected.
You can specify MajorVersion or VersionBump, but not both.
$sel:publicTypeArn:ActivateType', activateType_publicTypeArn - The Amazon Resource Name (ARN) of the public extension.
Conditional: You must specify PublicTypeArn, or TypeName, Type,
and PublisherId.
ActivateType, activateType_publisherId - The ID of the extension publisher.
Conditional: You must specify PublicTypeArn, or TypeName, Type,
and PublisherId.
ActivateType, activateType_type - The extension type.
Conditional: You must specify PublicTypeArn, or TypeName, Type,
and PublisherId.
ActivateType, activateType_typeName - The name of the extension.
Conditional: You must specify PublicTypeArn, or TypeName, Type,
and PublisherId.
ActivateType, activateType_typeNameAlias - An alias to assign to the public extension, in this account and region.
If you specify an alias for the extension, CloudFormation treats the
alias as the extension type name within this account and region. You
must use the alias to refer to the extension in your templates, API
calls, and CloudFormation console.
An extension alias must be unique within a given account and region. You can activate the same public resource multiple times in the same account and region, using different type name aliases.
$sel:versionBump:ActivateType', activateType_versionBump - Manually updates a previously-activated type to a new major or minor
version, if available. You can also use this parameter to update the
value of AutoUpdate.
MAJOR: CloudFormation updates the extension to the newest major version, if one is available.MINOR: CloudFormation updates the extension to the newest minor version, if one is available.
data ActivateTypeResponse Source #
See: newActivateTypeResponse smart constructor.
Constructors
| ActivateTypeResponse' (Maybe Text) Int |
Instances
newActivateTypeResponse Source #
Arguments
| :: Int | |
| -> ActivateTypeResponse |
Create a value of ActivateTypeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ActivateTypeResponse, activateTypeResponse_arn - The Amazon Resource Name (ARN) of the activated extension, in this
account and region.
$sel:httpStatus:ActivateTypeResponse', activateTypeResponse_httpStatus - The response's http status code.
BatchDescribeTypeConfigurations
data BatchDescribeTypeConfigurations Source #
See: newBatchDescribeTypeConfigurations smart constructor.
Instances
newBatchDescribeTypeConfigurations Source #
Arguments
| :: NonEmpty TypeConfigurationIdentifier |
|
| -> BatchDescribeTypeConfigurations |
Create a value of BatchDescribeTypeConfigurations with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:typeConfigurationIdentifiers:BatchDescribeTypeConfigurations', batchDescribeTypeConfigurations_typeConfigurationIdentifiers - The list of identifiers for the desired extension configurations.
data BatchDescribeTypeConfigurationsResponse Source #
See: newBatchDescribeTypeConfigurationsResponse smart constructor.
Constructors
| BatchDescribeTypeConfigurationsResponse' (Maybe [BatchDescribeTypeConfigurationsError]) (Maybe [TypeConfigurationDetails]) (Maybe [TypeConfigurationIdentifier]) Int |
Instances
newBatchDescribeTypeConfigurationsResponse Source #
Arguments
| :: Int | |
| -> BatchDescribeTypeConfigurationsResponse |
Create a value of BatchDescribeTypeConfigurationsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errors:BatchDescribeTypeConfigurationsResponse', batchDescribeTypeConfigurationsResponse_errors - A list of information concerning any errors generated during the setting
of the specified configurations.
$sel:typeConfigurations:BatchDescribeTypeConfigurationsResponse', batchDescribeTypeConfigurationsResponse_typeConfigurations - A list of any of the specified extension configurations from the
CloudFormation registry.
$sel:unprocessedTypeConfigurations:BatchDescribeTypeConfigurationsResponse', batchDescribeTypeConfigurationsResponse_unprocessedTypeConfigurations - A list of any of the specified extension configurations that
CloudFormation could not process for any reason.
$sel:httpStatus:BatchDescribeTypeConfigurationsResponse', batchDescribeTypeConfigurationsResponse_httpStatus - The response's http status code.
CancelUpdateStack
data CancelUpdateStack Source #
The input for the CancelUpdateStack action.
See: newCancelUpdateStack smart constructor.
Constructors
| CancelUpdateStack' (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> CancelUpdateStack |
Create a value of CancelUpdateStack with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CancelUpdateStack, cancelUpdateStack_clientRequestToken - A unique identifier for this CancelUpdateStack request. Specify this
token if you plan to retry requests so that CloudFormation knows that
you're not attempting to cancel an update on a stack with the same
name. You might retry CancelUpdateStack requests to ensure that
CloudFormation successfully received them.
CancelUpdateStack, cancelUpdateStack_stackName - The name or the unique stack ID that's associated with the stack.
data CancelUpdateStackResponse Source #
See: newCancelUpdateStackResponse smart constructor.
Constructors
| CancelUpdateStackResponse' | |
Instances
newCancelUpdateStackResponse :: CancelUpdateStackResponse Source #
Create a value of CancelUpdateStackResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ContinueUpdateRollback
data ContinueUpdateRollback Source #
The input for the ContinueUpdateRollback action.
See: newContinueUpdateRollback smart constructor.
Instances
newContinueUpdateRollback Source #
Arguments
| :: Text | |
| -> ContinueUpdateRollback |
Create a value of ContinueUpdateRollback with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ContinueUpdateRollback, continueUpdateRollback_clientRequestToken - A unique identifier for this ContinueUpdateRollback request. Specify
this token if you plan to retry requests so that CloudFormationknows
that you're not attempting to continue the rollback to a stack with the
same name. You might retry ContinueUpdateRollback requests to ensure
that CloudFormation successfully received them.
$sel:resourcesToSkip:ContinueUpdateRollback', continueUpdateRollback_resourcesToSkip - A list of the logical IDs of the resources that CloudFormation skips
during the continue update rollback operation. You can specify only
resources that are in the UPDATE_FAILED state because a rollback
failed. You can't specify resources that are in the UPDATE_FAILED
state for other reasons, for example, because an update was canceled. To
check why a resource update failed, use the DescribeStackResources
action, and view the resource status reason.
Specify this property to skip rolling back resources that CloudFormation
can't successfully roll back. We recommend that you
troubleshoot
resources before skipping them. CloudFormation sets the status of the
specified resources to UPDATE_COMPLETE and continues to roll back the
stack. After the rollback is complete, the state of the skipped
resources will be inconsistent with the state of the resources in the
stack template. Before performing another stack update, you must update
the stack or resources to be consistent with each other. If you don't,
subsequent stack updates might fail, and the stack will become
unrecoverable.
Specify the minimum number of resources required to successfully roll back your stack. For example, a failed resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the dependent resources.
To skip resources that are part of nested stacks, use the following
format: NestedStackName.ResourceLogicalID. If you want to specify the
logical ID of a stack resource (Type: AWS::CloudFormation::Stack) in
the ResourcesToSkip list, then its corresponding embedded stack must
be in one of the following states: DELETE_IN_PROGRESS,
DELETE_COMPLETE, or DELETE_FAILED.
Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an example of a continue update rollback operation with nested stacks, see Using ResourcesToSkip to recover a nested stacks hierarchy.
ContinueUpdateRollback, continueUpdateRollback_roleARN - The Amazon Resource Name (ARN) of an Identity and Access Management
(IAM) role that CloudFormation assumes to roll back the stack.
CloudFormation uses the role's credentials to make calls on your
behalf. CloudFormation always uses this role for all future operations
on the stack. Provided that users have permission to operate on the
stack, CloudFormation uses this role even if the users don't have
permission to pass it. Ensure that the role grants least permission.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.
ContinueUpdateRollback, continueUpdateRollback_stackName - The name or the unique ID of the stack that you want to continue rolling
back.
Don't specify the name of a nested stack (a stack that was created by
using the AWS::CloudFormation::Stack resource). Instead, use this
operation on the parent stack (the stack that contains the
AWS::CloudFormation::Stack resource).
data ContinueUpdateRollbackResponse Source #
The output for a ContinueUpdateRollback operation.
See: newContinueUpdateRollbackResponse smart constructor.
Constructors
| ContinueUpdateRollbackResponse' Int |
Instances
newContinueUpdateRollbackResponse Source #
Create a value of ContinueUpdateRollbackResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:ContinueUpdateRollbackResponse', continueUpdateRollbackResponse_httpStatus - The response's http status code.
CreateChangeSet
data CreateChangeSet Source #
The input for the CreateChangeSet action.
See: newCreateChangeSet smart constructor.
Constructors
| CreateChangeSet' (Maybe [Capability]) (Maybe ChangeSetType) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe [Parameter]) (Maybe [Text]) (Maybe [ResourceToImport]) (Maybe Text) (Maybe RollbackConfiguration) (Maybe [Tag]) (Maybe Text) (Maybe Text) (Maybe Bool) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CreateChangeSet |
Create a value of CreateChangeSet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateChangeSet, createChangeSet_capabilities - In some cases, you must explicitly acknowledge that your stack template
contains certain capabilities in order for CloudFormation to create the
stack.
CAPABILITY_IAMandCAPABILITY_NAMED_IAMSome stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the
CAPABILITY_IAMorCAPABILITY_NAMED_IAMcapability.- If you have IAM resources, you can specify either capability.
- If you have IAM resources with custom names, you must specify
CAPABILITY_NAMED_IAM. - If you don't specify either of these capabilities,
CloudFormation returns an
InsufficientCapabilitieserror.
If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.
- AWS::IAM::AccessKey
- AWS::IAM::Group
- AWS::IAM::InstanceProfile
- AWS::IAM::Policy
- AWS::IAM::Role
- AWS::IAM::User
- AWS::IAM::UserToGroupAddition
For more information, see Acknowledging IAM resources in CloudFormation templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no effect.
If you want to create a stack from a stack template that contains macros and nested stacks, you must create or update the stack directly from the template using the CreateStack or UpdateStack action, and specifying this capability.
For more information about macros, see Using CloudFormation macros to perform custom processing on templates.
$sel:changeSetType:CreateChangeSet', createChangeSet_changeSetType - The type of change set operation. To create a change set for a new
stack, specify CREATE. To create a change set for an existing stack,
specify UPDATE. To create a change set for an import operation,
specify IMPORT.
If you create a change set for a new stack, CloudFormation creates a stack with a unique stack ID, but no template or resources. The stack will be in the REVIEW_IN_PROGRESS state until you execute the change set.
By default, CloudFormation specifies UPDATE. You can't use the
UPDATE type to create a change set for a new stack or the CREATE
type to create a change set for an existing stack.
$sel:clientToken:CreateChangeSet', createChangeSet_clientToken - A unique identifier for this CreateChangeSet request. Specify this
token if you plan to retry requests so that CloudFormation knows that
you're not attempting to create another change set with the same name.
You might retry CreateChangeSet requests to ensure that CloudFormation
successfully received them.
CreateChangeSet, createChangeSet_description - A description to help you identify this change set.
CreateChangeSet, createChangeSet_includeNestedStacks - Creates a change set for the all nested stacks specified in the
template. The default behavior of this action is set to False. To
include nested sets in a change set, specify True.
CreateChangeSet, createChangeSet_notificationARNs - The Amazon Resource Names (ARNs) of Amazon Simple Notification Service
(Amazon SNS) topics that CloudFormation associates with the stack. To
remove all associated notification topics, specify an empty list.
CreateChangeSet, createChangeSet_parameters - A list of Parameter structures that specify input parameters for the
change set. For more information, see the Parameter data type.
$sel:resourceTypes:CreateChangeSet', createChangeSet_resourceTypes - The template resource types that you have permissions to work with if
you execute this change set, such as AWS::EC2::Instance,
AWS::EC2::*, or Custom::MyCustomInstance.
If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for CloudFormation. For more information, see Controlling access with Identity and Access Management in the CloudFormation User Guide.
$sel:resourcesToImport:CreateChangeSet', createChangeSet_resourcesToImport - The resources to import into your stack.
CreateChangeSet, createChangeSet_roleARN - The Amazon Resource Name (ARN) of an Identity and Access Management
(IAM) role that CloudFormation assumes when executing the change set.
CloudFormation uses the role's credentials to make calls on your
behalf. CloudFormation uses this role for all future operations on the
stack. Provided that users have permission to operate on the stack,
CloudFormation uses this role even if the users don't have permission
to pass it. Ensure that the role grants least permission.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.
CreateChangeSet, createChangeSet_rollbackConfiguration - The rollback triggers for CloudFormation to monitor during stack
creation and updating operations, and for the specified monitoring
period afterwards.
CreateChangeSet, createChangeSet_tags - Key-value pairs to associate with this stack. CloudFormation also
propagates these tags to resources in the stack. You can specify a
maximum of 50 tags.
CreateChangeSet, createChangeSet_templateBody - A structure that contains the body of the revised template, with a
minimum length of 1 byte and a maximum length of 51,200 bytes.
CloudFormation generates the change set by comparing this template with
the template of the stack that you specified.
Conditional: You must specify only TemplateBody or TemplateURL.
$sel:templateURL:CreateChangeSet', createChangeSet_templateURL - The location of the file that contains the revised template. The URL
must point to a template (max size: 460,800 bytes) that's located in an
Amazon S3 bucket or a Systems Manager document. CloudFormation generates
the change set by comparing this template with the stack that you
specified.
Conditional: You must specify only TemplateBody or TemplateURL.
$sel:usePreviousTemplate:CreateChangeSet', createChangeSet_usePreviousTemplate - Whether to reuse the template that's associated with the stack to
create the change set.
CreateChangeSet, createChangeSet_stackName - The name or the unique ID of the stack for which you are creating a
change set. CloudFormation generates the change set by comparing this
stack's information with the information that you submit, such as a
modified template or different parameter input values.
CreateChangeSet, createChangeSet_changeSetName - The name of the change set. The name must be unique among all change
sets that are associated with the specified stack.
A change set name can contain only alphanumeric, case sensitive characters, and hyphens. It must start with an alphabetical character and can't exceed 128 characters.
data CreateChangeSetResponse Source #
The output for the CreateChangeSet action.
See: newCreateChangeSetResponse smart constructor.
Instances
newCreateChangeSetResponse Source #
Create a value of CreateChangeSetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:CreateChangeSetResponse', createChangeSetResponse_id - The Amazon Resource Name (ARN) of the change set.
CreateChangeSetResponse, createChangeSetResponse_stackId - The unique ID of the stack.
$sel:httpStatus:CreateChangeSetResponse', createChangeSetResponse_httpStatus - The response's http status code.
CreateStack
data CreateStack Source #
The input for CreateStack action.
See: newCreateStack smart constructor.
Constructors
| CreateStack' (Maybe [Capability]) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe [Text]) (Maybe OnFailure) (Maybe [Parameter]) (Maybe [Text]) (Maybe Text) (Maybe RollbackConfiguration) (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe Text) (Maybe Text) (Maybe Natural) Text |
Instances
Arguments
| :: Text | |
| -> CreateStack |
Create a value of CreateStack with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateStack, createStack_capabilities - In some cases, you must explicitly acknowledge that your stack template
contains certain capabilities in order for CloudFormation to create the
stack.
CAPABILITY_IAMandCAPABILITY_NAMED_IAMSome stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the
CAPABILITY_IAMorCAPABILITY_NAMED_IAMcapability.- If you have IAM resources, you can specify either capability.
- If you have IAM resources with custom names, you must specify
CAPABILITY_NAMED_IAM. - If you don't specify either of these capabilities,
CloudFormation returns an
InsufficientCapabilitieserror.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
- AWS::IAM::AccessKey
- AWS::IAM::Group
- AWS::IAM::InstanceProfile
- AWS::IAM::Policy
- AWS::IAM::Role
- AWS::IAM::User
- AWS::IAM::UserToGroupAddition
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability.
You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.
For more information, see Using CloudFormation macros to perform custom processing on templates.
CreateStack, createStack_clientRequestToken - A unique identifier for this CreateStack request. Specify this token
if you plan to retry requests so that CloudFormation knows that you're
not attempting to create a stack with the same name. You might retry
CreateStack requests to ensure that CloudFormation successfully
received them.
All events initiated by a given stack operation are assigned the same
client request token, which you can use to track operations. For
example, if you execute a CreateStack operation with the token
token1, then all the StackEvents generated by that operation will
have ClientRequestToken set as token1.
In the console, stack operations display the client request token on the
Events tab. Stack operations that are initiated from the console use the
token format Console-StackOperation-ID, which helps you easily
identify the stack operation . For example, if you create a stack using
the console, each stack event would be assigned the same token in the
following format:
Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
CreateStack, createStack_disableRollback - Set to true to disable rollback of the stack if stack creation failed.
You can specify either DisableRollback or OnFailure, but not both.
Default: false
CreateStack, createStack_enableTerminationProtection - Whether to enable termination protection on the specified stack. If a
user attempts to delete a stack with termination protection enabled, the
operation fails and the stack remains unchanged. For more information,
see
Protecting a Stack From Being Deleted
in the CloudFormation User Guide. Termination protection is
deactivated on stacks by default.
For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack.
CreateStack, createStack_notificationARNs - The Amazon Simple Notification Service (Amazon SNS) topic ARNs to
publish stack related events. You can find your Amazon SNS topic ARNs
using the Amazon SNS console or your Command Line Interface (CLI).
$sel:onFailure:CreateStack', createStack_onFailure - Determines what action will be taken if stack creation fails. This must
be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either
OnFailure or DisableRollback, but not both.
Default: ROLLBACK
CreateStack, createStack_parameters - A list of Parameter structures that specify input parameters for the
stack. For more information, see the
Parameter
data type.
$sel:resourceTypes:CreateStack', createStack_resourceTypes - The template resource types that you have permissions to work with for
this create stack action, such as AWS::EC2::Instance, AWS::EC2::*,
or Custom::MyCustomInstance. Use the following syntax to describe
template resource types: AWS::* (for all Amazon Web Services
resources), Custom::* (for all custom resources),
Custom::logical_ID (for a specific custom resource),
AWS::service_name::* (for all resources of a particular Amazon
Web Services service), and
AWS::service_name::resource_logical_ID (for a specific
Amazon Web Services resource).
If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.
CreateStack, createStack_roleARN - The Amazon Resource Name (ARN) of an Identity and Access Management
(IAM) role that CloudFormation assumes to create the stack.
CloudFormation uses the role's credentials to make calls on your
behalf. CloudFormation always uses this role for all future operations
on the stack. Provided that users have permission to operate on the
stack, CloudFormation uses this role even if the users don't have
permission to pass it. Ensure that the role grants least privilege.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.
CreateStack, createStack_rollbackConfiguration - The rollback triggers for CloudFormation to monitor during stack
creation and updating operations, and for the specified monitoring
period afterwards.
$sel:stackPolicyBody:CreateStack', createStack_stackPolicyBody - Structure containing the stack policy body. For more information, go to
Prevent Updates to Stack Resources
in the CloudFormation User Guide. You can specify either the
StackPolicyBody or the StackPolicyURL parameter, but not both.
$sel:stackPolicyURL:CreateStack', createStack_stackPolicyURL - Location of a file containing the stack policy. The URL must point to a
policy (maximum size: 16 KB) located in an S3 bucket in the same Region
as the stack. You can specify either the StackPolicyBody or the
StackPolicyURL parameter, but not both.
CreateStack, createStack_tags - Key-value pairs to associate with this stack. CloudFormation also
propagates these tags to the resources created in the stack. A maximum
number of 50 tags can be specified.
CreateStack, createStack_templateBody - Structure containing the template body with a minimum length of 1 byte
and a maximum length of 51,200 bytes. For more information, go to
Template anatomy
in the CloudFormation User Guide.
Conditional: You must specify either the TemplateBody or the
TemplateURL parameter, but not both.
$sel:templateURL:CreateStack', createStack_templateURL - Location of file containing the template body. The URL must point to a
template (max size: 460,800 bytes) that's located in an Amazon S3
bucket or a Systems Manager document. For more information, go to the
Template anatomy
in the CloudFormation User Guide.
Conditional: You must specify either the TemplateBody or the
TemplateURL parameter, but not both.
CreateStack, createStack_timeoutInMinutes - The amount of time that can pass before the stack status becomes
CREATE_FAILED; if DisableRollback is not set or is set to false, the
stack will be rolled back.
CreateStack, createStack_stackName - The name that's associated with the stack. The name must be unique in
the Region in which you are creating the stack.
A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an alphabetical character and can't be longer than 128 characters.
data CreateStackResponse Source #
The output for a CreateStack action.
See: newCreateStackResponse smart constructor.
Constructors
| CreateStackResponse' (Maybe Text) Int |
Instances
newCreateStackResponse Source #
Arguments
| :: Int | |
| -> CreateStackResponse |
Create a value of CreateStackResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateStackResponse, createStackResponse_stackId - Unique identifier of the stack.
$sel:httpStatus:CreateStackResponse', createStackResponse_httpStatus - The response's http status code.
CreateStackInstances
data CreateStackInstances Source #
See: newCreateStackInstances smart constructor.
Constructors
| CreateStackInstances' (Maybe [Text]) (Maybe CallAs) (Maybe DeploymentTargets) (Maybe Text) (Maybe StackSetOperationPreferences) (Maybe [Parameter]) Text [Text] |
Instances
newCreateStackInstances Source #
Arguments
| :: Text | |
| -> CreateStackInstances |
Create a value of CreateStackInstances with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateStackInstances, createStackInstances_accounts - [Self-managed permissions] The names of one or more Amazon Web Services
accounts that you want to create stack instances in the specified
Region(s) for.
You can specify Accounts or DeploymentTargets, but not both.
$sel:callAs:CreateStackInstances', createStackInstances_callAs - [Service-managed permissions] Specifies whether you are acting as an
account administrator in the organization's management account or as a
delegated administrator in a member account.
By default, SELF is specified. Use SELF for stack sets with
self-managed permissions.
- If you are signed in to the management account, specify
SELF. If you are signed in to a delegated administrator account, specify
DELEGATED_ADMIN.Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
CreateStackInstances, createStackInstances_deploymentTargets - [Service-managed permissions] The Organizations accounts for which to
create stack instances in the specified Amazon Web Services Regions.
You can specify Accounts or DeploymentTargets, but not both.
CreateStackInstances, createStackInstances_operationId - The unique identifier for this stack set operation.
The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.
If you don't specify an operation ID, the SDK generates one automatically.
Repeating this stack set operation with a new operation ID retries all
stack instances whose status is OUTDATED.
CreateStackInstances, createStackInstances_operationPreferences - Preferences for how CloudFormation performs this stack set operation.
CreateStackInstances, createStackInstances_parameterOverrides - A list of stack set parameters whose values you want to override in the
selected stack instances.
Any overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance operations:
- To override the current value for a parameter, include the parameter and specify its value.
- To leave an overridden parameter set to its present value, include
the parameter and specify
UsePreviousValueastrue. (You can't specify both a value and setUsePreviousValuetotrue.) - To set an overridden parameter back to the value specified in the stack set, specify a parameter list but don't include the parameter in the list.
- To leave all parameters set to their present values, don't specify this property at all.
During stack set updates, any parameter values overridden for a stack instance aren't updated, but retain their overridden value.
You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template.
CreateStackInstances, createStackInstances_stackSetName - The name or unique ID of the stack set that you want to create stack
instances from.
$sel:regions:CreateStackInstances', createStackInstances_regions - The names of one or more Amazon Web Services Regions where you want to
create stack instances using the specified Amazon Web Services accounts.
data CreateStackInstancesResponse Source #
See: newCreateStackInstancesResponse smart constructor.
Constructors
| CreateStackInstancesResponse' (Maybe Text) Int |
Instances
newCreateStackInstancesResponse Source #
Create a value of CreateStackInstancesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateStackInstances, createStackInstancesResponse_operationId - The unique identifier for this stack set operation.
$sel:httpStatus:CreateStackInstancesResponse', createStackInstancesResponse_httpStatus - The response's http status code.
CreateStackSet
data CreateStackSet Source #
See: newCreateStackSet smart constructor.
Constructors
| CreateStackSet' (Maybe Text) (Maybe AutoDeployment) (Maybe CallAs) (Maybe [Capability]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ManagedExecution) (Maybe [Parameter]) (Maybe PermissionModels) (Maybe Text) (Maybe [Tag]) (Maybe Text) (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> CreateStackSet |
Create a value of CreateStackSet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateStackSet, createStackSet_administrationRoleARN - The Amazon Resource Name (ARN) of the IAM role to use to create this
stack set.
Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the CloudFormation User Guide.
CreateStackSet, createStackSet_autoDeployment - Describes whether StackSets automatically deploys to Organizations
accounts that are added to the target organization or organizational
unit (OU). Specify only if PermissionModel is SERVICE_MANAGED.
$sel:callAs:CreateStackSet', createStackSet_callAs - [Service-managed permissions] Specifies whether you are acting as an
account administrator in the organization's management account or as a
delegated administrator in a member account.
By default, SELF is specified. Use SELF for stack sets with
self-managed permissions.
- To create a stack set with service-managed permissions while signed
in to the management account, specify
SELF. To create a stack set with service-managed permissions while signed in to a delegated administrator account, specify
DELEGATED_ADMIN.Your Amazon Web Services account must be registered as a delegated admin in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators.
CreateStackSet, createStackSet_capabilities - In some cases, you must explicitly acknowledge that your stack set
template contains certain capabilities in order for CloudFormation to
create the stack set and related stack instances.
CAPABILITY_IAMandCAPABILITY_NAMED_IAMSome stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the
CAPABILITY_IAMorCAPABILITY_NAMED_IAMcapability.- If you have IAM resources, you can specify either capability.
- If you have IAM resources with custom names, you must specify
CAPABILITY_NAMED_IAM. - If you don't specify either of these capabilities,
CloudFormation returns an
InsufficientCapabilitieserror.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
- AWS::IAM::AccessKey
- AWS::IAM::Group
- AWS::IAM::InstanceProfile
- AWS::IAM::Policy
- AWS::IAM::Role
- AWS::IAM::User
- AWS::IAM::UserToGroupAddition
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some templates reference macros. If your stack set template references one or more macros, you must create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
Stack sets with service-managed permissions don't currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.
CreateStackSet, createStackSet_clientRequestToken - A unique identifier for this CreateStackSet request. Specify this
token if you plan to retry requests so that CloudFormation knows that
you're not attempting to create another stack set with the same name.
You might retry CreateStackSet requests to ensure that CloudFormation
successfully received them.
If you don't specify an operation ID, the SDK generates one automatically.
CreateStackSet, createStackSet_description - A description of the stack set. You can use the description to identify
the stack set's purpose or other important information.
CreateStackSet, createStackSet_executionRoleName - The name of the IAM execution role to use to create the stack set. If
you do not specify an execution role, CloudFormation uses the
AWSCloudFormationStackSetExecutionRole role for the stack set
operation.
Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.
CreateStackSet, createStackSet_managedExecution - Describes whether StackSets performs non-conflicting operations
concurrently and queues conflicting operations.
CreateStackSet, createStackSet_parameters - The input parameters for the stack set template.
CreateStackSet, createStackSet_permissionModel - Describes how the IAM roles required for stack set operations are
created. By default, SELF-MANAGED is specified.
- With
self-managedpermissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant Self-Managed Stack Set Permissions. - With
service-managedpermissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
CreateStackSet, createStackSet_stackId - The stack ID you are importing into a new stack set. Specify the Amazon
Resource Name (ARN) of the stack.
CreateStackSet, createStackSet_tags - The key-value pairs to associate with this stack set and the stacks
created from it. CloudFormation also propagates these tags to supported
resources that are created in the stacks. A maximum number of 50 tags
can be specified.
If you specify tags as part of a CreateStackSet action, CloudFormation
checks to see if you have the required IAM permission to tag resources.
If you don't, the entire CreateStackSet action fails with an
access denied error, and the stack set is not created.
CreateStackSet, createStackSet_templateBody - The structure that contains the template body, with a minimum length of
1 byte and a maximum length of 51,200 bytes. For more information, see
Template Anatomy
in the CloudFormation User Guide.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
$sel:templateURL:CreateStackSet', createStackSet_templateURL - The location of the file that contains the template body. The URL must
point to a template (maximum size: 460,800 bytes) that's located in an
Amazon S3 bucket or a Systems Manager document. For more information,
see
Template Anatomy
in the CloudFormation User Guide.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
CreateStackSet, createStackSet_stackSetName - The name to associate with the stack set. The name must be unique in the
Region where you create your stack set.
A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and can't be longer than 128 characters.
data CreateStackSetResponse Source #
See: newCreateStackSetResponse smart constructor.
Constructors
| CreateStackSetResponse' (Maybe Text) Int |
Instances
newCreateStackSetResponse Source #
Create a value of CreateStackSetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateStackSetResponse, createStackSetResponse_stackSetId - The ID of the stack set that you're creating.
$sel:httpStatus:CreateStackSetResponse', createStackSetResponse_httpStatus - The response's http status code.
DeactivateType
data DeactivateType Source #
See: newDeactivateType smart constructor.
Constructors
| DeactivateType' (Maybe Text) (Maybe ThirdPartyType) (Maybe Text) |
Instances
newDeactivateType :: DeactivateType Source #
Create a value of DeactivateType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeactivateType, deactivateType_arn - The Amazon Resource Name (ARN) for the extension, in this account and
region.
Conditional: You must specify either Arn, or TypeName and Type.
DeactivateType, deactivateType_type - The extension type.
Conditional: You must specify either Arn, or TypeName and Type.
DeactivateType, deactivateType_typeName - The type name of the extension, in this account and region. If you
specified a type name alias when enabling the extension, use the type
name alias.
Conditional: You must specify either Arn, or TypeName and Type.
data DeactivateTypeResponse Source #
See: newDeactivateTypeResponse smart constructor.
Constructors
| DeactivateTypeResponse' Int |
Instances
newDeactivateTypeResponse Source #
Create a value of DeactivateTypeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeactivateTypeResponse', deactivateTypeResponse_httpStatus - The response's http status code.
DeleteChangeSet
data DeleteChangeSet Source #
The input for the DeleteChangeSet action.
See: newDeleteChangeSet smart constructor.
Constructors
| DeleteChangeSet' (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> DeleteChangeSet |
Create a value of DeleteChangeSet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteChangeSet, deleteChangeSet_stackName - If you specified the name of a change set to delete, specify the stack
name or Amazon Resource Name (ARN) that's associated with it.
DeleteChangeSet, deleteChangeSet_changeSetName - The name or Amazon Resource Name (ARN) of the change set that you want
to delete.
data DeleteChangeSetResponse Source #
The output for the DeleteChangeSet action.
See: newDeleteChangeSetResponse smart constructor.
Constructors
| DeleteChangeSetResponse' Int |
Instances
newDeleteChangeSetResponse Source #
Create a value of DeleteChangeSetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteChangeSetResponse', deleteChangeSetResponse_httpStatus - The response's http status code.
DeleteStack
data DeleteStack Source #
The input for DeleteStack action.
See: newDeleteStack smart constructor.
Instances
Arguments
| :: Text | |
| -> DeleteStack |
Create a value of DeleteStack with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteStack, deleteStack_clientRequestToken - A unique identifier for this DeleteStack request. Specify this token
if you plan to retry requests so that CloudFormation knows that you're
not attempting to delete a stack with the same name. You might retry
DeleteStack requests to ensure that CloudFormation successfully
received them.
All events initiated by a given stack operation are assigned the same
client request token, which you can use to track operations. For
example, if you execute a CreateStack operation with the token
token1, then all the StackEvents generated by that operation will
have ClientRequestToken set as token1.
In the console, stack operations display the client request token on the
Events tab. Stack operations that are initiated from the console use the
token format Console-StackOperation-ID, which helps you easily
identify the stack operation . For example, if you create a stack using
the console, each stack event would be assigned the same token in the
following format:
Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
$sel:retainResources:DeleteStack', deleteStack_retainResources - For stacks in the DELETE_FAILED state, a list of resource logical IDs
that are associated with the resources you want to retain. During
deletion, CloudFormation deletes the stack but doesn't delete the
retained resources.
Retaining resources is useful when you can't delete a resource, such as a non-empty S3 bucket, but you want to delete the stack.
DeleteStack, deleteStack_roleARN - The Amazon Resource Name (ARN) of an Identity and Access Management
(IAM) role that CloudFormation assumes to delete the stack.
CloudFormation uses the role's credentials to make calls on your
behalf.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.
DeleteStack, deleteStack_stackName - The name or the unique stack ID that's associated with the stack.
data DeleteStackResponse Source #
See: newDeleteStackResponse smart constructor.
Constructors
| DeleteStackResponse' | |
Instances
newDeleteStackResponse :: DeleteStackResponse Source #
Create a value of DeleteStackResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteStackInstances
data DeleteStackInstances Source #
See: newDeleteStackInstances smart constructor.
Constructors
| DeleteStackInstances' (Maybe [Text]) (Maybe CallAs) (Maybe DeploymentTargets) (Maybe Text) (Maybe StackSetOperationPreferences) Text [Text] Bool |
Instances
newDeleteStackInstances Source #
Arguments
| :: Text | |
| -> Bool | |
| -> DeleteStackInstances |
Create a value of DeleteStackInstances with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteStackInstances, deleteStackInstances_accounts - [Self-managed permissions] The names of the Amazon Web Services accounts
that you want to delete stack instances for.
You can specify Accounts or DeploymentTargets, but not both.
$sel:callAs:DeleteStackInstances', deleteStackInstances_callAs - [Service-managed permissions] Specifies whether you are acting as an
account administrator in the organization's management account or as a
delegated administrator in a member account.
By default, SELF is specified. Use SELF for stack sets with
self-managed permissions.
- If you are signed in to the management account, specify
SELF. If you are signed in to a delegated administrator account, specify
DELEGATED_ADMIN.Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
DeleteStackInstances, deleteStackInstances_deploymentTargets - [Service-managed permissions] The Organizations accounts from which to
delete stack instances.
You can specify Accounts or DeploymentTargets, but not both.
DeleteStackInstances, deleteStackInstances_operationId - The unique identifier for this stack set operation.
If you don't specify an operation ID, the SDK generates one automatically.
The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You can retry stack set operation requests to ensure that CloudFormation successfully received them.
Repeating this stack set operation with a new operation ID retries all
stack instances whose status is OUTDATED.
DeleteStackInstances, deleteStackInstances_operationPreferences - Preferences for how CloudFormation performs this stack set operation.
DeleteStackInstances, deleteStackInstances_stackSetName - The name or unique ID of the stack set that you want to delete stack
instances for.
$sel:regions:DeleteStackInstances', deleteStackInstances_regions - The Amazon Web Services Regions where you want to delete stack set
instances.
DeleteStackInstances, deleteStackInstances_retainStacks - Removes the stack instances from the specified stack set, but doesn't
delete the stacks. You can't reassociate a retained stack or add an
existing, saved stack to a new stack set.
For more information, see Stack set operation options.
data DeleteStackInstancesResponse Source #
See: newDeleteStackInstancesResponse smart constructor.
Constructors
| DeleteStackInstancesResponse' (Maybe Text) Int |
Instances
newDeleteStackInstancesResponse Source #
Create a value of DeleteStackInstancesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteStackInstances, deleteStackInstancesResponse_operationId - The unique identifier for this stack set operation.
$sel:httpStatus:DeleteStackInstancesResponse', deleteStackInstancesResponse_httpStatus - The response's http status code.
DeleteStackSet
data DeleteStackSet Source #
See: newDeleteStackSet smart constructor.
Constructors
| DeleteStackSet' (Maybe CallAs) Text |
Instances
Arguments
| :: Text | |
| -> DeleteStackSet |
Create a value of DeleteStackSet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:callAs:DeleteStackSet', deleteStackSet_callAs - [Service-managed permissions] Specifies whether you are acting as an
account administrator in the organization's management account or as a
delegated administrator in a member account.
By default, SELF is specified. Use SELF for stack sets with
self-managed permissions.
- If you are signed in to the management account, specify
SELF. If you are signed in to a delegated administrator account, specify
DELEGATED_ADMIN.Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
DeleteStackSet, deleteStackSet_stackSetName - The name or unique ID of the stack set that you're deleting. You can
obtain this value by running ListStackSets.
data DeleteStackSetResponse Source #
See: newDeleteStackSetResponse smart constructor.
Constructors
| DeleteStackSetResponse' Int |
Instances
newDeleteStackSetResponse Source #
Create a value of DeleteStackSetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteStackSetResponse', deleteStackSetResponse_httpStatus - The response's http status code.
DeregisterType
data DeregisterType Source #
See: newDeregisterType smart constructor.
Constructors
| DeregisterType' (Maybe Text) (Maybe RegistryType) (Maybe Text) (Maybe Text) |
Instances
newDeregisterType :: DeregisterType Source #
Create a value of DeregisterType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeregisterType, deregisterType_arn - The Amazon Resource Name (ARN) of the extension.
Conditional: You must specify either TypeName and Type, or Arn.
DeregisterType, deregisterType_type - The kind of extension.
Conditional: You must specify either TypeName and Type, or Arn.
DeregisterType, deregisterType_typeName - The name of the extension.
Conditional: You must specify either TypeName and Type, or Arn.
DeregisterType, deregisterType_versionId - The ID of a specific version of the extension. The version ID is the
value at the end of the Amazon Resource Name (ARN) assigned to the
extension version when it is registered.
data DeregisterTypeResponse Source #
See: newDeregisterTypeResponse smart constructor.
Constructors
| DeregisterTypeResponse' Int |
Instances
newDeregisterTypeResponse Source #
Create a value of DeregisterTypeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeregisterTypeResponse', deregisterTypeResponse_httpStatus - The response's http status code.
DescribeAccountLimits (Paginated)
data DescribeAccountLimits Source #
The input for the DescribeAccountLimits action.
See: newDescribeAccountLimits smart constructor.
Constructors
| DescribeAccountLimits' (Maybe Text) |
Instances
newDescribeAccountLimits :: DescribeAccountLimits Source #
Create a value of DescribeAccountLimits with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeAccountLimits, describeAccountLimits_nextToken - A string that identifies the next page of limits that you want to
retrieve.
data DescribeAccountLimitsResponse Source #
The output for the DescribeAccountLimits action.
See: newDescribeAccountLimitsResponse smart constructor.
Constructors
| DescribeAccountLimitsResponse' (Maybe [AccountLimit]) (Maybe Text) Int |
Instances
newDescribeAccountLimitsResponse Source #
Create a value of DescribeAccountLimitsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountLimits:DescribeAccountLimitsResponse', describeAccountLimitsResponse_accountLimits - An account limit structure that contain a list of CloudFormation account
limits and their values.
DescribeAccountLimits, describeAccountLimitsResponse_nextToken - If the output exceeds 1 MB in size, a string that identifies the next
page of limits. If no additional page exists, this value is null.
$sel:httpStatus:DescribeAccountLimitsResponse', describeAccountLimitsResponse_httpStatus - The response's http status code.
DescribeChangeSet (Paginated)
data DescribeChangeSet Source #
The input for the DescribeChangeSet action.
See: newDescribeChangeSet smart constructor.
Instances
Arguments
| :: Text | |
| -> DescribeChangeSet |
Create a value of DescribeChangeSet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeChangeSet, describeChangeSet_nextToken - A string (provided by the DescribeChangeSet response output) that
identifies the next page of information that you want to retrieve.
DescribeChangeSet, describeChangeSet_stackName - If you specified the name of a change set, specify the stack name or ID
(ARN) of the change set you want to describe.
DescribeChangeSet, describeChangeSet_changeSetName - The name or Amazon Resource Name (ARN) of the change set that you want
to describe.
data DescribeChangeSetResponse Source #
The output for the DescribeChangeSet action.
See: newDescribeChangeSetResponse smart constructor.
Constructors
| DescribeChangeSetResponse' (Maybe [Capability]) (Maybe Text) (Maybe Text) (Maybe [Change]) (Maybe ISO8601) (Maybe Text) (Maybe ExecutionStatus) (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe [Parameter]) (Maybe Text) (Maybe RollbackConfiguration) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Tag]) Int ChangeSetStatus |
Instances
newDescribeChangeSetResponse Source #
Arguments
| :: Int | |
| -> ChangeSetStatus | |
| -> DescribeChangeSetResponse |
Create a value of DescribeChangeSetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeChangeSetResponse, describeChangeSetResponse_capabilities - If you execute the change set, the list of capabilities that were
explicitly acknowledged when the change set was created.
DescribeChangeSetResponse, describeChangeSetResponse_changeSetId - The Amazon Resource Name (ARN) of the change set.
DescribeChangeSet, describeChangeSetResponse_changeSetName - The name of the change set.
$sel:changes:DescribeChangeSetResponse', describeChangeSetResponse_changes - A list of Change structures that describes the resources
CloudFormation changes if you execute the change set.
DescribeChangeSetResponse, describeChangeSetResponse_creationTime - The start time when the change set was created, in UTC.
DescribeChangeSetResponse, describeChangeSetResponse_description - Information about the change set.
DescribeChangeSetResponse, describeChangeSetResponse_executionStatus - 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 CloudFormation is still creating it or in an OBSOLETE state
because the stack was already updated.
DescribeChangeSetResponse, describeChangeSetResponse_includeNestedStacks - Verifies if IncludeNestedStacks is set to True.
DescribeChangeSet, describeChangeSetResponse_nextToken - If the output exceeds 1 MB, a string that identifies the next page of
changes. If there is no additional page, this value is null.
DescribeChangeSetResponse, describeChangeSetResponse_notificationARNs - The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics
that will be associated with the stack if you execute the change set.
DescribeChangeSetResponse, describeChangeSetResponse_parameters - A list of Parameter structures that describes the input parameters and
their values used to create the change set. For more information, see
the
Parameter
data type.
DescribeChangeSetResponse, describeChangeSetResponse_parentChangeSetId - Specifies the change set ID of the parent change set in the current
nested change set hierarchy.
DescribeChangeSetResponse, describeChangeSetResponse_rollbackConfiguration - The rollback triggers for CloudFormation to monitor during stack
creation and updating operations, and for the specified monitoring
period afterwards.
DescribeChangeSetResponse, describeChangeSetResponse_rootChangeSetId - Specifies the change set ID of the root change set in the current nested
change set hierarchy.
DescribeChangeSetResponse, describeChangeSetResponse_stackId - The Amazon Resource Name (ARN) of the stack that's associated with the
change set.
DescribeChangeSet, describeChangeSetResponse_stackName - The name of the stack that's associated with the change set.
DescribeChangeSetResponse, describeChangeSetResponse_statusReason - A description of the change set's status. For example, if your attempt
to create a change set failed, CloudFormation shows the error message.
DescribeChangeSetResponse, describeChangeSetResponse_tags - If you execute the change set, the tags that will be associated with the
stack.
$sel:httpStatus:DescribeChangeSetResponse', describeChangeSetResponse_httpStatus - The response's http status code.
DescribeChangeSetResponse, describeChangeSetResponse_status - The current status of the change set, such as CREATE_IN_PROGRESS,
CREATE_COMPLETE, or FAILED.
DescribeChangeSetHooks
data DescribeChangeSetHooks Source #
See: newDescribeChangeSetHooks smart constructor.
Instances
newDescribeChangeSetHooks Source #
Arguments
| :: Text | |
| -> DescribeChangeSetHooks |
Create a value of DescribeChangeSetHooks with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeChangeSetHooks, describeChangeSetHooks_logicalResourceId - If specified, lists only the hooks related to the specified
LogicalResourceId.
DescribeChangeSetHooks, describeChangeSetHooks_nextToken - A string, provided by the DescribeChangeSetHooks response output, that
identifies the next page of information that you want to retrieve.
DescribeChangeSetHooks, describeChangeSetHooks_stackName - If you specified the name of a change set, specify the stack name or
stack ID (ARN) of the change set you want to describe.
DescribeChangeSetHooks, describeChangeSetHooks_changeSetName - The name or Amazon Resource Name (ARN) of the change set that you want
to describe.
data DescribeChangeSetHooksResponse Source #
See: newDescribeChangeSetHooksResponse smart constructor.
Constructors
| DescribeChangeSetHooksResponse' (Maybe Text) (Maybe Text) (Maybe [ChangeSetHook]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ChangeSetHooksStatus) Int |
Instances
newDescribeChangeSetHooksResponse Source #
Create a value of DescribeChangeSetHooksResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeChangeSetHooksResponse, describeChangeSetHooksResponse_changeSetId - The change set identifier (stack ID).
DescribeChangeSetHooks, describeChangeSetHooksResponse_changeSetName - The change set name.
$sel:hooks:DescribeChangeSetHooksResponse', describeChangeSetHooksResponse_hooks - List of hook objects.
DescribeChangeSetHooks, describeChangeSetHooksResponse_nextToken - Pagination token, null or empty if no more results.
DescribeChangeSetHooksResponse, describeChangeSetHooksResponse_stackId - The stack identifier (stack ID).
DescribeChangeSetHooks, describeChangeSetHooksResponse_stackName - The stack name.
DescribeChangeSetHooksResponse, describeChangeSetHooksResponse_status - Provides the status of the change set hook.
$sel:httpStatus:DescribeChangeSetHooksResponse', describeChangeSetHooksResponse_httpStatus - The response's http status code.
DescribePublisher
data DescribePublisher Source #
See: newDescribePublisher smart constructor.
Constructors
| DescribePublisher' (Maybe Text) |
Instances
newDescribePublisher :: DescribePublisher Source #
Create a value of DescribePublisher with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribePublisher, describePublisher_publisherId - The ID of the extension publisher.
If you don't supply a PublisherId, and you have registered as an
extension publisher, DescribePublisher returns information about your
own publisher account.
data DescribePublisherResponse Source #
See: newDescribePublisherResponse smart constructor.
Constructors
| DescribePublisherResponse' (Maybe IdentityProvider) (Maybe Text) (Maybe Text) (Maybe PublisherStatus) Int |
Instances
newDescribePublisherResponse Source #
Create a value of DescribePublisherResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:identityProvider:DescribePublisherResponse', describePublisherResponse_identityProvider - The type of account used as the identity provider when registering this
publisher with CloudFormation.
DescribePublisher, describePublisherResponse_publisherId - The ID of the extension publisher.
$sel:publisherProfile:DescribePublisherResponse', describePublisherResponse_publisherProfile - The URL to the publisher's profile with the identity provider.
$sel:publisherStatus:DescribePublisherResponse', describePublisherResponse_publisherStatus - Whether the publisher is verified. Currently, all registered publishers
are verified.
$sel:httpStatus:DescribePublisherResponse', describePublisherResponse_httpStatus - The response's http status code.
DescribeStackDriftDetectionStatus
data DescribeStackDriftDetectionStatus Source #
See: newDescribeStackDriftDetectionStatus smart constructor.
Constructors
| DescribeStackDriftDetectionStatus' Text |
Instances
newDescribeStackDriftDetectionStatus Source #
Create a value of DescribeStackDriftDetectionStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeStackDriftDetectionStatus, describeStackDriftDetectionStatus_stackDriftDetectionId - The ID of the drift detection results of this operation.
CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of drift results CloudFormation retains for any given stack, and for how long, may vary.
data DescribeStackDriftDetectionStatusResponse Source #
See: newDescribeStackDriftDetectionStatusResponse smart constructor.
Constructors
| DescribeStackDriftDetectionStatusResponse' (Maybe Text) (Maybe Int) (Maybe StackDriftStatus) Int Text Text StackDriftDetectionStatus ISO8601 |
Instances
newDescribeStackDriftDetectionStatusResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> StackDriftDetectionStatus |
|
| -> UTCTime | |
| -> DescribeStackDriftDetectionStatusResponse |
Create a value of DescribeStackDriftDetectionStatusResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:detectionStatusReason:DescribeStackDriftDetectionStatusResponse', describeStackDriftDetectionStatusResponse_detectionStatusReason - The reason the stack drift detection operation has its current status.
$sel:driftedStackResourceCount:DescribeStackDriftDetectionStatusResponse', describeStackDriftDetectionStatusResponse_driftedStackResourceCount - Total number of stack resources that have drifted. This is NULL until
the drift detection operation reaches a status of DETECTION_COMPLETE.
This value will be 0 for stacks whose drift status is IN_SYNC.
DescribeStackDriftDetectionStatusResponse, describeStackDriftDetectionStatusResponse_stackDriftStatus - Status of the stack's actual configuration compared to its expected
configuration.
DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected template configuration.IN_SYNC: The stack's actual configuration matches its expected template configuration.UNKNOWN: This value is reserved for future use.
$sel:httpStatus:DescribeStackDriftDetectionStatusResponse', describeStackDriftDetectionStatusResponse_httpStatus - The response's http status code.
DescribeStackDriftDetectionStatusResponse, describeStackDriftDetectionStatusResponse_stackId - The ID of the stack.
DescribeStackDriftDetectionStatus, describeStackDriftDetectionStatusResponse_stackDriftDetectionId - The ID of the drift detection results of this operation.
CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of reports CloudFormation retains for any given stack, and for how long, may vary.
$sel:detectionStatus:DescribeStackDriftDetectionStatusResponse', describeStackDriftDetectionStatusResponse_detectionStatus - The status of the stack drift detection operation.
DETECTION_COMPLETE: The stack drift detection operation has successfully completed for all resources in the stack that support drift detection. (Resources that don't currently support stack detection remain unchecked.)If you specified logical resource IDs for CloudFormation to use as a filter for the stack drift detection operation, only the resources with those logical IDs are checked for drift.
DETECTION_FAILED: The stack drift detection operation has failed for at least one resource in the stack. Results will be available for resources on which CloudFormation successfully completed drift detection.DETECTION_IN_PROGRESS: The stack drift detection operation is currently in progress.
DescribeStackDriftDetectionStatusResponse, describeStackDriftDetectionStatusResponse_timestamp - Time at which the stack drift detection operation was initiated.
DescribeStackEvents (Paginated)
data DescribeStackEvents Source #
The input for DescribeStackEvents action.
See: newDescribeStackEvents smart constructor.
Constructors
| DescribeStackEvents' (Maybe Text) (Maybe Text) |
Instances
newDescribeStackEvents :: DescribeStackEvents Source #
Create a value of DescribeStackEvents with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeStackEvents, describeStackEvents_nextToken - A string that identifies the next page of events that you want to
retrieve.
DescribeStackEvents, describeStackEvents_stackName - The name or the unique stack ID that's associated with the stack, which
aren't always interchangeable:
- Running stacks: You can specify either the stack's name or its unique stack ID.
- Deleted stacks: You must specify the unique stack ID.
Default: There is no default value.
data DescribeStackEventsResponse Source #
The output for a DescribeStackEvents action.
See: newDescribeStackEventsResponse smart constructor.
Constructors
| DescribeStackEventsResponse' (Maybe Text) (Maybe [StackEvent]) Int |
Instances
newDescribeStackEventsResponse Source #
Create a value of DescribeStackEventsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeStackEvents, describeStackEventsResponse_nextToken - If the output exceeds 1 MB in size, a string that identifies the next
page of events. If no additional page exists, this value is null.
$sel:stackEvents:DescribeStackEventsResponse', describeStackEventsResponse_stackEvents - A list of StackEvents structures.
$sel:httpStatus:DescribeStackEventsResponse', describeStackEventsResponse_httpStatus - The response's http status code.
DescribeStackInstance
data DescribeStackInstance Source #
See: newDescribeStackInstance smart constructor.
Instances
newDescribeStackInstance Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> DescribeStackInstance |
Create a value of DescribeStackInstance with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:callAs:DescribeStackInstance', describeStackInstance_callAs - [Service-managed permissions] Specifies whether you are acting as an
account administrator in the organization's management account or as a
delegated administrator in a member account.
By default, SELF is specified. Use SELF for stack sets with
self-managed permissions.
- If you are signed in to the management account, specify
SELF. If you are signed in to a delegated administrator account, specify
DELEGATED_ADMIN.Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
DescribeStackInstance, describeStackInstance_stackSetName - The name or the unique stack ID of the stack set that you want to get
stack instance information for.
$sel:stackInstanceAccount:DescribeStackInstance', describeStackInstance_stackInstanceAccount - The ID of an Amazon Web Services account that's associated with this
stack instance.
$sel:stackInstanceRegion:DescribeStackInstance', describeStackInstance_stackInstanceRegion - The name of a Region that's associated with this stack instance.
data DescribeStackInstanceResponse Source #
See: newDescribeStackInstanceResponse smart constructor.
Constructors
| DescribeStackInstanceResponse' (Maybe StackInstance) Int |
Instances
newDescribeStackInstanceResponse Source #
Create a value of DescribeStackInstanceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:stackInstance:DescribeStackInstanceResponse', describeStackInstanceResponse_stackInstance - The stack instance that matches the specified request parameters.
$sel:httpStatus:DescribeStackInstanceResponse', describeStackInstanceResponse_httpStatus - The response's http status code.
DescribeStackResource
data DescribeStackResource Source #
The input for DescribeStackResource action.
See: newDescribeStackResource smart constructor.
Constructors
| DescribeStackResource' Text Text |
Instances
newDescribeStackResource Source #
Arguments
| :: Text | |
| -> Text | |
| -> DescribeStackResource |
Create a value of DescribeStackResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeStackResource, describeStackResource_stackName - The name or the unique stack ID that's associated with the stack, which
aren't always interchangeable:
- Running stacks: You can specify either the stack's name or its unique stack ID.
- Deleted stacks: You must specify the unique stack ID.
Default: There is no default value.
DescribeStackResource, describeStackResource_logicalResourceId - The logical name of the resource as specified in the template.
Default: There is no default value.
data DescribeStackResourceResponse Source #
The output for a DescribeStackResource action.
See: newDescribeStackResourceResponse smart constructor.
Constructors
| DescribeStackResourceResponse' (Maybe StackResourceDetail) Int |
Instances
newDescribeStackResourceResponse Source #
Create a value of DescribeStackResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:stackResourceDetail:DescribeStackResourceResponse', describeStackResourceResponse_stackResourceDetail - A StackResourceDetail structure containing the description of the
specified resource in the specified stack.
$sel:httpStatus:DescribeStackResourceResponse', describeStackResourceResponse_httpStatus - The response's http status code.
DescribeStackResourceDrifts
data DescribeStackResourceDrifts Source #
See: newDescribeStackResourceDrifts smart constructor.
Constructors
| DescribeStackResourceDrifts' (Maybe Natural) (Maybe Text) (Maybe (NonEmpty StackResourceDriftStatus)) Text |
Instances
newDescribeStackResourceDrifts Source #
Arguments
| :: Text | |
| -> DescribeStackResourceDrifts |
Create a value of DescribeStackResourceDrifts with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:DescribeStackResourceDrifts', describeStackResourceDrifts_maxResults - The maximum number of results to be returned with a single call. If the
number of available results exceeds this maximum, the response includes
a NextToken value that you can assign to the NextToken request
parameter to get the next set of results.
DescribeStackResourceDrifts, describeStackResourceDrifts_nextToken - A string that identifies the next page of stack resource drift results.
$sel:stackResourceDriftStatusFilters:DescribeStackResourceDrifts', describeStackResourceDrifts_stackResourceDriftStatusFilters - The resource drift status values to use as filters for the resource
drift results returned.
DELETED: The resource differs from its expected template configuration in that the resource has been deleted.MODIFIED: One or more resource properties differ from their expected template values.IN_SYNC: The resource's actual configuration matches its expected template configuration.NOT_CHECKED: CloudFormation doesn't currently return this value.
DescribeStackResourceDrifts, describeStackResourceDrifts_stackName - The name of the stack for which you want drift information.
data DescribeStackResourceDriftsResponse Source #
See: newDescribeStackResourceDriftsResponse smart constructor.
Constructors
| DescribeStackResourceDriftsResponse' (Maybe Text) Int [StackResourceDrift] |
Instances
newDescribeStackResourceDriftsResponse Source #
Arguments
| :: Int | |
| -> DescribeStackResourceDriftsResponse |
Create a value of DescribeStackResourceDriftsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeStackResourceDrifts, describeStackResourceDriftsResponse_nextToken - If the request doesn't return all the remaining results, NextToken is
set to a token. To retrieve the next set of results, call
DescribeStackResourceDrifts again and assign that token to the request
object's NextToken parameter. If the request returns all results,
NextToken is set to null.
$sel:httpStatus:DescribeStackResourceDriftsResponse', describeStackResourceDriftsResponse_httpStatus - The response's http status code.
$sel:stackResourceDrifts:DescribeStackResourceDriftsResponse', describeStackResourceDriftsResponse_stackResourceDrifts - Drift information for the resources that have been checked for drift in
the specified stack. This includes actual and expected configuration
values for resources where CloudFormation detects drift.
For a given stack, there will be one StackResourceDrift for each stack
resource that has been checked for drift. Resources that haven't yet
been checked for drift aren't included. Resources that do not currently
support drift detection aren't checked, and so not included. For a list
of resources that support drift detection, see
Resources that Support Drift Detection.
DescribeStackResources
data DescribeStackResources Source #
The input for DescribeStackResources action.
See: newDescribeStackResources smart constructor.
Instances
newDescribeStackResources :: DescribeStackResources Source #
Create a value of DescribeStackResources with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeStackResources, describeStackResources_logicalResourceId - The logical name of the resource as specified in the template.
Default: There is no default value.
DescribeStackResources, describeStackResources_physicalResourceId - The name or unique identifier that corresponds to a physical instance ID
of a resource supported by CloudFormation.
For example, for an Amazon Elastic Compute Cloud (EC2) instance,
PhysicalResourceId corresponds to the InstanceId. You can pass the
EC2 InstanceId to DescribeStackResources to find which stack the
instance belongs to and what other resources are part of the stack.
Required: Conditional. If you don't specify PhysicalResourceId, you
must specify StackName.
Default: There is no default value.
DescribeStackResources, describeStackResources_stackName - The name or the unique stack ID that is associated with the stack, which
aren't always interchangeable:
- Running stacks: You can specify either the stack's name or its unique stack ID.
- Deleted stacks: You must specify the unique stack ID.
Default: There is no default value.
Required: Conditional. If you don't specify StackName, you must
specify PhysicalResourceId.
data DescribeStackResourcesResponse Source #
The output for a DescribeStackResources action.
See: newDescribeStackResourcesResponse smart constructor.
Constructors
| DescribeStackResourcesResponse' (Maybe [StackResource]) Int |
Instances
newDescribeStackResourcesResponse Source #
Create a value of DescribeStackResourcesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:stackResources:DescribeStackResourcesResponse', describeStackResourcesResponse_stackResources - A list of StackResource structures.
$sel:httpStatus:DescribeStackResourcesResponse', describeStackResourcesResponse_httpStatus - The response's http status code.
DescribeStackSet
data DescribeStackSet Source #
See: newDescribeStackSet smart constructor.
Constructors
| DescribeStackSet' (Maybe CallAs) Text |
Instances
Arguments
| :: Text | |
| -> DescribeStackSet |
Create a value of DescribeStackSet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:callAs:DescribeStackSet', describeStackSet_callAs - [Service-managed permissions] Specifies whether you are acting as an
account administrator in the organization's management account or as a
delegated administrator in a member account.
By default, SELF is specified. Use SELF for stack sets with
self-managed permissions.
- If you are signed in to the management account, specify
SELF. If you are signed in to a delegated administrator account, specify
DELEGATED_ADMIN.Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
DescribeStackSet, describeStackSet_stackSetName - The name or unique ID of the stack set whose description you want.
data DescribeStackSetResponse Source #
See: newDescribeStackSetResponse smart constructor.
Constructors
| DescribeStackSetResponse' (Maybe StackSet) Int |
Instances
newDescribeStackSetResponse Source #
Create a value of DescribeStackSetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:stackSet:DescribeStackSetResponse', describeStackSetResponse_stackSet - The specified stack set.
$sel:httpStatus:DescribeStackSetResponse', describeStackSetResponse_httpStatus - The response's http status code.
DescribeStackSetOperation
data DescribeStackSetOperation Source #
See: newDescribeStackSetOperation smart constructor.
Constructors
| DescribeStackSetOperation' (Maybe CallAs) Text Text |
Instances
newDescribeStackSetOperation Source #
Arguments
| :: Text | |
| -> Text | |
| -> DescribeStackSetOperation |
Create a value of DescribeStackSetOperation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:callAs:DescribeStackSetOperation', describeStackSetOperation_callAs - [Service-managed permissions] Specifies whether you are acting as an
account administrator in the organization's management account or as a
delegated administrator in a member account.
By default, SELF is specified. Use SELF for stack sets with
self-managed permissions.
- If you are signed in to the management account, specify
SELF. If you are signed in to a delegated administrator account, specify
DELEGATED_ADMIN.Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
DescribeStackSetOperation, describeStackSetOperation_stackSetName - The name or the unique stack ID of the stack set for the stack
operation.
DescribeStackSetOperation, describeStackSetOperation_operationId - The unique ID of the stack set operation.
data DescribeStackSetOperationResponse Source #
See: newDescribeStackSetOperationResponse smart constructor.
Constructors
| DescribeStackSetOperationResponse' (Maybe StackSetOperation) Int |
Instances
newDescribeStackSetOperationResponse Source #
Arguments
| :: Int | |
| -> DescribeStackSetOperationResponse |
Create a value of DescribeStackSetOperationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:stackSetOperation:DescribeStackSetOperationResponse', describeStackSetOperationResponse_stackSetOperation - The specified stack set operation.
$sel:httpStatus:DescribeStackSetOperationResponse', describeStackSetOperationResponse_httpStatus - The response's http status code.
DescribeStacks (Paginated)
data DescribeStacks Source #
The input for DescribeStacks action.
See: newDescribeStacks smart constructor.
Constructors
| DescribeStacks' (Maybe Text) (Maybe Text) |
Instances
newDescribeStacks :: DescribeStacks Source #
Create a value of DescribeStacks with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeStacks, describeStacks_nextToken - A string that identifies the next page of stacks that you want to
retrieve.
DescribeStacks, describeStacks_stackName - The name or the unique stack ID that's associated with the stack, which
aren't always interchangeable:
- Running stacks: You can specify either the stack's name or its unique stack ID.
- Deleted stacks: You must specify the unique stack ID.
Default: There is no default value.
data DescribeStacksResponse Source #
The output for a DescribeStacks action.
See: newDescribeStacksResponse smart constructor.
Instances
newDescribeStacksResponse Source #
Create a value of DescribeStacksResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeStacks, describeStacksResponse_nextToken - If the output exceeds 1 MB in size, a string that identifies the next
page of stacks. If no additional page exists, this value is null.
$sel:stacks:DescribeStacksResponse', describeStacksResponse_stacks - A list of stack structures.
$sel:httpStatus:DescribeStacksResponse', describeStacksResponse_httpStatus - The response's http status code.
DescribeType
data DescribeType Source #
See: newDescribeType smart constructor.
Constructors
| DescribeType' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RegistryType) (Maybe Text) (Maybe Text) |
Instances
newDescribeType :: DescribeType Source #
Create a value of DescribeType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeType, describeType_arn - The Amazon Resource Name (ARN) of the extension.
Conditional: You must specify either TypeName and Type, or Arn.
DescribeType, describeType_publicVersionNumber - The version number of a public third-party extension.
DescribeType, describeType_publisherId - The publisher ID of the extension publisher.
Extensions provided by Amazon Web Services are not assigned a publisher ID.
DescribeType, describeType_type - The kind of extension.
Conditional: You must specify either TypeName and Type, or Arn.
DescribeType, describeType_typeName - The name of the extension.
Conditional: You must specify either TypeName and Type, or Arn.
DescribeType, describeType_versionId - The ID of a specific version of the extension. The version ID is the
value at the end of the Amazon Resource Name (ARN) assigned to the
extension version when it is registered.
If you specify a VersionId, DescribeType returns information about
that specific extension version. Otherwise, it returns information about
the default extension version.
data DescribeTypeResponse Source #
See: newDescribeTypeResponse smart constructor.
Constructors
| DescribeTypeResponse' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe DeprecatedStatus) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe ISO8601) (Maybe Text) (Maybe LoggingConfig) (Maybe Text) (Maybe Text) (Maybe ProvisioningType) (Maybe Text) (Maybe Text) (Maybe [RequiredActivatedType]) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe RegistryType) (Maybe Text) (Maybe TypeTestsStatus) (Maybe Text) (Maybe Visibility) Int |
Instances
newDescribeTypeResponse Source #
Arguments
| :: Int | |
| -> DescribeTypeResponse |
Create a value of DescribeTypeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeType, describeTypeResponse_arn - The Amazon Resource Name (ARN) of the extension.
$sel:autoUpdate:DescribeTypeResponse', describeTypeResponse_autoUpdate - Whether CloudFormation automatically updates the extension in this
account and region when a new minor version is published by the
extension publisher. Major versions released by the publisher must be
manually updated. For more information, see
Activating public extensions for use in your account
in the CloudFormation User Guide.
$sel:configurationSchema:DescribeTypeResponse', describeTypeResponse_configurationSchema - A JSON string that represent the current configuration data for the
extension in this account and region.
To set the configuration data for an extension, use SetTypeConfiguration. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
DescribeTypeResponse, describeTypeResponse_defaultVersionId - The ID of the default version of the extension. The default version is
used when the extension version isn't specified.
This applies only to private extensions you have registered in your
account. For public extensions, both those provided by Amazon Web
Services and published by third parties, CloudFormation returns null.
For more information, see
RegisterType.
To set the default version of an extension, use
SetTypeDefaultVersion .
$sel:deprecatedStatus:DescribeTypeResponse', describeTypeResponse_deprecatedStatus - The deprecation status of the extension version.
Valid values include:
LIVE: The extension is activated or registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.DEPRECATED: The extension has been deactivated or deregistered and can no longer be used in CloudFormation operations.
For public third-party extensions, CloudFormation returns null.
DescribeTypeResponse, describeTypeResponse_description - The description of the extension.
$sel:documentationUrl:DescribeTypeResponse', describeTypeResponse_documentationUrl - The URL of a page providing detailed documentation for this extension.
$sel:executionRoleArn:DescribeTypeResponse', describeTypeResponse_executionRoleArn - The Amazon Resource Name (ARN) of the IAM execution role used to
register the extension. This applies only to private extensions you have
registered in your account. For more information, see
RegisterType.
If the registered extension calls any Amazon Web Services APIs, you must create an <https:docs.aws.amazon.comIAMlatestUserGuideid_roles.html IAM execution role> that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your extension with the appropriate credentials.
DescribeTypeResponse, describeTypeResponse_isActivated - Whether the extension is activated in the account and region.
This only applies to public third-party extensions. For all other
extensions, CloudFormation returns null.
DescribeTypeResponse, describeTypeResponse_isDefaultVersion - Whether the specified extension version is set as the default version.
This applies only to private extensions you have registered in your
account, and extensions published by Amazon Web Services. For public
third-party extensions, whether they are activated in your account,
CloudFormation returns null.
DescribeTypeResponse, describeTypeResponse_lastUpdated - When the specified extension version was registered. This applies only
to:
- Private extensions you have registered in your account. For more information, see RegisterType.
- Public extensions you have activated in your account with auto-update specified. For more information, see ActivateType.
DescribeTypeResponse, describeTypeResponse_latestPublicVersion - The latest version of a public extension that is available for use.
This only applies if you specify a public extension, and you don't
specify a version. For all other requests, CloudFormation returns
null.
$sel:loggingConfig:DescribeTypeResponse', describeTypeResponse_loggingConfig - Contains logging configuration information for private extensions. This
applies only to private extensions you have registered in your account.
For public extensions, both those provided by Amazon Web Services and
published by third parties, CloudFormation returns null. For more
information, see
RegisterType.
$sel:originalTypeArn:DescribeTypeResponse', describeTypeResponse_originalTypeArn - For public extensions that have been activated for this account and
region, the Amazon Resource Name (ARN) of the public extension.
DescribeTypeResponse, describeTypeResponse_originalTypeName - For public extensions that have been activated for this account and
region, the type name of the public extension.
If you specified a TypeNameAlias when enabling the extension in this
account and region, CloudFormation treats that alias as the extension's
type name within the account and region, not the type name of the public
extension. For more information, see
Specifying aliases to refer to extensions
in the CloudFormation User Guide.
$sel:provisioningType:DescribeTypeResponse', describeTypeResponse_provisioningType - For resource type extensions, the provisioning behavior of the resource
type. CloudFormation determines the provisioning type during
registration, based on the types of handlers in the schema handler
package submitted.
Valid values include:
FULLY_MUTABLE: The resource type includes an update handler to process updates to the type during stack update operations.IMMUTABLE: The resource type doesn't include an update handler, so the type can't be updated and must instead be replaced during stack update operations.NON_PROVISIONABLE: The resource type doesn't include all the following handlers, and therefore can't actually be provisioned.- create
- read
- delete
DescribeType, describeTypeResponse_publicVersionNumber - The version number of a public third-party extension.
This applies only if you specify a public extension you have activated
in your account, or specify a public extension without specifying a
version. For all other extensions, CloudFormation returns null.
DescribeType, describeTypeResponse_publisherId - The publisher ID of the extension publisher.
This applies only to public third-party extensions. For private
registered extensions, and extensions provided by Amazon Web Services,
CloudFormation returns null.
$sel:requiredActivatedTypes:DescribeTypeResponse', describeTypeResponse_requiredActivatedTypes - For extensions that are modules, the public third-party extensions that
must be activated in your account in order for the module itself to be
activated.
$sel:schema:DescribeTypeResponse', describeTypeResponse_schema - The schema that defines the extension.
For more information about extension schemas, see Resource Provider Schema in the CloudFormation CLI User Guide.
$sel:sourceUrl:DescribeTypeResponse', describeTypeResponse_sourceUrl - The URL of the source code for the extension.
DescribeTypeResponse, describeTypeResponse_timeCreated - When the specified private extension version was registered or activated
in your account.
DescribeType, describeTypeResponse_type - The kind of extension.
DescribeType, describeTypeResponse_typeName - The name of the extension.
If the extension is a public third-party type you have activated with a type name alias, CloudFormation returns the type name alias. For more information, see ActivateType.
$sel:typeTestsStatus:DescribeTypeResponse', describeTypeResponse_typeTestsStatus - The contract test status of the registered extension version. To return
the extension test status of a specific extension version, you must
specify VersionId.
This applies only to registered private extension versions. CloudFormation doesn't return this information for public extensions, whether they are activated in your account.
PASSED: The extension has passed all its contract tests.An extension must have a test status of
PASSEDbefore it can be published. For more information, see Publishing extensions to make them available for public use in the CloudFormation Command Line Interface User Guide.FAILED: The extension has failed one or more contract tests.IN_PROGRESS: Contract tests are currently being performed on the extension.NOT_TESTED: Contract tests haven't been performed on the extension.
$sel:typeTestsStatusDescription:DescribeTypeResponse', describeTypeResponse_typeTestsStatusDescription - The description of the test status. To return the extension test status
of a specific extension version, you must specify VersionId.
This applies only to registered private extension versions. CloudFormation doesn't return this information for public extensions, whether they are activated in your account.
$sel:visibility:DescribeTypeResponse', describeTypeResponse_visibility - The scope at which the extension is visible and usable in CloudFormation
operations.
Valid values include:
PRIVATE: The extension is only visible and usable within the account in which it is registered. CloudFormation marks any extensions you register asPRIVATE.PUBLIC: The extension is publicly visible and usable within any Amazon Web Services account.
$sel:httpStatus:DescribeTypeResponse', describeTypeResponse_httpStatus - The response's http status code.
DescribeTypeRegistration
data DescribeTypeRegistration Source #
See: newDescribeTypeRegistration smart constructor.
Constructors
| DescribeTypeRegistration' Text |
Instances
newDescribeTypeRegistration Source #
Create a value of DescribeTypeRegistration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:registrationToken:DescribeTypeRegistration', describeTypeRegistration_registrationToken - The identifier for this registration request.
This registration token is generated by CloudFormation when you initiate
a registration request using RegisterType .
data DescribeTypeRegistrationResponse Source #
See: newDescribeTypeRegistrationResponse smart constructor.
Constructors
| DescribeTypeRegistrationResponse' (Maybe Text) (Maybe RegistrationStatus) (Maybe Text) (Maybe Text) Int |
Instances
newDescribeTypeRegistrationResponse Source #
Create a value of DescribeTypeRegistrationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeTypeRegistrationResponse, describeTypeRegistrationResponse_description - The description of the extension registration request.
$sel:progressStatus:DescribeTypeRegistrationResponse', describeTypeRegistrationResponse_progressStatus - The current status of the extension registration request.
DescribeTypeRegistrationResponse, describeTypeRegistrationResponse_typeArn - The Amazon Resource Name (ARN) of the extension being registered.
For registration requests with a ProgressStatus of other than
COMPLETE, this will be null.
$sel:typeVersionArn:DescribeTypeRegistrationResponse', describeTypeRegistrationResponse_typeVersionArn - The Amazon Resource Name (ARN) of this specific version of the extension
being registered.
For registration requests with a ProgressStatus of other than
COMPLETE, this will be null.
$sel:httpStatus:DescribeTypeRegistrationResponse', describeTypeRegistrationResponse_httpStatus - The response's http status code.
DetectStackDrift
data DetectStackDrift Source #
See: newDetectStackDrift smart constructor.
Constructors
| DetectStackDrift' (Maybe (NonEmpty Text)) Text |
Instances
Arguments
| :: Text | |
| -> DetectStackDrift |
Create a value of DetectStackDrift with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DetectStackDrift, detectStackDrift_logicalResourceIds - The logical names of any resources you want to use as filters.
DetectStackDrift, detectStackDrift_stackName - The name of the stack for which you want to detect drift.
data DetectStackDriftResponse Source #
See: newDetectStackDriftResponse smart constructor.
Constructors
| DetectStackDriftResponse' Int Text |
Instances
newDetectStackDriftResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> DetectStackDriftResponse |
Create a value of DetectStackDriftResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DetectStackDriftResponse', detectStackDriftResponse_httpStatus - The response's http status code.
$sel:stackDriftDetectionId:DetectStackDriftResponse', detectStackDriftResponse_stackDriftDetectionId - The ID of the drift detection results of this operation.
CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of drift results CloudFormation retains for any given stack, and for how long, may vary.
DetectStackResourceDrift
data DetectStackResourceDrift Source #
See: newDetectStackResourceDrift smart constructor.
Constructors
| DetectStackResourceDrift' Text Text |
Instances
newDetectStackResourceDrift Source #
Create a value of DetectStackResourceDrift with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DetectStackResourceDrift, detectStackResourceDrift_stackName - The name of the stack to which the resource belongs.
DetectStackResourceDrift, detectStackResourceDrift_logicalResourceId - The logical name of the resource for which to return drift information.
data DetectStackResourceDriftResponse Source #
See: newDetectStackResourceDriftResponse smart constructor.
Constructors
| DetectStackResourceDriftResponse' Int StackResourceDrift |
Instances
newDetectStackResourceDriftResponse Source #
Arguments
| :: Int | |
| -> StackResourceDrift | |
| -> DetectStackResourceDriftResponse |
Create a value of DetectStackResourceDriftResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DetectStackResourceDriftResponse', detectStackResourceDriftResponse_httpStatus - The response's http status code.
$sel:stackResourceDrift:DetectStackResourceDriftResponse', detectStackResourceDriftResponse_stackResourceDrift - Information about whether the resource's actual configuration has
drifted from its expected template configuration, including actual and
expected property values and any differences detected.
DetectStackSetDrift
data DetectStackSetDrift Source #
See: newDetectStackSetDrift smart constructor.
Constructors
| DetectStackSetDrift' (Maybe CallAs) (Maybe Text) (Maybe StackSetOperationPreferences) Text |
Instances
newDetectStackSetDrift Source #
Arguments
| :: Text | |
| -> DetectStackSetDrift |
Create a value of DetectStackSetDrift with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:callAs:DetectStackSetDrift', detectStackSetDrift_callAs - [Service-managed permissions] Specifies whether you are acting as an
account administrator in the organization's management account or as a
delegated administrator in a member account.
By default, SELF is specified. Use SELF for stack sets with
self-managed permissions.
- If you are signed in to the management account, specify
SELF. If you are signed in to a delegated administrator account, specify
DELEGATED_ADMIN.Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
DetectStackSetDrift, detectStackSetDrift_operationId - The ID of the stack set operation.
DetectStackSetDrift, detectStackSetDrift_operationPreferences - Undocumented member.
DetectStackSetDrift, detectStackSetDrift_stackSetName - The name of the stack set on which to perform the drift detection
operation.
data DetectStackSetDriftResponse Source #
See: newDetectStackSetDriftResponse smart constructor.
Constructors
| DetectStackSetDriftResponse' (Maybe Text) Int |
Instances
newDetectStackSetDriftResponse Source #
Create a value of DetectStackSetDriftResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DetectStackSetDrift, detectStackSetDriftResponse_operationId - The ID of the drift detection stack set operation.
You can use this operation ID with DescribeStackSetOperation to
monitor the progress of the drift detection operation.
$sel:httpStatus:DetectStackSetDriftResponse', detectStackSetDriftResponse_httpStatus - The response's http status code.
EstimateTemplateCost
data EstimateTemplateCost Source #
The input for an EstimateTemplateCost action.
See: newEstimateTemplateCost smart constructor.
Instances
newEstimateTemplateCost :: EstimateTemplateCost Source #
Create a value of EstimateTemplateCost with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
EstimateTemplateCost, estimateTemplateCost_parameters - A list of Parameter structures that specify input parameters.
EstimateTemplateCost, estimateTemplateCost_templateBody - Structure containing the template body with a minimum length of 1 byte
and a maximum length of 51,200 bytes. (For more information, go to
Template Anatomy
in the CloudFormation User Guide.)
Conditional: You must pass TemplateBody or TemplateURL. If both are
passed, only TemplateBody is used.
$sel:templateURL:EstimateTemplateCost', estimateTemplateCost_templateURL - Location of file containing the template body. The URL must point to a
template that's located in an Amazon S3 bucket or a Systems Manager
document. For more information, go to
Template Anatomy
in the CloudFormation User Guide.
Conditional: You must pass TemplateURL or TemplateBody. If both are
passed, only TemplateBody is used.
data EstimateTemplateCostResponse Source #
The output for a EstimateTemplateCost action.
See: newEstimateTemplateCostResponse smart constructor.
Constructors
| EstimateTemplateCostResponse' (Maybe Text) Int |
Instances
newEstimateTemplateCostResponse Source #
Create a value of EstimateTemplateCostResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:url:EstimateTemplateCostResponse', estimateTemplateCostResponse_url - An Amazon Web Services Simple Monthly Calculator URL with a query string
that describes the resources required to run the template.
$sel:httpStatus:EstimateTemplateCostResponse', estimateTemplateCostResponse_httpStatus - The response's http status code.
ExecuteChangeSet
data ExecuteChangeSet Source #
The input for the ExecuteChangeSet action.
See: newExecuteChangeSet smart constructor.
Instances
Arguments
| :: Text | |
| -> ExecuteChangeSet |
Create a value of ExecuteChangeSet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ExecuteChangeSet, executeChangeSet_clientRequestToken - A unique identifier for this ExecuteChangeSet request. Specify this
token if you plan to retry requests so that CloudFormation knows that
you're not attempting to execute a change set to update a stack with
the same name. You might retry ExecuteChangeSet requests to ensure
that CloudFormation successfully received them.
ExecuteChangeSet, executeChangeSet_disableRollback - Preserves the state of previously provisioned resources when an
operation fails.
Default: True
ExecuteChangeSet, executeChangeSet_stackName - If you specified the name of a change set, specify the stack name or
Amazon Resource Name (ARN) that's associated with the change set you
want to execute.
ExecuteChangeSet, executeChangeSet_changeSetName - The name or Amazon Resource Name (ARN) of the change set that you want
use to update the specified stack.
data ExecuteChangeSetResponse Source #
The output for the ExecuteChangeSet action.
See: newExecuteChangeSetResponse smart constructor.
Constructors
| ExecuteChangeSetResponse' Int |
Instances
newExecuteChangeSetResponse Source #
Create a value of ExecuteChangeSetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:ExecuteChangeSetResponse', executeChangeSetResponse_httpStatus - The response's http status code.
GetStackPolicy
data GetStackPolicy Source #
The input for the GetStackPolicy action.
See: newGetStackPolicy smart constructor.
Constructors
| GetStackPolicy' Text |
Instances
Arguments
| :: Text | |
| -> GetStackPolicy |
Create a value of GetStackPolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetStackPolicy, getStackPolicy_stackName - The name or unique stack ID that's associated with the stack whose
policy you want to get.
data GetStackPolicyResponse Source #
The output for the GetStackPolicy action.
See: newGetStackPolicyResponse smart constructor.
Constructors
| GetStackPolicyResponse' (Maybe Text) Int |
Instances
newGetStackPolicyResponse Source #
Create a value of GetStackPolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:stackPolicyBody:GetStackPolicyResponse', getStackPolicyResponse_stackPolicyBody - Structure containing the stack policy body. (For more information, go to
Prevent Updates to Stack Resources
in the CloudFormation User Guide.)
$sel:httpStatus:GetStackPolicyResponse', getStackPolicyResponse_httpStatus - The response's http status code.
GetTemplate
data GetTemplate Source #
The input for a GetTemplate action.
See: newGetTemplate smart constructor.
Constructors
| GetTemplate' (Maybe Text) (Maybe Text) (Maybe TemplateStage) |
Instances
newGetTemplate :: GetTemplate Source #
Create a value of GetTemplate with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetTemplate, getTemplate_changeSetName - The name or Amazon Resource Name (ARN) of a change set for which
CloudFormation returns the associated template. If you specify a name,
you must also specify the StackName.
GetTemplate, getTemplate_stackName - The name or the unique stack ID that's associated with the stack, which
aren't always interchangeable:
- Running stacks: You can specify either the stack's name or its unique stack ID.
- Deleted stacks: You must specify the unique stack ID.
Default: There is no default value.
$sel:templateStage:GetTemplate', getTemplate_templateStage - For templates that include transforms, the stage of the template that
CloudFormation returns. To get the user-submitted template, specify
Original. To get the template after CloudFormation has processed all
transforms, specify Processed.
If the template doesn't include transforms, Original and Processed
return the same template. By default, CloudFormation specifies
Processed.
data GetTemplateResponse Source #
The output for GetTemplate action.
See: newGetTemplateResponse smart constructor.
Constructors
| GetTemplateResponse' (Maybe [TemplateStage]) (Maybe Text) Int |
Instances
newGetTemplateResponse Source #
Arguments
| :: Int | |
| -> GetTemplateResponse |
Create a value of GetTemplateResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:stagesAvailable:GetTemplateResponse', getTemplateResponse_stagesAvailable - The stage of the template that you can retrieve. For stacks, the
Original and Processed templates are always available. For change
sets, the Original template is always available. After CloudFormation
finishes creating the change set, the Processed template becomes
available.
GetTemplateResponse, getTemplateResponse_templateBody - Structure containing the template body. (For more information, go to
Template Anatomy
in the CloudFormation User Guide.)
CloudFormation returns the same template that was used when the stack was created.
$sel:httpStatus:GetTemplateResponse', getTemplateResponse_httpStatus - The response's http status code.
GetTemplateSummary
data GetTemplateSummary Source #
The input for the GetTemplateSummary action.
See: newGetTemplateSummary smart constructor.
Instances
newGetTemplateSummary :: GetTemplateSummary Source #
Create a value of GetTemplateSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:callAs:GetTemplateSummary', getTemplateSummary_callAs - [Service-managed permissions] Specifies whether you are acting as an
account administrator in the organization's management account or as a
delegated administrator in a member account.
By default, SELF is specified. Use SELF for stack sets with
self-managed permissions.
- If you are signed in to the management account, specify
SELF. If you are signed in to a delegated administrator account, specify
DELEGATED_ADMIN.Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
GetTemplateSummary, getTemplateSummary_stackName - The name or the stack ID that's associated with the stack, which
aren't always interchangeable. For running stacks, you can specify
either the stack's name or its unique stack ID. For deleted stack, you
must specify the unique stack ID.
Conditional: You must specify only one of the following parameters:
StackName, StackSetName, TemplateBody, or TemplateURL.
GetTemplateSummary, getTemplateSummary_stackSetName - The name or unique ID of the stack set from which the stack was created.
Conditional: You must specify only one of the following parameters:
StackName, StackSetName, TemplateBody, or TemplateURL.
GetTemplateSummary, getTemplateSummary_templateBody - Structure containing the template body with a minimum length of 1 byte
and a maximum length of 51,200 bytes. For more information about
templates, see
Template anatomy
in the CloudFormation User Guide.
Conditional: You must specify only one of the following parameters:
StackName, StackSetName, TemplateBody, or TemplateURL.
$sel:templateURL:GetTemplateSummary', getTemplateSummary_templateURL - Location of file containing the template body. The URL must point to a
template (max size: 460,800 bytes) that's located in an Amazon S3
bucket or a Systems Manager document. For more information about
templates, see
Template anatomy
in the CloudFormation User Guide.
Conditional: You must specify only one of the following parameters:
StackName, StackSetName, TemplateBody, or TemplateURL.
data GetTemplateSummaryResponse Source #
The output for the GetTemplateSummary action.
See: newGetTemplateSummaryResponse smart constructor.
Constructors
| GetTemplateSummaryResponse' (Maybe [Capability]) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe [ParameterDeclaration]) (Maybe [ResourceIdentifierSummary]) (Maybe [Text]) (Maybe Text) Int |
Instances
newGetTemplateSummaryResponse Source #
Create a value of GetTemplateSummaryResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetTemplateSummaryResponse, getTemplateSummaryResponse_capabilities - The capabilities found within the template. If your template contains
IAM resources, you must specify the CAPABILITY_IAM or
CAPABILITY_NAMED_IAM value for this parameter when you use the
CreateStack or UpdateStack actions with your template; otherwise, those
actions return an InsufficientCapabilities error.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
$sel:capabilitiesReason:GetTemplateSummaryResponse', getTemplateSummaryResponse_capabilitiesReason - The list of resources that generated the values in the Capabilities
response element.
$sel:declaredTransforms:GetTemplateSummaryResponse', getTemplateSummaryResponse_declaredTransforms - A list of the transforms that are declared in the template.
GetTemplateSummaryResponse, getTemplateSummaryResponse_description - The value that's defined in the Description property of the template.
GetTemplateSummaryResponse, getTemplateSummaryResponse_metadata - The value that's defined for the Metadata property of the template.
GetTemplateSummaryResponse, getTemplateSummaryResponse_parameters - A list of parameter declarations that describe various properties for
each parameter.
$sel:resourceIdentifierSummaries:GetTemplateSummaryResponse', getTemplateSummaryResponse_resourceIdentifierSummaries - A list of resource identifier summaries that describe the target
resources of an import operation and the properties you can provide
during the import to identify the target resources. For example,
BucketName is a possible identifier property for an AWS::S3::Bucket
resource.
$sel:resourceTypes:GetTemplateSummaryResponse', getTemplateSummaryResponse_resourceTypes - A list of all the template resource types that are defined in the
template, such as AWS::EC2::Instance, AWS::Dynamo::Table, and
Custom::MyCustomInstance.
$sel:version:GetTemplateSummaryResponse', getTemplateSummaryResponse_version - The Amazon Web Services template format version, which identifies the
capabilities of the template.
$sel:httpStatus:GetTemplateSummaryResponse', getTemplateSummaryResponse_httpStatus - The response's http status code.
ImportStacksToStackSet
data ImportStacksToStackSet Source #
See: newImportStacksToStackSet smart constructor.
Constructors
| ImportStacksToStackSet' (Maybe CallAs) (Maybe Text) (Maybe StackSetOperationPreferences) (Maybe [Text]) (Maybe [Text]) (Maybe Text) Text |
Instances
newImportStacksToStackSet Source #
Arguments
| :: Text | |
| -> ImportStacksToStackSet |
Create a value of ImportStacksToStackSet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:callAs:ImportStacksToStackSet', importStacksToStackSet_callAs - By default, SELF is specified. Use SELF for stack sets with
self-managed permissions.
- If you are signed in to the management account, specify
SELF. - For service managed stack sets, specify
DELEGATED_ADMIN.
ImportStacksToStackSet, importStacksToStackSet_operationId - A unique, user defined, identifier for the stack set operation.
ImportStacksToStackSet, importStacksToStackSet_operationPreferences - Undocumented member.
ImportStacksToStackSet, importStacksToStackSet_organizationalUnitIds - The list of OU ID's to which the stacks being imported has to be mapped
as deployment target.
$sel:stackIds:ImportStacksToStackSet', importStacksToStackSet_stackIds - The IDs of the stacks you are importing into a stack set. You import up
to 10 stacks per stack set at a time.
Specify either StackIds or StackIdsUrl.
$sel:stackIdsUrl:ImportStacksToStackSet', importStacksToStackSet_stackIdsUrl - The Amazon S3 URL which contains list of stack ids to be inputted.
Specify either StackIds or StackIdsUrl.
ImportStacksToStackSet, importStacksToStackSet_stackSetName - The name of the stack set. The name must be unique in the Region where
you create your stack set.
data ImportStacksToStackSetResponse Source #
See: newImportStacksToStackSetResponse smart constructor.
Constructors
| ImportStacksToStackSetResponse' (Maybe Text) Int |
Instances
newImportStacksToStackSetResponse Source #
Create a value of ImportStacksToStackSetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ImportStacksToStackSet, importStacksToStackSetResponse_operationId - The unique identifier for the stack set operation.
$sel:httpStatus:ImportStacksToStackSetResponse', importStacksToStackSetResponse_httpStatus - The response's http status code.
ListChangeSets (Paginated)
data ListChangeSets Source #
The input for the ListChangeSets action.
See: newListChangeSets smart constructor.
Constructors
| ListChangeSets' (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> ListChangeSets |
Create a value of ListChangeSets with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListChangeSets, listChangeSets_nextToken - A string (provided by the ListChangeSets response output) that
identifies the next page of change sets that you want to retrieve.
ListChangeSets, listChangeSets_stackName - The name or the Amazon Resource Name (ARN) of the stack for which you
want to list change sets.
data ListChangeSetsResponse Source #
The output for the ListChangeSets action.
See: newListChangeSetsResponse smart constructor.
Constructors
| ListChangeSetsResponse' (Maybe Text) (Maybe [ChangeSetSummary]) Int |
Instances
newListChangeSetsResponse Source #
Create a value of ListChangeSetsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListChangeSets, listChangeSetsResponse_nextToken - If the output exceeds 1 MB, a string that identifies the next page of
change sets. If there is no additional page, this value is null.
$sel:summaries:ListChangeSetsResponse', listChangeSetsResponse_summaries - A list of ChangeSetSummary structures that provides the ID and status
of each change set for the specified stack.
$sel:httpStatus:ListChangeSetsResponse', listChangeSetsResponse_httpStatus - The response's http status code.
ListExports (Paginated)
data ListExports Source #
See: newListExports smart constructor.
Constructors
| ListExports' (Maybe Text) |
Instances
newListExports :: ListExports Source #
Create a value of ListExports with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListExports, listExports_nextToken - A string (provided by the ListExports response output) that identifies
the next page of exported output values that you asked to retrieve.
data ListExportsResponse Source #
See: newListExportsResponse smart constructor.
Instances
newListExportsResponse Source #
Arguments
| :: Int | |
| -> ListExportsResponse |
Create a value of ListExportsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:exports:ListExportsResponse', listExportsResponse_exports - The output for the ListExports action.
ListExports, listExportsResponse_nextToken - If the output exceeds 100 exported output values, a string that
identifies the next page of exports. If there is no additional page,
this value is null.
$sel:httpStatus:ListExportsResponse', listExportsResponse_httpStatus - The response's http status code.
ListImports (Paginated)
data ListImports Source #
See: newListImports smart constructor.
Constructors
| ListImports' (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> ListImports |
Create a value of ListImports with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListImports, listImports_nextToken - A string (provided by the ListImports response output) that identifies
the next page of stacks that are importing the specified exported output
value.
ListImports, listImports_exportName - The name of the exported output value. CloudFormation returns the stack
names that are importing this value.
data ListImportsResponse Source #
See: newListImportsResponse smart constructor.
Instances
newListImportsResponse Source #
Arguments
| :: Int | |
| -> ListImportsResponse |
Create a value of ListImportsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:imports:ListImportsResponse', listImportsResponse_imports - A list of stack names that are importing the specified exported output
value.
ListImports, listImportsResponse_nextToken - A string that identifies the next page of exports. If there is no
additional page, this value is null.
$sel:httpStatus:ListImportsResponse', listImportsResponse_httpStatus - The response's http status code.
ListStackInstances (Paginated)
data ListStackInstances Source #
See: newListStackInstances smart constructor.
Constructors
| ListStackInstances' (Maybe CallAs) (Maybe [StackInstanceFilter]) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) Text |
Instances
newListStackInstances Source #
Arguments
| :: Text | |
| -> ListStackInstances |
Create a value of ListStackInstances with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:callAs:ListStackInstances', listStackInstances_callAs - [Service-managed permissions] Specifies whether you are acting as an
account administrator in the organization's management account or as a
delegated administrator in a member account.
By default, SELF is specified. Use SELF for stack sets with
self-managed permissions.
- If you are signed in to the management account, specify
SELF. If you are signed in to a delegated administrator account, specify
DELEGATED_ADMIN.Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
$sel:filters:ListStackInstances', listStackInstances_filters - The filter to apply to stack instances
$sel:maxResults:ListStackInstances', listStackInstances_maxResults - The maximum number of results to be returned with a single call. If the
number of available results exceeds this maximum, the response includes
a NextToken value that you can assign to the NextToken request
parameter to get the next set of results.
ListStackInstances, listStackInstances_nextToken - If the previous request didn't return all the remaining results, the
response's NextToken parameter value is set to a token. To retrieve
the next set of results, call ListStackInstances again and assign that
token to the request object's NextToken parameter. If there are no
remaining results, the previous response object's NextToken parameter
is set to null.
$sel:stackInstanceAccount:ListStackInstances', listStackInstances_stackInstanceAccount - The name of the Amazon Web Services account that you want to list stack
instances for.
$sel:stackInstanceRegion:ListStackInstances', listStackInstances_stackInstanceRegion - The name of the Region where you want to list stack instances.
ListStackInstances, listStackInstances_stackSetName - The name or unique ID of the stack set that you want to list stack
instances for.
data ListStackInstancesResponse Source #
See: newListStackInstancesResponse smart constructor.
Constructors
| ListStackInstancesResponse' (Maybe Text) (Maybe [StackInstanceSummary]) Int |
Instances
newListStackInstancesResponse Source #
Create a value of ListStackInstancesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListStackInstances, listStackInstancesResponse_nextToken - If the request doesn't return all the remaining results, NextToken is
set to a token. To retrieve the next set of results, call
ListStackInstances again and assign that token to the request
object's NextToken parameter. If the request returns all results,
NextToken is set to null.
$sel:summaries:ListStackInstancesResponse', listStackInstancesResponse_summaries - A list of StackInstanceSummary structures that contain information
about the specified stack instances.
$sel:httpStatus:ListStackInstancesResponse', listStackInstancesResponse_httpStatus - The response's http status code.
ListStackResources (Paginated)
data ListStackResources Source #
The input for the ListStackResource action.
See: newListStackResources smart constructor.
Constructors
| ListStackResources' (Maybe Text) Text |
Instances
newListStackResources Source #
Arguments
| :: Text | |
| -> ListStackResources |
Create a value of ListStackResources with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListStackResources, listStackResources_nextToken - A string that identifies the next page of stack resources that you want
to retrieve.
ListStackResources, listStackResources_stackName - The name or the unique stack ID that is associated with the stack, which
aren't always interchangeable:
- Running stacks: You can specify either the stack's name or its unique stack ID.
- Deleted stacks: You must specify the unique stack ID.
Default: There is no default value.
data ListStackResourcesResponse Source #
The output for a ListStackResources action.
See: newListStackResourcesResponse smart constructor.
Constructors
| ListStackResourcesResponse' (Maybe Text) (Maybe [StackResourceSummary]) Int |
Instances
newListStackResourcesResponse Source #
Create a value of ListStackResourcesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListStackResources, listStackResourcesResponse_nextToken - If the output exceeds 1 MB, a string that identifies the next page of
stack resources. If no additional page exists, this value is null.
$sel:stackResourceSummaries:ListStackResourcesResponse', listStackResourcesResponse_stackResourceSummaries - A list of StackResourceSummary structures.
$sel:httpStatus:ListStackResourcesResponse', listStackResourcesResponse_httpStatus - The response's http status code.
ListStackSetOperationResults (Paginated)
data ListStackSetOperationResults Source #
See: newListStackSetOperationResults smart constructor.
Constructors
| ListStackSetOperationResults' (Maybe CallAs) (Maybe [OperationResultFilter]) (Maybe Natural) (Maybe Text) Text Text |
Instances
newListStackSetOperationResults Source #
Arguments
| :: Text | |
| -> Text | |
| -> ListStackSetOperationResults |
Create a value of ListStackSetOperationResults with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:callAs:ListStackSetOperationResults', listStackSetOperationResults_callAs - [Service-managed permissions] Specifies whether you are acting as an
account administrator in the organization's management account or as a
delegated administrator in a member account.
By default, SELF is specified. Use SELF for stack sets with
self-managed permissions.
- If you are signed in to the management account, specify
SELF. If you are signed in to a delegated administrator account, specify
DELEGATED_ADMIN.Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
$sel:filters:ListStackSetOperationResults', listStackSetOperationResults_filters - The filter to apply to operation results.
$sel:maxResults:ListStackSetOperationResults', listStackSetOperationResults_maxResults - The maximum number of results to be returned with a single call. If the
number of available results exceeds this maximum, the response includes
a NextToken value that you can assign to the NextToken request
parameter to get the next set of results.
ListStackSetOperationResults, listStackSetOperationResults_nextToken - If the previous request didn't return all the remaining results, the
response object's NextToken parameter value is set to a token. To
retrieve the next set of results, call ListStackSetOperationResults
again and assign that token to the request object's NextToken
parameter. If there are no remaining results, the previous response
object's NextToken parameter is set to null.
ListStackSetOperationResults, listStackSetOperationResults_stackSetName - The name or unique ID of the stack set that you want to get operation
results for.
ListStackSetOperationResults, listStackSetOperationResults_operationId - The ID of the stack set operation.
data ListStackSetOperationResultsResponse Source #
See: newListStackSetOperationResultsResponse smart constructor.
Constructors
| ListStackSetOperationResultsResponse' (Maybe Text) (Maybe [StackSetOperationResultSummary]) Int |
Instances
newListStackSetOperationResultsResponse Source #
Arguments
| :: Int | |
| -> ListStackSetOperationResultsResponse |
Create a value of ListStackSetOperationResultsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListStackSetOperationResults, listStackSetOperationResultsResponse_nextToken - If the request doesn't return all results, NextToken is set to a
token. To retrieve the next set of results, call ListOperationResults
again and assign that token to the request object's NextToken
parameter. If there are no remaining results, NextToken is set to
null.
$sel:summaries:ListStackSetOperationResultsResponse', listStackSetOperationResultsResponse_summaries - A list of StackSetOperationResultSummary structures that contain
information about the specified operation results, for accounts and
Amazon Web Services Regions that are included in the operation.
$sel:httpStatus:ListStackSetOperationResultsResponse', listStackSetOperationResultsResponse_httpStatus - The response's http status code.
ListStackSetOperations (Paginated)
data ListStackSetOperations Source #
See: newListStackSetOperations smart constructor.
Instances
newListStackSetOperations Source #
Arguments
| :: Text | |
| -> ListStackSetOperations |
Create a value of ListStackSetOperations with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:callAs:ListStackSetOperations', listStackSetOperations_callAs - [Service-managed permissions] Specifies whether you are acting as an
account administrator in the organization's management account or as a
delegated administrator in a member account.
By default, SELF is specified. Use SELF for stack sets with
self-managed permissions.
- If you are signed in to the management account, specify
SELF. If you are signed in to a delegated administrator account, specify
DELEGATED_ADMIN.Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
$sel:maxResults:ListStackSetOperations', listStackSetOperations_maxResults - The maximum number of results to be returned with a single call. If the
number of available results exceeds this maximum, the response includes
a NextToken value that you can assign to the NextToken request
parameter to get the next set of results.
ListStackSetOperations, listStackSetOperations_nextToken - If the previous paginated request didn't return all of the remaining
results, the response object's NextToken parameter value is set to a
token. To retrieve the next set of results, call
ListStackSetOperations again and assign that token to the request
object's NextToken parameter. If there are no remaining results, the
previous response object's NextToken parameter is set to null.
ListStackSetOperations, listStackSetOperations_stackSetName - The name or unique ID of the stack set that you want to get operation
summaries for.
data ListStackSetOperationsResponse Source #
See: newListStackSetOperationsResponse smart constructor.
Constructors
| ListStackSetOperationsResponse' (Maybe Text) (Maybe [StackSetOperationSummary]) Int |
Instances
newListStackSetOperationsResponse Source #
Create a value of ListStackSetOperationsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListStackSetOperations, listStackSetOperationsResponse_nextToken - If the request doesn't return all results, NextToken is set to a
token. To retrieve the next set of results, call ListOperationResults
again and assign that token to the request object's NextToken
parameter. If there are no remaining results, NextToken is set to
null.
$sel:summaries:ListStackSetOperationsResponse', listStackSetOperationsResponse_summaries - A list of StackSetOperationSummary structures that contain summary
information about operations for the specified stack set.
$sel:httpStatus:ListStackSetOperationsResponse', listStackSetOperationsResponse_httpStatus - The response's http status code.
ListStackSets (Paginated)
data ListStackSets Source #
See: newListStackSets smart constructor.
Constructors
| ListStackSets' (Maybe CallAs) (Maybe Natural) (Maybe Text) (Maybe StackSetStatus) |
Instances
newListStackSets :: ListStackSets Source #
Create a value of ListStackSets with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:callAs:ListStackSets', listStackSets_callAs - [Service-managed permissions] Specifies whether you are acting as an
account administrator in the management account or as a delegated
administrator in a member account.
By default, SELF is specified. Use SELF for stack sets with
self-managed permissions.
- If you are signed in to the management account, specify
SELF. If you are signed in to a delegated administrator account, specify
DELEGATED_ADMIN.Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
$sel:maxResults:ListStackSets', listStackSets_maxResults - The maximum number of results to be returned with a single call. If the
number of available results exceeds this maximum, the response includes
a NextToken value that you can assign to the NextToken request
parameter to get the next set of results.
ListStackSets, listStackSets_nextToken - If the previous paginated request didn't return all the remaining
results, the response object's NextToken parameter value is set to a
token. To retrieve the next set of results, call ListStackSets again
and assign that token to the request object's NextToken parameter. If
there are no remaining results, the previous response object's
NextToken parameter is set to null.
ListStackSets, listStackSets_status - The status of the stack sets that you want to get summary information
about.
data ListStackSetsResponse Source #
See: newListStackSetsResponse smart constructor.
Constructors
| ListStackSetsResponse' (Maybe Text) (Maybe [StackSetSummary]) Int |
Instances
newListStackSetsResponse Source #
Create a value of ListStackSetsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListStackSets, listStackSetsResponse_nextToken - If the request doesn't return all of the remaining results, NextToken
is set to a token. To retrieve the next set of results, call
ListStackInstances again and assign that token to the request
object's NextToken parameter. If the request returns all results,
NextToken is set to null.
$sel:summaries:ListStackSetsResponse', listStackSetsResponse_summaries - A list of StackSetSummary structures that contain information about
the user's stack sets.
$sel:httpStatus:ListStackSetsResponse', listStackSetsResponse_httpStatus - The response's http status code.
ListStacks (Paginated)
data ListStacks Source #
The input for ListStacks action.
See: newListStacks smart constructor.
Constructors
| ListStacks' (Maybe Text) (Maybe [StackStatus]) |
Instances
newListStacks :: ListStacks Source #
Create a value of ListStacks with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListStacks, listStacks_nextToken - A string that identifies the next page of stacks that you want to
retrieve.
$sel:stackStatusFilter:ListStacks', listStacks_stackStatusFilter - Stack status to use as a filter. Specify one or more stack status codes
to list only stacks with the specified status codes. For a complete list
of stack status codes, see the StackStatus parameter of the Stack data
type.
data ListStacksResponse Source #
The output for ListStacks action.
See: newListStacksResponse smart constructor.
Constructors
| ListStacksResponse' (Maybe Text) (Maybe [StackSummary]) Int |
Instances
newListStacksResponse Source #
Arguments
| :: Int | |
| -> ListStacksResponse |
Create a value of ListStacksResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListStacks, listStacksResponse_nextToken - If the output exceeds 1 MB in size, a string that identifies the next
page of stacks. If no additional page exists, this value is null.
$sel:stackSummaries:ListStacksResponse', listStacksResponse_stackSummaries - A list of StackSummary structures containing information about the
specified stacks.
$sel:httpStatus:ListStacksResponse', listStacksResponse_httpStatus - The response's http status code.
ListTypeRegistrations
data ListTypeRegistrations Source #
See: newListTypeRegistrations smart constructor.
Constructors
| ListTypeRegistrations' (Maybe Natural) (Maybe Text) (Maybe RegistrationStatus) (Maybe RegistryType) (Maybe Text) (Maybe Text) |
Instances
newListTypeRegistrations :: ListTypeRegistrations Source #
Create a value of ListTypeRegistrations with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListTypeRegistrations', listTypeRegistrations_maxResults - The maximum number of results to be returned with a single call. If the
number of available results exceeds this maximum, the response includes
a NextToken value that you can assign to the NextToken request
parameter to get the next set of results.
ListTypeRegistrations, listTypeRegistrations_nextToken - If the previous paginated request didn't return all the remaining
results, the response object's NextToken parameter value is set to a
token. To retrieve the next set of results, call this action again and
assign that token to the request object's NextToken parameter. If
there are no remaining results, the previous response object's
NextToken parameter is set to null.
$sel:registrationStatusFilter:ListTypeRegistrations', listTypeRegistrations_registrationStatusFilter - The current status of the extension registration request.
The default is IN_PROGRESS.
ListTypeRegistrations, listTypeRegistrations_type - The kind of extension.
Conditional: You must specify either TypeName and Type, or Arn.
ListTypeRegistrations, listTypeRegistrations_typeArn - The Amazon Resource Name (ARN) of the extension.
Conditional: You must specify either TypeName and Type, or Arn.
ListTypeRegistrations, listTypeRegistrations_typeName - The name of the extension.
Conditional: You must specify either TypeName and Type, or Arn.
data ListTypeRegistrationsResponse Source #
See: newListTypeRegistrationsResponse smart constructor.
Instances
newListTypeRegistrationsResponse Source #
Create a value of ListTypeRegistrationsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTypeRegistrations, listTypeRegistrationsResponse_nextToken - If the request doesn't return all the remaining results, NextToken is
set to a token. To retrieve the next set of results, call this action
again and assign that token to the request object's NextToken
parameter. If the request returns all results, NextToken is set to
null.
$sel:registrationTokenList:ListTypeRegistrationsResponse', listTypeRegistrationsResponse_registrationTokenList - A list of extension registration tokens.
Use DescribeTypeRegistration to return detailed information
about a type registration request.
$sel:httpStatus:ListTypeRegistrationsResponse', listTypeRegistrationsResponse_httpStatus - The response's http status code.
ListTypeVersions
data ListTypeVersions Source #
See: newListTypeVersions smart constructor.
Constructors
| ListTypeVersions' (Maybe Text) (Maybe DeprecatedStatus) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe RegistryType) (Maybe Text) |
Instances
newListTypeVersions :: ListTypeVersions Source #
Create a value of ListTypeVersions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTypeVersions, listTypeVersions_arn - The Amazon Resource Name (ARN) of the extension for which you want
version summary information.
Conditional: You must specify either TypeName and Type, or Arn.
$sel:deprecatedStatus:ListTypeVersions', listTypeVersions_deprecatedStatus - The deprecation status of the extension versions that you want to get
summary information about.
Valid values include:
LIVE: The extension version is registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.DEPRECATED: The extension version has been deregistered and can no longer be used in CloudFormation operations.
The default is LIVE.
$sel:maxResults:ListTypeVersions', listTypeVersions_maxResults - The maximum number of results to be returned with a single call. If the
number of available results exceeds this maximum, the response includes
a NextToken value that you can assign to the NextToken request
parameter to get the next set of results.
ListTypeVersions, listTypeVersions_nextToken - If the previous paginated request didn't return all of the remaining
results, the response object's NextToken parameter value is set to a
token. To retrieve the next set of results, call this action again and
assign that token to the request object's NextToken parameter. If
there are no remaining results, the previous response object's
NextToken parameter is set to null.
ListTypeVersions, listTypeVersions_publisherId - The publisher ID of the extension publisher.
Extensions published by Amazon aren't assigned a publisher ID.
ListTypeVersions, listTypeVersions_type - The kind of the extension.
Conditional: You must specify either TypeName and Type, or Arn.
ListTypeVersions, listTypeVersions_typeName - The name of the extension for which you want version summary
information.
Conditional: You must specify either TypeName and Type, or Arn.
data ListTypeVersionsResponse Source #
See: newListTypeVersionsResponse smart constructor.
Constructors
| ListTypeVersionsResponse' (Maybe Text) (Maybe [TypeVersionSummary]) Int |
Instances
newListTypeVersionsResponse Source #
Create a value of ListTypeVersionsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTypeVersions, listTypeVersionsResponse_nextToken - If the request doesn't return all of the remaining results, NextToken
is set to a token. To retrieve the next set of results, call this action
again and assign that token to the request object's NextToken
parameter. If the request returns all results, NextToken is set to
null.
$sel:typeVersionSummaries:ListTypeVersionsResponse', listTypeVersionsResponse_typeVersionSummaries - A list of TypeVersionSummary structures that contain information about
the specified extension's versions.
$sel:httpStatus:ListTypeVersionsResponse', listTypeVersionsResponse_httpStatus - The response's http status code.
ListTypes (Paginated)
See: newListTypes smart constructor.
Constructors
| ListTypes' (Maybe DeprecatedStatus) (Maybe TypeFilters) (Maybe Natural) (Maybe Text) (Maybe ProvisioningType) (Maybe RegistryType) (Maybe Visibility) |
Instances
newListTypes :: ListTypes Source #
Create a value of ListTypes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deprecatedStatus:ListTypes', listTypes_deprecatedStatus - The deprecation status of the extension that you want to get summary
information about.
Valid values include:
LIVE: The extension is registered for use in CloudFormation operations.DEPRECATED: The extension has been deregistered and can no longer be used in CloudFormation operations.
$sel:filters:ListTypes', listTypes_filters - Filter criteria to use in determining which extensions to return.
Filters must be compatible with Visibility to return valid results.
For example, specifying AWS_TYPES for Category and PRIVATE for
Visibility returns an empty list of types, but specifying PUBLIC for
Visibility returns the desired list.
$sel:maxResults:ListTypes', listTypes_maxResults - The maximum number of results to be returned with a single call. If the
number of available results exceeds this maximum, the response includes
a NextToken value that you can assign to the NextToken request
parameter to get the next set of results.
ListTypes, listTypes_nextToken - If the previous paginated request didn't return all the remaining
results, the response object's NextToken parameter value is set to a
token. To retrieve the next set of results, call this action again and
assign that token to the request object's NextToken parameter. If
there are no remaining results, the previous response object's
NextToken parameter is set to null.
$sel:provisioningType:ListTypes', listTypes_provisioningType - For resource types, the provisioning behavior of the resource type.
CloudFormation determines the provisioning type during registration,
based on the types of handlers in the schema handler package submitted.
Valid values include:
FULLY_MUTABLE: The resource type includes an update handler to process updates to the type during stack update operations.IMMUTABLE: The resource type doesn't include an update handler, so the type can't be updated and must instead be replaced during stack update operations.NON_PROVISIONABLE: The resource type doesn't include create, read, and delete handlers, and therefore can't actually be provisioned.
The default is FULLY_MUTABLE.
ListTypes, listTypes_type - The type of extension.
$sel:visibility:ListTypes', listTypes_visibility - The scope at which the extensions are visible and usable in
CloudFormation operations.
Valid values include:
PRIVATE: Extensions that are visible and usable within this account and region. This includes:- Private extensions you have registered in this account and region.
- Public extensions that you have activated in this account and region.
PUBLIC: Extensions that are publicly visible and available to be activated within any Amazon Web Services account. This includes extensions from Amazon Web Services, in addition to third-party publishers.
The default is PRIVATE.
data ListTypesResponse Source #
See: newListTypesResponse smart constructor.
Constructors
| ListTypesResponse' (Maybe Text) (Maybe [TypeSummary]) Int |
Instances
Arguments
| :: Int | |
| -> ListTypesResponse |
Create a value of ListTypesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTypes, listTypesResponse_nextToken - If the request doesn't return all the remaining results, NextToken is
set to a token. To retrieve the next set of results, call this action
again and assign that token to the request object's NextToken
parameter. If the request returns all results, NextToken is set to
null.
$sel:typeSummaries:ListTypesResponse', listTypesResponse_typeSummaries - A list of TypeSummary structures that contain information about the
specified extensions.
$sel:httpStatus:ListTypesResponse', listTypesResponse_httpStatus - The response's http status code.
PublishType
data PublishType Source #
See: newPublishType smart constructor.
Constructors
| PublishType' (Maybe Text) (Maybe Text) (Maybe ThirdPartyType) (Maybe Text) |
Instances
newPublishType :: PublishType Source #
Create a value of PublishType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PublishType, publishType_arn - The Amazon Resource Name (ARN) of the extension.
Conditional: You must specify Arn, or TypeName and Type.
PublishType, publishType_publicVersionNumber - The version number to assign to this version of the extension.
Use the following format, and adhere to semantic versioning when assigning a version number to your extension:
MAJOR.MINOR.PATCH
For more information, see Semantic Versioning 2.0.0.
If you don't specify a version number, CloudFormation increments the version number by one minor version release.
You cannot specify a version number the first time you publish a type.
CloudFormation automatically sets the first version number to be
1.0.0.
PublishType, publishType_type - The type of the extension.
Conditional: You must specify Arn, or TypeName and Type.
PublishType, publishType_typeName - The name of the extension.
Conditional: You must specify Arn, or TypeName and Type.
data PublishTypeResponse Source #
See: newPublishTypeResponse smart constructor.
Constructors
| PublishTypeResponse' (Maybe Text) Int |
Instances
newPublishTypeResponse Source #
Arguments
| :: Int | |
| -> PublishTypeResponse |
Create a value of PublishTypeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:publicTypeArn:PublishTypeResponse', publishTypeResponse_publicTypeArn - The Amazon Resource Name (ARN) assigned to the public extension upon
publication.
$sel:httpStatus:PublishTypeResponse', publishTypeResponse_httpStatus - The response's http status code.
RecordHandlerProgress
data RecordHandlerProgress Source #
See: newRecordHandlerProgress smart constructor.
Constructors
| RecordHandlerProgress' (Maybe Text) (Maybe OperationStatus) (Maybe HandlerErrorCode) (Maybe Text) (Maybe Text) Text OperationStatus |
Instances
newRecordHandlerProgress Source #
Arguments
| :: Text | |
| -> OperationStatus | |
| -> RecordHandlerProgress |
Create a value of RecordHandlerProgress with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
RecordHandlerProgress, recordHandlerProgress_clientRequestToken - Reserved for use by the
CloudFormation CLI.
$sel:currentOperationStatus:RecordHandlerProgress', recordHandlerProgress_currentOperationStatus - Reserved for use by the
CloudFormation CLI.
RecordHandlerProgress, recordHandlerProgress_errorCode - Reserved for use by the
CloudFormation CLI.
$sel:resourceModel:RecordHandlerProgress', recordHandlerProgress_resourceModel - Reserved for use by the
CloudFormation CLI.
$sel:statusMessage:RecordHandlerProgress', recordHandlerProgress_statusMessage - Reserved for use by the
CloudFormation CLI.
$sel:bearerToken:RecordHandlerProgress', recordHandlerProgress_bearerToken - Reserved for use by the
CloudFormation CLI.
$sel:operationStatus:RecordHandlerProgress', recordHandlerProgress_operationStatus - Reserved for use by the
CloudFormation CLI.
data RecordHandlerProgressResponse Source #
See: newRecordHandlerProgressResponse smart constructor.
Constructors
| RecordHandlerProgressResponse' Int |
Instances
newRecordHandlerProgressResponse Source #
Create a value of RecordHandlerProgressResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:RecordHandlerProgressResponse', recordHandlerProgressResponse_httpStatus - The response's http status code.
RegisterPublisher
data RegisterPublisher Source #
See: newRegisterPublisher smart constructor.
Constructors
| RegisterPublisher' (Maybe Bool) (Maybe Text) |
Instances
newRegisterPublisher :: RegisterPublisher Source #
Create a value of RegisterPublisher with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:acceptTermsAndConditions:RegisterPublisher', registerPublisher_acceptTermsAndConditions - Whether you accept the
Terms and Conditions
for publishing extensions in the CloudFormation registry. You must
accept the terms and conditions in order to register to publish public
extensions to the CloudFormation registry.
The default is false.
$sel:connectionArn:RegisterPublisher', registerPublisher_connectionArn - If you are using a Bitbucket or GitHub account for identity
verification, the Amazon Resource Name (ARN) for your connection to that
account.
For more information, see Registering your account to publish CloudFormation extensions in the CloudFormation CLI User Guide.
data RegisterPublisherResponse Source #
See: newRegisterPublisherResponse smart constructor.
Constructors
| RegisterPublisherResponse' (Maybe Text) Int |
Instances
newRegisterPublisherResponse Source #
Create a value of RegisterPublisherResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
RegisterPublisherResponse, registerPublisherResponse_publisherId - The ID assigned this account by CloudFormation for publishing
extensions.
$sel:httpStatus:RegisterPublisherResponse', registerPublisherResponse_httpStatus - The response's http status code.
RegisterType
data RegisterType Source #
See: newRegisterType smart constructor.
Constructors
| RegisterType' (Maybe Text) (Maybe Text) (Maybe LoggingConfig) (Maybe RegistryType) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> RegisterType |
Create a value of RegisterType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
RegisterType, registerType_clientRequestToken - A unique identifier that acts as an idempotency key for this
registration request. Specifying a client request token prevents
CloudFormation from generating more than one version of an extension
from the same registration request, even if the request is submitted
multiple times.
$sel:executionRoleArn:RegisterType', registerType_executionRoleArn - The Amazon Resource Name (ARN) of the IAM role for CloudFormation to
assume when invoking the extension.
For CloudFormation to assume the specified execution role, the role must
contain a trust relationship with the CloudFormation service principle
(resources.cloudformation.amazonaws.com). For more information about
adding trust relationships, see
Modifying a role trust policy
in the Identity and Access Management User Guide.
If your extension calls Amazon Web Services APIs in any of its handlers, you must create an <https:docs.aws.amazon.comIAMlatestUserGuideid_roles.html IAM execution role> that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource type handler, thereby supplying your resource type with the appropriate credentials.
$sel:loggingConfig:RegisterType', registerType_loggingConfig - Specifies logging configuration information for an extension.
RegisterType, registerType_type - The kind of extension.
RegisterType, registerType_typeName - The name of the extension being registered.
We suggest that extension names adhere to the following patterns:
- For resource types, company_or_organization::service::type.
- For modules, company_or_organization::service::type::MODULE.
- For hooks, MyCompany::Testing::MyTestHook.
The following organization namespaces are reserved and can't be used in your extension names:
Alexa
AMZN
Amazon
AWS
Custom
Dev
$sel:schemaHandlerPackage:RegisterType', registerType_schemaHandlerPackage - A URL to the S3 bucket containing the extension project package that
contains the necessary files for the extension you want to register.
For information about generating a schema handler package for the extension you want to register, see submit in the CloudFormation CLI User Guide.
The user registering the extension must be able to access the package in the S3 bucket. That's, the user needs to have GetObject permissions for the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Identity and Access Management User Guide.
data RegisterTypeResponse Source #
See: newRegisterTypeResponse smart constructor.
Constructors
| RegisterTypeResponse' (Maybe Text) Int |
Instances
newRegisterTypeResponse Source #
Arguments
| :: Int | |
| -> RegisterTypeResponse |
Create a value of RegisterTypeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:registrationToken:RegisterTypeResponse', registerTypeResponse_registrationToken - The identifier for this registration request.
Use this registration token when calling
DescribeTypeRegistration , which returns information about the
status and IDs of the extension registration.
$sel:httpStatus:RegisterTypeResponse', registerTypeResponse_httpStatus - The response's http status code.
RollbackStack
data RollbackStack Source #
See: newRollbackStack smart constructor.
Instances
Arguments
| :: Text | |
| -> RollbackStack |
Create a value of RollbackStack with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
RollbackStack, rollbackStack_clientRequestToken - A unique identifier for this RollbackStack request.
RollbackStack, rollbackStack_roleARN - The Amazon Resource Name (ARN) of an Identity and Access Management role
that CloudFormation assumes to rollback the stack.
RollbackStack, rollbackStack_stackName - The name that's associated with the stack.
data RollbackStackResponse Source #
See: newRollbackStackResponse smart constructor.
Constructors
| RollbackStackResponse' (Maybe Text) Int |
Instances
newRollbackStackResponse Source #
Create a value of RollbackStackResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
RollbackStackResponse, rollbackStackResponse_stackId - Unique identifier of the stack.
$sel:httpStatus:RollbackStackResponse', rollbackStackResponse_httpStatus - The response's http status code.
SetStackPolicy
data SetStackPolicy Source #
The input for the SetStackPolicy action.
See: newSetStackPolicy smart constructor.
Instances
Arguments
| :: Text | |
| -> SetStackPolicy |
Create a value of SetStackPolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:stackPolicyBody:SetStackPolicy', setStackPolicy_stackPolicyBody - Structure containing the stack policy body. For more information, go to
Prevent updates to stack resources
in the CloudFormation User Guide. You can specify either the
StackPolicyBody or the StackPolicyURL parameter, but not both.
$sel:stackPolicyURL:SetStackPolicy', setStackPolicy_stackPolicyURL - Location of a file containing the stack policy. The URL must point to a
policy (maximum size: 16 KB) located in an Amazon S3 bucket in the same
Amazon Web Services Region as the stack. You can specify either the
StackPolicyBody or the StackPolicyURL parameter, but not both.
SetStackPolicy, setStackPolicy_stackName - The name or unique stack ID that you want to associate a policy with.
data SetStackPolicyResponse Source #
See: newSetStackPolicyResponse smart constructor.
Constructors
| SetStackPolicyResponse' | |
Instances
newSetStackPolicyResponse :: SetStackPolicyResponse Source #
Create a value of SetStackPolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
SetTypeConfiguration
data SetTypeConfiguration Source #
See: newSetTypeConfiguration smart constructor.
Constructors
| SetTypeConfiguration' (Maybe Text) (Maybe ThirdPartyType) (Maybe Text) (Maybe Text) Text |
Instances
newSetTypeConfiguration Source #
Arguments
| :: Text | |
| -> SetTypeConfiguration |
Create a value of SetTypeConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:configurationAlias:SetTypeConfiguration', setTypeConfiguration_configurationAlias - An alias by which to refer to this extension configuration data.
Conditional: Specifying a configuration alias is required when setting a configuration for a resource type extension.
SetTypeConfiguration, setTypeConfiguration_type - The type of extension.
Conditional: You must specify ConfigurationArn, or Type and
TypeName.
SetTypeConfiguration, setTypeConfiguration_typeArn - The Amazon Resource Name (ARN) for the extension, in this account and
region.
For public extensions, this will be the ARN assigned when you activate the type in this account and region. For private extensions, this will be the ARN assigned when you register the type in this account and region.
Do not include the extension versions suffix at the end of the ARN. You can set the configuration for an extension, but not for a specific extension version.
SetTypeConfiguration, setTypeConfiguration_typeName - The name of the extension.
Conditional: You must specify ConfigurationArn, or Type and
TypeName.
SetTypeConfiguration, setTypeConfiguration_configuration - The configuration data for the extension, in this account and region.
The configuration data must be formatted as JSON, and validate against
the schema returned in the ConfigurationSchema response element of
API_DescribeType.
For more information, see
Defining account-level configuration data for an extension
in the CloudFormation CLI User Guide.
data SetTypeConfigurationResponse Source #
See: newSetTypeConfigurationResponse smart constructor.
Constructors
| SetTypeConfigurationResponse' (Maybe Text) Int |
Instances
newSetTypeConfigurationResponse Source #
Create a value of SetTypeConfigurationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:configurationArn:SetTypeConfigurationResponse', setTypeConfigurationResponse_configurationArn - The Amazon Resource Name (ARN) for the configuration data, in this
account and region.
Conditional: You must specify ConfigurationArn, or Type and
TypeName.
$sel:httpStatus:SetTypeConfigurationResponse', setTypeConfigurationResponse_httpStatus - The response's http status code.
SetTypeDefaultVersion
data SetTypeDefaultVersion Source #
See: newSetTypeDefaultVersion smart constructor.
Constructors
| SetTypeDefaultVersion' (Maybe Text) (Maybe RegistryType) (Maybe Text) (Maybe Text) |
Instances
newSetTypeDefaultVersion :: SetTypeDefaultVersion Source #
Create a value of SetTypeDefaultVersion with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
SetTypeDefaultVersion, setTypeDefaultVersion_arn - The Amazon Resource Name (ARN) of the extension for which you want
version summary information.
Conditional: You must specify either TypeName and Type, or Arn.
SetTypeDefaultVersion, setTypeDefaultVersion_type - The kind of extension.
Conditional: You must specify either TypeName and Type, or Arn.
SetTypeDefaultVersion, setTypeDefaultVersion_typeName - The name of the extension.
Conditional: You must specify either TypeName and Type, or Arn.
SetTypeDefaultVersion, setTypeDefaultVersion_versionId - The ID of a specific version of the extension. The version ID is the
value at the end of the Amazon Resource Name (ARN) assigned to the
extension version when it is registered.
data SetTypeDefaultVersionResponse Source #
See: newSetTypeDefaultVersionResponse smart constructor.
Constructors
| SetTypeDefaultVersionResponse' Int |
Instances
newSetTypeDefaultVersionResponse Source #
Create a value of SetTypeDefaultVersionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:SetTypeDefaultVersionResponse', setTypeDefaultVersionResponse_httpStatus - The response's http status code.
SignalResource
data SignalResource Source #
The input for the SignalResource action.
See: newSignalResource smart constructor.
Constructors
| SignalResource' Text Text Text ResourceSignalStatus |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> ResourceSignalStatus | |
| -> SignalResource |
Create a value of SignalResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
SignalResource, signalResource_stackName - The stack name or unique stack ID that includes the resource that you
want to signal.
SignalResource, signalResource_logicalResourceId - The logical ID of the resource that you want to signal. The logical ID
is the name of the resource that given in the template.
$sel:uniqueId:SignalResource', signalResource_uniqueId - A unique ID of the signal. When you signal Amazon EC2 instances or Auto
Scaling groups, specify the instance ID that you are signaling as the
unique ID. If you send multiple signals to a single resource (such as
signaling a wait condition), each signal requires a different unique ID.
SignalResource, signalResource_status - The status of the signal, which is either success or failure. A failure
signal causes CloudFormation to immediately fail the stack creation or
update.
data SignalResourceResponse Source #
See: newSignalResourceResponse smart constructor.
Constructors
| SignalResourceResponse' | |
Instances
newSignalResourceResponse :: SignalResourceResponse Source #
Create a value of SignalResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
StopStackSetOperation
data StopStackSetOperation Source #
See: newStopStackSetOperation smart constructor.
Constructors
| StopStackSetOperation' (Maybe CallAs) Text Text |
Instances
newStopStackSetOperation Source #
Arguments
| :: Text | |
| -> Text | |
| -> StopStackSetOperation |
Create a value of StopStackSetOperation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:callAs:StopStackSetOperation', stopStackSetOperation_callAs - [Service-managed permissions] Specifies whether you are acting as an
account administrator in the organization's management account or as a
delegated administrator in a member account.
By default, SELF is specified. Use SELF for stack sets with
self-managed permissions.
- If you are signed in to the management account, specify
SELF. If you are signed in to a delegated administrator account, specify
DELEGATED_ADMIN.Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
StopStackSetOperation, stopStackSetOperation_stackSetName - The name or unique ID of the stack set that you want to stop the
operation for.
StopStackSetOperation, stopStackSetOperation_operationId - The ID of the stack operation.
data StopStackSetOperationResponse Source #
See: newStopStackSetOperationResponse smart constructor.
Constructors
| StopStackSetOperationResponse' Int |
Instances
newStopStackSetOperationResponse Source #
Create a value of StopStackSetOperationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:StopStackSetOperationResponse', stopStackSetOperationResponse_httpStatus - The response's http status code.
TestType
See: newTestType smart constructor.
Instances
newTestType :: TestType Source #
Create a value of TestType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
TestType, testType_arn - The Amazon Resource Name (ARN) of the extension.
Conditional: You must specify Arn, or TypeName and Type.
$sel:logDeliveryBucket:TestType', testType_logDeliveryBucket - The S3 bucket to which CloudFormation delivers the contract test
execution logs.
CloudFormation delivers the logs by the time contract testing has
completed and the extension has been assigned a test type status of
PASSED or FAILED.
The user calling TestType must be able to access items in the
specified S3 bucket. Specifically, the user needs the following
permissions:
GetObject
PutObject
For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Amazon Web Services Identity and Access Management User Guide.
TestType, testType_type - The type of the extension to test.
Conditional: You must specify Arn, or TypeName and Type.
TestType, testType_typeName - The name of the extension to test.
Conditional: You must specify Arn, or TypeName and Type.
TestType, testType_versionId - The version of the extension to test.
You can specify the version id with either Arn, or with TypeName and
Type.
If you don't specify a version, CloudFormation uses the default version of the extension in this account and region for testing.
data TestTypeResponse Source #
See: newTestTypeResponse smart constructor.
Constructors
| TestTypeResponse' (Maybe Text) Int |
Instances
Arguments
| :: Int | |
| -> TestTypeResponse |
Create a value of TestTypeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:typeVersionArn:TestTypeResponse', testTypeResponse_typeVersionArn - The Amazon Resource Name (ARN) of the extension.
$sel:httpStatus:TestTypeResponse', testTypeResponse_httpStatus - The response's http status code.
UpdateStack
data UpdateStack Source #
The input for an UpdateStack action.
See: newUpdateStack smart constructor.
Constructors
| UpdateStack' (Maybe [Capability]) (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe [Parameter]) (Maybe [Text]) (Maybe Text) (Maybe RollbackConfiguration) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe Text) (Maybe Text) (Maybe Bool) Text |
Instances
Arguments
| :: Text | |
| -> UpdateStack |
Create a value of UpdateStack with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateStack, updateStack_capabilities - In some cases, you must explicitly acknowledge that your stack template
contains certain capabilities in order for CloudFormation to update the
stack.
CAPABILITY_IAMandCAPABILITY_NAMED_IAMSome stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the
CAPABILITY_IAMorCAPABILITY_NAMED_IAMcapability.- If you have IAM resources, you can specify either capability.
- If you have IAM resources with custom names, you must specify
CAPABILITY_NAMED_IAM. - If you don't specify either of these capabilities,
CloudFormation returns an
InsufficientCapabilitieserror.
If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.
- AWS::IAM::AccessKey
- AWS::IAM::Group
- AWS::IAM::InstanceProfile
- AWS::IAM::Policy
- AWS::IAM::Role
- AWS::IAM::User
- AWS::IAM::UserToGroupAddition
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually updating the stack. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.
You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.
For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
UpdateStack, updateStack_clientRequestToken - A unique identifier for this UpdateStack request. Specify this token
if you plan to retry requests so that CloudFormation knows that you're
not attempting to update a stack with the same name. You might retry
UpdateStack requests to ensure that CloudFormation successfully
received them.
All events triggered by a given stack operation are assigned the same
client request token, which you can use to track operations. For
example, if you execute a CreateStack operation with the token
token1, then all the StackEvents generated by that operation will
have ClientRequestToken set as token1.
In the console, stack operations display the client request token on the
Events tab. Stack operations that are initiated from the console use the
token format Console-StackOperation-ID, which helps you easily
identify the stack operation . For example, if you create a stack using
the console, each stack event would be assigned the same token in the
following format:
Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
UpdateStack, updateStack_disableRollback - Preserve the state of previously provisioned resources when an operation
fails.
Default: False
UpdateStack, updateStack_notificationARNs - Amazon Simple Notification Service topic Amazon Resource Names (ARNs)
that CloudFormation associates with the stack. Specify an empty list to
remove all notification topics.
UpdateStack, updateStack_parameters - A list of Parameter structures that specify input parameters for the
stack. For more information, see the
Parameter
data type.
$sel:resourceTypes:UpdateStack', updateStack_resourceTypes - The template resource types that you have permissions to work with for
this update stack action, such as AWS::EC2::Instance, AWS::EC2::*,
or Custom::MyCustomInstance.
If the list of resource types doesn't include a resource that you're updating, the stack update fails. By default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.
UpdateStack, updateStack_roleARN - The Amazon Resource Name (ARN) of an Identity and Access Management
(IAM) role that CloudFormation assumes to update the stack.
CloudFormation uses the role's credentials to make calls on your
behalf. CloudFormation always uses this role for all future operations
on the stack. Provided that users have permission to operate on the
stack, CloudFormation uses this role even if the users don't have
permission to pass it. Ensure that the role grants least privilege.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.
UpdateStack, updateStack_rollbackConfiguration - The rollback triggers for CloudFormation to monitor during stack
creation and updating operations, and for the specified monitoring
period afterwards.
$sel:stackPolicyBody:UpdateStack', updateStack_stackPolicyBody - Structure containing a new stack policy body. You can specify either the
StackPolicyBody or the StackPolicyURL parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you don't specify a stack policy, the current policy that is associated with the stack is unchanged.
$sel:stackPolicyDuringUpdateBody:UpdateStack', updateStack_stackPolicyDuringUpdateBody - Structure containing the temporary overriding stack policy body. You can
specify either the StackPolicyDuringUpdateBody or the
StackPolicyDuringUpdateURL parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If you don't specify a stack policy, the current policy that is associated with the stack will be used.
$sel:stackPolicyDuringUpdateURL:UpdateStack', updateStack_stackPolicyDuringUpdateURL - Location of a file containing the temporary overriding stack policy. The
URL must point to a policy (max size: 16KB) located in an S3 bucket in
the same Region as the stack. You can specify either the
StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL
parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If you don't specify a stack policy, the current policy that is associated with the stack will be used.
$sel:stackPolicyURL:UpdateStack', updateStack_stackPolicyURL - Location of a file containing the updated stack policy. The URL must
point to a policy (max size: 16KB) located in an S3 bucket in the same
Region as the stack. You can specify either the StackPolicyBody or the
StackPolicyURL parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you don't specify a stack policy, the current policy that is associated with the stack is unchanged.
UpdateStack, updateStack_tags - Key-value pairs to associate with this stack. CloudFormation also
propagates these tags to supported resources in the stack. You can
specify a maximum number of 50 tags.
If you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you specify an empty value, CloudFormation removes all associated tags.
UpdateStack, updateStack_templateBody - Structure containing the template body with a minimum length of 1 byte
and a maximum length of 51,200 bytes. (For more information, go to
Template Anatomy
in the CloudFormation User Guide.)
Conditional: You must specify only one of the following parameters:
TemplateBody, TemplateURL, or set the UsePreviousTemplate to
true.
$sel:templateURL:UpdateStack', updateStack_templateURL - Location of file containing the template body. The URL must point to a
template that's located in an Amazon S3 bucket or a Systems Manager
document. For more information, go to
Template Anatomy
in the CloudFormation User Guide.
Conditional: You must specify only one of the following parameters:
TemplateBody, TemplateURL, or set the UsePreviousTemplate to
true.
$sel:usePreviousTemplate:UpdateStack', updateStack_usePreviousTemplate - Reuse the existing template that is associated with the stack that you
are updating.
Conditional: You must specify only one of the following parameters:
TemplateBody, TemplateURL, or set the UsePreviousTemplate to
true.
UpdateStack, updateStack_stackName - The name or unique stack ID of the stack to update.
data UpdateStackResponse Source #
The output for an UpdateStack action.
See: newUpdateStackResponse smart constructor.
Constructors
| UpdateStackResponse' (Maybe Text) Int |
Instances
newUpdateStackResponse Source #
Arguments
| :: Int | |
| -> UpdateStackResponse |
Create a value of UpdateStackResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateStackResponse, updateStackResponse_stackId - Unique identifier of the stack.
$sel:httpStatus:UpdateStackResponse', updateStackResponse_httpStatus - The response's http status code.
UpdateStackInstances
data UpdateStackInstances Source #
See: newUpdateStackInstances smart constructor.
Constructors
| UpdateStackInstances' (Maybe [Text]) (Maybe CallAs) (Maybe DeploymentTargets) (Maybe Text) (Maybe StackSetOperationPreferences) (Maybe [Parameter]) Text [Text] |
Instances
newUpdateStackInstances Source #
Arguments
| :: Text | |
| -> UpdateStackInstances |
Create a value of UpdateStackInstances with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateStackInstances, updateStackInstances_accounts - [Self-managed permissions] The names of one or more Amazon Web Services
accounts for which you want to update parameter values for stack
instances. The overridden parameter values will be applied to all stack
instances in the specified accounts and Amazon Web Services Regions.
You can specify Accounts or DeploymentTargets, but not both.
$sel:callAs:UpdateStackInstances', updateStackInstances_callAs - [Service-managed permissions] Specifies whether you are acting as an
account administrator in the organization's management account or as a
delegated administrator in a member account.
By default, SELF is specified. Use SELF for stack sets with
self-managed permissions.
- If you are signed in to the management account, specify
SELF. If you are signed in to a delegated administrator account, specify
DELEGATED_ADMIN.Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
UpdateStackInstances, updateStackInstances_deploymentTargets - [Service-managed permissions] The Organizations accounts for which you
want to update parameter values for stack instances. If your update
targets OUs, the overridden parameter values only apply to the accounts
that are currently in the target OUs and their child OUs. Accounts added
to the target OUs and their child OUs in the future won't use the
overridden values.
You can specify Accounts or DeploymentTargets, but not both.
UpdateStackInstances, updateStackInstances_operationId - The unique identifier for this stack set operation.
The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.
If you don't specify an operation ID, the SDK generates one automatically.
UpdateStackInstances, updateStackInstances_operationPreferences - Preferences for how CloudFormation performs this stack set operation.
UpdateStackInstances, updateStackInstances_parameterOverrides - A list of input parameters whose values you want to update for the
specified stack instances.
Any overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance update operations:
- To override the current value for a parameter, include the parameter and specify its value.
- To leave an overridden parameter set to its present value, include
the parameter and specify
UsePreviousValueastrue. (You can't specify both a value and setUsePreviousValuetotrue.) - To set an overridden parameter back to the value specified in the stack set, specify a parameter list but don't include the parameter in the list.
- To leave all parameters set to their present values, don't specify this property at all.
During stack set updates, any parameter values overridden for a stack instance aren't updated, but retain their overridden value.
You can only override the parameter values that are specified in the
stack set; to add or delete a parameter itself, use UpdateStackSet to
update the stack set template. If you add a parameter to a template,
before you can override the parameter value specified in the stack set
you must first use
UpdateStackSet
to update all stack instances with the updated template and parameter
value specified in the stack set. Once a stack instance has been updated
with the new parameter, you can then override the parameter value using
UpdateStackInstances.
UpdateStackInstances, updateStackInstances_stackSetName - The name or unique ID of the stack set associated with the stack
instances.
$sel:regions:UpdateStackInstances', updateStackInstances_regions - The names of one or more Amazon Web Services Regions in which you want
to update parameter values for stack instances. The overridden parameter
values will be applied to all stack instances in the specified accounts
and Amazon Web Services Regions.
data UpdateStackInstancesResponse Source #
See: newUpdateStackInstancesResponse smart constructor.
Constructors
| UpdateStackInstancesResponse' (Maybe Text) Int |
Instances
newUpdateStackInstancesResponse Source #
Create a value of UpdateStackInstancesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateStackInstances, updateStackInstancesResponse_operationId - The unique identifier for this stack set operation.
$sel:httpStatus:UpdateStackInstancesResponse', updateStackInstancesResponse_httpStatus - The response's http status code.
UpdateStackSet
data UpdateStackSet Source #
See: newUpdateStackSet smart constructor.
Constructors
| UpdateStackSet' (Maybe [Text]) (Maybe Text) (Maybe AutoDeployment) (Maybe CallAs) (Maybe [Capability]) (Maybe DeploymentTargets) (Maybe Text) (Maybe Text) (Maybe ManagedExecution) (Maybe Text) (Maybe StackSetOperationPreferences) (Maybe [Parameter]) (Maybe PermissionModels) (Maybe [Text]) (Maybe [Tag]) (Maybe Text) (Maybe Text) (Maybe Bool) Text |
Instances
Arguments
| :: Text | |
| -> UpdateStackSet |
Create a value of UpdateStackSet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateStackSet, updateStackSet_accounts - [Self-managed permissions] The accounts in which to update associated
stack instances. If you specify accounts, you must also specify the
Amazon Web Services Regions in which to update stack set instances.
To update all the stack instances associated with this stack set,
don't specify the Accounts or Regions properties.
If the stack set update includes changes to the template (that is, if
the TemplateBody or TemplateURL properties are specified), or the
Parameters property, CloudFormation marks all stack instances with a
status of OUTDATED prior to updating the stack instances in the
specified accounts and Amazon Web Services Regions. If the stack set
update does not include changes to the template or parameters,
CloudFormation updates the stack instances in the specified accounts and
Amazon Web Services Regions, while leaving all other stack instances
with their existing stack instance status.
UpdateStackSet, updateStackSet_administrationRoleARN - The Amazon Resource Name (ARN) of the IAM role to use to update this
stack set.
Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Granting Permissions for Stack Set Operations in the CloudFormation User Guide.
If you specified a customized administrator role when you created the stack set, you must specify a customized administrator role, even if it is the same customized administrator role used with this stack set previously.
UpdateStackSet, updateStackSet_autoDeployment - [Service-managed permissions] Describes whether StackSets automatically
deploys to Organizations accounts that are added to a target
organization or organizational unit (OU).
If you specify AutoDeployment, don't specify DeploymentTargets or
Regions.
$sel:callAs:UpdateStackSet', updateStackSet_callAs - [Service-managed permissions] Specifies whether you are acting as an
account administrator in the organization's management account or as a
delegated administrator in a member account.
By default, SELF is specified. Use SELF for stack sets with
self-managed permissions.
- If you are signed in to the management account, specify
SELF. If you are signed in to a delegated administrator account, specify
DELEGATED_ADMIN.Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
UpdateStackSet, updateStackSet_capabilities - In some cases, you must explicitly acknowledge that your stack template
contains certain capabilities in order for CloudFormation to update the
stack set and its associated stack instances.
CAPABILITY_IAMandCAPABILITY_NAMED_IAMSome stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks sets, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the
CAPABILITY_IAMorCAPABILITY_NAMED_IAMcapability.- If you have IAM resources, you can specify either capability.
- If you have IAM resources with custom names, you must specify
CAPABILITY_NAMED_IAM. - If you don't specify either of these capabilities,
CloudFormation returns an
InsufficientCapabilitieserror.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
- AWS::IAM::AccessKey
- AWS::IAM::Group
- AWS::IAM::InstanceProfile
- AWS::IAM::Policy
- AWS::IAM::Role
- AWS::IAM::User
- AWS::IAM::UserToGroupAddition
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some templates reference macros. If your stack set template references one or more macros, you must update the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To update the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
Stack sets with service-managed permissions do not currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.
UpdateStackSet, updateStackSet_deploymentTargets - [Service-managed permissions] The Organizations accounts in which to
update associated stack instances.
To update all the stack instances associated with this stack set, do not
specify DeploymentTargets or Regions.
If the stack set update includes changes to the template (that is, if
TemplateBody or TemplateURL is specified), or the Parameters,
CloudFormation marks all stack instances with a status of OUTDATED
prior to updating the stack instances in the specified accounts and
Amazon Web Services Regions. If the stack set update doesn't include
changes to the template or parameters, CloudFormation updates the stack
instances in the specified accounts and Regions, while leaving all other
stack instances with their existing stack instance status.
UpdateStackSet, updateStackSet_description - A brief description of updates that you are making.
UpdateStackSet, updateStackSet_executionRoleName - The name of the IAM execution role to use to update the stack set. If
you do not specify an execution role, CloudFormation uses the
AWSCloudFormationStackSetExecutionRole role for the stack set
operation.
Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.
If you specify a customized execution role, CloudFormation uses that role to update the stack. If you do not specify a customized execution role, CloudFormation performs the update using the role previously associated with the stack set, so long as you have permissions to perform operations on the stack set.
UpdateStackSet, updateStackSet_managedExecution - Describes whether StackSets performs non-conflicting operations
concurrently and queues conflicting operations.
UpdateStackSet, updateStackSet_operationId - The unique ID for this stack set operation.
The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.
If you don't specify an operation ID, CloudFormation generates one automatically.
Repeating this stack set operation with a new operation ID retries all
stack instances whose status is OUTDATED.
UpdateStackSet, updateStackSet_operationPreferences - Preferences for how CloudFormation performs this stack set operation.
UpdateStackSet, updateStackSet_parameters - A list of input parameters for the stack set template.
UpdateStackSet, updateStackSet_permissionModel - Describes how the IAM roles required for stack set operations are
created. You cannot modify PermissionModel if there are stack
instances associated with your stack set.
- With
self-managedpermissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant Self-Managed Stack Set Permissions. - With
service-managedpermissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
$sel:regions:UpdateStackSet', updateStackSet_regions - The Amazon Web Services Regions in which to update associated stack
instances. If you specify Regions, you must also specify accounts in
which to update stack set instances.
To update all the stack instances associated with this stack set, do
not specify the Accounts or Regions properties.
If the stack set update includes changes to the template (that is, if
the TemplateBody or TemplateURL properties are specified), or the
Parameters property, CloudFormation marks all stack instances with a
status of OUTDATED prior to updating the stack instances in the
specified accounts and Regions. If the stack set update does not include
changes to the template or parameters, CloudFormation updates the stack
instances in the specified accounts and Regions, while leaving all other
stack instances with their existing stack instance status.
UpdateStackSet, updateStackSet_tags - The key-value pairs to associate with this stack set and the stacks
created from it. CloudFormation also propagates these tags to supported
resources that are created in the stacks. You can specify a maximum
number of 50 tags.
If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this stack set. This means:
- If you don't specify this parameter, CloudFormation doesn't modify the stack's tags.
- If you specify any tags using this parameter, you must specify all the tags that you want associated with this stack set, even tags you've specified before (for example, when creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the updated list of tags are removed from the stack set, and therefore from the stacks and resources as well.
- If you specify an empty value, CloudFormation removes all currently associated tags.
If you specify new tags as part of an UpdateStackSet action,
CloudFormation checks to see if you have the required IAM permission to
tag resources. If you omit tags that are currently associated with the
stack set from the list of tags you specify, CloudFormation assumes that
you want to remove those tags from the stack set, and checks to see if
you have permission to untag resources. If you don't have the necessary
permission(s), the entire UpdateStackSet action fails with an
access denied error, and the stack set is not updated.
UpdateStackSet, updateStackSet_templateBody - The structure that contains the template body, with a minimum length of
1 byte and a maximum length of 51,200 bytes. For more information, see
Template Anatomy
in the CloudFormation User Guide.
Conditional: You must specify only one of the following parameters:
TemplateBody or TemplateURL—or set UsePreviousTemplate to true.
$sel:templateURL:UpdateStackSet', updateStackSet_templateURL - The location of the file that contains the template body. The URL must
point to a template (maximum size: 460,800 bytes) that is located in an
Amazon S3 bucket or a Systems Manager document. For more information,
see
Template Anatomy
in the CloudFormation User Guide.
Conditional: You must specify only one of the following parameters:
TemplateBody or TemplateURL—or set UsePreviousTemplate to true.
$sel:usePreviousTemplate:UpdateStackSet', updateStackSet_usePreviousTemplate - Use the existing template that's associated with the stack set that
you're updating.
Conditional: You must specify only one of the following parameters:
TemplateBody or TemplateURL—or set UsePreviousTemplate to true.
UpdateStackSet, updateStackSet_stackSetName - The name or unique ID of the stack set that you want to update.
data UpdateStackSetResponse Source #
See: newUpdateStackSetResponse smart constructor.
Constructors
| UpdateStackSetResponse' (Maybe Text) Int |
Instances
newUpdateStackSetResponse Source #
Create a value of UpdateStackSetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateStackSet, updateStackSetResponse_operationId - The unique ID for this stack set operation.
$sel:httpStatus:UpdateStackSetResponse', updateStackSetResponse_httpStatus - The response's http status code.
UpdateTerminationProtection
data UpdateTerminationProtection Source #
See: newUpdateTerminationProtection smart constructor.
Constructors
| UpdateTerminationProtection' Bool Text |
Instances
newUpdateTerminationProtection Source #
Arguments
| :: Bool | |
| -> Text | |
| -> UpdateTerminationProtection |
Create a value of UpdateTerminationProtection with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateTerminationProtection, updateTerminationProtection_enableTerminationProtection - Whether to enable termination protection on the specified stack.
UpdateTerminationProtection, updateTerminationProtection_stackName - The name or unique ID of the stack for which you want to set termination
protection.
data UpdateTerminationProtectionResponse Source #
See: newUpdateTerminationProtectionResponse smart constructor.
Constructors
| UpdateTerminationProtectionResponse' (Maybe Text) Int |
Instances
newUpdateTerminationProtectionResponse Source #
Arguments
| :: Int | |
| -> UpdateTerminationProtectionResponse |
Create a value of UpdateTerminationProtectionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateTerminationProtectionResponse, updateTerminationProtectionResponse_stackId - The unique ID of the stack.
$sel:httpStatus:UpdateTerminationProtectionResponse', updateTerminationProtectionResponse_httpStatus - The response's http status code.
ValidateTemplate
data ValidateTemplate Source #
The input for ValidateTemplate action.
See: newValidateTemplate smart constructor.
Constructors
| ValidateTemplate' (Maybe Text) (Maybe Text) |
Instances
newValidateTemplate :: ValidateTemplate Source #
Create a value of ValidateTemplate with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ValidateTemplate, validateTemplate_templateBody - Structure containing the template body with a minimum length of 1 byte
and a maximum length of 51,200 bytes. For more information, go to
Template Anatomy
in the CloudFormation User Guide.
Conditional: You must pass TemplateURL or TemplateBody. If both are
passed, only TemplateBody is used.
$sel:templateURL:ValidateTemplate', validateTemplate_templateURL - Location of file containing the template body. The URL must point to a
template (max size: 460,800 bytes) that is located in an Amazon S3
bucket or a Systems Manager document. For more information, go to
Template Anatomy
in the CloudFormation User Guide.
Conditional: You must pass TemplateURL or TemplateBody. If both are
passed, only TemplateBody is used.
data ValidateTemplateResponse Source #
The output for ValidateTemplate action.
See: newValidateTemplateResponse smart constructor.
Constructors
| ValidateTemplateResponse' (Maybe [Capability]) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe [TemplateParameter]) Int |
Instances
newValidateTemplateResponse Source #
Create a value of ValidateTemplateResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ValidateTemplateResponse, validateTemplateResponse_capabilities - The capabilities found within the template. If your template contains
IAM resources, you must specify the CAPABILITY_IAM or
CAPABILITY_NAMED_IAM value for this parameter when you use the
CreateStack or UpdateStack actions with your template; otherwise, those
actions return an InsufficientCapabilities error.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
$sel:capabilitiesReason:ValidateTemplateResponse', validateTemplateResponse_capabilitiesReason - The list of resources that generated the values in the Capabilities
response element.
$sel:declaredTransforms:ValidateTemplateResponse', validateTemplateResponse_declaredTransforms - A list of the transforms that are declared in the template.
ValidateTemplateResponse, validateTemplateResponse_description - The description found within the template.
ValidateTemplateResponse, validateTemplateResponse_parameters - A list of TemplateParameter structures.
$sel:httpStatus:ValidateTemplateResponse', validateTemplateResponse_httpStatus - The response's http status code.
Types
AccountFilterType
newtype AccountFilterType Source #
Constructors
| AccountFilterType' | |
Fields | |
Bundled Patterns
| pattern AccountFilterType_DIFFERENCE :: AccountFilterType | |
| pattern AccountFilterType_INTERSECTION :: AccountFilterType | |
| pattern AccountFilterType_NONE :: AccountFilterType | |
| pattern AccountFilterType_UNION :: AccountFilterType |
Instances
AccountGateStatus
newtype AccountGateStatus Source #
Constructors
| AccountGateStatus' | |
Fields | |
Bundled Patterns
| pattern AccountGateStatus_FAILED :: AccountGateStatus | |
| pattern AccountGateStatus_SKIPPED :: AccountGateStatus | |
| pattern AccountGateStatus_SUCCEEDED :: AccountGateStatus |
Instances
CallAs
Constructors
| CallAs' | |
Fields
| |
Bundled Patterns
| pattern CallAs_DELEGATED_ADMIN :: CallAs | |
| pattern CallAs_SELF :: CallAs |
Instances
Capability
newtype Capability Source #
Constructors
| Capability' | |
Fields | |
Bundled Patterns
| pattern Capability_CAPABILITY_AUTO_EXPAND :: Capability | |
| pattern Capability_CAPABILITY_IAM :: Capability | |
| pattern Capability_CAPABILITY_NAMED_IAM :: Capability |
Instances
Category
Constructors
| Category' | |
Fields
| |
Bundled Patterns
| pattern Category_ACTIVATED :: Category | |
| pattern Category_AWS_TYPES :: Category | |
| pattern Category_REGISTERED :: Category | |
| pattern Category_THIRD_PARTY :: Category |
Instances
ChangeAction
newtype ChangeAction Source #
Constructors
| ChangeAction' | |
Fields | |
Bundled Patterns
| pattern ChangeAction_Add :: ChangeAction | |
| pattern ChangeAction_Dynamic :: ChangeAction | |
| pattern ChangeAction_Import :: ChangeAction | |
| pattern ChangeAction_Modify :: ChangeAction | |
| pattern ChangeAction_Remove :: ChangeAction |
Instances
ChangeSetHooksStatus
newtype ChangeSetHooksStatus Source #
Constructors
| ChangeSetHooksStatus' | |
Fields | |
Bundled Patterns
| pattern ChangeSetHooksStatus_PLANNED :: ChangeSetHooksStatus | |
| pattern ChangeSetHooksStatus_PLANNING :: ChangeSetHooksStatus | |
| pattern ChangeSetHooksStatus_UNAVAILABLE :: ChangeSetHooksStatus |
Instances
ChangeSetStatus
newtype ChangeSetStatus Source #
Constructors
| ChangeSetStatus' | |
Fields | |
Bundled Patterns
| pattern ChangeSetStatus_CREATE_COMPLETE :: ChangeSetStatus | |
| pattern ChangeSetStatus_CREATE_IN_PROGRESS :: ChangeSetStatus | |
| pattern ChangeSetStatus_CREATE_PENDING :: ChangeSetStatus | |
| pattern ChangeSetStatus_DELETE_COMPLETE :: ChangeSetStatus | |
| pattern ChangeSetStatus_DELETE_FAILED :: ChangeSetStatus | |
| pattern ChangeSetStatus_DELETE_IN_PROGRESS :: ChangeSetStatus | |
| pattern ChangeSetStatus_DELETE_PENDING :: ChangeSetStatus | |
| pattern ChangeSetStatus_FAILED :: ChangeSetStatus |
Instances
ChangeSetType
newtype ChangeSetType Source #
Constructors
| ChangeSetType' | |
Fields | |
Bundled Patterns
| pattern ChangeSetType_CREATE :: ChangeSetType | |
| pattern ChangeSetType_IMPORT :: ChangeSetType | |
| pattern ChangeSetType_UPDATE :: ChangeSetType |
Instances
ChangeSource
newtype ChangeSource Source #
Constructors
| ChangeSource' | |
Fields | |
Bundled Patterns
| pattern ChangeSource_Automatic :: ChangeSource | |
| pattern ChangeSource_DirectModification :: ChangeSource | |
| pattern ChangeSource_ParameterReference :: ChangeSource | |
| pattern ChangeSource_ResourceAttribute :: ChangeSource | |
| pattern ChangeSource_ResourceReference :: ChangeSource |
Instances
ChangeType
newtype ChangeType Source #
Constructors
| ChangeType' | |
Fields | |
Bundled Patterns
| pattern ChangeType_Resource :: ChangeType |
Instances
DeprecatedStatus
newtype DeprecatedStatus Source #
Constructors
| DeprecatedStatus' | |
Fields | |
Bundled Patterns
| pattern DeprecatedStatus_DEPRECATED :: DeprecatedStatus | |
| pattern DeprecatedStatus_LIVE :: DeprecatedStatus |
Instances
DifferenceType
newtype DifferenceType Source #
Constructors
| DifferenceType' | |
Fields | |
Bundled Patterns
| pattern DifferenceType_ADD :: DifferenceType | |
| pattern DifferenceType_NOT_EQUAL :: DifferenceType | |
| pattern DifferenceType_REMOVE :: DifferenceType |
Instances
EvaluationType
newtype EvaluationType Source #
Constructors
| EvaluationType' | |
Fields | |
Bundled Patterns
| pattern EvaluationType_Dynamic :: EvaluationType | |
| pattern EvaluationType_Static :: EvaluationType |
Instances
ExecutionStatus
newtype ExecutionStatus Source #
Constructors
| ExecutionStatus' | |
Fields | |
Bundled Patterns
| pattern ExecutionStatus_AVAILABLE :: ExecutionStatus | |
| pattern ExecutionStatus_EXECUTE_COMPLETE :: ExecutionStatus | |
| pattern ExecutionStatus_EXECUTE_FAILED :: ExecutionStatus | |
| pattern ExecutionStatus_EXECUTE_IN_PROGRESS :: ExecutionStatus | |
| pattern ExecutionStatus_OBSOLETE :: ExecutionStatus | |
| pattern ExecutionStatus_UNAVAILABLE :: ExecutionStatus |
Instances
HandlerErrorCode
newtype HandlerErrorCode Source #
Constructors
| HandlerErrorCode' | |
Fields | |
Bundled Patterns
Instances
HookFailureMode
newtype HookFailureMode Source #
Constructors
| HookFailureMode' | |
Fields | |
Bundled Patterns
| pattern HookFailureMode_FAIL :: HookFailureMode | |
| pattern HookFailureMode_WARN :: HookFailureMode |
Instances
HookInvocationPoint
newtype HookInvocationPoint Source #
Constructors
| HookInvocationPoint' | |
Fields | |
Bundled Patterns
| pattern HookInvocationPoint_PRE_PROVISION :: HookInvocationPoint |
Instances
HookStatus
newtype HookStatus Source #
Constructors
| HookStatus' | |
Fields | |
Bundled Patterns
| pattern HookStatus_HOOK_COMPLETE_FAILED :: HookStatus | |
| pattern HookStatus_HOOK_COMPLETE_SUCCEEDED :: HookStatus | |
| pattern HookStatus_HOOK_FAILED :: HookStatus | |
| pattern HookStatus_HOOK_IN_PROGRESS :: HookStatus |
Instances
HookTargetType
newtype HookTargetType Source #
Constructors
| HookTargetType' | |
Fields | |
Bundled Patterns
| pattern HookTargetType_RESOURCE :: HookTargetType |
Instances
IdentityProvider
newtype IdentityProvider Source #
Constructors
| IdentityProvider' | |
Fields | |
Bundled Patterns
| pattern IdentityProvider_AWS_Marketplace :: IdentityProvider | |
| pattern IdentityProvider_Bitbucket :: IdentityProvider | |
| pattern IdentityProvider_GitHub :: IdentityProvider |
Instances
OnFailure
Constructors
| OnFailure' | |
Fields | |
Bundled Patterns
| pattern OnFailure_DELETE :: OnFailure | |
| pattern OnFailure_DO_NOTHING :: OnFailure | |
| pattern OnFailure_ROLLBACK :: OnFailure |
Instances
OperationResultFilterName
newtype OperationResultFilterName Source #
Constructors
| OperationResultFilterName' | |
Fields | |
Bundled Patterns
| pattern OperationResultFilterName_OPERATION_RESULT_STATUS :: OperationResultFilterName |
Instances
OperationStatus
newtype OperationStatus Source #
Constructors
| OperationStatus' | |
Fields | |
Bundled Patterns
| pattern OperationStatus_FAILED :: OperationStatus | |
| pattern OperationStatus_IN_PROGRESS :: OperationStatus | |
| pattern OperationStatus_PENDING :: OperationStatus | |
| pattern OperationStatus_SUCCESS :: OperationStatus |
Instances
PermissionModels
newtype PermissionModels Source #
Constructors
| PermissionModels' | |
Fields | |
Bundled Patterns
| pattern PermissionModels_SELF_MANAGED :: PermissionModels | |
| pattern PermissionModels_SERVICE_MANAGED :: PermissionModels |
Instances
ProvisioningType
newtype ProvisioningType Source #
Constructors
| ProvisioningType' | |
Fields | |
Bundled Patterns
| pattern ProvisioningType_FULLY_MUTABLE :: ProvisioningType | |
| pattern ProvisioningType_IMMUTABLE :: ProvisioningType | |
| pattern ProvisioningType_NON_PROVISIONABLE :: ProvisioningType |
Instances
PublisherStatus
newtype PublisherStatus Source #
Constructors
| PublisherStatus' | |
Fields | |
Bundled Patterns
| pattern PublisherStatus_UNVERIFIED :: PublisherStatus | |
| pattern PublisherStatus_VERIFIED :: PublisherStatus |
Instances
RegionConcurrencyType
newtype RegionConcurrencyType Source #
Constructors
| RegionConcurrencyType' | |
Fields | |
Bundled Patterns
| pattern RegionConcurrencyType_PARALLEL :: RegionConcurrencyType | |
| pattern RegionConcurrencyType_SEQUENTIAL :: RegionConcurrencyType |
Instances
RegistrationStatus
newtype RegistrationStatus Source #
Constructors
| RegistrationStatus' | |
Fields | |
Bundled Patterns
| pattern RegistrationStatus_COMPLETE :: RegistrationStatus | |
| pattern RegistrationStatus_FAILED :: RegistrationStatus | |
| pattern RegistrationStatus_IN_PROGRESS :: RegistrationStatus |
Instances
RegistryType
newtype RegistryType Source #
Constructors
| RegistryType' | |
Fields | |
Bundled Patterns
| pattern RegistryType_HOOK :: RegistryType | |
| pattern RegistryType_MODULE :: RegistryType | |
| pattern RegistryType_RESOURCE :: RegistryType |
Instances
Replacement
newtype Replacement Source #
Constructors
| Replacement' | |
Fields | |
Bundled Patterns
| pattern Replacement_Conditional :: Replacement | |
| pattern Replacement_False :: Replacement | |
| pattern Replacement_True :: Replacement |
Instances
RequiresRecreation
newtype RequiresRecreation Source #
Constructors
| RequiresRecreation' | |
Fields | |
Bundled Patterns
| pattern RequiresRecreation_Always :: RequiresRecreation | |
| pattern RequiresRecreation_Conditionally :: RequiresRecreation | |
| pattern RequiresRecreation_Never :: RequiresRecreation |
Instances
ResourceAttribute
newtype ResourceAttribute Source #
Constructors
| ResourceAttribute' | |
Fields | |
Bundled Patterns
| pattern ResourceAttribute_CreationPolicy :: ResourceAttribute | |
| pattern ResourceAttribute_DeletionPolicy :: ResourceAttribute | |
| pattern ResourceAttribute_Metadata :: ResourceAttribute | |
| pattern ResourceAttribute_Properties :: ResourceAttribute | |
| pattern ResourceAttribute_Tags :: ResourceAttribute | |
| pattern ResourceAttribute_UpdatePolicy :: ResourceAttribute |
Instances
ResourceSignalStatus
newtype ResourceSignalStatus Source #
Constructors
| ResourceSignalStatus' | |
Fields | |
Bundled Patterns
| pattern ResourceSignalStatus_FAILURE :: ResourceSignalStatus | |
| pattern ResourceSignalStatus_SUCCESS :: ResourceSignalStatus |
Instances
ResourceStatus
newtype ResourceStatus Source #
Constructors
| ResourceStatus' | |
Fields | |
Bundled Patterns
Instances
StackDriftDetectionStatus
newtype StackDriftDetectionStatus Source #
Constructors
| StackDriftDetectionStatus' | |
Fields | |
Bundled Patterns
Instances
StackDriftStatus
newtype StackDriftStatus Source #
Constructors
| StackDriftStatus' | |
Fields | |
Bundled Patterns
| pattern StackDriftStatus_DRIFTED :: StackDriftStatus | |
| pattern StackDriftStatus_IN_SYNC :: StackDriftStatus | |
| pattern StackDriftStatus_NOT_CHECKED :: StackDriftStatus | |
| pattern StackDriftStatus_UNKNOWN :: StackDriftStatus |
Instances
StackInstanceDetailedStatus
newtype StackInstanceDetailedStatus Source #
Constructors
| StackInstanceDetailedStatus' | |
Fields | |
Bundled Patterns
Instances
StackInstanceFilterName
newtype StackInstanceFilterName Source #
Constructors
| StackInstanceFilterName' | |
Fields | |
Bundled Patterns
| pattern StackInstanceFilterName_DETAILED_STATUS :: StackInstanceFilterName | |
| pattern StackInstanceFilterName_LAST_OPERATION_ID :: StackInstanceFilterName |
Instances
StackInstanceStatus
newtype StackInstanceStatus Source #
Constructors
| StackInstanceStatus' | |
Fields | |
Bundled Patterns
| pattern StackInstanceStatus_CURRENT :: StackInstanceStatus | |
| pattern StackInstanceStatus_INOPERABLE :: StackInstanceStatus | |
| pattern StackInstanceStatus_OUTDATED :: StackInstanceStatus |
Instances
StackResourceDriftStatus
newtype StackResourceDriftStatus Source #
Constructors
| StackResourceDriftStatus' | |
Fields | |
Bundled Patterns
Instances
StackSetDriftDetectionStatus
newtype StackSetDriftDetectionStatus Source #
Constructors
| StackSetDriftDetectionStatus' | |
Fields | |
Bundled Patterns
Instances
StackSetDriftStatus
newtype StackSetDriftStatus Source #
Constructors
| StackSetDriftStatus' | |
Fields | |
Bundled Patterns
| pattern StackSetDriftStatus_DRIFTED :: StackSetDriftStatus | |
| pattern StackSetDriftStatus_IN_SYNC :: StackSetDriftStatus | |
| pattern StackSetDriftStatus_NOT_CHECKED :: StackSetDriftStatus |
Instances
StackSetOperationAction
newtype StackSetOperationAction Source #
Constructors
| StackSetOperationAction' | |
Fields | |
Bundled Patterns
Instances
StackSetOperationResultStatus
newtype StackSetOperationResultStatus Source #
Constructors
| StackSetOperationResultStatus' | |
Fields | |
Bundled Patterns
Instances
StackSetOperationStatus
newtype StackSetOperationStatus Source #
Constructors
| StackSetOperationStatus' | |
Fields | |
Bundled Patterns
Instances
StackSetStatus
newtype StackSetStatus Source #
Constructors
| StackSetStatus' | |
Fields | |
Bundled Patterns
| pattern StackSetStatus_ACTIVE :: StackSetStatus | |
| pattern StackSetStatus_DELETED :: StackSetStatus |
Instances
StackStatus
newtype StackStatus Source #
Constructors
| StackStatus' | |
Fields | |
Bundled Patterns
Instances
TemplateStage
newtype TemplateStage Source #
Constructors
| TemplateStage' | |
Fields | |
Bundled Patterns
| pattern TemplateStage_Original :: TemplateStage | |
| pattern TemplateStage_Processed :: TemplateStage |
Instances
ThirdPartyType
newtype ThirdPartyType Source #
Constructors
| ThirdPartyType' | |
Fields | |
Bundled Patterns
| pattern ThirdPartyType_HOOK :: ThirdPartyType | |
| pattern ThirdPartyType_MODULE :: ThirdPartyType | |
| pattern ThirdPartyType_RESOURCE :: ThirdPartyType |
Instances
TypeTestsStatus
newtype TypeTestsStatus Source #
Constructors
| TypeTestsStatus' | |
Fields | |
Bundled Patterns
| pattern TypeTestsStatus_FAILED :: TypeTestsStatus | |
| pattern TypeTestsStatus_IN_PROGRESS :: TypeTestsStatus | |
| pattern TypeTestsStatus_NOT_TESTED :: TypeTestsStatus | |
| pattern TypeTestsStatus_PASSED :: TypeTestsStatus |
Instances
VersionBump
newtype VersionBump Source #
Constructors
| VersionBump' | |
Fields | |
Bundled Patterns
| pattern VersionBump_MAJOR :: VersionBump | |
| pattern VersionBump_MINOR :: VersionBump |
Instances
Visibility
newtype Visibility Source #
Constructors
| Visibility' | |
Fields | |
Bundled Patterns
| pattern Visibility_PRIVATE :: Visibility | |
| pattern Visibility_PUBLIC :: Visibility |
Instances
AccountGateResult
data AccountGateResult Source #
Structure that contains the results of the account gate function which CloudFormation invokes, if present, before proceeding with a stack set operation in an account and Region.
For each account and Region, CloudFormation lets you specify a Lambda
function that encapsulates any requirements that must be met before
CloudFormation can proceed with a stack set operation in that account
and Region. CloudFormation invokes the function each time a stack set
operation is requested for that account and Region; if the function
returns FAILED, CloudFormation cancels the operation in that account
and Region, and sets the stack set operation result status for that
account and Region to FAILED.
For more information, see Configuring a target account gate.
See: newAccountGateResult smart constructor.
Constructors
| AccountGateResult' (Maybe AccountGateStatus) (Maybe Text) |
Instances
newAccountGateResult :: AccountGateResult Source #
Create a value of AccountGateResult with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:AccountGateResult', accountGateResult_status - The status of the account gate function.
SUCCEEDED: The account gate function has determined that the account and Region passes any requirements for a stack set operation to occur. CloudFormation proceeds with the stack operation in that account and Region.FAILED: The account gate function has determined that the account and Region doesn't meet the requirements for a stack set operation to occur. CloudFormation cancels the stack set operation in that account and Region, and sets the stack set operation result status for that account and Region toFAILED.SKIPPED: CloudFormation has skipped calling the account gate function for this account and Region, for one of the following reasons:- An account gate function hasn't been specified for the account and Region. CloudFormation proceeds with the stack set operation in this account and Region.
- The
AWSCloudFormationStackSetExecutionRoleof the stack set administration account lacks permissions to invoke the function. CloudFormation proceeds with the stack set operation in this account and Region. - Either no action is necessary, or no action is possible, on the stack. CloudFormation skips the stack set operation in this account and Region.
$sel:statusReason:AccountGateResult', accountGateResult_statusReason - The reason for the account gate status assigned to this account and
Region for the stack set operation.
AccountLimit
data AccountLimit Source #
The AccountLimit data type.
CloudFormation has the following limits per account:
- Number of concurrent resources
- Number of stacks
- Number of stack outputs
For more information about these account limits, and other CloudFormation limits, see CloudFormation quotas in the CloudFormation User Guide.
See: newAccountLimit smart constructor.
Constructors
| AccountLimit' (Maybe Text) (Maybe Int) |
Instances
newAccountLimit :: AccountLimit Source #
Create a value of AccountLimit with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:AccountLimit', accountLimit_name - The name of the account limit.
Values: ConcurrentResourcesLimit | StackLimit | StackOutputsLimit
$sel:value:AccountLimit', accountLimit_value - The value that's associated with the account limit name.
AutoDeployment
data AutoDeployment Source #
- Service-managed permissions
- Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU).
See: newAutoDeployment smart constructor.
Constructors
| AutoDeployment' (Maybe Bool) (Maybe Bool) |
Instances
newAutoDeployment :: AutoDeployment Source #
Create a value of AutoDeployment with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enabled:AutoDeployment', autoDeployment_enabled - If set to true, StackSets automatically deploys additional stack
instances to Organizations accounts that are added to a target
organization or organizational unit (OU) in the specified Regions. If an
account is removed from a target organization or OU, StackSets deletes
stack instances from the account in the specified Regions.
$sel:retainStacksOnAccountRemoval:AutoDeployment', autoDeployment_retainStacksOnAccountRemoval - If set to true, stack resources are retained when an account is
removed from a target organization or OU. If set to false, stack
resources are deleted. Specify only if Enabled is set to True.
BatchDescribeTypeConfigurationsError
data BatchDescribeTypeConfigurationsError Source #
Detailed information concerning an error generated during the setting of configuration data for a CloudFormation extension.
See: newBatchDescribeTypeConfigurationsError smart constructor.
Constructors
| BatchDescribeTypeConfigurationsError' (Maybe Text) (Maybe Text) (Maybe TypeConfigurationIdentifier) |
Instances
newBatchDescribeTypeConfigurationsError :: BatchDescribeTypeConfigurationsError Source #
Create a value of BatchDescribeTypeConfigurationsError with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errorCode:BatchDescribeTypeConfigurationsError', batchDescribeTypeConfigurationsError_errorCode - The error code.
$sel:errorMessage:BatchDescribeTypeConfigurationsError', batchDescribeTypeConfigurationsError_errorMessage - The error message.
$sel:typeConfigurationIdentifier:BatchDescribeTypeConfigurationsError', batchDescribeTypeConfigurationsError_typeConfigurationIdentifier - Undocumented member.
Change
The Change structure describes the changes CloudFormation will perform
if you execute the change set.
See: newChange smart constructor.
Constructors
| Change' (Maybe Natural) (Maybe ResourceChange) (Maybe ChangeType) |
Instances
| FromXML Change Source # | |
| Generic Change Source # | |
| Read Change Source # | |
| Show Change Source # | |
| NFData Change Source # | |
Defined in Amazonka.CloudFormation.Types.Change | |
| Eq Change Source # | |
| Hashable Change Source # | |
Defined in Amazonka.CloudFormation.Types.Change | |
| type Rep Change Source # | |
Defined in Amazonka.CloudFormation.Types.Change type Rep Change = D1 ('MetaData "Change" "Amazonka.CloudFormation.Types.Change" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "Change'" 'PrefixI 'True) (S1 ('MetaSel ('Just "hookInvocationCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "resourceChange") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceChange)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChangeType))))) | |
Create a value of Change with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:hookInvocationCount:Change', change_hookInvocationCount - Is either null, if no hooks invoke for the resource, or contains the
number of hooks that will invoke for the resource.
$sel:resourceChange:Change', change_resourceChange - A ResourceChange structure that describes the resource and action that
CloudFormation will perform.
$sel:type':Change', change_type - The type of entity that CloudFormation changes. Currently, the only
entity type is Resource.
ChangeSetHook
data ChangeSetHook Source #
Specifies the resource, the hook, and the hook version to be invoked.
See: newChangeSetHook smart constructor.
Constructors
| ChangeSetHook' (Maybe HookFailureMode) (Maybe HookInvocationPoint) (Maybe ChangeSetHookTargetDetails) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newChangeSetHook :: ChangeSetHook Source #
Create a value of ChangeSetHook with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:failureMode:ChangeSetHook', changeSetHook_failureMode - Specify the hook failure mode for non-compliant resources in the
followings ways.
FAILStops provisioning resources.WARNAllows provisioning to continue with a warning message.
$sel:invocationPoint:ChangeSetHook', changeSetHook_invocationPoint - Specifies the points in provisioning logic where a hook is invoked.
$sel:targetDetails:ChangeSetHook', changeSetHook_targetDetails - Specifies details about the target that the hook will run against.
$sel:typeConfigurationVersionId:ChangeSetHook', changeSetHook_typeConfigurationVersionId - The version ID of the type configuration.
$sel:typeName:ChangeSetHook', changeSetHook_typeName - The unique name for your hook. Specifies a three-part namespace for your
hook, with a recommended pattern of Organization::Service::Hook.
The following organization namespaces are reserved and can't be used in your hook type names:
Alexa
AMZN
Amazon
ASK
AWS
Custom
Dev
$sel:typeVersionId:ChangeSetHook', changeSetHook_typeVersionId - The version ID of the type specified.
ChangeSetHookResourceTargetDetails
data ChangeSetHookResourceTargetDetails Source #
Specifies RESOURCE type target details for activated hooks.
See: newChangeSetHookResourceTargetDetails smart constructor.
Constructors
| ChangeSetHookResourceTargetDetails' (Maybe Text) (Maybe ChangeAction) (Maybe Text) |
Instances
newChangeSetHookResourceTargetDetails :: ChangeSetHookResourceTargetDetails Source #
Create a value of ChangeSetHookResourceTargetDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:logicalResourceId:ChangeSetHookResourceTargetDetails', changeSetHookResourceTargetDetails_logicalResourceId - The resource's logical ID, which is defined in the stack's template.
$sel:resourceAction:ChangeSetHookResourceTargetDetails', changeSetHookResourceTargetDetails_resourceAction - Specifies the action of the resource.
$sel:resourceType:ChangeSetHookResourceTargetDetails', changeSetHookResourceTargetDetails_resourceType - The type of CloudFormation resource, such as AWS::S3::Bucket.
ChangeSetHookTargetDetails
data ChangeSetHookTargetDetails Source #
Specifies target details for an activated hook.
See: newChangeSetHookTargetDetails smart constructor.
Constructors
| ChangeSetHookTargetDetails' (Maybe ChangeSetHookResourceTargetDetails) (Maybe HookTargetType) |
Instances
newChangeSetHookTargetDetails :: ChangeSetHookTargetDetails Source #
Create a value of ChangeSetHookTargetDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceTargetDetails:ChangeSetHookTargetDetails', changeSetHookTargetDetails_resourceTargetDetails - Required if TargetType is RESOURCE.
$sel:targetType:ChangeSetHookTargetDetails', changeSetHookTargetDetails_targetType - The name of the type.
ChangeSetSummary
data ChangeSetSummary Source #
The ChangeSetSummary structure describes a change set, its status, and
the stack with which it's associated.
See: newChangeSetSummary smart constructor.
Constructors
| ChangeSetSummary' (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe ExecutionStatus) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ChangeSetStatus) (Maybe Text) |
Instances
newChangeSetSummary :: ChangeSetSummary Source #
Create a value of ChangeSetSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:changeSetId:ChangeSetSummary', changeSetSummary_changeSetId - The ID of the change set.
$sel:changeSetName:ChangeSetSummary', changeSetSummary_changeSetName - The name of the change set.
$sel:creationTime:ChangeSetSummary', changeSetSummary_creationTime - The start time when the change set was created, in UTC.
$sel:description:ChangeSetSummary', changeSetSummary_description - Descriptive information about the change set.
$sel:executionStatus:ChangeSetSummary', changeSetSummary_executionStatus - 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 CloudFormation is still creating it or in an OBSOLETE state
because the stack was already updated.
$sel:includeNestedStacks:ChangeSetSummary', changeSetSummary_includeNestedStacks - Specifies the current setting of IncludeNestedStacks for the change
set.
$sel:parentChangeSetId:ChangeSetSummary', changeSetSummary_parentChangeSetId - The parent change set ID.
$sel:rootChangeSetId:ChangeSetSummary', changeSetSummary_rootChangeSetId - The root change set ID.
$sel:stackId:ChangeSetSummary', changeSetSummary_stackId - The ID of the stack with which the change set is associated.
$sel:stackName:ChangeSetSummary', changeSetSummary_stackName - The name of the stack with which the change set is associated.
$sel:status:ChangeSetSummary', changeSetSummary_status - The state of the change set, such as CREATE_IN_PROGRESS,
CREATE_COMPLETE, or FAILED.
$sel:statusReason:ChangeSetSummary', changeSetSummary_statusReason - A description of the change set's status. For example, if your change
set is in the FAILED state, CloudFormation shows the error message.
DeploymentTargets
data DeploymentTargets Source #
- Service-managed permissions
- The Organizations accounts to which StackSets deploys. StackSets doesn't deploy stack instances to the organization management account, even if the organization management account is in your organization or in an OU in your organization.
For update operations, you can specify either Accounts or
OrganizationalUnitIds. For create and delete operations, specify
OrganizationalUnitIds.
See: newDeploymentTargets smart constructor.
Constructors
| DeploymentTargets' (Maybe AccountFilterType) (Maybe [Text]) (Maybe Text) (Maybe [Text]) |
Instances
newDeploymentTargets :: DeploymentTargets Source #
Create a value of DeploymentTargets with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountFilterType:DeploymentTargets', deploymentTargets_accountFilterType - Limit deployment targets to individual accounts or include additional
accounts with provided OUs.
The following is a list of possible values for the AccountFilterType
operation.
INTERSECTION: StackSets deploys to the accounts specified inAccountsparameter.DIFFERENCE: StackSets excludes the accounts specified inAccountsparameter. This enables user to avoid certain accounts within an OU such as suspended accounts.UNION: StackSets includes additional accounts deployment targets.This is the default value if
AccountFilterTypeis not provided. This enables user to update an entire OU and individual accounts from a different OU in one request, which used to be two separate requests.NONE: Deploys to all the accounts in specified organizational units (OU).
$sel:accounts:DeploymentTargets', deploymentTargets_accounts - The names of one or more Amazon Web Services accounts for which you want
to deploy stack set updates.
$sel:accountsUrl:DeploymentTargets', deploymentTargets_accountsUrl - Returns the value of the AccountsUrl property.
$sel:organizationalUnitIds:DeploymentTargets', deploymentTargets_organizationalUnitIds - The organization root ID or organizational unit (OU) IDs to which
StackSets deploys.
Export
The Export structure describes the exported output values for a stack.
See: newExport smart constructor.
Instances
| FromXML Export Source # | |
| Generic Export Source # | |
| Read Export Source # | |
| Show Export Source # | |
| NFData Export Source # | |
Defined in Amazonka.CloudFormation.Types.Export | |
| Eq Export Source # | |
| Hashable Export Source # | |
Defined in Amazonka.CloudFormation.Types.Export | |
| type Rep Export Source # | |
Defined in Amazonka.CloudFormation.Types.Export type Rep Export = D1 ('MetaData "Export" "Amazonka.CloudFormation.Types.Export" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "Export'" 'PrefixI 'True) (S1 ('MetaSel ('Just "exportingStackId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) | |
Create a value of Export with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:exportingStackId:Export', export_exportingStackId - The stack that contains the exported output name and value.
$sel:name:Export', export_name - 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.
$sel:value:Export', export_value - 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.
LoggingConfig
data LoggingConfig Source #
Contains logging configuration information for an extension.
See: newLoggingConfig smart constructor.
Constructors
| LoggingConfig' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> LoggingConfig |
Create a value of LoggingConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:logRoleArn:LoggingConfig', loggingConfig_logRoleArn - The Amazon Resource Name (ARN) of the role that CloudFormation should
assume when sending log entries to CloudWatch Logs.
$sel:logGroupName:LoggingConfig', loggingConfig_logGroupName - The Amazon CloudWatch Logs group to which CloudFormation sends error
logging information when invoking the extension's handlers.
ManagedExecution
data ManagedExecution Source #
Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
See: newManagedExecution smart constructor.
Constructors
| ManagedExecution' (Maybe Bool) |
Instances
newManagedExecution :: ManagedExecution Source #
Create a value of ManagedExecution with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:active:ManagedExecution', managedExecution_active - When true, StackSets performs non-conflicting operations concurrently
and queues conflicting operations. After conflicting operations finish,
StackSets starts queued operations in request order.
If there are already running or queued operations, StackSets queues all incoming operations even if they are non-conflicting.
You can't modify your stack set's execution configuration while there are running or queued operations for that stack set.
When false (default), StackSets performs one operation at a time in
request order.
ModuleInfo
data ModuleInfo Source #
Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.
For more information about modules, see Using modules to encapsulate and reuse resource configurations in the CloudFormation User Guide.
See: newModuleInfo smart constructor.
Constructors
| ModuleInfo' (Maybe Text) (Maybe Text) |
Instances
newModuleInfo :: ModuleInfo Source #
Create a value of ModuleInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:logicalIdHierarchy:ModuleInfo', moduleInfo_logicalIdHierarchy - A concatenated list of the logical IDs of the module or modules
containing the resource. Modules are listed starting with the inner-most
nested module, and separated by /.
In the following example, the resource was created from a module,
moduleA, that's nested inside a parent module, moduleB.
moduleA/moduleB
For more information, see Referencing resources in a module in the CloudFormation User Guide.
$sel:typeHierarchy:ModuleInfo', moduleInfo_typeHierarchy - A concatenated list of the module type or types containing the resource.
Module types are listed starting with the inner-most nested module, and
separated by /.
In the following example, the resource was created from a module of type
AWS::First::Example::MODULE, that's nested inside a parent module of
type AWS::Second::Example::MODULE.
AWS::First::Example::MODULE/AWS::Second::Example::MODULE
OperationResultFilter
data OperationResultFilter Source #
The status that operation results are filtered by.
See: newOperationResultFilter smart constructor.
Constructors
| OperationResultFilter' (Maybe OperationResultFilterName) (Maybe Text) |
Instances
newOperationResultFilter :: OperationResultFilter Source #
Create a value of OperationResultFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:OperationResultFilter', operationResultFilter_name - The type of filter to apply.
$sel:values:OperationResultFilter', operationResultFilter_values - The value to filter by.
Output
The Output data type.
See: newOutput smart constructor.
Instances
| FromXML Output Source # | |
| Generic Output Source # | |
| Read Output Source # | |
| Show Output Source # | |
| NFData Output Source # | |
Defined in Amazonka.CloudFormation.Types.Output | |
| Eq Output Source # | |
| Hashable Output Source # | |
Defined in Amazonka.CloudFormation.Types.Output | |
| type Rep Output Source # | |
Defined in Amazonka.CloudFormation.Types.Output type Rep Output = D1 ('MetaData "Output" "Amazonka.CloudFormation.Types.Output" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "Output'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "exportName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "outputKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "outputValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) | |
Create a value of Output with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:Output', output_description - User defined description associated with the output.
$sel:exportName:Output', output_exportName - The name of the export associated with the output.
$sel:outputKey:Output', output_outputKey - The key associated with the output.
$sel:outputValue:Output', output_outputValue - The value associated with the output.
Parameter
The Parameter data type.
See: newParameter smart constructor.
Instances
newParameter :: Parameter Source #
Create a value of Parameter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:parameterKey:Parameter', parameter_parameterKey - The key associated with the parameter. If you don't specify a key and
value for a particular parameter, CloudFormation uses the default value
that's specified in your template.
$sel:parameterValue:Parameter', parameter_parameterValue - The input value associated with the parameter.
$sel:resolvedValue:Parameter', parameter_resolvedValue - Read-only. The value that corresponds to a SSM parameter key. This field
is returned only for
SSM
parameter types in the template.
$sel:usePreviousValue:Parameter', parameter_usePreviousValue - 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 CloudFormation uses to validate parameter values.
Although other constraints might be defined in the stack template,
CloudFormation returns only the AllowedValues property.
See: newParameterConstraints smart constructor.
Constructors
| ParameterConstraints' (Maybe [Text]) |
Instances
newParameterConstraints :: ParameterConstraints Source #
Create a value of ParameterConstraints with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:allowedValues:ParameterConstraints', parameterConstraints_allowedValues - A list of values that are permitted for a parameter.
ParameterDeclaration
data ParameterDeclaration Source #
The ParameterDeclaration data type.
See: newParameterDeclaration smart constructor.
Constructors
| ParameterDeclaration' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe ParameterConstraints) (Maybe Text) (Maybe Text) |
Instances
newParameterDeclaration :: ParameterDeclaration Source #
Create a value of ParameterDeclaration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:defaultValue:ParameterDeclaration', parameterDeclaration_defaultValue - The default value of the parameter.
$sel:description:ParameterDeclaration', parameterDeclaration_description - The description that's associate with the parameter.
$sel:noEcho:ParameterDeclaration', parameterDeclaration_noEcho - Flag that indicates whether the parameter value is shown as plain text
in logs and in the Amazon Web Services Management Console.
$sel:parameterConstraints:ParameterDeclaration', parameterDeclaration_parameterConstraints - The criteria that CloudFormation uses to validate parameter values.
$sel:parameterKey:ParameterDeclaration', parameterDeclaration_parameterKey - The name that's associated with the parameter.
$sel:parameterType:ParameterDeclaration', parameterDeclaration_parameterType - The type of parameter.
PhysicalResourceIdContextKeyValuePair
data PhysicalResourceIdContextKeyValuePair Source #
Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses context key-value pairs in cases where a resource's logical and physical IDs aren't enough to uniquely identify that resource. Each context key-value pair specifies a resource that contains the targeted resource.
See: newPhysicalResourceIdContextKeyValuePair smart constructor.
Constructors
| PhysicalResourceIdContextKeyValuePair' Text Text |
Instances
newPhysicalResourceIdContextKeyValuePair Source #
Arguments
| :: Text | |
| -> Text | |
| -> PhysicalResourceIdContextKeyValuePair |
Create a value of PhysicalResourceIdContextKeyValuePair with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:PhysicalResourceIdContextKeyValuePair', physicalResourceIdContextKeyValuePair_key - The resource context key.
$sel:value:PhysicalResourceIdContextKeyValuePair', physicalResourceIdContextKeyValuePair_value - The resource context value.
PropertyDifference
data PropertyDifference Source #
Information about a resource property whose actual value differs from
its expected value, as defined in the stack template and any values
specified as template parameters. These will be present only for
resources whose StackResourceDriftStatus is MODIFIED. For more
information, see
Detecting Unregulated Configuration Changes to Stacks and Resources.
See: newPropertyDifference smart constructor.
Constructors
| PropertyDifference' Text Text Text DifferenceType |
Instances
newPropertyDifference Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> DifferenceType | |
| -> PropertyDifference |
Create a value of PropertyDifference with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:propertyPath:PropertyDifference', propertyDifference_propertyPath - The fully-qualified path to the resource property.
$sel:expectedValue:PropertyDifference', propertyDifference_expectedValue - The expected property value of the resource property, as defined in the
stack template and any values specified as template parameters.
$sel:actualValue:PropertyDifference', propertyDifference_actualValue - The actual property value of the resource property.
$sel:differenceType:PropertyDifference', propertyDifference_differenceType - The type of property difference.
ADD: A value has been added to a resource property that's an array or list data type.REMOVE: The property has been removed from the current resource configuration.NOT_EQUAL: The current property value differs from its expected value (as defined in the stack template and any values specified as template parameters).
RequiredActivatedType
data RequiredActivatedType Source #
For extensions that are modules, a public third-party extension that must be activated in your account in order for the module itself to be activated.
For more information, see Activating public modules for use in your account in the CloudFormation User Guide.
See: newRequiredActivatedType smart constructor.
Instances
newRequiredActivatedType :: RequiredActivatedType Source #
Create a value of RequiredActivatedType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:originalTypeName:RequiredActivatedType', requiredActivatedType_originalTypeName - The type name of the public extension.
If you specified a TypeNameAlias when enabling the extension in this
account and region, CloudFormation treats that alias as the extension's
type name within the account and region, not the type name of the public
extension. For more information, see
Specifying aliases to refer to extensions
in the CloudFormation User Guide.
$sel:publisherId:RequiredActivatedType', requiredActivatedType_publisherId - The publisher ID of the extension publisher.
$sel:supportedMajorVersions:RequiredActivatedType', requiredActivatedType_supportedMajorVersions - A list of the major versions of the extension type that the macro
supports.
$sel:typeNameAlias:RequiredActivatedType', requiredActivatedType_typeNameAlias - An alias assigned to the public extension, in this account and region.
If you specify an alias for the extension, CloudFormation treats the
alias as the extension type name within this account and region. You
must use the alias to refer to the extension in your templates, API
calls, and CloudFormation console.
ResourceChange
data ResourceChange Source #
The ResourceChange structure describes the resource and the action
that CloudFormation will perform on it if you execute this change set.
See: newResourceChange smart constructor.
Constructors
| ResourceChange' (Maybe ChangeAction) (Maybe Text) (Maybe [ResourceChangeDetail]) (Maybe Text) (Maybe ModuleInfo) (Maybe Text) (Maybe Replacement) (Maybe Text) (Maybe [ResourceAttribute]) |
Instances
newResourceChange :: ResourceChange Source #
Create a value of ResourceChange with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:action:ResourceChange', resourceChange_action - The action that CloudFormation takes on the resource, such as Add
(adds a new resource), Modify (changes a resource), Remove (deletes
a resource), Import (imports a resource), or Dynamic (exact action
for the resource can't be determined).
$sel:changeSetId:ResourceChange', resourceChange_changeSetId - The change set ID of the nested change set.
$sel:details:ResourceChange', resourceChange_details - For the Modify action, a list of ResourceChangeDetail structures
that describes the changes that CloudFormation will make to the
resource.
$sel:logicalResourceId:ResourceChange', resourceChange_logicalResourceId - The resource's logical ID, which is defined in the stack's template.
$sel:moduleInfo:ResourceChange', resourceChange_moduleInfo - Contains information about the module from which the resource was
created, if the resource was created from a module included in the stack
template.
$sel:physicalResourceId:ResourceChange', resourceChange_physicalResourceId - The resource's physical ID (resource name). Resources that you are
adding don't have physical IDs because they haven't been created.
$sel:replacement:ResourceChange', resourceChange_replacement - For the Modify action, indicates whether 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.
$sel:resourceType:ResourceChange', resourceChange_resourceType - The type of CloudFormation resource, such as AWS::S3::Bucket.
$sel:scope:ResourceChange', resourceChange_scope - 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.
ResourceChangeDetail
data ResourceChangeDetail Source #
For a resource with Modify as the action, the ResourceChange
structure describes the changes CloudFormation will make to that
resource.
See: newResourceChangeDetail smart constructor.
Constructors
| ResourceChangeDetail' (Maybe Text) (Maybe ChangeSource) (Maybe EvaluationType) (Maybe ResourceTargetDefinition) |
Instances
newResourceChangeDetail :: ResourceChangeDetail Source #
Create a value of ResourceChangeDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:causingEntity:ResourceChangeDetail', resourceChangeDetail_causingEntity - The identity of the entity that triggered this change. This entity is a
member of the group that's 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.
$sel:changeSource:ResourceChangeDetail', resourceChangeDetail_changeSource - The group to which the CausingEntity value belongs. There are five
entity groups:
ResourceReferenceentities areRefintrinsic functions that refer to resources in the template, such as{ "Ref" : "MyEC2InstanceResource" }.ParameterReferenceentities areRefintrinsic functions that get template parameter values, such as{ "Ref" : "MyPasswordParameter" }.ResourceAttributeentities areFn::GetAttintrinsic functions that get resource attribute values, such as{ "Fn::GetAtt" : [ "MyEC2InstanceResource", "PublicDnsName" ] }.DirectModificationentities are changes that are made directly to the template.Automaticentities areAWS::CloudFormation::Stackresource types, which are also known as nested stacks. If you made no changes to theAWS::CloudFormation::Stackresource, CloudFormation sets theChangeSourcetoAutomaticbecause the nested stack's template might have changed. Changes to a nested stack's template aren't visible to CloudFormation until you run an update on the parent stack.
$sel:evaluation:ResourceChangeDetail', resourceChangeDetail_evaluation - Indicates whether CloudFormation can determine the target value, and
whether the target value will change before you execute a change set.
For Static evaluations, 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, CloudFormation knows
that this property value will change, and its value, so this is a
Static evaluation.
For Dynamic evaluations, can't 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's
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.
$sel:target:ResourceChangeDetail', resourceChangeDetail_target - A ResourceTargetDefinition structure that describes the field that
CloudFormation will change and whether the resource will be recreated.
ResourceIdentifierSummary
data ResourceIdentifierSummary Source #
Describes the target resources of a specific type in your import
template (for example, all AWS::S3::Bucket resources) and the
properties you can provide during the import to identify resources of
that type.
See: newResourceIdentifierSummary smart constructor.
Instances
newResourceIdentifierSummary :: ResourceIdentifierSummary Source #
Create a value of ResourceIdentifierSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:logicalResourceIds:ResourceIdentifierSummary', resourceIdentifierSummary_logicalResourceIds - The logical IDs of the target resources of the specified ResourceType,
as defined in the import template.
$sel:resourceIdentifiers:ResourceIdentifierSummary', resourceIdentifierSummary_resourceIdentifiers - The resource properties you can provide during the import to identify
your target resources. For example, BucketName is a possible
identifier property for AWS::S3::Bucket resources.
$sel:resourceType:ResourceIdentifierSummary', resourceIdentifierSummary_resourceType - The template resource type of the target resources, such as
AWS::S3::Bucket.
ResourceTargetDefinition
data ResourceTargetDefinition Source #
The field that CloudFormation will change, such as the name of a resource's property, and whether the resource will be recreated.
See: newResourceTargetDefinition smart constructor.
Constructors
| ResourceTargetDefinition' (Maybe ResourceAttribute) (Maybe Text) (Maybe RequiresRecreation) |
Instances
newResourceTargetDefinition :: ResourceTargetDefinition Source #
Create a value of ResourceTargetDefinition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attribute:ResourceTargetDefinition', resourceTargetDefinition_attribute - Indicates which resource attribute is triggering this update, such as a
change in the resource attribute's Metadata, Properties, or Tags.
$sel:name:ResourceTargetDefinition', resourceTargetDefinition_name - If the Attribute value is Properties, the name of the property. For
all other attributes, the value is null.
$sel:requiresRecreation:ResourceTargetDefinition', resourceTargetDefinition_requiresRecreation - 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 CloudFormation User Guide.
ResourceToImport
data ResourceToImport Source #
Describes the target resource of an import operation.
See: newResourceToImport smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ResourceToImport |
Create a value of ResourceToImport with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceType:ResourceToImport', resourceToImport_resourceType - The type of resource to import into your stack, such as
AWS::S3::Bucket. For a list of supported resource types, see
Resources that support import operations
in the CloudFormation User Guide.
$sel:logicalResourceId:ResourceToImport', resourceToImport_logicalResourceId - The logical ID of the target resource as specified in the template.
$sel:resourceIdentifier:ResourceToImport', resourceToImport_resourceIdentifier - A key-value pair that identifies the target resource. The key is an
identifier property (for example, BucketName for AWS::S3::Bucket
resources) and the value is the actual property value (for example,
MyS3Bucket).
RollbackConfiguration
data RollbackConfiguration Source #
Structure containing the rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
Rollback triggers enable you to have CloudFormation monitor the state of your application during stack creation and updating, and to roll back that operation if the application breaches the threshold of any of the alarms you've specified. For more information, see Monitor and Roll Back Stack Operations.
See: newRollbackConfiguration smart constructor.
Constructors
| RollbackConfiguration' (Maybe Natural) (Maybe [RollbackTrigger]) |
Instances
newRollbackConfiguration :: RollbackConfiguration Source #
Create a value of RollbackConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:monitoringTimeInMinutes:RollbackConfiguration', rollbackConfiguration_monitoringTimeInMinutes - The amount of time, in minutes, during which CloudFormation should
monitor all the rollback triggers after the stack creation or update
operation deploys all necessary resources.
The default is 0 minutes.
If you specify a monitoring period but don't specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources after update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary.
If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes.
$sel:rollbackTriggers:RollbackConfiguration', rollbackConfiguration_rollbackTriggers - The triggers to monitor during stack creation or update actions.
By default, CloudFormation saves the rollback triggers specified for a stack and applies them to any subsequent update operations for the stack, unless you specify otherwise. If you do specify rollback triggers for this parameter, those triggers replace any list of triggers previously specified for the stack. This means:
- To use the rollback triggers previously specified for this stack, if any, don't specify this parameter.
- To specify new or updated rollback triggers, you must specify all the triggers that you want used for this stack, even triggers you've specified before (for example, when creating the stack or during a previous stack update). Any triggers that you don't include in the updated list of triggers are no longer applied to the stack.
- To remove all currently specified triggers, specify an empty list for this parameter.
If a specified trigger is missing, the entire stack operation fails and is rolled back.
RollbackTrigger
data RollbackTrigger Source #
A rollback trigger CloudFormation monitors during creation and updating of stacks. If any of the alarms you specify goes to ALARM state during the stack operation or within the specified monitoring period afterwards, CloudFormation rolls back the entire stack operation.
See: newRollbackTrigger smart constructor.
Constructors
| RollbackTrigger' Text Text |
Instances
Create a value of RollbackTrigger with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:RollbackTrigger', rollbackTrigger_arn - The Amazon Resource Name (ARN) of the rollback trigger.
If a specified trigger is missing, the entire stack operation fails and is rolled back.
$sel:type':RollbackTrigger', rollbackTrigger_type - The resource type of the rollback trigger. Specify either
AWS::CloudWatch::Alarm
or
AWS::CloudWatch::CompositeAlarm
resource types.
Stack
The Stack data type.
See: newStack smart constructor.
Constructors
| Stack' (Maybe [Capability]) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe Bool) (Maybe StackDriftInformation) (Maybe Bool) (Maybe ISO8601) (Maybe [Text]) (Maybe [Output]) (Maybe [Parameter]) (Maybe Text) (Maybe Text) (Maybe RollbackConfiguration) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe Natural) Text ISO8601 StackStatus |
Instances
Arguments
| :: Text | |
| -> UTCTime | |
| -> StackStatus | |
| -> Stack |
Create a value of Stack with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:capabilities:Stack', stack_capabilities - The capabilities allowed in the stack.
$sel:changeSetId:Stack', stack_changeSetId - The unique ID of the change set.
$sel:deletionTime:Stack', stack_deletionTime - The time the stack was deleted.
Stack, stack_description - A user-defined description associated with the stack.
$sel:disableRollback:Stack', stack_disableRollback - Boolean to enable or disable rollback on stack creation failures:
true: disable rollback.false: enable rollback.
$sel:driftInformation:Stack', stack_driftInformation - Information about whether a stack's actual configuration differs, or
has drifted, from it's expected configuration, as defined in the
stack template and any values specified as template parameters. For more
information, see
Detecting Unregulated Configuration Changes to Stacks and Resources.
$sel:enableTerminationProtection:Stack', stack_enableTerminationProtection - Whether termination protection is enabled for the stack.
For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the CloudFormation User Guide.
$sel:lastUpdatedTime:Stack', stack_lastUpdatedTime - The time the stack was last updated. This field will only be returned if
the stack has been updated at least once.
$sel:notificationARNs:Stack', stack_notificationARNs - Amazon SNS topic Amazon Resource Names (ARNs) to which stack related
events are published.
$sel:outputs:Stack', stack_outputs - A list of output structures.
$sel:parameters:Stack', stack_parameters - A list of Parameter structures.
$sel:parentId:Stack', stack_parentId - For nested stacks--stacks created as resources for another stack--the
stack ID of the direct parent of this stack. For the first level of
nested stacks, the root stack is also the parent stack.
For more information, see Working with Nested Stacks in the CloudFormation User Guide.
$sel:roleARN:Stack', stack_roleARN - The Amazon Resource Name (ARN) of an Identity and Access Management
(IAM) role that's associated with the stack. During a stack operation,
CloudFormation uses this role's credentials to make calls on your
behalf.
$sel:rollbackConfiguration:Stack', stack_rollbackConfiguration - The rollback triggers for CloudFormation to monitor during stack
creation and updating operations, and for the specified monitoring
period afterwards.
$sel:rootId:Stack', stack_rootId - For nested stacks--stacks created as resources for another stack--the
stack ID of the top-level stack to which the nested stack ultimately
belongs.
For more information, see Working with Nested Stacks in the CloudFormation User Guide.
$sel:stackId:Stack', stack_stackId - Unique identifier of the stack.
$sel:stackStatusReason:Stack', stack_stackStatusReason - Success/failure message associated with the stack status.
$sel:tags:Stack', stack_tags - A list of Tags that specify information about the stack.
$sel:timeoutInMinutes:Stack', stack_timeoutInMinutes - The amount of time within which stack creation should complete.
$sel:stackName:Stack', stack_stackName - The name associated with the stack.
$sel:creationTime:Stack', stack_creationTime - The time at which the stack was created.
$sel:stackStatus:Stack', stack_stackStatus - Current status of the stack.
StackDriftInformation
data StackDriftInformation Source #
Contains information about whether the stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted.
See: newStackDriftInformation smart constructor.
Constructors
| StackDriftInformation' (Maybe ISO8601) StackDriftStatus |
Instances
newStackDriftInformation Source #
Create a value of StackDriftInformation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lastCheckTimestamp:StackDriftInformation', stackDriftInformation_lastCheckTimestamp - Most recent time when a drift detection operation was initiated on the
stack, or any of its individual resources that support drift detection.
$sel:stackDriftStatus:StackDriftInformation', stackDriftInformation_stackDriftStatus - Status of the stack's actual configuration compared to its expected
template configuration.
DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected template configuration.IN_SYNC: The stack's actual configuration matches its expected template configuration.UNKNOWN: This value is reserved for future use.
StackDriftInformationSummary
data StackDriftInformationSummary Source #
Contains information about whether the stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted.
See: newStackDriftInformationSummary smart constructor.
Constructors
| StackDriftInformationSummary' (Maybe ISO8601) StackDriftStatus |
Instances
newStackDriftInformationSummary Source #
Arguments
| :: StackDriftStatus | |
| -> StackDriftInformationSummary |
Create a value of StackDriftInformationSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lastCheckTimestamp:StackDriftInformationSummary', stackDriftInformationSummary_lastCheckTimestamp - Most recent time when a drift detection operation was initiated on the
stack, or any of its individual resources that support drift detection.
$sel:stackDriftStatus:StackDriftInformationSummary', stackDriftInformationSummary_stackDriftStatus - Status of the stack's actual configuration compared to its expected
template configuration.
DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected template configuration.IN_SYNC: The stack's actual configuration matches its expected template configuration.UNKNOWN: This value is reserved for future use.
StackEvent
data StackEvent Source #
The StackEvent data type.
See: newStackEvent smart constructor.
Constructors
| StackEvent' (Maybe Text) (Maybe HookFailureMode) (Maybe HookInvocationPoint) (Maybe HookStatus) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ResourceStatus) (Maybe Text) (Maybe Text) Text Text Text ISO8601 |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> UTCTime | |
| -> StackEvent |
Create a value of StackEvent with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientRequestToken:StackEvent', stackEvent_clientRequestToken - The token passed to the operation that generated this event.
All events triggered by a given stack operation are assigned the same
client request token, which you can use to track operations. For
example, if you execute a CreateStack operation with the token
token1, then all the StackEvents generated by that operation will
have ClientRequestToken set as token1.
In the console, stack operations display the client request token on the
Events tab. Stack operations that are initiated from the console use the
token format Console-StackOperation-ID, which helps you easily
identify the stack operation . For example, if you create a stack using
the console, each stack event would be assigned the same token in the
following format:
Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
$sel:hookFailureMode:StackEvent', stackEvent_hookFailureMode - Specify the hook failure mode for non-compliant resources in the
followings ways.
FAILStops provisioning resources.WARNAllows provisioning to continue with a warning message.
$sel:hookInvocationPoint:StackEvent', stackEvent_hookInvocationPoint - Invocation points are points in provisioning logic where hooks are
initiated.
$sel:hookStatus:StackEvent', stackEvent_hookStatus - Provides the status of the change set hook.
$sel:hookStatusReason:StackEvent', stackEvent_hookStatusReason - Provides the reason for the hook status.
$sel:hookType:StackEvent', stackEvent_hookType - The name of the hook.
$sel:logicalResourceId:StackEvent', stackEvent_logicalResourceId - The logical name of the resource specified in the template.
$sel:physicalResourceId:StackEvent', stackEvent_physicalResourceId - The name or unique identifier associated with the physical instance of
the resource.
$sel:resourceProperties:StackEvent', stackEvent_resourceProperties - BLOB of the properties used to create the resource.
$sel:resourceStatus:StackEvent', stackEvent_resourceStatus - Current status of the resource.
$sel:resourceStatusReason:StackEvent', stackEvent_resourceStatusReason - Success/failure message associated with the resource.
$sel:resourceType:StackEvent', stackEvent_resourceType - Type of resource. (For more information, go to
Amazon Web Services Resource Types Reference
in the CloudFormation User Guide.)
$sel:stackId:StackEvent', stackEvent_stackId - The unique ID name of the instance of the stack.
$sel:eventId:StackEvent', stackEvent_eventId - The unique ID of this event.
$sel:stackName:StackEvent', stackEvent_stackName - The name associated with a stack.
$sel:timestamp:StackEvent', stackEvent_timestamp - Time the status was updated.
StackInstance
data StackInstance Source #
An CloudFormation stack, in a specific account and Region, that's part of a stack set operation. A stack instance is a reference to an attempted or actual stack in a given account within a given Region. A stack instance can exist without a stack—for example, if the stack couldn't be created for some reason. A stack instance is associated with only one stack set. Each stack instance contains the ID of its associated stack set, in addition to the ID of the actual stack and the stack status.
See: newStackInstance smart constructor.
Constructors
| StackInstance' (Maybe Text) (Maybe StackDriftStatus) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe [Parameter]) (Maybe Text) (Maybe Text) (Maybe StackInstanceComprehensiveStatus) (Maybe Text) (Maybe StackInstanceStatus) (Maybe Text) |
Instances
newStackInstance :: StackInstance Source #
Create a value of StackInstance with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:account:StackInstance', stackInstance_account - [Self-managed permissions] The name of the Amazon Web Services account
that the stack instance is associated with.
$sel:driftStatus:StackInstance', stackInstance_driftStatus - Status of the stack instance's actual configuration compared to the
expected template and parameter configuration of the stack set to which
it belongs.
DRIFTED: The stack differs from the expected template and parameter configuration of the stack set to which it belongs. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.NOT_CHECKED: CloudFormation hasn't checked if the stack instance differs from its expected stack set configuration.IN_SYNC: The stack instance's actual configuration matches its expected stack set configuration.UNKNOWN: This value is reserved for future use.
$sel:lastDriftCheckTimestamp:StackInstance', stackInstance_lastDriftCheckTimestamp - Most recent time when CloudFormation performed a drift detection
operation on the stack instance. This value will be NULL for any stack
instance on which drift detection hasn't yet been performed.
$sel:lastOperationId:StackInstance', stackInstance_lastOperationId - The last unique ID of a StackSet operation performed on a stack
instance.
$sel:organizationalUnitId:StackInstance', stackInstance_organizationalUnitId - [Service-managed permissions] The organization root ID or organizational
unit (OU) IDs that you specified for
DeploymentTargets.
$sel:parameterOverrides:StackInstance', stackInstance_parameterOverrides - A list of parameters from the stack set template whose values have been
overridden in this stack instance.
$sel:region:StackInstance', stackInstance_region - The name of the Amazon Web Services Region that the stack instance is
associated with.
$sel:stackId:StackInstance', stackInstance_stackId - The ID of the stack instance.
$sel:stackInstanceStatus:StackInstance', stackInstance_stackInstanceStatus - The detailed status of the stack instance.
$sel:stackSetId:StackInstance', stackInstance_stackSetId - The name or unique ID of the stack set that the stack instance is
associated with.
$sel:status:StackInstance', stackInstance_status - The status of the stack instance, in terms of its synchronization with
its associated stack set.
INOPERABLE: ADeleteStackInstancesoperation has failed and left the stack in an unstable state. Stacks in this state are excluded from furtherUpdateStackSetoperations. You might need to perform aDeleteStackInstancesoperation, withRetainStacksset totrue, to delete the stack instance, and then delete the stack manually.OUTDATED: The stack isn't currently up to date with the stack set because:- The associated stack failed during a
CreateStackSetorUpdateStackSetoperation. - The stack was part of a
CreateStackSetorUpdateStackSetoperation that failed or was stopped before the stack was created or updated.
- The associated stack failed during a
CURRENT: The stack is currently up to date with the stack set.
$sel:statusReason:StackInstance', stackInstance_statusReason - The explanation for the specific status code that's assigned to this
stack instance.
StackInstanceComprehensiveStatus
data StackInstanceComprehensiveStatus Source #
The detailed status of the stack instance.
See: newStackInstanceComprehensiveStatus smart constructor.
Instances
newStackInstanceComprehensiveStatus :: StackInstanceComprehensiveStatus Source #
Create a value of StackInstanceComprehensiveStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:detailedStatus:StackInstanceComprehensiveStatus', stackInstanceComprehensiveStatus_detailedStatus - - CANCELLED: The operation in the specified account and Region has
been canceled. This is either because a user has stopped the stack
set operation, or because the failure tolerance of the stack set
operation has been exceeded.
FAILED: The operation in the specified account and Region failed. If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded.INOPERABLE: ADeleteStackInstancesoperation has failed and left the stack in an unstable state. Stacks in this state are excluded from furtherUpdateStackSetoperations. You might need to perform aDeleteStackInstancesoperation, withRetainStacksset totrue, to delete the stack instance, and then delete the stack manually.PENDING: The operation in the specified account and Region has yet to start.RUNNING: The operation in the specified account and Region is currently in progress.SUCCEEDED: The operation in the specified account and Region completed successfully.
StackInstanceFilter
data StackInstanceFilter Source #
The filter to apply to stack instances
See: newStackInstanceFilter smart constructor.
Constructors
| StackInstanceFilter' (Maybe StackInstanceFilterName) (Maybe Text) |
Instances
newStackInstanceFilter :: StackInstanceFilter Source #
Create a value of StackInstanceFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:StackInstanceFilter', stackInstanceFilter_name - The type of filter to apply.
$sel:values:StackInstanceFilter', stackInstanceFilter_values - The status to filter by.
StackInstanceSummary
data StackInstanceSummary Source #
The structure that contains summary information about a stack instance.
See: newStackInstanceSummary smart constructor.
Constructors
Instances
newStackInstanceSummary :: StackInstanceSummary Source #
Create a value of StackInstanceSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:account:StackInstanceSummary', stackInstanceSummary_account - [Self-managed permissions] The name of the Amazon Web Services account
that the stack instance is associated with.
$sel:driftStatus:StackInstanceSummary', stackInstanceSummary_driftStatus - Status of the stack instance's actual configuration compared to the
expected template and parameter configuration of the stack set to which
it belongs.
DRIFTED: The stack differs from the expected template and parameter configuration of the stack set to which it belongs. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.NOT_CHECKED: CloudFormation hasn't checked if the stack instance differs from its expected stack set configuration.IN_SYNC: The stack instance's actual configuration matches its expected stack set configuration.UNKNOWN: This value is reserved for future use.
$sel:lastDriftCheckTimestamp:StackInstanceSummary', stackInstanceSummary_lastDriftCheckTimestamp - Most recent time when CloudFormation performed a drift detection
operation on the stack instance. This value will be NULL for any stack
instance on which drift detection hasn't yet been performed.
$sel:lastOperationId:StackInstanceSummary', stackInstanceSummary_lastOperationId - The last unique ID of a StackSet operation performed on a stack
instance.
$sel:organizationalUnitId:StackInstanceSummary', stackInstanceSummary_organizationalUnitId - [Service-managed permissions] The organization root ID or organizational
unit (OU) IDs that you specified for
DeploymentTargets.
$sel:region:StackInstanceSummary', stackInstanceSummary_region - The name of the Amazon Web Services Region that the stack instance is
associated with.
$sel:stackId:StackInstanceSummary', stackInstanceSummary_stackId - The ID of the stack instance.
$sel:stackInstanceStatus:StackInstanceSummary', stackInstanceSummary_stackInstanceStatus - The detailed status of the stack instance.
$sel:stackSetId:StackInstanceSummary', stackInstanceSummary_stackSetId - The name or unique ID of the stack set that the stack instance is
associated with.
$sel:status:StackInstanceSummary', stackInstanceSummary_status - The status of the stack instance, in terms of its synchronization with
its associated stack set.
INOPERABLE: ADeleteStackInstancesoperation has failed and left the stack in an unstable state. Stacks in this state are excluded from furtherUpdateStackSetoperations. You might need to perform aDeleteStackInstancesoperation, withRetainStacksset totrue, to delete the stack instance, and then delete the stack manually.OUTDATED: The stack isn't currently up to date with the stack set because:- The associated stack failed during a
CreateStackSetorUpdateStackSetoperation. - The stack was part of a
CreateStackSetorUpdateStackSetoperation that failed or was stopped before the stack was created or updated.
- The associated stack failed during a
CURRENT: The stack is currently up to date with the stack set.
$sel:statusReason:StackInstanceSummary', stackInstanceSummary_statusReason - The explanation for the specific status code assigned to this stack
instance.
StackResource
data StackResource Source #
The StackResource data type.
See: newStackResource smart constructor.
Constructors
| StackResource' (Maybe Text) (Maybe StackResourceDriftInformation) (Maybe ModuleInfo) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text Text ISO8601 ResourceStatus |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> UTCTime | |
| -> ResourceStatus | |
| -> StackResource |
Create a value of StackResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:StackResource', stackResource_description - User defined description associated with the resource.
$sel:driftInformation:StackResource', stackResource_driftInformation - Information about whether the resource's actual configuration differs,
or has drifted, from its expected configuration, as defined in the
stack template and any values specified as template parameters. For more
information, see
Detecting Unregulated Configuration Changes to Stacks and Resources.
$sel:moduleInfo:StackResource', stackResource_moduleInfo - Contains information about the module from which the resource was
created, if the resource was created from a module included in the stack
template.
$sel:physicalResourceId:StackResource', stackResource_physicalResourceId - The name or unique identifier that corresponds to a physical instance ID
of a resource supported by CloudFormation.
$sel:resourceStatusReason:StackResource', stackResource_resourceStatusReason - Success/failure message associated with the resource.
$sel:stackId:StackResource', stackResource_stackId - Unique identifier of the stack.
$sel:stackName:StackResource', stackResource_stackName - The name associated with the stack.
$sel:logicalResourceId:StackResource', stackResource_logicalResourceId - The logical name of the resource specified in the template.
$sel:resourceType:StackResource', stackResource_resourceType - Type of resource. For more information, go to
Amazon Web Services Resource Types Reference
in the CloudFormation User Guide.
$sel:timestamp:StackResource', stackResource_timestamp - Time the status was updated.
$sel:resourceStatus:StackResource', stackResource_resourceStatus - Current status of the resource.
StackResourceDetail
data StackResourceDetail Source #
Contains detailed information about the specified stack resource.
See: newStackResourceDetail smart constructor.
Constructors
| StackResourceDetail' (Maybe Text) (Maybe StackResourceDriftInformation) (Maybe Text) (Maybe ModuleInfo) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text Text ISO8601 ResourceStatus |
Instances
newStackResourceDetail Source #
Arguments
| :: Text | |
| -> Text | |
| -> UTCTime | |
| -> ResourceStatus | |
| -> StackResourceDetail |
Create a value of StackResourceDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:StackResourceDetail', stackResourceDetail_description - User defined description associated with the resource.
$sel:driftInformation:StackResourceDetail', stackResourceDetail_driftInformation - Information about whether the resource's actual configuration differs,
or has drifted, from its expected configuration, as defined in the
stack template and any values specified as template parameters. For more
information, see
Detecting Unregulated Configuration Changes to Stacks and Resources.
$sel:metadata:StackResourceDetail', stackResourceDetail_metadata - The content of the Metadata attribute declared for the resource. For
more information, see
Metadata Attribute
in the CloudFormation User Guide.
$sel:moduleInfo:StackResourceDetail', stackResourceDetail_moduleInfo - Contains information about the module from which the resource was
created, if the resource was created from a module included in the stack
template.
$sel:physicalResourceId:StackResourceDetail', stackResourceDetail_physicalResourceId - The name or unique identifier that corresponds to a physical instance ID
of a resource supported by CloudFormation.
$sel:resourceStatusReason:StackResourceDetail', stackResourceDetail_resourceStatusReason - Success/failure message associated with the resource.
$sel:stackId:StackResourceDetail', stackResourceDetail_stackId - Unique identifier of the stack.
$sel:stackName:StackResourceDetail', stackResourceDetail_stackName - The name associated with the stack.
$sel:logicalResourceId:StackResourceDetail', stackResourceDetail_logicalResourceId - The logical name of the resource specified in the template.
$sel:resourceType:StackResourceDetail', stackResourceDetail_resourceType - Type of resource. For more information, go to
Amazon Web Services Resource Types Reference
in the CloudFormation User Guide.
$sel:lastUpdatedTimestamp:StackResourceDetail', stackResourceDetail_lastUpdatedTimestamp - Time the status was updated.
$sel:resourceStatus:StackResourceDetail', stackResourceDetail_resourceStatus - Current status of the resource.
StackResourceDrift
data StackResourceDrift Source #
Contains the drift information for a resource that has been checked for drift. This includes actual and expected property values for resources in which CloudFormation has detected drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
Resources that don't currently support drift detection can't be checked. For a list of resources that support drift detection, see Resources that Support Drift Detection.
Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.
See: newStackResourceDrift smart constructor.
Constructors
Instances
newStackResourceDrift Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> StackResourceDriftStatus | |
| -> UTCTime | |
| -> StackResourceDrift |
Create a value of StackResourceDrift with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:actualProperties:StackResourceDrift', stackResourceDrift_actualProperties - A JSON structure containing the actual property values of the stack
resource.
For resources whose StackResourceDriftStatus is DELETED, this
structure will not be present.
$sel:expectedProperties:StackResourceDrift', stackResourceDrift_expectedProperties - A JSON structure containing the expected property values of the stack
resource, as defined in the stack template and any values specified as
template parameters.
For resources whose StackResourceDriftStatus is DELETED, this
structure will not be present.
$sel:moduleInfo:StackResourceDrift', stackResourceDrift_moduleInfo - Contains information about the module from which the resource was
created, if the resource was created from a module included in the stack
template.
$sel:physicalResourceId:StackResourceDrift', stackResourceDrift_physicalResourceId - The name or unique identifier that corresponds to a physical instance ID
of a resource supported by CloudFormation.
$sel:physicalResourceIdContext:StackResourceDrift', stackResourceDrift_physicalResourceIdContext - Context information that enables CloudFormation to uniquely identify a
resource. CloudFormation uses context key-value pairs in cases where a
resource's logical and physical IDs aren't enough to uniquely identify
that resource. Each context key-value pair specifies a unique resource
that contains the targeted resource.
$sel:propertyDifferences:StackResourceDrift', stackResourceDrift_propertyDifferences - A collection of the resource properties whose actual values differ from
their expected values. These will be present only for resources whose
StackResourceDriftStatus is MODIFIED.
$sel:stackId:StackResourceDrift', stackResourceDrift_stackId - The ID of the stack.
$sel:logicalResourceId:StackResourceDrift', stackResourceDrift_logicalResourceId - The logical name of the resource specified in the template.
$sel:resourceType:StackResourceDrift', stackResourceDrift_resourceType - The type of the resource.
$sel:stackResourceDriftStatus:StackResourceDrift', stackResourceDrift_stackResourceDriftStatus - Status of the resource's actual configuration compared to its expected
configuration.
DELETED: The resource differs from its expected template configuration because the resource has been deleted.MODIFIED: One or more resource properties differ from their expected values (as defined in the stack template and any values specified as template parameters).IN_SYNC: The resource's actual configuration matches its expected template configuration.NOT_CHECKED: CloudFormation does not currently return this value.
$sel:timestamp:StackResourceDrift', stackResourceDrift_timestamp - Time at which CloudFormation performed drift detection on the stack
resource.
StackResourceDriftInformation
data StackResourceDriftInformation Source #
Contains information about whether the resource's actual configuration differs, or has drifted, from its expected configuration.
See: newStackResourceDriftInformation smart constructor.
Constructors
| StackResourceDriftInformation' (Maybe ISO8601) StackResourceDriftStatus |
Instances
newStackResourceDriftInformation Source #
Arguments
| :: StackResourceDriftStatus |
|
| -> StackResourceDriftInformation |
Create a value of StackResourceDriftInformation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lastCheckTimestamp:StackResourceDriftInformation', stackResourceDriftInformation_lastCheckTimestamp - When CloudFormation last checked if the resource had drifted from its
expected configuration.
$sel:stackResourceDriftStatus:StackResourceDriftInformation', stackResourceDriftInformation_stackResourceDriftStatus - Status of the resource's actual configuration compared to its expected
configuration
DELETED: The resource differs from its expected configuration in that it has been deleted.MODIFIED: The resource differs from its expected configuration.NOT_CHECKED: CloudFormation has not checked if the resource differs from its expected configuration.Any resources that do not currently support drift detection have a status of
NOT_CHECKED. For more information, see Resources that Support Drift Detection.IN_SYNC: The resource's actual configuration matches its expected configuration.
StackResourceDriftInformationSummary
data StackResourceDriftInformationSummary Source #
Summarizes information about whether the resource's actual configuration differs, or has drifted, from its expected configuration.
See: newStackResourceDriftInformationSummary smart constructor.
Instances
newStackResourceDriftInformationSummary Source #
Arguments
| :: StackResourceDriftStatus |
|
| -> StackResourceDriftInformationSummary |
Create a value of StackResourceDriftInformationSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lastCheckTimestamp:StackResourceDriftInformationSummary', stackResourceDriftInformationSummary_lastCheckTimestamp - When CloudFormation last checked if the resource had drifted from its
expected configuration.
$sel:stackResourceDriftStatus:StackResourceDriftInformationSummary', stackResourceDriftInformationSummary_stackResourceDriftStatus - Status of the resource's actual configuration compared to its expected
configuration.
DELETED: The resource differs from its expected configuration in that it has been deleted.MODIFIED: The resource differs from its expected configuration.NOT_CHECKED: CloudFormation hasn't checked if the resource differs from its expected configuration.Any resources that don't currently support drift detection have a status of
NOT_CHECKED. For more information, see Resources that Support Drift Detection. If you performed an ContinueUpdateRollback operation on a stack, any resources included inResourcesToSkipwill also have a status ofNOT_CHECKED. For more information about skipping resources during rollback operations, see Continue Rolling Back an Update in the CloudFormation User Guide.IN_SYNC: The resource's actual configuration matches its expected configuration.
StackResourceSummary
data StackResourceSummary Source #
Contains high-level information about the specified stack resource.
See: newStackResourceSummary smart constructor.
Constructors
| StackResourceSummary' (Maybe StackResourceDriftInformationSummary) (Maybe ModuleInfo) (Maybe Text) (Maybe Text) Text Text ISO8601 ResourceStatus |
Instances
newStackResourceSummary Source #
Arguments
| :: Text | |
| -> Text | |
| -> UTCTime | |
| -> ResourceStatus | |
| -> StackResourceSummary |
Create a value of StackResourceSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:driftInformation:StackResourceSummary', stackResourceSummary_driftInformation - Information about whether the resource's actual configuration differs,
or has drifted, from its expected configuration, as defined in the
stack template and any values specified as template parameters. For more
information, see
Detecting Unregulated Configuration Changes to Stacks and Resources.
$sel:moduleInfo:StackResourceSummary', stackResourceSummary_moduleInfo - Contains information about the module from which the resource was
created, if the resource was created from a module included in the stack
template.
$sel:physicalResourceId:StackResourceSummary', stackResourceSummary_physicalResourceId - The name or unique identifier that corresponds to a physical instance ID
of the resource.
$sel:resourceStatusReason:StackResourceSummary', stackResourceSummary_resourceStatusReason - Success/failure message associated with the resource.
$sel:logicalResourceId:StackResourceSummary', stackResourceSummary_logicalResourceId - The logical name of the resource specified in the template.
$sel:resourceType:StackResourceSummary', stackResourceSummary_resourceType - Type of resource. (For more information, go to
Amazon Web Services Resource Types Reference
in the CloudFormation User Guide.)
$sel:lastUpdatedTimestamp:StackResourceSummary', stackResourceSummary_lastUpdatedTimestamp - Time the status was updated.
$sel:resourceStatus:StackResourceSummary', stackResourceSummary_resourceStatus - Current status of the resource.
StackSet
A structure that contains information about a stack set. A stack set enables you to provision stacks into Amazon Web Services accounts and across Regions by using a single CloudFormation template. In the stack set, you specify the template to use, in addition to any parameters and capabilities that the template requires.
See: newStackSet smart constructor.
Constructors
| StackSet' (Maybe Text) (Maybe AutoDeployment) (Maybe [Capability]) (Maybe Text) (Maybe Text) (Maybe ManagedExecution) (Maybe [Text]) (Maybe [Parameter]) (Maybe PermissionModels) (Maybe Text) (Maybe StackSetDriftDetectionDetails) (Maybe Text) (Maybe Text) (Maybe StackSetStatus) (Maybe [Tag]) (Maybe Text) |
Instances
newStackSet :: StackSet Source #
Create a value of StackSet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:administrationRoleARN:StackSet', stackSet_administrationRoleARN - The Amazon Resource Name (ARN) of the IAM role used to create or update
the stack set.
Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the CloudFormation User Guide.
$sel:autoDeployment:StackSet', stackSet_autoDeployment - [Service-managed permissions] Describes whether StackSets automatically
deploys to Organizations accounts that are added to a target
organization or organizational unit (OU).
$sel:capabilities:StackSet', stackSet_capabilities - The capabilities that are allowed in the stack set. Some stack set
templates might include resources that can affect permissions in your
Amazon Web Services account—for example, by creating new Identity and
Access Management (IAM) users. For more information, see
Acknowledging IAM Resources in CloudFormation Templates.
$sel:description:StackSet', stackSet_description - A description of the stack set that you specify when the stack set is
created or updated.
$sel:executionRoleName:StackSet', stackSet_executionRoleName - The name of the IAM execution role used to create or update the stack
set.
Use customized execution roles to control which stack resources users and groups can include in their stack sets.
$sel:managedExecution:StackSet', stackSet_managedExecution - Describes whether StackSets performs non-conflicting operations
concurrently and queues conflicting operations.
$sel:organizationalUnitIds:StackSet', stackSet_organizationalUnitIds - [Service-managed permissions] The organization root ID or organizational
unit (OU) IDs that you specified for
DeploymentTargets.
$sel:parameters:StackSet', stackSet_parameters - A list of input parameters for a stack set.
$sel:permissionModel:StackSet', stackSet_permissionModel - Describes how the IAM roles required for stack set operations are
created.
- With
self-managedpermissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant Self-Managed Stack Set Permissions. - With
service-managedpermissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
$sel:stackSetARN:StackSet', stackSet_stackSetARN - The Amazon Resource Name (ARN) of the stack set.
$sel:stackSetDriftDetectionDetails:StackSet', stackSet_stackSetDriftDetectionDetails - Detailed information about the drift status of the stack set.
For stack sets, contains information about the last completed drift operation performed on the stack set. Information about drift operations currently in progress isn't included.
$sel:stackSetId:StackSet', stackSet_stackSetId - The ID of the stack set.
$sel:stackSetName:StackSet', stackSet_stackSetName - The name that's associated with the stack set.
$sel:status:StackSet', stackSet_status - The status of the stack set.
$sel:tags:StackSet', stackSet_tags - A list of tags that specify information about the stack set. A maximum
number of 50 tags can be specified.
$sel:templateBody:StackSet', stackSet_templateBody - The structure that contains the body of the template that was used to
create or update the stack set.
StackSetDriftDetectionDetails
data StackSetDriftDetectionDetails Source #
Detailed information about the drift status of the stack set.
For stack sets, contains information about the last completed drift operation performed on the stack set. Information about drift operations in-progress isn't included.
For stack set operations, includes information about drift operations currently being performed on the stack set.
For more information, see Detecting unmanaged changes in stack sets in the CloudFormation User Guide.
See: newStackSetDriftDetectionDetails smart constructor.
Constructors
| StackSetDriftDetectionDetails' (Maybe StackSetDriftDetectionStatus) (Maybe StackSetDriftStatus) (Maybe Natural) (Maybe Natural) (Maybe Natural) (Maybe Natural) (Maybe ISO8601) (Maybe Natural) |
Instances
newStackSetDriftDetectionDetails :: StackSetDriftDetectionDetails Source #
Create a value of StackSetDriftDetectionDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:driftDetectionStatus:StackSetDriftDetectionDetails', stackSetDriftDetectionDetails_driftDetectionStatus - The status of the stack set drift detection operation.
COMPLETED: The drift detection operation completed without failing on any stack instances.FAILED: The drift detection operation exceeded the specified failure tolerance.PARTIAL_SUCCESS: The drift detection operation completed without exceeding the failure tolerance for the operation.IN_PROGRESS: The drift detection operation is currently being performed.STOPPED: The user has canceled the drift detection operation.
$sel:driftStatus:StackSetDriftDetectionDetails', stackSetDriftDetectionDetails_driftStatus - Status of the stack set's actual configuration compared to its expected
template and parameter configuration. A stack set is considered to have
drifted if one or more of its stack instances have drifted from their
expected template and parameter configuration.
DRIFTED: One or more of the stack instances belonging to the stack set stack differs from the expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.NOT_CHECKED: CloudFormation hasn't checked the stack set for drift.IN_SYNC: All of the stack instances belonging to the stack set stack match from the expected template and parameter configuration.
$sel:driftedStackInstancesCount:StackSetDriftDetectionDetails', stackSetDriftDetectionDetails_driftedStackInstancesCount - The number of stack instances that have drifted from the expected
template and parameter configuration of the stack set. A stack instance
is considered to have drifted if one or more of the resources in the
associated stack don't match their expected configuration.
$sel:failedStackInstancesCount:StackSetDriftDetectionDetails', stackSetDriftDetectionDetails_failedStackInstancesCount - The number of stack instances for which the drift detection operation
failed.
$sel:inProgressStackInstancesCount:StackSetDriftDetectionDetails', stackSetDriftDetectionDetails_inProgressStackInstancesCount - The number of stack instances that are currently being checked for
drift.
$sel:inSyncStackInstancesCount:StackSetDriftDetectionDetails', stackSetDriftDetectionDetails_inSyncStackInstancesCount - The number of stack instances which match the expected template and
parameter configuration of the stack set.
$sel:lastDriftCheckTimestamp:StackSetDriftDetectionDetails', stackSetDriftDetectionDetails_lastDriftCheckTimestamp - Most recent time when CloudFormation performed a drift detection
operation on the stack set. This value will be NULL for any stack set
on which drift detection hasn't yet been performed.
$sel:totalStackInstancesCount:StackSetDriftDetectionDetails', stackSetDriftDetectionDetails_totalStackInstancesCount - The total number of stack instances belonging to this stack set.
The total number of stack instances is equal to the total of:
- Stack instances that match the stack set configuration.
- Stack instances that have drifted from the stack set configuration.
- Stack instances where the drift detection operation has failed.
- Stack instances currently being checked for drift.
StackSetOperation
data StackSetOperation Source #
The structure that contains information about a stack set operation.
See: newStackSetOperation smart constructor.
Constructors
Instances
newStackSetOperation :: StackSetOperation Source #
Create a value of StackSetOperation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:action:StackSetOperation', stackSetOperation_action - The type of stack set operation: CREATE, UPDATE, or DELETE. Create
and delete operations affect only the specified stack set instances that
are associated with the specified stack set. Update operations affect
both the stack set itself, in addition to all associated stack set
instances.
$sel:administrationRoleARN:StackSetOperation', stackSetOperation_administrationRoleARN - The Amazon Resource Name (ARN) of the IAM role used to perform this
stack set operation.
Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Define Permissions for Multiple Administrators in the CloudFormation User Guide.
$sel:creationTimestamp:StackSetOperation', stackSetOperation_creationTimestamp - The time at which the operation was initiated. Note that the creation
times for the stack set operation might differ from the creation time of
the individual stacks themselves. This is because CloudFormation needs
to perform preparatory work for the operation, such as dispatching the
work to the requested Regions, before actually creating the first
stacks.
$sel:deploymentTargets:StackSetOperation', stackSetOperation_deploymentTargets - [Service-managed permissions] The Organizations accounts affected by the
stack operation.
$sel:endTimestamp:StackSetOperation', stackSetOperation_endTimestamp - The time at which the stack set operation ended, across all accounts and
Regions specified. Note that this doesn't necessarily mean that the
stack set operation was successful, or even attempted, in each account
or Region.
$sel:executionRoleName:StackSetOperation', stackSetOperation_executionRoleName - The name of the IAM execution role used to create or update the stack
set.
Use customized execution roles to control which stack resources users and groups can include in their stack sets.
$sel:operationId:StackSetOperation', stackSetOperation_operationId - The unique ID of a stack set operation.
$sel:operationPreferences:StackSetOperation', stackSetOperation_operationPreferences - The preferences for how CloudFormation performs this stack set
operation.
$sel:retainStacks:StackSetOperation', stackSetOperation_retainStacks - For stack set operations of action type DELETE, specifies whether to
remove the stack instances from the specified stack set, but doesn't
delete the stacks. You can't re-associate a retained stack, or add an
existing, saved stack to a new stack set.
$sel:stackSetDriftDetectionDetails:StackSetOperation', stackSetOperation_stackSetDriftDetectionDetails - Detailed information about the drift status of the stack set. This
includes information about drift operations currently being performed on
the stack set.
This information will only be present for stack set operations whose
Action type is DETECT_DRIFT.
For more information, see Detecting Unmanaged Changes in Stack Sets in the CloudFormation User Guide.
$sel:stackSetId:StackSetOperation', stackSetOperation_stackSetId - The ID of the stack set.
$sel:status:StackSetOperation', stackSetOperation_status - The status of the operation.
FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set toFAILED. This in turn sets the status of the operation as a whole toFAILED, and CloudFormation cancels the operation in any remaining Regions.QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the CloudFormation User Guide.RUNNING: The operation is currently being performed.STOPPED: The user has canceled the operation.STOPPING: The operation is in the process of stopping, at user request.SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.
$sel:statusDetails:StackSetOperation', stackSetOperation_statusDetails - Detailed information about the StackSet operation.
$sel:statusReason:StackSetOperation', stackSetOperation_statusReason - The status of the operation in details.
StackSetOperationPreferences
data StackSetOperationPreferences Source #
The user-specified preferences for how CloudFormation performs a stack set operation.
For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.
See: newStackSetOperationPreferences smart constructor.
Constructors
| StackSetOperationPreferences' (Maybe Natural) (Maybe Natural) (Maybe Natural) (Maybe Natural) (Maybe RegionConcurrencyType) (Maybe [Text]) |
Instances
newStackSetOperationPreferences :: StackSetOperationPreferences Source #
Create a value of StackSetOperationPreferences with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:failureToleranceCount:StackSetOperationPreferences', stackSetOperationPreferences_failureToleranceCount - The number of accounts, per Region, for which this operation can fail
before CloudFormation stops the operation in that Region. If the
operation is stopped in a Region, CloudFormation doesn't attempt the
operation in any subsequent Regions.
Conditional: You must specify either FailureToleranceCount or
FailureTolerancePercentage (but not both).
By default, 0 is specified.
$sel:failureTolerancePercentage:StackSetOperationPreferences', stackSetOperationPreferences_failureTolerancePercentage - The percentage of accounts, per Region, for which this stack operation
can fail before CloudFormation stops the operation in that Region. If
the operation is stopped in a Region, CloudFormation doesn't attempt
the operation in any subsequent Regions.
When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number.
Conditional: You must specify either FailureToleranceCount or
FailureTolerancePercentage, but not both.
By default, 0 is specified.
$sel:maxConcurrentCount:StackSetOperationPreferences', stackSetOperationPreferences_maxConcurrentCount - The maximum number of accounts in which to perform this operation at one
time. This is dependent on the value of
FailureToleranceCount.MaxConcurrentCount is at most one more than
the FailureToleranceCount.
Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.
Conditional: You must specify either MaxConcurrentCount or
MaxConcurrentPercentage, but not both.
By default, 1 is specified.
$sel:maxConcurrentPercentage:StackSetOperationPreferences', stackSetOperationPreferences_maxConcurrentPercentage - The maximum percentage of accounts in which to perform this operation at
one time.
When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead.
Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.
Conditional: You must specify either MaxConcurrentCount or
MaxConcurrentPercentage, but not both.
By default, 1 is specified.
$sel:regionConcurrencyType:StackSetOperationPreferences', stackSetOperationPreferences_regionConcurrencyType - The concurrency type of deploying StackSets operations in Regions, could
be in parallel or one Region at a time.
$sel:regionOrder:StackSetOperationPreferences', stackSetOperationPreferences_regionOrder - The order of the Regions in where you want to perform the stack
operation.
StackSetOperationResultSummary
data StackSetOperationResultSummary Source #
The structure that contains information about a specified operation's results for a given account in a given Region.
See: newStackSetOperationResultSummary smart constructor.
Constructors
| StackSetOperationResultSummary' (Maybe Text) (Maybe AccountGateResult) (Maybe Text) (Maybe Text) (Maybe StackSetOperationResultStatus) (Maybe Text) |
Instances
newStackSetOperationResultSummary :: StackSetOperationResultSummary Source #
Create a value of StackSetOperationResultSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:account:StackSetOperationResultSummary', stackSetOperationResultSummary_account - [Self-managed permissions] The name of the Amazon Web Services account
for this operation result.
$sel:accountGateResult:StackSetOperationResultSummary', stackSetOperationResultSummary_accountGateResult - The results of the account gate function CloudFormation invokes, if
present, before proceeding with stack set operations in an account.
$sel:organizationalUnitId:StackSetOperationResultSummary', stackSetOperationResultSummary_organizationalUnitId - [Service-managed permissions] The organization root ID or organizational
unit (OU) IDs that you specified for
DeploymentTargets.
$sel:region:StackSetOperationResultSummary', stackSetOperationResultSummary_region - The name of the Amazon Web Services Region for this operation result.
StackSetOperationResultSummary, stackSetOperationResultSummary_status - The result status of the stack set operation for the given account in
the given Region.
CANCELLED: The operation in the specified account and Region has been canceled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded.FAILED: The operation in the specified account and Region failed.If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded.
RUNNING: The operation in the specified account and Region is currently in progress.PENDING: The operation in the specified account and Region has yet to start.SUCCEEDED: The operation in the specified account and Region completed successfully.
StackSetOperationResultSummary, stackSetOperationResultSummary_statusReason - The reason for the assigned result status.
StackSetOperationStatusDetails
data StackSetOperationStatusDetails Source #
Detailed information about the StackSet operation.
See: newStackSetOperationStatusDetails smart constructor.
Constructors
| StackSetOperationStatusDetails' (Maybe Natural) |
Instances
newStackSetOperationStatusDetails :: StackSetOperationStatusDetails Source #
Create a value of StackSetOperationStatusDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:failedStackInstancesCount:StackSetOperationStatusDetails', stackSetOperationStatusDetails_failedStackInstancesCount - The number of stack instances for which the StackSet operation failed.
StackSetOperationSummary
data StackSetOperationSummary Source #
The structures that contain summary information about the specified operation.
See: newStackSetOperationSummary smart constructor.
Constructors
Instances
newStackSetOperationSummary :: StackSetOperationSummary Source #
Create a value of StackSetOperationSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:action:StackSetOperationSummary', stackSetOperationSummary_action - The type of operation: CREATE, UPDATE, or DELETE. Create and
delete operations affect only the specified stack instances that are
associated with the specified stack set. Update operations affect both
the stack set itself and all associated stack set instances.
$sel:creationTimestamp:StackSetOperationSummary', stackSetOperationSummary_creationTimestamp - The time at which the operation was initiated. Note that the creation
times for the stack set operation might differ from the creation time of
the individual stacks themselves. This is because CloudFormation needs
to perform preparatory work for the operation, such as dispatching the
work to the requested Regions, before actually creating the first
stacks.
$sel:endTimestamp:StackSetOperationSummary', stackSetOperationSummary_endTimestamp - The time at which the stack set operation ended, across all accounts and
Regions specified. Note that this doesn't necessarily mean that the
stack set operation was successful, or even attempted, in each account
or Region.
$sel:operationId:StackSetOperationSummary', stackSetOperationSummary_operationId - The unique ID of the stack set operation.
$sel:operationPreferences:StackSetOperationSummary', stackSetOperationSummary_operationPreferences - Undocumented member.
$sel:status:StackSetOperationSummary', stackSetOperationSummary_status - The overall status of the operation.
FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set toFAILED. This in turn sets the status of the operation as a whole toFAILED, and CloudFormation cancels the operation in any remaining Regions.QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the CloudFormation User Guide.RUNNING: The operation is currently being performed.STOPPED: The user has canceled the operation.STOPPING: The operation is in the process of stopping, at user request.SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.
$sel:statusDetails:StackSetOperationSummary', stackSetOperationSummary_statusDetails - Detailed information about the stack set operation.
$sel:statusReason:StackSetOperationSummary', stackSetOperationSummary_statusReason - The status of the operation in details.
StackSetSummary
data StackSetSummary Source #
The structures that contain summary information about the specified stack set.
See: newStackSetSummary smart constructor.
Constructors
| StackSetSummary' (Maybe AutoDeployment) (Maybe Text) (Maybe StackDriftStatus) (Maybe ISO8601) (Maybe ManagedExecution) (Maybe PermissionModels) (Maybe Text) (Maybe Text) (Maybe StackSetStatus) |
Instances
newStackSetSummary :: StackSetSummary Source #
Create a value of StackSetSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:autoDeployment:StackSetSummary', stackSetSummary_autoDeployment - [Service-managed permissions] Describes whether StackSets automatically
deploys to Organizations accounts that are added to a target
organizational unit (OU).
$sel:description:StackSetSummary', stackSetSummary_description - A description of the stack set that you specify when the stack set is
created or updated.
$sel:driftStatus:StackSetSummary', stackSetSummary_driftStatus - Status of the stack set's actual configuration compared to its expected
template and parameter configuration. A stack set is considered to have
drifted if one or more of its stack instances have drifted from their
expected template and parameter configuration.
DRIFTED: One or more of the stack instances belonging to the stack set stack differs from the expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.NOT_CHECKED: CloudFormation hasn't checked the stack set for drift.IN_SYNC: All the stack instances belonging to the stack set stack match from the expected template and parameter configuration.UNKNOWN: This value is reserved for future use.
$sel:lastDriftCheckTimestamp:StackSetSummary', stackSetSummary_lastDriftCheckTimestamp - Most recent time when CloudFormation performed a drift detection
operation on the stack set. This value will be NULL for any stack set
on which drift detection hasn't yet been performed.
$sel:managedExecution:StackSetSummary', stackSetSummary_managedExecution - Describes whether StackSets performs non-conflicting operations
concurrently and queues conflicting operations.
$sel:permissionModel:StackSetSummary', stackSetSummary_permissionModel - Describes how the IAM roles required for stack set operations are
created.
- With
self-managedpermissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant Self-Managed Stack Set Permissions. - With
service-managedpermissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
$sel:stackSetId:StackSetSummary', stackSetSummary_stackSetId - The ID of the stack set.
$sel:stackSetName:StackSetSummary', stackSetSummary_stackSetName - The name of the stack set.
$sel:status:StackSetSummary', stackSetSummary_status - The status of the stack set.
StackSummary
data StackSummary Source #
The StackSummary Data Type
See: newStackSummary smart constructor.
Constructors
| StackSummary' (Maybe ISO8601) (Maybe StackDriftInformationSummary) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text ISO8601 StackStatus |
Instances
Arguments
| :: Text | |
| -> UTCTime | |
| -> StackStatus | |
| -> StackSummary |
Create a value of StackSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deletionTime:StackSummary', stackSummary_deletionTime - The time the stack was deleted.
$sel:driftInformation:StackSummary', stackSummary_driftInformation - Summarizes information about whether a stack's actual configuration
differs, or has drifted, from it's expected configuration, as defined
in the stack template and any values specified as template parameters.
For more information, see
Detecting Unregulated Configuration Changes to Stacks and Resources.
$sel:lastUpdatedTime:StackSummary', stackSummary_lastUpdatedTime - The time the stack was last updated. This field will only be returned if
the stack has been updated at least once.
$sel:parentId:StackSummary', stackSummary_parentId - For nested stacks--stacks created as resources for another stack--the
stack ID of the direct parent of this stack. For the first level of
nested stacks, the root stack is also the parent stack.
For more information, see Working with Nested Stacks in the CloudFormation User Guide.
$sel:rootId:StackSummary', stackSummary_rootId - For nested stacks--stacks created as resources for another stack--the
stack ID of the top-level stack to which the nested stack ultimately
belongs.
For more information, see Working with Nested Stacks in the CloudFormation User Guide.
$sel:stackId:StackSummary', stackSummary_stackId - Unique stack identifier.
$sel:stackStatusReason:StackSummary', stackSummary_stackStatusReason - Success/Failure message associated with the stack status.
$sel:templateDescription:StackSummary', stackSummary_templateDescription - The template description of the template used to create the stack.
$sel:stackName:StackSummary', stackSummary_stackName - The name associated with the stack.
$sel:creationTime:StackSummary', stackSummary_creationTime - The time the stack was created.
$sel:stackStatus:StackSummary', stackSummary_stackStatus - 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 CloudFormation stack.
See: newTag smart constructor.
Instances
| ToQuery Tag Source # | |
Defined in Amazonka.CloudFormation.Types.Tag Methods toQuery :: Tag -> QueryString # | |
| FromXML Tag Source # | |
| Generic Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.CloudFormation.Types.Tag | |
| Eq Tag Source # | |
| Hashable Tag Source # | |
Defined in Amazonka.CloudFormation.Types.Tag | |
| type Rep Tag Source # | |
Defined in Amazonka.CloudFormation.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.CloudFormation.Types.Tag" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Tag with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag', tag_key - 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 (Amazon Web Services) have the reserved prefix: aws:.
$sel:value:Tag', tag_value - Required. A string containing the value for this tag. You can specify
a maximum of 256 characters for a tag value.
TemplateParameter
data TemplateParameter Source #
The TemplateParameter data type.
See: newTemplateParameter smart constructor.
Instances
newTemplateParameter :: TemplateParameter Source #
Create a value of TemplateParameter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:defaultValue:TemplateParameter', templateParameter_defaultValue - The default value associated with the parameter.
$sel:description:TemplateParameter', templateParameter_description - User defined description associated with the parameter.
$sel:noEcho:TemplateParameter', templateParameter_noEcho - Flag indicating whether the parameter should be displayed as plain text
in logs and UIs.
$sel:parameterKey:TemplateParameter', templateParameter_parameterKey - The name associated with the parameter.
TypeConfigurationDetails
data TypeConfigurationDetails Source #
Detailed information concerning the specification of a CloudFormation extension in a given account and region.
For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
See: newTypeConfigurationDetails smart constructor.
Constructors
| TypeConfigurationDetails' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe ISO8601) (Maybe Text) (Maybe Text) |
Instances
newTypeConfigurationDetails :: TypeConfigurationDetails Source #
Create a value of TypeConfigurationDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:alias:TypeConfigurationDetails', typeConfigurationDetails_alias - The alias specified for this configuration, if one was specified when
the configuration was set.
$sel:arn:TypeConfigurationDetails', typeConfigurationDetails_arn - The Amazon Resource Name (ARN) for the configuration data, in this
account and region.
$sel:configuration:TypeConfigurationDetails', typeConfigurationDetails_configuration - A JSON string specifying the configuration data for the extension, in
this account and region.
If a configuration hasn't been set for a specified extension,
CloudFormation returns {}.
$sel:isDefaultConfiguration:TypeConfigurationDetails', typeConfigurationDetails_isDefaultConfiguration - Whether this configuration data is the default configuration for the
extension.
$sel:lastUpdated:TypeConfigurationDetails', typeConfigurationDetails_lastUpdated - When the configuration data was last updated for this extension.
If a configuration hasn't been set for a specified extension,
CloudFormation returns null.
$sel:typeArn:TypeConfigurationDetails', typeConfigurationDetails_typeArn - The Amazon Resource Name (ARN) for the extension, in this account and
region.
For public extensions, this will be the ARN assigned when you activate the type in this account and region. For private extensions, this will be the ARN assigned when you register the type in this account and region.
$sel:typeName:TypeConfigurationDetails', typeConfigurationDetails_typeName - The name of the extension.
TypeConfigurationIdentifier
data TypeConfigurationIdentifier Source #
Identifying information for the configuration of a CloudFormation extension.
See: newTypeConfigurationIdentifier smart constructor.
Constructors
| TypeConfigurationIdentifier' (Maybe ThirdPartyType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newTypeConfigurationIdentifier :: TypeConfigurationIdentifier Source #
Create a value of TypeConfigurationIdentifier with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:type':TypeConfigurationIdentifier', typeConfigurationIdentifier_type - The type of extension.
$sel:typeArn:TypeConfigurationIdentifier', typeConfigurationIdentifier_typeArn - The Amazon Resource Name (ARN) for the extension, in this account and
region.
For public extensions, this will be the ARN assigned when you activate the type in this account and region. For private extensions, this will be the ARN assigned when you register the type in this account and region.
$sel:typeConfigurationAlias:TypeConfigurationIdentifier', typeConfigurationIdentifier_typeConfigurationAlias - The alias specified for this configuration, if one was specified when
the configuration was set.
$sel:typeConfigurationArn:TypeConfigurationIdentifier', typeConfigurationIdentifier_typeConfigurationArn - The Amazon Resource Name (ARN) for the configuration, in this account
and region.
$sel:typeName:TypeConfigurationIdentifier', typeConfigurationIdentifier_typeName - The name of the extension type to which this configuration applies.
TypeFilters
data TypeFilters Source #
Filter criteria to use in determining which extensions to return.
See: newTypeFilters smart constructor.
Instances
newTypeFilters :: TypeFilters Source #
Create a value of TypeFilters with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:category:TypeFilters', typeFilters_category - The category of extensions to return.
REGISTERED: Private extensions that have been registered for this account and region.ACTIVATED: Public extensions that have been activated for this account and region.THIRD_PARTY: Extensions available for use from publishers other than Amazon. This includes:- Private extensions registered in the account.
- Public extensions from publishers other than Amazon, whether activated or not.
AWS_TYPES: Extensions available for use from Amazon.
$sel:publisherId:TypeFilters', typeFilters_publisherId - The id of the publisher of the extension.
Extensions published by Amazon aren't assigned a publisher ID. Use the
AWS_TYPES category to specify a list of types published by Amazon.
$sel:typeNamePrefix:TypeFilters', typeFilters_typeNamePrefix - A prefix to use as a filter for results.
TypeSummary
data TypeSummary Source #
Contains summary information about the specified CloudFormation extension.
See: newTypeSummary smart constructor.
Constructors
| TypeSummary' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe IdentityProvider) (Maybe Text) (Maybe RegistryType) (Maybe Text) (Maybe Text) |
Instances
newTypeSummary :: TypeSummary Source #
Create a value of TypeSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:defaultVersionId:TypeSummary', typeSummary_defaultVersionId - The ID of the default version of the extension. The default version is
used when the extension version isn't specified.
This applies only to private extensions you have registered in your
account. For public extensions, both those provided by Amazon and
published by third parties, CloudFormation returns null. For more
information, see
RegisterType.
To set the default version of an extension, use
SetTypeDefaultVersion .
$sel:description:TypeSummary', typeSummary_description - The description of the extension.
$sel:isActivated:TypeSummary', typeSummary_isActivated - Whether the extension is activated for this account and region.
This applies only to third-party public extensions. Extensions published by Amazon are activated by default.
$sel:lastUpdated:TypeSummary', typeSummary_lastUpdated - When the specified extension version was registered. This applies only
to:
- Private extensions you have registered in your account. For more information, see RegisterType.
- Public extensions you have activated in your account with auto-update specified. For more information, see ActivateType.
For all other extension types, CloudFormation returns null.
$sel:latestPublicVersion:TypeSummary', typeSummary_latestPublicVersion - For public extensions that have been activated for this account and
region, the latest version of the public extension that is available.
For any extensions other than activated third-arty extensions,
CloudFormation returns null.
How you specified AutoUpdate when enabling the extension affects
whether CloudFormation automatically updates the extension in this
account and region when a new version is released. For more information,
see
Setting CloudFormation to automatically use new versions of extensions
in the CloudFormation User Guide.
$sel:originalTypeName:TypeSummary', typeSummary_originalTypeName - For public extensions that have been activated for this account and
region, the type name of the public extension.
If you specified a TypeNameAlias when enabling the extension in this
account and region, CloudFormation treats that alias as the extension's
type name within the account and region, not the type name of the public
extension. For more information, see
Specifying aliases to refer to extensions
in the CloudFormation User Guide.
$sel:publicVersionNumber:TypeSummary', typeSummary_publicVersionNumber - For public extensions that have been activated for this account and
region, the version of the public extension to be used for
CloudFormation operations in this account and Region.
How you specified AutoUpdate when enabling the extension affects
whether CloudFormation automatically updates the extension in this
account and region when a new version is released. For more information,
see
Setting CloudFormation to automatically use new versions of extensions
in the CloudFormation User Guide.
$sel:publisherId:TypeSummary', typeSummary_publisherId - The ID of the extension publisher, if the extension is published by a
third party. Extensions published by Amazon don't return a publisher
ID.
$sel:publisherIdentity:TypeSummary', typeSummary_publisherIdentity - The service used to verify the publisher identity.
For more information, see Registering your account to publish CloudFormation extensions in the CFN-CLI User Guide for Extension Development.
$sel:publisherName:TypeSummary', typeSummary_publisherName - The publisher name, as defined in the public profile for that publisher
in the service used to verify the publisher identity.
$sel:type':TypeSummary', typeSummary_type - The kind of extension.
$sel:typeArn:TypeSummary', typeSummary_typeArn - The Amazon Resource Name (ARN) of the extension.
$sel:typeName:TypeSummary', typeSummary_typeName - The name of the extension.
If you specified a TypeNameAlias when you
activate this extension
in your account and region, CloudFormation considers that alias as the
type name.
TypeVersionSummary
data TypeVersionSummary Source #
Contains summary information about a specific version of a CloudFormation extension.
See: newTypeVersionSummary smart constructor.
Constructors
| TypeVersionSummary' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe ISO8601) (Maybe RegistryType) (Maybe Text) (Maybe Text) |
Instances
newTypeVersionSummary :: TypeVersionSummary Source #
Create a value of TypeVersionSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:TypeVersionSummary', typeVersionSummary_arn - The Amazon Resource Name (ARN) of the extension version.
$sel:description:TypeVersionSummary', typeVersionSummary_description - The description of the extension version.
$sel:isDefaultVersion:TypeVersionSummary', typeVersionSummary_isDefaultVersion - Whether the specified extension version is set as the default version.
This applies only to private extensions you have registered in your
account, and extensions published by Amazon. For public third-party
extensions, CloudFormation returns null.
$sel:publicVersionNumber:TypeVersionSummary', typeVersionSummary_publicVersionNumber - For public extensions that have been activated for this account and
region, the version of the public extension to be used for
CloudFormation operations in this account and region. For any extensions
other than activated third-arty extensions, CloudFormation returns
null.
How you specified AutoUpdate when enabling the extension affects
whether CloudFormation automatically updates the extension in this
account and region when a new version is released. For more information,
see
Setting CloudFormation to automatically use new versions of extensions
in the CloudFormation User Guide.
$sel:timeCreated:TypeVersionSummary', typeVersionSummary_timeCreated - When the version was registered.
$sel:type':TypeVersionSummary', typeVersionSummary_type - The kind of extension.
$sel:typeName:TypeVersionSummary', typeVersionSummary_typeName - The name of the extension.
$sel:versionId:TypeVersionSummary', typeVersionSummary_versionId - The ID of a specific version of the extension. The version ID is the
value at the end of the Amazon Resource Name (ARN) assigned to the
extension version when it's registered.