libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CloudFormation

Contents

Description

Derived from API version 2010-05-15 of the AWS service descriptions, licensed under Apache 2.0.

AWS 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 of 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

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.

TypeNotFoundException

_TypeNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The specified extension does not exist in the CloudFormation registry.

CreatedButModifiedException

_CreatedButModifiedException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The specified resource exists, but has been changed.

ChangeSetNotFoundException

_ChangeSetNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the ListChangeSets action.

OperationInProgressException

_OperationInProgressException :: AsError a => Getting (First ServiceError) 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.

InvalidChangeSetStatusException

_InvalidChangeSetStatusException :: AsError a => Getting (First ServiceError) 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.

OperationNotFoundException

_OperationNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The specified ID refers to an operation that doesn't exist.

OperationIdAlreadyExistsException

_OperationIdAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The specified operation ID already exists.

TypeConfigurationNotFoundException

_TypeConfigurationNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The specified extension configuration cannot be found.

InsufficientCapabilitiesException

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

The template contains resources with capabilities that weren't specified in the Capabilities parameter.

TokenAlreadyExistsException

_TokenAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #

A client request token already exists.

StackNotFoundException

_StackNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The specified stack ARN doesn’t exist or stack doesn’t exist corresponding to the ARN in input.

StackSetNotFoundException

_StackSetNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The specified stack set doesn't exist.

StackInstanceNotFoundException

_StackInstanceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The specified stack instance doesn't exist.

OperationStatusCheckFailedException

_OperationStatusCheckFailedException :: AsError a => Getting (First ServiceError) a ServiceError Source #

Error reserved for use by the CloudFormation CLI. CloudFormation does not return this error to users.

StackSetNotEmptyException

_StackSetNotEmptyException :: AsError a => Getting (First ServiceError) 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.

InvalidOperationException

_InvalidOperationException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The specified operation isn't valid.

InvalidStateTransitionException

_InvalidStateTransitionException :: AsError a => Getting (First ServiceError) a ServiceError Source #

Error reserved for use by the CloudFormation CLI. CloudFormation does not return this error to users.

NameAlreadyExistsException

_NameAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The specified name is already in use.

CFNRegistryException

_CFNRegistryException :: AsError a => Getting (First ServiceError) a ServiceError Source #

An error occurred during a CloudFormation registry operation.

StaleRequestException

_StaleRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #

Another operation has been performed on this stack set since the specified operation was performed.

AlreadyExistsException

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

The resource with the name requested already exists.

LimitExceededException

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

The quota for the resource has already been reached.

For information on resource and stack limitations, see Limits in the CloudFormation User Guide.

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.

StackImportComplete

newStackImportComplete :: Wait DescribeStacks Source #

Polls DescribeStacks 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.

StackRollbackComplete

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

StackUpdateComplete

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

StackDeleteComplete

newStackDeleteComplete :: Wait DescribeStacks Source #

Polls DescribeStacks every 30 seconds until a successful state is reached. An error is returned after 120 failed checks.

ChangeSetCreateComplete

newChangeSetCreateComplete :: Wait DescribeChangeSet Source #

Polls DescribeChangeSet every 30 seconds until a successful state is reached. An error is returned after 120 failed checks.

Operations

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

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

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

DescribeStackSetOperation

data DescribeStackSetOperation Source #

See: newDescribeStackSetOperation smart constructor.

Instances

Instances details
Eq DescribeStackSetOperation Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackSetOperation

Read DescribeStackSetOperation Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackSetOperation

Show DescribeStackSetOperation Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackSetOperation

Generic DescribeStackSetOperation Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackSetOperation

Associated Types

type Rep DescribeStackSetOperation :: Type -> Type #

NFData DescribeStackSetOperation Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackSetOperation

Hashable DescribeStackSetOperation Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackSetOperation

AWSRequest DescribeStackSetOperation Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackSetOperation

ToHeaders DescribeStackSetOperation Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackSetOperation

ToPath DescribeStackSetOperation Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackSetOperation

ToQuery DescribeStackSetOperation Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackSetOperation

type Rep DescribeStackSetOperation Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackSetOperation

type Rep DescribeStackSetOperation = D1 ('MetaData "DescribeStackSetOperation" "Amazonka.CloudFormation.DescribeStackSetOperation" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" 'False) (C1 ('MetaCons "DescribeStackSetOperation'" 'PrefixI 'True) (S1 ('MetaSel ('Just "callAs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CallAs)) :*: (S1 ('MetaSel ('Just "stackSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "operationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse DescribeStackSetOperation Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackSetOperation

newDescribeStackSetOperation Source #

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.

$sel:stackSetName:DescribeStackSetOperation', describeStackSetOperation_stackSetName - The name or the unique stack ID of the stack set for the stack operation.

$sel:operationId:DescribeStackSetOperation', describeStackSetOperation_operationId - The unique ID of the stack set operation.

data DescribeStackSetOperationResponse Source #

See: newDescribeStackSetOperationResponse smart constructor.

Instances

Instances details
Eq DescribeStackSetOperationResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackSetOperation

Read DescribeStackSetOperationResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackSetOperation

Show DescribeStackSetOperationResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackSetOperation

Generic DescribeStackSetOperationResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackSetOperation

Associated Types

type Rep DescribeStackSetOperationResponse :: Type -> Type #

NFData DescribeStackSetOperationResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackSetOperation

type Rep DescribeStackSetOperationResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackSetOperation

type Rep DescribeStackSetOperationResponse = D1 ('MetaData "DescribeStackSetOperationResponse" "Amazonka.CloudFormation.DescribeStackSetOperation" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" 'False) (C1 ('MetaCons "DescribeStackSetOperationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "stackSetOperation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StackSetOperation)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeStackSetOperationResponse Source #

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.

ImportStacksToStackSet

data ImportStacksToStackSet Source #

See: newImportStacksToStackSet smart constructor.

Instances

Instances details
Eq ImportStacksToStackSet Source # 
Instance details

Defined in Amazonka.CloudFormation.ImportStacksToStackSet

Read ImportStacksToStackSet Source # 
Instance details

Defined in Amazonka.CloudFormation.ImportStacksToStackSet

Show ImportStacksToStackSet Source # 
Instance details

Defined in Amazonka.CloudFormation.ImportStacksToStackSet

Generic ImportStacksToStackSet Source # 
Instance details

Defined in Amazonka.CloudFormation.ImportStacksToStackSet

Associated Types

type Rep ImportStacksToStackSet :: Type -> Type #

NFData ImportStacksToStackSet Source # 
Instance details

Defined in Amazonka.CloudFormation.ImportStacksToStackSet

Methods

rnf :: ImportStacksToStackSet -> () #

Hashable ImportStacksToStackSet Source # 
Instance details

Defined in Amazonka.CloudFormation.ImportStacksToStackSet

AWSRequest ImportStacksToStackSet Source # 
Instance details

Defined in Amazonka.CloudFormation.ImportStacksToStackSet

Associated Types

type AWSResponse ImportStacksToStackSet #

ToHeaders ImportStacksToStackSet Source # 
Instance details

Defined in Amazonka.CloudFormation.ImportStacksToStackSet

ToPath ImportStacksToStackSet Source # 
Instance details

Defined in Amazonka.CloudFormation.ImportStacksToStackSet

ToQuery ImportStacksToStackSet Source # 
Instance details

Defined in Amazonka.CloudFormation.ImportStacksToStackSet

type Rep ImportStacksToStackSet Source # 
Instance details

Defined in Amazonka.CloudFormation.ImportStacksToStackSet

type Rep ImportStacksToStackSet = D1 ('MetaData "ImportStacksToStackSet" "Amazonka.CloudFormation.ImportStacksToStackSet" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" 'False) (C1 ('MetaCons "ImportStacksToStackSet'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "callAs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CallAs)) :*: S1 ('MetaSel ('Just "operationPreferences") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StackSetOperationPreferences))) :*: (S1 ('MetaSel ('Just "operationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "stackSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "stackIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))))
type AWSResponse ImportStacksToStackSet Source # 
Instance details

Defined in Amazonka.CloudFormation.ImportStacksToStackSet

newImportStacksToStackSet Source #

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.

$sel:operationPreferences:ImportStacksToStackSet', importStacksToStackSet_operationPreferences - Undocumented member.

$sel:operationId:ImportStacksToStackSet', importStacksToStackSet_operationId - A unique, user defined, identifier for the stack set operation.

$sel:stackSetName:ImportStacksToStackSet', importStacksToStackSet_stackSetName - The name of the stack set. The name must be unique in the Region where you create your stack set.

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

data ImportStacksToStackSetResponse Source #

See: newImportStacksToStackSetResponse smart constructor.

Instances

Instances details
Eq ImportStacksToStackSetResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ImportStacksToStackSet

Read ImportStacksToStackSetResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ImportStacksToStackSet

Show ImportStacksToStackSetResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ImportStacksToStackSet

Generic ImportStacksToStackSetResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ImportStacksToStackSet

Associated Types

type Rep ImportStacksToStackSetResponse :: Type -> Type #

NFData ImportStacksToStackSetResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ImportStacksToStackSet

type Rep ImportStacksToStackSetResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ImportStacksToStackSet

type Rep ImportStacksToStackSetResponse = D1 ('MetaData "ImportStacksToStackSetResponse" "Amazonka.CloudFormation.ImportStacksToStackSet" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" 'False) (C1 ('MetaCons "ImportStacksToStackSetResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "operationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

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:

$sel:operationId:ImportStacksToStackSet', importStacksToStackSetResponse_operationId - The unique identifier for the stack set operation.

$sel:httpStatus:ImportStacksToStackSetResponse', importStacksToStackSetResponse_httpStatus - The response's http status code.

DeleteStack

data DeleteStack Source #

The input for DeleteStack action.

See: newDeleteStack smart constructor.

Constructors

DeleteStack' (Maybe [Text]) (Maybe Text) (Maybe Text) Text 

Instances

Instances details
Eq DeleteStack Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStack

Read DeleteStack Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStack

Show DeleteStack Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStack

Generic DeleteStack Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStack

Associated Types

type Rep DeleteStack :: Type -> Type #

NFData DeleteStack Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStack

Methods

rnf :: DeleteStack -> () #

Hashable DeleteStack Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStack

AWSRequest DeleteStack Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStack

Associated Types

type AWSResponse DeleteStack #

ToHeaders DeleteStack Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStack

Methods

toHeaders :: DeleteStack -> [Header] #

ToPath DeleteStack Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStack

ToQuery DeleteStack Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStack

type Rep DeleteStack Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStack

type Rep DeleteStack = D1 ('MetaData "DeleteStack" "Amazonka.CloudFormation.DeleteStack" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" 'False) (C1 ('MetaCons "DeleteStack'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "retainResources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "stackName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse DeleteStack Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStack

newDeleteStack Source #

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:

$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 does not delete the retained resources.

Retaining resources is useful when you cannot delete a resource, such as a non-empty S3 bucket, but you want to delete the stack.

$sel:clientRequestToken: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 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:roleARN: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 is generated from your user credentials.

$sel:stackName:DeleteStack', deleteStack_stackName - The name or the unique stack ID that is associated with the stack.

data DeleteStackResponse Source #

See: newDeleteStackResponse smart constructor.

Constructors

DeleteStackResponse' 

Instances

Instances details
Eq DeleteStackResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStack

Read DeleteStackResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStack

Show DeleteStackResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStack

Generic DeleteStackResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStack

Associated Types

type Rep DeleteStackResponse :: Type -> Type #

NFData DeleteStackResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStack

Methods

rnf :: DeleteStackResponse -> () #

type Rep DeleteStackResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStack

type Rep DeleteStackResponse = D1 ('MetaData "DeleteStackResponse" "Amazonka.CloudFormation.DeleteStack" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" 'False) (C1 ('MetaCons "DeleteStackResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteStackResponse :: DeleteStackResponse Source #

Create a value of DeleteStackResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

UpdateStack

data UpdateStack Source #

The input for an UpdateStack action.

See: newUpdateStack smart constructor.

Instances

Instances details
Eq UpdateStack Source # 
Instance details

Defined in Amazonka.CloudFormation.UpdateStack

Read UpdateStack Source # 
Instance details

Defined in Amazonka.CloudFormation.UpdateStack

Show UpdateStack Source # 
Instance details

Defined in Amazonka.CloudFormation.UpdateStack

Generic UpdateStack Source # 
Instance details

Defined in Amazonka.CloudFormation.UpdateStack

Associated Types

type Rep UpdateStack :: Type -> Type #

NFData UpdateStack Source # 
Instance details

Defined in Amazonka.CloudFormation.UpdateStack

Methods

rnf :: UpdateStack -> () #

Hashable UpdateStack Source # 
Instance details

Defined in Amazonka.CloudFormation.UpdateStack

AWSRequest UpdateStack Source # 
Instance details

Defined in Amazonka.CloudFormation.UpdateStack

Associated Types

type AWSResponse UpdateStack #

ToHeaders UpdateStack Source # 
Instance details

Defined in Amazonka.CloudFormation.UpdateStack

Methods

toHeaders :: UpdateStack -> [Header] #

ToPath UpdateStack Source # 
Instance details

Defined in Amazonka.CloudFormation.UpdateStack

ToQuery UpdateStack Source # 
Instance details

Defined in Amazonka.CloudFormation.UpdateStack

type Rep UpdateStack Source # 
Instance details

Defined in Amazonka.CloudFormation.UpdateStack

type Rep UpdateStack = D1 ('MetaData "UpdateStack" "Amazonka.CloudFormation.UpdateStack" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" 'False) (C1 ('MetaCons "UpdateStack'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "disableRollback") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "usePreviousTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "notificationARNs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "stackPolicyBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "stackPolicyDuringUpdateBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "stackPolicyDuringUpdateURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Parameter])) :*: S1 ('MetaSel ('Just "stackPolicyURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "templateBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "templateURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "capabilities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Capability])))) :*: ((S1 ('MetaSel ('Just "rollbackConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RollbackConfiguration)) :*: S1 ('MetaSel ('Just "resourceTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: (S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "stackName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))
type AWSResponse UpdateStack Source # 
Instance details

Defined in Amazonka.CloudFormation.UpdateStack

newUpdateStack Source #

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:

$sel:disableRollback:UpdateStack', updateStack_disableRollback - Preserve the state of previously provisioned resources when an operation fails.

Default: False

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

$sel:notificationARNs: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.

$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 do not 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 do not 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 do not specify a stack policy, the current policy that is associated with the stack will be used.

$sel:parameters:UpdateStack', updateStack_parameters - A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.

$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 do not specify a stack policy, the current policy that is associated with the stack is unchanged.

$sel:templateBody: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 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 specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.

$sel:clientRequestToken: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.

$sel:capabilities: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_IAM and CAPABILITY_NAMED_IAM

    Some 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_IAM or CAPABILITY_NAMED_IAM capability.

    • 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 InsufficientCapabilities error.

    If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

    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.

$sel:rollbackConfiguration:UpdateStack', updateStack_rollbackConfiguration - The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

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

$sel:tags: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.

$sel:roleARN: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. As long as 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.

$sel:stackName: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.

Instances

Instances details
Eq UpdateStackResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.UpdateStack

Read UpdateStackResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.UpdateStack

Show UpdateStackResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.UpdateStack

Generic UpdateStackResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.UpdateStack

Associated Types

type Rep UpdateStackResponse :: Type -> Type #

NFData UpdateStackResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.UpdateStack

Methods

rnf :: UpdateStackResponse -> () #

type Rep UpdateStackResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.UpdateStack

type Rep UpdateStackResponse = D1 ('MetaData "UpdateStackResponse" "Amazonka.CloudFormation.UpdateStack" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" 'False) (C1 ('MetaCons "UpdateStackResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "stackId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateStackResponse Source #

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:

$sel:stackId:UpdateStackResponse', updateStackResponse_stackId - Unique identifier of the stack.

$sel:httpStatus:UpdateStackResponse', updateStackResponse_httpStatus - The response's http status code.

BatchDescribeTypeConfigurations

data BatchDescribeTypeConfigurations Source #

See: newBatchDescribeTypeConfigurations smart constructor.

Instances

Instances details
Eq BatchDescribeTypeConfigurations Source # 
Instance details

Defined in Amazonka.CloudFormation.BatchDescribeTypeConfigurations

Read BatchDescribeTypeConfigurations Source # 
Instance details

Defined in Amazonka.CloudFormation.BatchDescribeTypeConfigurations

Show BatchDescribeTypeConfigurations Source # 
Instance details

Defined in Amazonka.CloudFormation.BatchDescribeTypeConfigurations

Generic BatchDescribeTypeConfigurations Source # 
Instance details

Defined in Amazonka.CloudFormation.BatchDescribeTypeConfigurations

Associated Types

type Rep BatchDescribeTypeConfigurations :: Type -> Type #

NFData BatchDescribeTypeConfigurations Source # 
Instance details

Defined in Amazonka.CloudFormation.BatchDescribeTypeConfigurations

Hashable BatchDescribeTypeConfigurations Source # 
Instance details

Defined in Amazonka.CloudFormation.BatchDescribeTypeConfigurations

AWSRequest BatchDescribeTypeConfigurations Source # 
Instance details

Defined in Amazonka.CloudFormation.BatchDescribeTypeConfigurations

ToHeaders BatchDescribeTypeConfigurations Source # 
Instance details

Defined in Amazonka.CloudFormation.BatchDescribeTypeConfigurations

ToPath BatchDescribeTypeConfigurations Source # 
Instance details

Defined in Amazonka.CloudFormation.BatchDescribeTypeConfigurations

ToQuery BatchDescribeTypeConfigurations Source # 
Instance details

Defined in Amazonka.CloudFormation.BatchDescribeTypeConfigurations

type Rep BatchDescribeTypeConfigurations Source # 
Instance details

Defined in Amazonka.CloudFormation.BatchDescribeTypeConfigurations

type Rep BatchDescribeTypeConfigurations = D1 ('MetaData "BatchDescribeTypeConfigurations" "Amazonka.CloudFormation.BatchDescribeTypeConfigurations" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" 'False) (C1 ('MetaCons "BatchDescribeTypeConfigurations'" 'PrefixI 'True) (S1 ('MetaSel ('Just "typeConfigurationIdentifiers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty TypeConfigurationIdentifier))))
type AWSResponse BatchDescribeTypeConfigurations Source # 
Instance details

Defined in Amazonka.CloudFormation.BatchDescribeTypeConfigurations

newBatchDescribeTypeConfigurations Source #

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 #

Instances

Instances details
Eq BatchDescribeTypeConfigurationsResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.BatchDescribeTypeConfigurations

Read BatchDescribeTypeConfigurationsResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.BatchDescribeTypeConfigurations

Show BatchDescribeTypeConfigurationsResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.BatchDescribeTypeConfigurations

Generic BatchDescribeTypeConfigurationsResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.BatchDescribeTypeConfigurations

NFData BatchDescribeTypeConfigurationsResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.BatchDescribeTypeConfigurations

type Rep BatchDescribeTypeConfigurationsResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.BatchDescribeTypeConfigurations

type Rep BatchDescribeTypeConfigurationsResponse = D1 ('MetaData "BatchDescribeTypeConfigurationsResponse" "Amazonka.CloudFormation.BatchDescribeTypeConfigurations" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" 'False) (C1 ('MetaCons "BatchDescribeTypeConfigurationsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "unprocessedTypeConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TypeConfigurationIdentifier])) :*: S1 ('MetaSel ('Just "typeConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TypeConfigurationDetails]))) :*: (S1 ('MetaSel ('Just "errors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BatchDescribeTypeConfigurationsError])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newBatchDescribeTypeConfigurationsResponse Source #

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:unprocessedTypeConfigurations:BatchDescribeTypeConfigurationsResponse', batchDescribeTypeConfigurationsResponse_unprocessedTypeConfigurations - A list of any of the specified extension configurations that CloudFormation could not process for any reason.

$sel:typeConfigurations:BatchDescribeTypeConfigurationsResponse', batchDescribeTypeConfigurationsResponse_typeConfigurations - A list of any of the specified extension configurations from the CloudFormation registry.

$sel:errors:BatchDescribeTypeConfigurationsResponse', batchDescribeTypeConfigurationsResponse_errors - A list of information concerning any errors generated during the setting of the specified configurations.

$sel:httpStatus:BatchDescribeTypeConfigurationsResponse', batchDescribeTypeConfigurationsResponse_httpStatus - The response's http status code.

SetTypeConfiguration

data SetTypeConfiguration Source #

See: newSetTypeConfiguration smart constructor.

Instances

Instances details
Eq SetTypeConfiguration Source # 
Instance details

Defined in Amazonka.CloudFormation.SetTypeConfiguration

Read SetTypeConfiguration Source # 
Instance details

Defined in Amazonka.CloudFormation.SetTypeConfiguration

Show SetTypeConfiguration Source # 
Instance details

Defined in Amazonka.CloudFormation.SetTypeConfiguration

Generic SetTypeConfiguration Source # 
Instance details

Defined in Amazonka.CloudFormation.SetTypeConfiguration

Associated Types

type Rep SetTypeConfiguration :: Type -> Type #

NFData SetTypeConfiguration Source # 
Instance details

Defined in Amazonka.CloudFormation.SetTypeConfiguration

Methods

rnf :: SetTypeConfiguration -> () #

Hashable SetTypeConfiguration Source # 
Instance details

Defined in Amazonka.CloudFormation.SetTypeConfiguration

AWSRequest SetTypeConfiguration Source # 
Instance details

Defined in Amazonka.CloudFormation.SetTypeConfiguration

Associated Types

type AWSResponse SetTypeConfiguration #

ToHeaders SetTypeConfiguration Source # 
Instance details

Defined in Amazonka.CloudFormation.SetTypeConfiguration

ToPath SetTypeConfiguration Source # 
Instance details

Defined in Amazonka.CloudFormation.SetTypeConfiguration

ToQuery SetTypeConfiguration Source # 
Instance details

Defined in Amazonka.CloudFormation.SetTypeConfiguration

type Rep SetTypeConfiguration Source # 
Instance details

Defined in Amazonka.CloudFormation.SetTypeConfiguration

type Rep SetTypeConfiguration = D1 ('MetaData "SetTypeConfiguration" "Amazonka.CloudFormation.SetTypeConfiguration" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" 'False) (C1 ('MetaCons "SetTypeConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "typeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "typeArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ThirdPartyType)) :*: (S1 ('MetaSel ('Just "configurationAlias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse SetTypeConfiguration Source # 
Instance details

Defined in Amazonka.CloudFormation.SetTypeConfiguration

newSetTypeConfiguration Source #

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:typeName:SetTypeConfiguration', setTypeConfiguration_typeName - The name of the extension.

Conditional: You must specify ConfigurationArn, or Type and TypeName.

$sel:typeArn: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.

$sel:type':SetTypeConfiguration', setTypeConfiguration_type - The type of extension.

Conditional: You must specify ConfigurationArn, or Type and TypeName.

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

$sel:configuration: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.

Instances

Instances details
Eq SetTypeConfigurationResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.SetTypeConfiguration

Read SetTypeConfigurationResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.SetTypeConfiguration

Show SetTypeConfigurationResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.SetTypeConfiguration

Generic SetTypeConfigurationResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.SetTypeConfiguration

Associated Types

type Rep SetTypeConfigurationResponse :: Type -> Type #

NFData SetTypeConfigurationResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.SetTypeConfiguration

type Rep SetTypeConfigurationResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.SetTypeConfiguration

type Rep SetTypeConfigurationResponse = D1 ('MetaData "SetTypeConfigurationResponse" "Amazonka.CloudFormation.SetTypeConfiguration" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" 'False) (C1 ('MetaCons "SetTypeConfigurationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "configurationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

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.

GetTemplateSummary

data GetTemplateSummary Source #

The input for the GetTemplateSummary action.

See: newGetTemplateSummary smart constructor.

Instances

Instances details
Eq GetTemplateSummary Source # 
Instance details

Defined in Amazonka.CloudFormation.GetTemplateSummary

Read GetTemplateSummary Source # 
Instance details

Defined in Amazonka.CloudFormation.GetTemplateSummary

Show GetTemplateSummary Source # 
Instance details

Defined in Amazonka.CloudFormation.GetTemplateSummary

Generic GetTemplateSummary Source # 
Instance details

Defined in Amazonka.CloudFormation.GetTemplateSummary

Associated Types

type Rep GetTemplateSummary :: Type -> Type #

NFData GetTemplateSummary Source # 
Instance details

Defined in Amazonka.CloudFormation.GetTemplateSummary

Methods

rnf :: GetTemplateSummary -> () #

Hashable GetTemplateSummary Source # 
Instance details

Defined in Amazonka.CloudFormation.GetTemplateSummary

AWSRequest GetTemplateSummary Source # 
Instance details

Defined in Amazonka.CloudFormation.GetTemplateSummary

Associated Types

type AWSResponse GetTemplateSummary #

ToHeaders GetTemplateSummary Source # 
Instance details

Defined in Amazonka.CloudFormation.GetTemplateSummary

ToPath GetTemplateSummary Source # 
Instance details

Defined in Amazonka.CloudFormation.GetTemplateSummary

ToQuery GetTemplateSummary Source # 
Instance details

Defined in Amazonka.CloudFormation.GetTemplateSummary

type Rep GetTemplateSummary Source # 
Instance details

Defined in Amazonka.CloudFormation.GetTemplateSummary

type Rep GetTemplateSummary = D1 ('MetaData "GetTemplateSummary" "Amazonka.CloudFormation.GetTemplateSummary" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" 'False) (C1 ('MetaCons "GetTemplateSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "callAs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CallAs)) :*: S1 ('MetaSel ('Just "templateBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "templateURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "stackSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "stackName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))
type AWSResponse GetTemplateSummary Source # 
Instance details

Defined in Amazonka.CloudFormation.GetTemplateSummary

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.

$sel:templateBody: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 is 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.

$sel:stackSetName: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.

$sel:stackName:GetTemplateSummary', getTemplateSummary_stackName - The name or the stack ID that is associated with the stack, which are not 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.

data GetTemplateSummaryResponse Source #

The output for the GetTemplateSummary action.

See: newGetTemplateSummaryResponse smart constructor.

Instances

Instances details
Eq GetTemplateSummaryResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.GetTemplateSummary

Read GetTemplateSummaryResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.GetTemplateSummary

Show GetTemplateSummaryResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.GetTemplateSummary

Generic GetTemplateSummaryResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.GetTemplateSummary

Associated Types

type Rep GetTemplateSummaryResponse :: Type -> Type #

NFData GetTemplateSummaryResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.GetTemplateSummary

type Rep GetTemplateSummaryResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.GetTemplateSummary

type Rep GetTemplateSummaryResponse = D1 ('MetaData "GetTemplateSummaryResponse" "Amazonka.CloudFormation.GetTemplateSummary" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" 'False) (C1 ('MetaCons "GetTemplateSummaryResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "declaredTransforms") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "capabilitiesReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ParameterDeclaration])) :*: S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "resourceIdentifierSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ResourceIdentifierSummary])) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "capabilities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Capability])) :*: (S1 ('MetaSel ('Just "resourceTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

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:

$sel:declaredTransforms:GetTemplateSummaryResponse', getTemplateSummaryResponse_declaredTransforms - A list of the transforms that are declared in the template.

$sel:version:GetTemplateSummaryResponse', getTemplateSummaryResponse_version - The Amazon Web Services template format version, which identifies the capabilities of the template.

$sel:capabilitiesReason:GetTemplateSummaryResponse', getTemplateSummaryResponse_capabilitiesReason - The list of resources that generated the values in the Capabilities response element.

$sel:parameters:GetTemplateSummaryResponse', getTemplateSummaryResponse_parameters - A list of parameter declarations that describe various properties for each parameter.

$sel:metadata:GetTemplateSummaryResponse', getTemplateSummaryResponse_metadata - The value that is defined for the Metadata property of the template.

$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:description:GetTemplateSummaryResponse', getTemplateSummaryResponse_description - The value that is defined in the Description property of the template.

$sel:capabilities: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: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:httpStatus:GetTemplateSummaryResponse', getTemplateSummaryResponse_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

Instances details
Eq ListChangeSets Source # 
Instance details

Defined in Amazonka.CloudFormation.ListChangeSets

Read ListChangeSets Source # 
Instance details

Defined in Amazonka.CloudFormation.ListChangeSets

Show ListChangeSets Source # 
Instance details

Defined in Amazonka.CloudFormation.ListChangeSets

Generic ListChangeSets Source # 
Instance details

Defined in Amazonka.CloudFormation.ListChangeSets

Associated Types

type Rep ListChangeSets :: Type -> Type #

NFData ListChangeSets Source # 
Instance details

Defined in Amazonka.CloudFormation.ListChangeSets

Methods

rnf :: ListChangeSets -> () #

Hashable ListChangeSets Source # 
Instance details

Defined in Amazonka.CloudFormation.ListChangeSets

AWSPager ListChangeSets Source # 
Instance details

Defined in Amazonka.CloudFormation.ListChangeSets

AWSRequest ListChangeSets Source # 
Instance details

Defined in Amazonka.CloudFormation.ListChangeSets

Associated Types

type AWSResponse ListChangeSets #

ToHeaders ListChangeSets Source # 
Instance details

Defined in Amazonka.CloudFormation.ListChangeSets

ToPath ListChangeSets Source # 
Instance details

Defined in Amazonka.CloudFormation.ListChangeSets

ToQuery ListChangeSets Source # 
Instance details

Defined in Amazonka.CloudFormation.ListChangeSets

type Rep ListChangeSets Source # 
Instance details

Defined in Amazonka.CloudFormation.ListChangeSets

type Rep ListChangeSets = D1 ('MetaData "ListChangeSets" "Amazonka.CloudFormation.ListChangeSets" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" 'False) (C1 ('MetaCons "ListChangeSets'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "stackName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse ListChangeSets Source # 
Instance details

Defined in Amazonka.CloudFormation.ListChangeSets

newListChangeSets Source #

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:

$sel:nextToken:ListChangeSets', listChangeSets_nextToken - A string (provided by the ListChangeSets response output) that identifies the next page of change sets that you want to retrieve.

$sel:stackName: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.

Instances

Instances details
Eq ListChangeSetsResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ListChangeSets

Read ListChangeSetsResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ListChangeSets

Show ListChangeSetsResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ListChangeSets

Generic ListChangeSetsResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ListChangeSets

Associated Types

type Rep ListChangeSetsResponse :: Type -> Type #

NFData ListChangeSetsResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ListChangeSets

Methods

rnf :: ListChangeSetsResponse -> () #

type Rep ListChangeSetsResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ListChangeSets

type Rep ListChangeSetsResponse = D1 ('MetaData "ListChangeSetsResponse" "Amazonka.CloudFormation.ListChangeSets" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" 'False) (C1 ('MetaCons "ListChangeSetsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "summaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ChangeSetSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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:

$sel:nextToken: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.

ListStackResources (Paginated)

data ListStackResources Source #

The input for the ListStackResource action.

See: newListStackResources smart constructor.

Instances

Instances details
Eq ListStackResources Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackResources

Read ListStackResources Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackResources

Show ListStackResources Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackResources

Generic ListStackResources Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackResources

Associated Types

type Rep ListStackResources :: Type -> Type #

NFData ListStackResources Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackResources

Methods

rnf :: ListStackResources -> () #

Hashable ListStackResources Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackResources

AWSPager ListStackResources Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackResources

AWSRequest ListStackResources Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackResources

Associated Types

type AWSResponse ListStackResources #

ToHeaders ListStackResources Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackResources

ToPath ListStackResources Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackResources

ToQuery ListStackResources Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackResources

type Rep ListStackResources Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackResources

type Rep ListStackResources = D1 ('MetaData "ListStackResources" "Amazonka.CloudFormation.ListStackResources" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" 'False) (C1 ('MetaCons "ListStackResources'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "stackName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse ListStackResources Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackResources

newListStackResources Source #

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:

$sel:nextToken:ListStackResources', listStackResources_nextToken - A string that identifies the next page of stack resources that you want to retrieve.

$sel:stackName:ListStackResources', listStackResources_stackName - The name or the unique stack ID that is associated with the stack, which are not 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.

Instances

Instances details
Eq ListStackResourcesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackResources

Read ListStackResourcesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackResources

Show ListStackResourcesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackResources

Generic ListStackResourcesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackResources

Associated Types

type Rep ListStackResourcesResponse :: Type -> Type #

NFData ListStackResourcesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackResources

type Rep ListStackResourcesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackResources

type Rep ListStackResourcesResponse = D1 ('MetaData "ListStackResourcesResponse" "Amazonka.CloudFormation.ListStackResources" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" 'False) (C1 ('MetaCons "ListStackResourcesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "stackResourceSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [StackResourceSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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:

$sel:nextToken: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.

UpdateStackInstances

data UpdateStackInstances Source #

See: newUpdateStackInstances smart constructor.

Instances

Instances details
Eq UpdateStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.UpdateStackInstances

Read UpdateStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.UpdateStackInstances

Show UpdateStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.UpdateStackInstances

Generic UpdateStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.UpdateStackInstances

Associated Types

type Rep UpdateStackInstances :: Type -> Type #

NFData UpdateStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.UpdateStackInstances

Methods

rnf :: UpdateStackInstances -> () #

Hashable UpdateStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.UpdateStackInstances

AWSRequest UpdateStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.UpdateStackInstances

Associated Types

type AWSResponse UpdateStackInstances #

ToHeaders UpdateStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.UpdateStackInstances

ToPath UpdateStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.UpdateStackInstances

ToQuery UpdateStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.UpdateStackInstances

type Rep UpdateStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.UpdateStackInstances

type Rep UpdateStackInstances = D1 ('MetaData "UpdateStackInstances" "Amazonka.CloudFormation.UpdateStackInstances" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" 'False) (C1 ('MetaCons "UpdateStackInstances'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "accounts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "callAs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CallAs))) :*: (S1 ('MetaSel ('Just "operationPreferences") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StackSetOperationPreferences)) :*: S1 ('MetaSel ('Just "operationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "deploymentTargets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeploymentTargets)) :*: S1 ('MetaSel ('Just "parameterOverrides") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Parameter]))) :*: (S1 ('MetaSel ('Just "stackSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "regions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))))
type AWSResponse UpdateStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.UpdateStackInstances

newUpdateStackInstances Source #

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:

$sel:accounts: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 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.

$sel:operationPreferences:UpdateStackInstances', updateStackInstances_operationPreferences - Preferences for how CloudFormation performs this stack set operation.

$sel:operationId: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.

$sel:deploymentTargets: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.

$sel:parameterOverrides: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 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 UsePreviousValue as true. (You cannot specify both a value and set UsePreviousValue to true.)
  • To set an overridden parameter back to the value specified in the stack set, specify a parameter list but do not include the parameter in the list.
  • To leave all parameters set to their present values, do not specify this property at all.

During stack set updates, any parameter values overridden for a stack instance are not 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.

$sel:stackSetName: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 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 Regions.

data UpdateStackInstancesResponse Source #

See: newUpdateStackInstancesResponse smart constructor.

Instances

Instances details
Eq UpdateStackInstancesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.UpdateStackInstances

Read UpdateStackInstancesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.UpdateStackInstances

Show UpdateStackInstancesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.UpdateStackInstances

Generic UpdateStackInstancesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.UpdateStackInstances

Associated Types

type Rep UpdateStackInstancesResponse :: Type -> Type #

NFData UpdateStackInstancesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.UpdateStackInstances

type Rep UpdateStackInstancesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.UpdateStackInstances

type Rep UpdateStackInstancesResponse = D1 ('MetaData "UpdateStackInstancesResponse" "Amazonka.CloudFormation.UpdateStackInstances" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" 'False) (C1 ('MetaCons "UpdateStackInstancesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "operationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

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:

$sel:operationId:UpdateStackInstances', updateStackInstancesResponse_operationId - The unique identifier for this stack set operation.

$sel:httpStatus:UpdateStackInstancesResponse', updateStackInstancesResponse_httpStatus - The response's http status code.

DeleteStackInstances

data DeleteStackInstances Source #

See: newDeleteStackInstances smart constructor.

Instances

Instances details
Eq DeleteStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStackInstances

Read DeleteStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStackInstances

Show DeleteStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStackInstances

Generic DeleteStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStackInstances

Associated Types

type Rep DeleteStackInstances :: Type -> Type #

NFData DeleteStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStackInstances

Methods

rnf :: DeleteStackInstances -> () #

Hashable DeleteStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStackInstances

AWSRequest DeleteStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStackInstances

Associated Types

type AWSResponse DeleteStackInstances #

ToHeaders DeleteStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStackInstances

ToPath DeleteStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStackInstances

ToQuery DeleteStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStackInstances

type Rep DeleteStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStackInstances

type Rep DeleteStackInstances = D1 ('MetaData "DeleteStackInstances" "Amazonka.CloudFormation.DeleteStackInstances" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" 'False) (C1 ('MetaCons "DeleteStackInstances'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "accounts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "callAs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CallAs))) :*: (S1 ('MetaSel ('Just "operationPreferences") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StackSetOperationPreferences)) :*: S1 ('MetaSel ('Just "operationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "deploymentTargets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeploymentTargets)) :*: S1 ('MetaSel ('Just "stackSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "regions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :*: S1 ('MetaSel ('Just "retainStacks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))))
type AWSResponse DeleteStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStackInstances

newDeleteStackInstances Source #

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:

$sel:accounts: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.

$sel:operationPreferences:DeleteStackInstances', deleteStackInstances_operationPreferences - Preferences for how CloudFormation performs this stack set operation.

$sel:operationId: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.

$sel:deploymentTargets:DeleteStackInstances', deleteStackInstances_deploymentTargets - [Service-managed permissions] The Organizations accounts from which to delete stack instances.

You can specify Accounts or DeploymentTargets, but not both.

$sel:stackSetName: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 Regions where you want to delete stack set instances.

$sel:retainStacks: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.

Instances

Instances details
Eq DeleteStackInstancesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStackInstances

Read DeleteStackInstancesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStackInstances

Show DeleteStackInstancesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStackInstances

Generic DeleteStackInstancesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStackInstances

Associated Types

type Rep DeleteStackInstancesResponse :: Type -> Type #

NFData DeleteStackInstancesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStackInstances

type Rep DeleteStackInstancesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStackInstances

type Rep DeleteStackInstancesResponse = D1 ('MetaData "DeleteStackInstancesResponse" "Amazonka.CloudFormation.DeleteStackInstances" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" 'False) (C1 ('MetaCons "DeleteStackInstancesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "operationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

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:

$sel:operationId:DeleteStackInstances', deleteStackInstancesResponse_operationId - The unique identifier for this stack set operation.

$sel:httpStatus:DeleteStackInstancesResponse', deleteStackInstancesResponse_httpStatus - The response's http status code.

DescribeType

data DescribeType Source #

See: newDescribeType smart constructor.

Instances

Instances details
Eq DescribeType Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeType

Read DescribeType Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeType

Show DescribeType Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeType

Generic DescribeType Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeType

Associated Types

type Rep DescribeType :: Type -> Type #

NFData DescribeType Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeType

Methods

rnf :: DescribeType -> () #

Hashable DescribeType Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeType

AWSRequest DescribeType Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeType

Associated Types

type AWSResponse DescribeType #

ToHeaders DescribeType Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeType

ToPath DescribeType Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeType

ToQuery DescribeType Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeType

type Rep DescribeType Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeType

type Rep DescribeType = D1 ('MetaData "DescribeType" "Amazonka.CloudFormation.DescribeType" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" 'False) (C1 ('MetaCons "DescribeType'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "versionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "typeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "publicVersionNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RegistryType)) :*: S1 ('MetaSel ('Just "publisherId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))
type AWSResponse DescribeType Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeType

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:

$sel:versionId: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.

$sel:typeName:DescribeType', describeType_typeName - The name of the extension.

Conditional: You must specify either TypeName and Type, or Arn.

$sel:arn:DescribeType', describeType_arn - The Amazon Resource Name (ARN) of the extension.

Conditional: You must specify either TypeName and Type, or Arn.

$sel:publicVersionNumber:DescribeType', describeType_publicVersionNumber - The version number of a public third-party extension.

$sel:type':DescribeType', describeType_type - The kind of extension.

Conditional: You must specify either TypeName and Type, or Arn.

$sel:publisherId:DescribeType', describeType_publisherId - The publisher ID of the extension publisher.

Extensions provided by Amazon are not assigned a publisher ID.

data DescribeTypeResponse Source #

See: newDescribeTypeResponse smart constructor.

Instances

Instances details
Eq DescribeTypeResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeType

Read DescribeTypeResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeType

Show DescribeTypeResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeType

Generic DescribeTypeResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeType

Associated Types

type Rep DescribeTypeResponse :: Type -> Type #

NFData DescribeTypeResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeType

Methods

rnf :: DescribeTypeResponse -> () #

type Rep DescribeTypeResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeType

type Rep DescribeTypeResponse = D1 ('MetaData "DescribeTypeResponse" "Amazonka.CloudFormation.DescribeType" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" 'False) (C1 ('MetaCons "DescribeTypeResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "typeTestsStatusDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "lastUpdated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "typeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "publicVersionNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "executionRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "autoUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :*: ((S1 ('MetaSel ('Just "originalTypeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "visibility") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Visibility)) :*: S1 ('MetaSel ('Just "schema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "originalTypeArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "defaultVersionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "isActivated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "requiredActivatedTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RequiredActivatedType])))))) :*: (((S1 ('MetaSel ('Just "deprecatedStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeprecatedStatus)) :*: (S1 ('MetaSel ('Just "timeCreated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RegistryType)))) :*: ((S1 ('MetaSel ('Just "latestPublicVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "publisherId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "isDefaultVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "sourceUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "documentationUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "configurationSchema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "provisioningType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProvisioningType)) :*: S1 ('MetaSel ('Just "typeTestsStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TypeTestsStatus))) :*: (S1 ('MetaSel ('Just "loggingConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LoggingConfig)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

newDescribeTypeResponse Source #

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:

$sel:typeTestsStatusDescription:DescribeTypeResponse', describeTypeResponse_typeTestsStatusDescription - The description of the test status. To return the extension test status of a specifc extension version, you must specify VersionId.

This applies only to registered private extension versions. CloudFormation does not return this information for public extensions, whether or not they are activated in your account.

$sel:lastUpdated: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.

$sel:typeName: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:arn:DescribeType', describeTypeResponse_arn - The Amazon Resource Name (ARN) of the extension.

$sel:publicVersionNumber: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.

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

$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:originalTypeName: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: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 as PRIVATE.
  • PUBLIC: The extension is publically visible and usable within any Amazon account.

$sel:schema:DescribeTypeResponse', describeTypeResponse_schema - The schema that defines the extension.

For more information on extension schemas, see Resource Provider Schema in the CloudFormation CLI User Guide.

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

$sel:defaultVersionId:DescribeTypeResponse', describeTypeResponse_defaultVersionId - The ID of the default version of the extension. The default version is used when the extension version is not 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:isActivated:DescribeTypeResponse', describeTypeResponse_isActivated - Whether or not the extension is activated in the account and region.

This only applies to public third-party extensions. For all other extensions, 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: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.

$sel:timeCreated:DescribeTypeResponse', describeTypeResponse_timeCreated - When the specified private extension version was registered or activated in your account.

$sel:type':DescribeType', describeTypeResponse_type - The kind of extension.

$sel:latestPublicVersion: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 do not specify a version. For all other requests, CloudFormation returns null.

$sel:publisherId: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, CloudFormation returns null.

$sel:isDefaultVersion: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. For public third-party extensions, whether or not they are activated in your account, CloudFormation returns null.

$sel:description:DescribeTypeResponse', describeTypeResponse_description - The description of the extension.

$sel:sourceUrl:DescribeTypeResponse', describeTypeResponse_sourceUrl - The URL of the source code for the extension.

$sel:documentationUrl:DescribeTypeResponse', describeTypeResponse_documentationUrl - The URL of a page providing detailed documentation for this extension.

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

$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 does not include an update handler, so the type cannot be updated and must instead be replaced during stack update operations.
  • NON_PROVISIONABLE: The resource type does not include all of the following handlers, and therefore cannot actually be provisioned.

    • create
    • read
    • delete

$sel:typeTestsStatus:DescribeTypeResponse', describeTypeResponse_typeTestsStatus - The contract test status of the registered extension version. To return the extension test status of a specifc extension version, you must specify VersionId.

This applies only to registered private extension versions. CloudFormation does not return this information for public extensions, whether or not they are activated in your account.

  • PASSED: The extension has passed all its contract tests.

    An extension must have a test status of PASSED before 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 have not been performed on the extension.

$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 and published by third parties, CloudFormation returns null. For more information, see RegisterType.

$sel:httpStatus:DescribeTypeResponse', describeTypeResponse_httpStatus - The response's http status code.

CreateStackInstances

data CreateStackInstances Source #

See: newCreateStackInstances smart constructor.

Instances

Instances details
Eq CreateStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackInstances

Read CreateStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackInstances

Show CreateStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackInstances

Generic CreateStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackInstances

Associated Types

type Rep CreateStackInstances :: Type -> Type #

NFData CreateStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackInstances

Methods

rnf :: CreateStackInstances -> () #

Hashable CreateStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackInstances

AWSRequest CreateStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackInstances

Associated Types

type AWSResponse CreateStackInstances #

ToHeaders CreateStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackInstances

ToPath CreateStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackInstances

ToQuery CreateStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackInstances

type Rep CreateStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackInstances

type Rep CreateStackInstances = D1 ('MetaData "CreateStackInstances" "Amazonka.CloudFormation.CreateStackInstances" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" 'False) (C1 ('MetaCons "CreateStackInstances'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "accounts&