Amazonka.CloudFormation.Lens

Operations

ActivateType

activateType_autoUpdate :: Lens' ActivateType (Maybe Bool)

Whether to automatically update the extension in this account and region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated.

The default is true.

activateType_executionRoleArn :: Lens' ActivateType (Maybe Text)

The name of the IAM execution role to use to activate the extension.

activateType_loggingConfig :: Lens' ActivateType (Maybe LoggingConfig)

Undocumented member.

activateType_majorVersion :: Lens' ActivateType (Maybe Natural)

The major version of this extension you want to activate, if multiple major versions are available. The default is the latest major version. CloudFormation uses the latest available minor version of the major version selected.

You can specify MajorVersion or VersionBump, but not both.

activateType_publicTypeArn :: Lens' ActivateType (Maybe Text)

The Amazon Resource Name (ARN) of the public extension.

Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

activateType_publisherId :: Lens' ActivateType (Maybe Text)

The ID of the extension publisher.

Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

activateType_type :: Lens' ActivateType (Maybe ThirdPartyType)

The extension type.

Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

activateType_typeName :: Lens' ActivateType (Maybe Text)

The name of the extension.

Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

activateType_typeNameAlias :: Lens' ActivateType (Maybe Text)

An alias to assign to the public extension, in this account and region. If you specify an alias for the extension, CloudFormation treats the alias as the extension type name within this account and region. You must use the alias to refer to the extension in your templates, API calls, and CloudFormation console.

An extension alias must be unique within a given account and region. You can activate the same public resource multiple times in the same account and region, using different type name aliases.

activateType_versionBump :: Lens' ActivateType (Maybe VersionBump)

Manually updates a previously-activated type to a new major or minor version, if available. You can also use this parameter to update the value of AutoUpdate.

• MAJOR: CloudFormation updates the extension to the newest major version, if one is available.
• MINOR: CloudFormation updates the extension to the newest minor version, if one is available.

activateTypeResponse_arn :: Lens' ActivateTypeResponse (Maybe Text)

The Amazon Resource Name (ARN) of the activated extension, in this account and region.

activateTypeResponse_httpStatus :: Lens' ActivateTypeResponse Int

The response's http status code.

BatchDescribeTypeConfigurations

batchDescribeTypeConfigurations_typeConfigurationIdentifiers :: Lens' BatchDescribeTypeConfigurations (NonEmpty TypeConfigurationIdentifier)

The list of identifiers for the desired extension configurations.

batchDescribeTypeConfigurationsResponse_errors :: Lens' BatchDescribeTypeConfigurationsResponse (Maybe [BatchDescribeTypeConfigurationsError])

A list of information concerning any errors generated during the setting of the specified configurations.

batchDescribeTypeConfigurationsResponse_typeConfigurations :: Lens' BatchDescribeTypeConfigurationsResponse (Maybe [TypeConfigurationDetails])

A list of any of the specified extension configurations from the CloudFormation registry.

batchDescribeTypeConfigurationsResponse_unprocessedTypeConfigurations :: Lens' BatchDescribeTypeConfigurationsResponse (Maybe [TypeConfigurationIdentifier])

A list of any of the specified extension configurations that CloudFormation could not process for any reason.

batchDescribeTypeConfigurationsResponse_httpStatus :: Lens' BatchDescribeTypeConfigurationsResponse Int

The response's http status code.

CancelUpdateStack

cancelUpdateStack_clientRequestToken :: Lens' CancelUpdateStack (Maybe Text)

A unique identifier for this CancelUpdateStack request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to cancel an update on a stack with the same name. You might retry CancelUpdateStack requests to ensure that CloudFormation successfully received them.

cancelUpdateStack_stackName :: Lens' CancelUpdateStack Text

The name or the unique stack ID that's associated with the stack.

ContinueUpdateRollback

continueUpdateRollback_clientRequestToken :: Lens' ContinueUpdateRollback (Maybe Text)

A unique identifier for this ContinueUpdateRollback request. Specify this token if you plan to retry requests so that CloudFormationknows that you're not attempting to continue the rollback to a stack with the same name. You might retry ContinueUpdateRollback requests to ensure that CloudFormation successfully received them.

continueUpdateRollback_resourcesToSkip :: Lens' ContinueUpdateRollback (Maybe [Text])

A list of the logical IDs of the resources that CloudFormation skips during the continue update rollback operation. You can specify only resources that are in the UPDATE_FAILED state because a rollback failed. You can't specify resources that are in the UPDATE_FAILED state for other reasons, for example, because an update was canceled. To check why a resource update failed, use the DescribeStackResources action, and view the resource status reason.

Specify this property to skip rolling back resources that CloudFormation can't successfully roll back. We recommend that you troubleshoot resources before skipping them. CloudFormation sets the status of the specified resources to UPDATE_COMPLETE and continues to roll back the stack. After the rollback is complete, the state of the skipped resources will be inconsistent with the state of the resources in the stack template. Before performing another stack update, you must update the stack or resources to be consistent with each other. If you don't, subsequent stack updates might fail, and the stack will become unrecoverable.

Specify the minimum number of resources required to successfully roll back your stack. For example, a failed resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the dependent resources.

To skip resources that are part of nested stacks, use the following format: NestedStackName.ResourceLogicalID. If you want to specify the logical ID of a stack resource (Type: AWS::CloudFormation::Stack) in the ResourcesToSkip list, then its corresponding embedded stack must be in one of the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE, or DELETE_FAILED.

Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an example of a continue update rollback operation with nested stacks, see Using ResourcesToSkip to recover a nested stacks hierarchy.

continueUpdateRollback_roleARN :: Lens' ContinueUpdateRollback (Maybe Text)

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to roll back the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least permission.

If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.

continueUpdateRollback_stackName :: Lens' ContinueUpdateRollback Text

The name or the unique ID of the stack that you want to continue rolling back.

Don't specify the name of a nested stack (a stack that was created by using the AWS::CloudFormation::Stack resource). Instead, use this operation on the parent stack (the stack that contains the AWS::CloudFormation::Stack resource).

continueUpdateRollbackResponse_httpStatus :: Lens' ContinueUpdateRollbackResponse Int

The response's http status code.

CreateChangeSet

createChangeSet_capabilities :: Lens' CreateChangeSet (Maybe [Capability])

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create 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 suggest that you review all permissions associated with them and edit their permissions if necessary.

  • AWS::IAM::AccessKey
  • AWS::IAM::Group
  • AWS::IAM::InstanceProfile
  • AWS::IAM::Policy
  • AWS::IAM::Role
  • AWS::IAM::User
  • AWS::IAM::UserToGroupAddition

  For more information, see Acknowledging IAM resources in CloudFormation templates.

• CAPABILITY_AUTO_EXPAND

  Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.

  This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no effect.

  If you want to create a stack from a stack template that contains macros and nested stacks, you must create or update the stack directly from the template using the CreateStack or UpdateStack action, and specifying this capability.

  For more information about macros, see Using CloudFormation macros to perform custom processing on templates.

createChangeSet_changeSetType :: Lens' CreateChangeSet (Maybe ChangeSetType)

The type of change set operation. To create a change set for a new stack, specify CREATE. To create a change set for an existing stack, specify UPDATE. To create a change set for an import operation, specify IMPORT.

If you create a change set for a new stack, CloudFormation creates a stack with a unique stack ID, but no template or resources. The stack will be in the REVIEW_IN_PROGRESS state until you execute the change set.

By default, CloudFormation specifies UPDATE. You can't use the UPDATE type to create a change set for a new stack or the CREATE type to create a change set for an existing stack.

createChangeSet_clientToken :: Lens' CreateChangeSet (Maybe Text)

A unique identifier for this CreateChangeSet request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to create another change set with the same name. You might retry CreateChangeSet requests to ensure that CloudFormation successfully received them.

createChangeSet_description :: Lens' CreateChangeSet (Maybe Text)

A description to help you identify this change set.

createChangeSet_includeNestedStacks :: Lens' CreateChangeSet (Maybe Bool)

Creates a change set for the all nested stacks specified in the template. The default behavior of this action is set to False. To include nested sets in a change set, specify True.

createChangeSet_notificationARNs :: Lens' CreateChangeSet (Maybe [Text])

The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.

createChangeSet_parameters :: Lens' CreateChangeSet (Maybe [Parameter])

A list of Parameter structures that specify input parameters for the change set. For more information, see the Parameter data type.

createChangeSet_resourceTypes :: Lens' CreateChangeSet (Maybe [Text])

The template resource types that you have permissions to work with if you execute this change set, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.

If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for CloudFormation. For more information, see Controlling access with Identity and Access Management in the CloudFormation User Guide.

createChangeSet_resourcesToImport :: Lens' CreateChangeSet (Maybe [ResourceToImport])

The resources to import into your stack.

createChangeSet_roleARN :: Lens' CreateChangeSet (Maybe Text)

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes when executing the change set. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least permission.

If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.

createChangeSet_rollbackConfiguration :: Lens' CreateChangeSet (Maybe RollbackConfiguration)

The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

createChangeSet_tags :: Lens' CreateChangeSet (Maybe [Tag])

Key-value pairs to associate with this stack. CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 50 tags.

createChangeSet_templateBody :: Lens' CreateChangeSet (Maybe Text)

A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. CloudFormation generates the change set by comparing this template with the template of the stack that you specified.

Conditional: You must specify only TemplateBody or TemplateURL.

createChangeSet_templateURL :: Lens' CreateChangeSet (Maybe Text)

The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. CloudFormation generates the change set by comparing this template with the stack that you specified.

Conditional: You must specify only TemplateBody or TemplateURL.

createChangeSet_usePreviousTemplate :: Lens' CreateChangeSet (Maybe Bool)

Whether to reuse the template that's associated with the stack to create the change set.

createChangeSet_stackName :: Lens' CreateChangeSet Text

The name or the unique ID of the stack for which you are creating a change set. CloudFormation generates the change set by comparing this stack's information with the information that you submit, such as a modified template or different parameter input values.

createChangeSet_changeSetName :: Lens' CreateChangeSet Text

The name of the change set. The name must be unique among all change sets that are associated with the specified stack.

A change set name can contain only alphanumeric, case sensitive characters, and hyphens. It must start with an alphabetical character and can't exceed 128 characters.

createChangeSetResponse_id :: Lens' CreateChangeSetResponse (Maybe Text)

The Amazon Resource Name (ARN) of the change set.

createChangeSetResponse_stackId :: Lens' CreateChangeSetResponse (Maybe Text)

The unique ID of the stack.

createChangeSetResponse_httpStatus :: Lens' CreateChangeSetResponse Int

The response's http status code.

CreateStack

createStack_capabilities :: Lens' CreateStack (Maybe [Capability])

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create 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.

  • AWS::IAM::AccessKey
  • AWS::IAM::Group
  • AWS::IAM::InstanceProfile
  • AWS::IAM::Policy
  • AWS::IAM::Role
  • AWS::IAM::User
  • AWS::IAM::UserToGroupAddition

  For more information, see Acknowledging IAM Resources in CloudFormation Templates.

• CAPABILITY_AUTO_EXPAND

  Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.

  If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability.

  You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.

  Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.

  For more information, see Using CloudFormation macros to perform custom processing on templates.

createStack_clientRequestToken :: Lens' CreateStack (Maybe Text)

A unique identifier for this CreateStack request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to create a stack with the same name. You might retry CreateStack requests to ensure that CloudFormation successfully received them.

All events initiated by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.

In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

createStack_disableRollback :: Lens' CreateStack (Maybe Bool)

Set to true to disable rollback of the stack if stack creation failed. You can specify either DisableRollback or OnFailure, but not both.

Default: false

createStack_enableTerminationProtection :: Lens' CreateStack (Maybe Bool)

Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted in the CloudFormation User Guide. Termination protection is deactivated on stacks by default.

For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack.

createStack_notificationARNs :: Lens' CreateStack (Maybe [Text])

The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events. You can find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).

createStack_onFailure :: Lens' CreateStack (Maybe OnFailure)

Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either OnFailure or DisableRollback, but not both.

Default: ROLLBACK

createStack_parameters :: Lens' CreateStack (Maybe [Parameter])

A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.

createStack_resourceTypes :: Lens' CreateStack (Maybe [Text])

The template resource types that you have permissions to work with for this create stack action, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. Use the following syntax to describe template resource types: AWS::* (for all Amazon Web Services resources), Custom::* (for all custom resources), Custom::logical_ID (for a specific custom resource), AWS::service_name::* (for all resources of a particular Amazon Web Services service), and AWS::service_name::resource_logical_ID (for a specific Amazon Web Services resource).

If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.

createStack_roleARN :: Lens' CreateStack (Maybe Text)

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to create the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.

If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.

createStack_rollbackConfiguration :: Lens' CreateStack (Maybe RollbackConfiguration)

The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

createStack_stackPolicyBody :: Lens' CreateStack (Maybe Text)

Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources in the CloudFormation User Guide. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

createStack_stackPolicyURL :: Lens' CreateStack (Maybe Text)

Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same Region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

createStack_tags :: Lens' CreateStack (Maybe [Tag])

Key-value pairs to associate with this stack. CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.

createStack_templateBody :: Lens' CreateStack (Maybe Text)

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template anatomy in the CloudFormation User Guide.

Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

createStack_templateURL :: Lens' CreateStack (Maybe Text)

Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to the Template anatomy in the CloudFormation User Guide.

Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

createStack_timeoutInMinutes :: Lens' CreateStack (Maybe Natural)

The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback is not set or is set to false, the stack will be rolled back.

createStack_stackName :: Lens' CreateStack Text

The name that's associated with the stack. The name must be unique in the Region in which you are creating the stack.

A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an alphabetical character and can't be longer than 128 characters.

createStackResponse_stackId :: Lens' CreateStackResponse (Maybe Text)

Unique identifier of the stack.

createStackResponse_httpStatus :: Lens' CreateStackResponse Int

The response's http status code.

CreateStackInstances

createStackInstances_accounts :: Lens' CreateStackInstances (Maybe [Text])

Self-managed permissions

The names of one or more Amazon Web Services accounts that you want to create stack instances in the specified Region(s) for.

You can specify Accounts or DeploymentTargets, but not both.

createStackInstances_callAs :: Lens' CreateStackInstances (Maybe CallAs)

Service-managed permissions

Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

• If you are signed in to the management account, specify SELF.

• If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

  Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

createStackInstances_deploymentTargets :: Lens' CreateStackInstances (Maybe DeploymentTargets)

Service-managed permissions

The Organizations accounts for which to create stack instances in the specified Amazon Web Services Regions.

You can specify Accounts or DeploymentTargets, but not both.

createStackInstances_operationId :: Lens' CreateStackInstances (Maybe Text)

The unique identifier for this stack set operation.

The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.

If you don't specify an operation ID, the SDK generates one automatically.

Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.

createStackInstances_operationPreferences :: Lens' CreateStackInstances (Maybe StackSetOperationPreferences)

Preferences for how CloudFormation performs this stack set operation.

createStackInstances_parameterOverrides :: Lens' CreateStackInstances (Maybe [Parameter])

A list of stack set parameters whose values you want to override in the selected stack instances.

Any overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance operations:

• To override the current value for a parameter, include the parameter and specify its value.
• To leave an overridden parameter set to its present value, include the parameter and specify UsePreviousValue as true. (You can't 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 don't include the parameter in the list.
• To leave all parameters set to their present values, don't specify this property at all.

During stack set updates, any parameter values overridden for a stack instance aren't updated, but retain their overridden value.

You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template.

createStackInstances_stackSetName :: Lens' CreateStackInstances Text

The name or unique ID of the stack set that you want to create stack instances from.

createStackInstances_regions :: Lens' CreateStackInstances [Text]

The names of one or more Amazon Web Services Regions where you want to create stack instances using the specified Amazon Web Services accounts.

createStackInstancesResponse_operationId :: Lens' CreateStackInstancesResponse (Maybe Text)

The unique identifier for this stack set operation.

createStackInstancesResponse_httpStatus :: Lens' CreateStackInstancesResponse Int

The response's http status code.

CreateStackSet

createStackSet_administrationRoleARN :: Lens' CreateStackSet (Maybe Text)

The Amazon Resource Name (ARN) of the IAM role to use to create this stack set.

Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the CloudFormation User Guide.

createStackSet_autoDeployment :: Lens' CreateStackSet (Maybe AutoDeployment)

Describes whether StackSets automatically deploys to Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED.

createStackSet_callAs :: Lens' CreateStackSet (Maybe CallAs)

Service-managed permissions

Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

• To create a stack set with service-managed permissions while signed in to the management account, specify SELF.

• To create a stack set with service-managed permissions while signed in to a delegated administrator account, specify DELEGATED_ADMIN.

  Your Amazon Web Services account must be registered as a delegated admin in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators.

createStackSet_capabilities :: Lens' CreateStackSet (Maybe [Capability])

In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for CloudFormation to create the stack set and related stack instances.

• CAPABILITY_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 stack sets, 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.

  • AWS::IAM::AccessKey
  • AWS::IAM::Group
  • AWS::IAM::InstanceProfile
  • AWS::IAM::Policy
  • AWS::IAM::Role
  • AWS::IAM::User
  • AWS::IAM::UserToGroupAddition

  For more information, see Acknowledging IAM Resources in CloudFormation Templates.

• CAPABILITY_AUTO_EXPAND

  Some templates reference macros. If your stack set template references one or more macros, you must create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.

  Stack sets with service-managed permissions don't currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.

createStackSet_clientRequestToken :: Lens' CreateStackSet (Maybe Text)

A unique identifier for this CreateStackSet request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to create another stack set with the same name. You might retry CreateStackSet requests to ensure that CloudFormation successfully received them.

If you don't specify an operation ID, the SDK generates one automatically.

createStackSet_description :: Lens' CreateStackSet (Maybe Text)

A description of the stack set. You can use the description to identify the stack set's purpose or other important information.

createStackSet_executionRoleName :: Lens' CreateStackSet (Maybe Text)

The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.

Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.

createStackSet_managedExecution :: Lens' CreateStackSet (Maybe ManagedExecution)

Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.

createStackSet_parameters :: Lens' CreateStackSet (Maybe [Parameter])

The input parameters for the stack set template.

createStackSet_permissionModel :: Lens' CreateStackSet (Maybe PermissionModels)

Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.

• With self-managed permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant Self-Managed Stack Set Permissions.
• With service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set Permissions.

createStackSet_stackId :: Lens' CreateStackSet (Maybe Text)

The stack ID you are importing into a new stack set. Specify the Amazon Resource Name (ARN) of the stack.

createStackSet_tags :: Lens' CreateStackSet (Maybe [Tag])

The key-value pairs to associate with this stack set and the stacks created from it. CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified.

If you specify tags as part of a CreateStackSet action, CloudFormation checks to see if you have the required IAM permission to tag resources. If you don't, the entire CreateStackSet action fails with an access denied error, and the stack set is not created.

createStackSet_templateBody :: Lens' CreateStackSet (Maybe Text)

The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the CloudFormation User Guide.

Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

createStackSet_templateURL :: Lens' CreateStackSet (Maybe Text)

The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information, see Template Anatomy in the CloudFormation User Guide.

Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

createStackSet_stackSetName :: Lens' CreateStackSet Text

The name to associate with the stack set. The name must be unique in the Region where you create your stack set.

A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and can't be longer than 128 characters.

createStackSetResponse_stackSetId :: Lens' CreateStackSetResponse (Maybe Text)

The ID of the stack set that you're creating.

createStackSetResponse_httpStatus :: Lens' CreateStackSetResponse Int

The response's http status code.

DeactivateType

deactivateType_arn :: Lens' DeactivateType (Maybe Text)

The Amazon Resource Name (ARN) for the extension, in this account and region.

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

deactivateType_type :: Lens' DeactivateType (Maybe ThirdPartyType)

The extension type.

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

deactivateType_typeName :: Lens' DeactivateType (Maybe Text)

The type name of the extension, in this account and region. If you specified a type name alias when enabling the extension, use the type name alias.

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

deactivateTypeResponse_httpStatus :: Lens' DeactivateTypeResponse Int

The response's http status code.

DeleteChangeSet

deleteChangeSet_stackName :: Lens' DeleteChangeSet (Maybe Text)

If you specified the name of a change set to delete, specify the stack name or Amazon Resource Name (ARN) that's associated with it.

deleteChangeSet_changeSetName :: Lens' DeleteChangeSet Text

The name or Amazon Resource Name (ARN) of the change set that you want to delete.

deleteChangeSetResponse_httpStatus :: Lens' DeleteChangeSetResponse Int

The response's http status code.

DeleteStack

deleteStack_clientRequestToken :: Lens' DeleteStack (Maybe Text)

A unique identifier for this DeleteStack request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to delete a stack with the same name. You might retry DeleteStack requests to ensure that CloudFormation successfully received them.

All events initiated by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.

In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

deleteStack_retainResources :: Lens' DeleteStack (Maybe [Text])

For stacks in the DELETE_FAILED state, a list of resource logical IDs that are associated with the resources you want to retain. During deletion, CloudFormation deletes the stack but doesn't delete the retained resources.

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

deleteStack_roleARN :: Lens' DeleteStack (Maybe Text)

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to delete the stack. CloudFormation uses the role's credentials to make calls on your behalf.

If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.

deleteStack_stackName :: Lens' DeleteStack Text

The name or the unique stack ID that's associated with the stack.

DeleteStackInstances

deleteStackInstances_accounts :: Lens' DeleteStackInstances (Maybe [Text])

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.

deleteStackInstances_callAs :: Lens' DeleteStackInstances (Maybe CallAs)

Service-managed permissions

Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

• If you are signed in to the management account, specify SELF.

• If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

  Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

deleteStackInstances_deploymentTargets :: Lens' DeleteStackInstances (Maybe DeploymentTargets)

Service-managed permissions

The Organizations accounts from which to delete stack instances.

You can specify Accounts or DeploymentTargets, but not both.

deleteStackInstances_operationId :: Lens' DeleteStackInstances (Maybe Text)

The unique identifier for this stack set operation.

If you don't specify an operation ID, the SDK generates one automatically.

The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You can retry stack set operation requests to ensure that CloudFormation successfully received them.

Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.

deleteStackInstances_operationPreferences :: Lens' DeleteStackInstances (Maybe StackSetOperationPreferences)

Preferences for how CloudFormation performs this stack set operation.

deleteStackInstances_stackSetName :: Lens' DeleteStackInstances Text

The name or unique ID of the stack set that you want to delete stack instances for.

deleteStackInstances_regions :: Lens' DeleteStackInstances [Text]

The Amazon Web Services Regions where you want to delete stack set instances.

deleteStackInstances_retainStacks :: Lens' DeleteStackInstances Bool

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.

deleteStackInstancesResponse_operationId :: Lens' DeleteStackInstancesResponse (Maybe Text)

The unique identifier for this stack set operation.

deleteStackInstancesResponse_httpStatus :: Lens' DeleteStackInstancesResponse Int

The response's http status code.

DeleteStackSet

deleteStackSet_callAs :: Lens' DeleteStackSet (Maybe CallAs)

Service-managed permissions

Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

• If you are signed in to the management account, specify SELF.

• If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

  Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

deleteStackSet_stackSetName :: Lens' DeleteStackSet Text

The name or unique ID of the stack set that you're deleting. You can obtain this value by running ListStackSets.

deleteStackSetResponse_httpStatus :: Lens' DeleteStackSetResponse Int

The response's http status code.

DeregisterType

deregisterType_arn :: Lens' DeregisterType (Maybe Text)

The Amazon Resource Name (ARN) of the extension.

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

deregisterType_type :: Lens' DeregisterType (Maybe RegistryType)

The kind of extension.

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

deregisterType_typeName :: Lens' DeregisterType (Maybe Text)

The name of the extension.

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

deregisterType_versionId :: Lens' DeregisterType (Maybe Text)

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.

deregisterTypeResponse_httpStatus :: Lens' DeregisterTypeResponse Int

The response's http status code.

DescribeAccountLimits

describeAccountLimits_nextToken :: Lens' DescribeAccountLimits (Maybe Text)

A string that identifies the next page of limits that you want to retrieve.

describeAccountLimitsResponse_accountLimits :: Lens' DescribeAccountLimitsResponse (Maybe [AccountLimit])

An account limit structure that contain a list of CloudFormation account limits and their values.

describeAccountLimitsResponse_nextToken :: Lens' DescribeAccountLimitsResponse (Maybe Text)

If the output exceeds 1 MB in size, a string that identifies the next page of limits. If no additional page exists, this value is null.

describeAccountLimitsResponse_httpStatus :: Lens' DescribeAccountLimitsResponse Int

The response's http status code.

DescribeChangeSet

describeChangeSet_nextToken :: Lens' DescribeChangeSet (Maybe Text)

A string (provided by the DescribeChangeSet response output) that identifies the next page of information that you want to retrieve.

describeChangeSet_stackName :: Lens' DescribeChangeSet (Maybe Text)

If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to describe.

describeChangeSet_changeSetName :: Lens' DescribeChangeSet Text

The name or Amazon Resource Name (ARN) of the change set that you want to describe.

describeChangeSetResponse_capabilities :: Lens' DescribeChangeSetResponse (Maybe [Capability])

If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.

describeChangeSetResponse_changeSetId :: Lens' DescribeChangeSetResponse (Maybe Text)

The Amazon Resource Name (ARN) of the change set.

describeChangeSetResponse_changeSetName :: Lens' DescribeChangeSetResponse (Maybe Text)

The name of the change set.

describeChangeSetResponse_changes :: Lens' DescribeChangeSetResponse (Maybe [Change])

A list of Change structures that describes the resources CloudFormation changes if you execute the change set.

describeChangeSetResponse_creationTime :: Lens' DescribeChangeSetResponse (Maybe UTCTime)

The start time when the change set was created, in UTC.

describeChangeSetResponse_description :: Lens' DescribeChangeSetResponse (Maybe Text)

Information about the change set.

describeChangeSetResponse_executionStatus :: Lens' DescribeChangeSetResponse (Maybe ExecutionStatus)

If the change set execution status is AVAILABLE, you can execute the change set. If you can't execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE state because CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.

describeChangeSetResponse_includeNestedStacks :: Lens' DescribeChangeSetResponse (Maybe Bool)

Verifies if IncludeNestedStacks is set to True.

describeChangeSetResponse_nextToken :: Lens' DescribeChangeSetResponse (Maybe Text)

If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page, this value is null.

describeChangeSetResponse_notificationARNs :: Lens' DescribeChangeSetResponse (Maybe [Text])

The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.

describeChangeSetResponse_parameters :: Lens' DescribeChangeSetResponse (Maybe [Parameter])

A list of Parameter structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.

describeChangeSetResponse_parentChangeSetId :: Lens' DescribeChangeSetResponse (Maybe Text)

Specifies the change set ID of the parent change set in the current nested change set hierarchy.

describeChangeSetResponse_rollbackConfiguration :: Lens' DescribeChangeSetResponse (Maybe RollbackConfiguration)

The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

describeChangeSetResponse_rootChangeSetId :: Lens' DescribeChangeSetResponse (Maybe Text)

Specifies the change set ID of the root change set in the current nested change set hierarchy.

describeChangeSetResponse_stackId :: Lens' DescribeChangeSetResponse (Maybe Text)

The Amazon Resource Name (ARN) of the stack that's associated with the change set.

describeChangeSetResponse_stackName :: Lens' DescribeChangeSetResponse (Maybe Text)

The name of the stack that's associated with the change set.

describeChangeSetResponse_statusReason :: Lens' DescribeChangeSetResponse (Maybe Text)

A description of the change set's status. For example, if your attempt to create a change set failed, CloudFormation shows the error message.

describeChangeSetResponse_tags :: Lens' DescribeChangeSetResponse (Maybe [Tag])

If you execute the change set, the tags that will be associated with the stack.

describeChangeSetResponse_httpStatus :: Lens' DescribeChangeSetResponse Int

The response's http status code.

describeChangeSetResponse_status :: Lens' DescribeChangeSetResponse ChangeSetStatus

The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.

DescribeChangeSetHooks

describeChangeSetHooks_logicalResourceId :: Lens' DescribeChangeSetHooks (Maybe Text)

If specified, lists only the hooks related to the specified LogicalResourceId.

describeChangeSetHooks_nextToken :: Lens' DescribeChangeSetHooks (Maybe Text)

A string, provided by the DescribeChangeSetHooks response output, that identifies the next page of information that you want to retrieve.

describeChangeSetHooks_stackName :: Lens' DescribeChangeSetHooks (Maybe Text)

If you specified the name of a change set, specify the stack name or stack ID (ARN) of the change set you want to describe.

describeChangeSetHooks_changeSetName :: Lens' DescribeChangeSetHooks Text

The name or Amazon Resource Name (ARN) of the change set that you want to describe.

describeChangeSetHooksResponse_changeSetId :: Lens' DescribeChangeSetHooksResponse (Maybe Text)

The change set identifier (stack ID).

describeChangeSetHooksResponse_changeSetName :: Lens' DescribeChangeSetHooksResponse (Maybe Text)

The change set name.

describeChangeSetHooksResponse_hooks :: Lens' DescribeChangeSetHooksResponse (Maybe [ChangeSetHook])

List of hook objects.

describeChangeSetHooksResponse_nextToken :: Lens' DescribeChangeSetHooksResponse (Maybe Text)

Pagination token, null or empty if no more results.

describeChangeSetHooksResponse_stackId :: Lens' DescribeChangeSetHooksResponse (Maybe Text)

The stack identifier (stack ID).

describeChangeSetHooksResponse_stackName :: Lens' DescribeChangeSetHooksResponse (Maybe Text)

The stack name.

describeChangeSetHooksResponse_status :: Lens' DescribeChangeSetHooksResponse (Maybe ChangeSetHooksStatus)

Provides the status of the change set hook.

describeChangeSetHooksResponse_httpStatus :: Lens' DescribeChangeSetHooksResponse Int

The response's http status code.

DescribePublisher

describePublisher_publisherId :: Lens' DescribePublisher (Maybe Text)

The ID of the extension publisher.

If you don't supply a PublisherId, and you have registered as an extension publisher, DescribePublisher returns information about your own publisher account.

describePublisherResponse_identityProvider :: Lens' DescribePublisherResponse (Maybe IdentityProvider)

The type of account used as the identity provider when registering this publisher with CloudFormation.

describePublisherResponse_publisherId :: Lens' DescribePublisherResponse (Maybe Text)

The ID of the extension publisher.

describePublisherResponse_publisherProfile :: Lens' DescribePublisherResponse (Maybe Text)

The URL to the publisher's profile with the identity provider.

describePublisherResponse_publisherStatus :: Lens' DescribePublisherResponse (Maybe PublisherStatus)

Whether the publisher is verified. Currently, all registered publishers are verified.

describePublisherResponse_httpStatus :: Lens' DescribePublisherResponse Int

The response's http status code.

DescribeStackDriftDetectionStatus

describeStackDriftDetectionStatus_stackDriftDetectionId :: Lens' DescribeStackDriftDetectionStatus Text

The ID of the drift detection results of this operation.

CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of drift results CloudFormation retains for any given stack, and for how long, may vary.

describeStackDriftDetectionStatusResponse_detectionStatusReason :: Lens' DescribeStackDriftDetectionStatusResponse (Maybe Text)

The reason the stack drift detection operation has its current status.

describeStackDriftDetectionStatusResponse_driftedStackResourceCount :: Lens' DescribeStackDriftDetectionStatusResponse (Maybe Int)

Total number of stack resources that have drifted. This is NULL until the drift detection operation reaches a status of DETECTION_COMPLETE. This value will be 0 for stacks whose drift status is IN_SYNC.

describeStackDriftDetectionStatusResponse_stackDriftStatus :: Lens' DescribeStackDriftDetectionStatusResponse (Maybe StackDriftStatus)

Status of the stack's actual configuration compared to its expected configuration.

• DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.
• NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected template configuration.
• IN_SYNC: The stack's actual configuration matches its expected template configuration.
• UNKNOWN: This value is reserved for future use.

describeStackDriftDetectionStatusResponse_httpStatus :: Lens' DescribeStackDriftDetectionStatusResponse Int

The response's http status code.

describeStackDriftDetectionStatusResponse_stackId :: Lens' DescribeStackDriftDetectionStatusResponse Text

The ID of the stack.

describeStackDriftDetectionStatusResponse_stackDriftDetectionId :: Lens' DescribeStackDriftDetectionStatusResponse Text

The ID of the drift detection results of this operation.

CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of reports CloudFormation retains for any given stack, and for how long, may vary.

describeStackDriftDetectionStatusResponse_detectionStatus :: Lens' DescribeStackDriftDetectionStatusResponse StackDriftDetectionStatus

The status of the stack drift detection operation.

• DETECTION_COMPLETE: The stack drift detection operation has successfully completed for all resources in the stack that support drift detection. (Resources that don't currently support stack detection remain unchecked.)

  If you specified logical resource IDs for CloudFormation to use as a filter for the stack drift detection operation, only the resources with those logical IDs are checked for drift.

• DETECTION_FAILED: The stack drift detection operation has failed for at least one resource in the stack. Results will be available for resources on which CloudFormation successfully completed drift detection.
• DETECTION_IN_PROGRESS: The stack drift detection operation is currently in progress.

describeStackDriftDetectionStatusResponse_timestamp :: Lens' DescribeStackDriftDetectionStatusResponse UTCTime

Time at which the stack drift detection operation was initiated.

DescribeStackEvents

describeStackEvents_nextToken :: Lens' DescribeStackEvents (Maybe Text)

A string that identifies the next page of events that you want to retrieve.

describeStackEvents_stackName :: Lens' DescribeStackEvents (Maybe Text)

The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:

• Running stacks: You can specify either the stack's name or its unique stack ID.
• Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

describeStackEventsResponse_nextToken :: Lens' DescribeStackEventsResponse (Maybe Text)

If the output exceeds 1 MB in size, a string that identifies the next page of events. If no additional page exists, this value is null.

describeStackEventsResponse_stackEvents :: Lens' DescribeStackEventsResponse (Maybe [StackEvent])

A list of StackEvents structures.

describeStackEventsResponse_httpStatus :: Lens' DescribeStackEventsResponse Int

The response's http status code.

DescribeStackInstance

describeStackInstance_callAs :: Lens' DescribeStackInstance (Maybe CallAs)

Service-managed permissions

Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

• If you are signed in to the management account, specify SELF.

• If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

  Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

describeStackInstance_stackSetName :: Lens' DescribeStackInstance Text

The name or the unique stack ID of the stack set that you want to get stack instance information for.

describeStackInstance_stackInstanceAccount :: Lens' DescribeStackInstance Text

The ID of an Amazon Web Services account that's associated with this stack instance.

describeStackInstance_stackInstanceRegion :: Lens' DescribeStackInstance Text

The name of a Region that's associated with this stack instance.

describeStackInstanceResponse_stackInstance :: Lens' DescribeStackInstanceResponse (Maybe StackInstance)

The stack instance that matches the specified request parameters.

describeStackInstanceResponse_httpStatus :: Lens' DescribeStackInstanceResponse Int

The response's http status code.

DescribeStackResource

describeStackResource_stackName :: Lens' DescribeStackResource Text

The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:

• Running stacks: You can specify either the stack's name or its unique stack ID.
• Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

describeStackResource_logicalResourceId :: Lens' DescribeStackResource Text

The logical name of the resource as specified in the template.

Default: There is no default value.

describeStackResourceResponse_stackResourceDetail :: Lens' DescribeStackResourceResponse (Maybe StackResourceDetail)

A StackResourceDetail structure containing the description of the specified resource in the specified stack.

describeStackResourceResponse_httpStatus :: Lens' DescribeStackResourceResponse Int

The response's http status code.

DescribeStackResourceDrifts

describeStackResourceDrifts_maxResults :: Lens' DescribeStackResourceDrifts (Maybe Natural)

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

describeStackResourceDrifts_nextToken :: Lens' DescribeStackResourceDrifts (Maybe Text)

A string that identifies the next page of stack resource drift results.

describeStackResourceDrifts_stackResourceDriftStatusFilters :: Lens' DescribeStackResourceDrifts (Maybe (NonEmpty StackResourceDriftStatus))

The resource drift status values to use as filters for the resource drift results returned.

• DELETED: The resource differs from its expected template configuration in that the resource has been deleted.
• MODIFIED: One or more resource properties differ from their expected template values.
• IN_SYNC: The resource's actual configuration matches its expected template configuration.
• NOT_CHECKED: CloudFormation doesn't currently return this value.

describeStackResourceDrifts_stackName :: Lens' DescribeStackResourceDrifts Text

The name of the stack for which you want drift information.

describeStackResourceDriftsResponse_nextToken :: Lens' DescribeStackResourceDriftsResponse (Maybe Text)

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call DescribeStackResourceDrifts again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

describeStackResourceDriftsResponse_httpStatus :: Lens' DescribeStackResourceDriftsResponse Int

The response's http status code.

describeStackResourceDriftsResponse_stackResourceDrifts :: Lens' DescribeStackResourceDriftsResponse [StackResourceDrift]

Drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where CloudFormation detects drift.

For a given stack, there will be one StackResourceDrift for each stack resource that has been checked for drift. Resources that haven't yet been checked for drift aren't included. Resources that do not currently support drift detection aren't checked, and so not included. For a list of resources that support drift detection, see Resources that Support Drift Detection.

DescribeStackResources

describeStackResources_logicalResourceId :: Lens' DescribeStackResources (Maybe Text)

The logical name of the resource as specified in the template.

Default: There is no default value.

describeStackResources_physicalResourceId :: Lens' DescribeStackResources (Maybe Text)

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

For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to find which stack the instance belongs to and what other resources are part of the stack.

Required: Conditional. If you don't specify PhysicalResourceId, you must specify StackName.

Default: There is no default value.

describeStackResources_stackName :: Lens' DescribeStackResources (Maybe Text)

The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:

• Running stacks: You can specify either the stack's name or its unique stack ID.
• Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

Required: Conditional. If you don't specify StackName, you must specify PhysicalResourceId.

describeStackResourcesResponse_stackResources :: Lens' DescribeStackResourcesResponse (Maybe [StackResource])

A list of StackResource structures.

describeStackResourcesResponse_httpStatus :: Lens' DescribeStackResourcesResponse Int

The response's http status code.

DescribeStackSet

describeStackSet_callAs :: Lens' DescribeStackSet (Maybe CallAs)

Service-managed permissions

Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

• If you are signed in to the management account, specify SELF.

• If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

  Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

describeStackSet_stackSetName :: Lens' DescribeStackSet Text

The name or unique ID of the stack set whose description you want.

describeStackSetResponse_stackSet :: Lens' DescribeStackSetResponse (Maybe StackSet)

The specified stack set.

describeStackSetResponse_httpStatus :: Lens' DescribeStackSetResponse Int

The response's http status code.

DescribeStackSetOperation

describeStackSetOperation_callAs :: Lens' DescribeStackSetOperation (Maybe CallAs)

Service-managed permissions

Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

• If you are signed in to the management account, specify SELF.

• If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

  Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

describeStackSetOperation_stackSetName :: Lens' DescribeStackSetOperation Text

The name or the unique stack ID of the stack set for the stack operation.

describeStackSetOperation_operationId :: Lens' DescribeStackSetOperation Text

The unique ID of the stack set operation.

describeStackSetOperationResponse_stackSetOperation :: Lens' DescribeStackSetOperationResponse (Maybe StackSetOperation)

The specified stack set operation.

describeStackSetOperationResponse_httpStatus :: Lens' DescribeStackSetOperationResponse Int

The response's http status code.

DescribeStacks

describeStacks_nextToken :: Lens' DescribeStacks (Maybe Text)

A string that identifies the next page of stacks that you want to retrieve.

describeStacks_stackName :: Lens' DescribeStacks (Maybe Text)

The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:

• Running stacks: You can specify either the stack's name or its unique stack ID.
• Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

describeStacksResponse_nextToken :: Lens' DescribeStacksResponse (Maybe Text)

If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, this value is null.

describeStacksResponse_stacks :: Lens' DescribeStacksResponse (Maybe [Stack])

A list of stack structures.

describeStacksResponse_httpStatus :: Lens' DescribeStacksResponse Int

The response's http status code.

DescribeType

describeType_arn :: Lens' DescribeType (Maybe Text)

The Amazon Resource Name (ARN) of the extension.

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

describeType_publicVersionNumber :: Lens' DescribeType (Maybe Text)

The version number of a public third-party extension.

describeType_publisherId :: Lens' DescribeType (Maybe Text)

The publisher ID of the extension publisher.

Extensions provided by Amazon Web Services are not assigned a publisher ID.

describeType_type :: Lens' DescribeType (Maybe RegistryType)

The kind of extension.

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

describeType_typeName :: Lens' DescribeType (Maybe Text)

The name of the extension.

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

describeType_versionId :: Lens' DescribeType (Maybe Text)

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.

describeTypeResponse_arn :: Lens' DescribeTypeResponse (Maybe Text)

The Amazon Resource Name (ARN) of the extension.

describeTypeResponse_autoUpdate :: Lens' DescribeTypeResponse (Maybe Bool)

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.

describeTypeResponse_configurationSchema :: Lens' DescribeTypeResponse (Maybe Text)

A JSON string that represent the current configuration data for the extension in this account and region.

To set the configuration data for an extension, use SetTypeConfiguration. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.

describeTypeResponse_defaultVersionId :: Lens' DescribeTypeResponse (Maybe Text)

The ID of the default version of the extension. The default version is used when the extension version isn't specified.

This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon Web Services and published by third parties, CloudFormation returns null. For more information, see RegisterType.

To set the default version of an extension, use SetTypeDefaultVersion .

describeTypeResponse_deprecatedStatus :: Lens' DescribeTypeResponse (Maybe DeprecatedStatus)

The deprecation status of the extension version.

Valid values include:

• LIVE: The extension is activated or registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.
• DEPRECATED: The extension has been deactivated or deregistered and can no longer be used in CloudFormation operations.

For public third-party extensions, CloudFormation returns null.

describeTypeResponse_description :: Lens' DescribeTypeResponse (Maybe Text)

The description of the extension.

describeTypeResponse_documentationUrl :: Lens' DescribeTypeResponse (Maybe Text)

The URL of a page providing detailed documentation for this extension.

describeTypeResponse_executionRoleArn :: Lens' DescribeTypeResponse (Maybe Text)

The Amazon Resource Name (ARN) of the IAM execution role used to register the extension. This applies only to private extensions you have registered in your account. For more information, see RegisterType.

If the registered extension calls any Amazon Web Services APIs, you must create an <https:docs.aws.amazon.comIAMlatestUserGuideid_roles.html IAM execution role> that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your extension with the appropriate credentials.

describeTypeResponse_isActivated :: Lens' DescribeTypeResponse (Maybe Bool)

Whether the extension is activated in the account and region.

This only applies to public third-party extensions. For all other extensions, CloudFormation returns null.

describeTypeResponse_isDefaultVersion :: Lens' DescribeTypeResponse (Maybe Bool)

Whether the specified extension version is set as the default version.

This applies only to private extensions you have registered in your account, and extensions published by Amazon Web Services. For public third-party extensions, whether they are activated in your account, CloudFormation returns null.

describeTypeResponse_lastUpdated :: Lens' DescribeTypeResponse (Maybe UTCTime)

When the specified extension version was registered. This applies only to:

• Private extensions you have registered in your account. For more information, see RegisterType.
• Public extensions you have activated in your account with auto-update specified. For more information, see ActivateType.

describeTypeResponse_latestPublicVersion :: Lens' DescribeTypeResponse (Maybe Text)

The latest version of a public extension that is available for use.

This only applies if you specify a public extension, and you don't specify a version. For all other requests, CloudFormation returns null.

describeTypeResponse_loggingConfig :: Lens' DescribeTypeResponse (Maybe LoggingConfig)

Contains logging configuration information for private extensions. This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon Web Services and published by third parties, CloudFormation returns null. For more information, see RegisterType.

describeTypeResponse_originalTypeArn :: Lens' DescribeTypeResponse (Maybe Text)

For public extensions that have been activated for this account and region, the Amazon Resource Name (ARN) of the public extension.

describeTypeResponse_originalTypeName :: Lens' DescribeTypeResponse (Maybe Text)

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.

describeTypeResponse_provisioningType :: Lens' DescribeTypeResponse (Maybe ProvisioningType)

For resource type extensions, the provisioning behavior of the resource type. CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

Valid values include:

• FULLY_MUTABLE: The resource type includes an update handler to process updates to the type during stack update operations.
• IMMUTABLE: The resource type doesn't include an update handler, so the type can't be updated and must instead be replaced during stack update operations.

• NON_PROVISIONABLE: The resource type doesn't include all the following handlers, and therefore can't actually be provisioned.

  • create
  • read
  • delete

describeTypeResponse_publicVersionNumber :: Lens' DescribeTypeResponse (Maybe Text)

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.

describeTypeResponse_publisherId :: Lens' DescribeTypeResponse (Maybe Text)

The publisher ID of the extension publisher.

This applies only to public third-party extensions. For private registered extensions, and extensions provided by Amazon Web Services, CloudFormation returns null.

describeTypeResponse_requiredActivatedTypes :: Lens' DescribeTypeResponse (Maybe [RequiredActivatedType])

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.

describeTypeResponse_schema :: Lens' DescribeTypeResponse (Maybe Text)

The schema that defines the extension.

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

describeTypeResponse_sourceUrl :: Lens' DescribeTypeResponse (Maybe Text)

The URL of the source code for the extension.

describeTypeResponse_timeCreated :: Lens' DescribeTypeResponse (Maybe UTCTime)

When the specified private extension version was registered or activated in your account.

describeTypeResponse_type :: Lens' DescribeTypeResponse (Maybe RegistryType)

The kind of extension.

describeTypeResponse_typeName :: Lens' DescribeTypeResponse (Maybe Text)

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.

describeTypeResponse_typeTestsStatus :: Lens' DescribeTypeResponse (Maybe TypeTestsStatus)

The contract test status of the registered extension version. To return the extension test status of a specific extension version, you must specify VersionId.

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

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

  An extension must have a test status of 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 haven't been performed on the extension.

describeTypeResponse_typeTestsStatusDescription :: Lens' DescribeTypeResponse (Maybe Text)

The description of the test status. To return the extension test status of a specific extension version, you must specify VersionId.

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

describeTypeResponse_visibility :: Lens' DescribeTypeResponse (Maybe 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 publicly visible and usable within any Amazon Web Services account.

describeTypeResponse_httpStatus :: Lens' DescribeTypeResponse Int

The response's http status code.

DescribeTypeRegistration

describeTypeRegistration_registrationToken :: Lens' DescribeTypeRegistration Text

The identifier for this registration request.

This registration token is generated by CloudFormation when you initiate a registration request using RegisterType .

describeTypeRegistrationResponse_description :: Lens' DescribeTypeRegistrationResponse (Maybe Text)

The description of the extension registration request.

describeTypeRegistrationResponse_progressStatus :: Lens' DescribeTypeRegistrationResponse (Maybe RegistrationStatus)

The current status of the extension registration request.

describeTypeRegistrationResponse_typeArn :: Lens' DescribeTypeRegistrationResponse (Maybe Text)

The Amazon Resource Name (ARN) of the extension being registered.

For registration requests with a ProgressStatus of other than COMPLETE, this will be null.

describeTypeRegistrationResponse_typeVersionArn :: Lens' DescribeTypeRegistrationResponse (Maybe Text)

The Amazon Resource Name (ARN) of this specific version of the extension being registered.

For registration requests with a ProgressStatus of other than COMPLETE, this will be null.

describeTypeRegistrationResponse_httpStatus :: Lens' DescribeTypeRegistrationResponse Int

The response's http status code.

DetectStackDrift

detectStackDrift_logicalResourceIds :: Lens' DetectStackDrift (Maybe (NonEmpty Text))

The logical names of any resources you want to use as filters.

detectStackDrift_stackName :: Lens' DetectStackDrift Text

The name of the stack for which you want to detect drift.

detectStackDriftResponse_httpStatus :: Lens' DetectStackDriftResponse Int

The response's http status code.

detectStackDriftResponse_stackDriftDetectionId :: Lens' DetectStackDriftResponse Text

The ID of the drift detection results of this operation.

CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of drift results CloudFormation retains for any given stack, and for how long, may vary.

DetectStackResourceDrift

detectStackResourceDrift_stackName :: Lens' DetectStackResourceDrift Text

The name of the stack to which the resource belongs.

detectStackResourceDrift_logicalResourceId :: Lens' DetectStackResourceDrift Text

The logical name of the resource for which to return drift information.

detectStackResourceDriftResponse_httpStatus :: Lens' DetectStackResourceDriftResponse Int

The response's http status code.

detectStackResourceDriftResponse_stackResourceDrift :: Lens' DetectStackResourceDriftResponse StackResourceDrift

Information about whether the resource's actual configuration has drifted from its expected template configuration, including actual and expected property values and any differences detected.

DetectStackSetDrift

detectStackSetDrift_callAs :: Lens' DetectStackSetDrift (Maybe CallAs)

Service-managed permissions

Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

• If you are signed in to the management account, specify SELF.

• If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

  Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

detectStackSetDrift_operationId :: Lens' DetectStackSetDrift (Maybe Text)

The ID of the stack set operation.

detectStackSetDrift_operationPreferences :: Lens' DetectStackSetDrift (Maybe StackSetOperationPreferences)

Undocumented member.

detectStackSetDrift_stackSetName :: Lens' DetectStackSetDrift Text

The name of the stack set on which to perform the drift detection operation.

detectStackSetDriftResponse_operationId :: Lens' DetectStackSetDriftResponse (Maybe Text)

The ID of the drift detection stack set operation.

You can use this operation ID with DescribeStackSetOperation to monitor the progress of the drift detection operation.

detectStackSetDriftResponse_httpStatus :: Lens' DetectStackSetDriftResponse Int

The response's http status code.

EstimateTemplateCost

estimateTemplateCost_parameters :: Lens' EstimateTemplateCost (Maybe [Parameter])

A list of Parameter structures that specify input parameters.

estimateTemplateCost_templateBody :: Lens' EstimateTemplateCost (Maybe Text)

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the CloudFormation User Guide.)

Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only TemplateBody is used.

estimateTemplateCost_templateURL :: Lens' EstimateTemplateCost (Maybe Text)

Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the CloudFormation User Guide.

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

estimateTemplateCostResponse_url :: Lens' EstimateTemplateCostResponse (Maybe Text)

An Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources required to run the template.

estimateTemplateCostResponse_httpStatus :: Lens' EstimateTemplateCostResponse Int

The response's http status code.

ExecuteChangeSet

executeChangeSet_clientRequestToken :: Lens' ExecuteChangeSet (Maybe Text)

A unique identifier for this ExecuteChangeSet request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to execute a change set to update a stack with the same name. You might retry ExecuteChangeSet requests to ensure that CloudFormation successfully received them.

executeChangeSet_disableRollback :: Lens' ExecuteChangeSet (Maybe Bool)

Preserves the state of previously provisioned resources when an operation fails.

Default: True

executeChangeSet_stackName :: Lens' ExecuteChangeSet (Maybe Text)

If you specified the name of a change set, specify the stack name or Amazon Resource Name (ARN) that's associated with the change set you want to execute.

executeChangeSet_changeSetName :: Lens' ExecuteChangeSet Text

The name or Amazon Resource Name (ARN) of the change set that you want use to update the specified stack.

executeChangeSetResponse_httpStatus :: Lens' ExecuteChangeSetResponse Int

The response's http status code.

GetStackPolicy

getStackPolicy_stackName :: Lens' GetStackPolicy Text

The name or unique stack ID that's associated with the stack whose policy you want to get.

getStackPolicyResponse_stackPolicyBody :: Lens' GetStackPolicyResponse (Maybe Text)

Structure containing the stack policy body. (For more information, go to Prevent Updates to Stack Resources in the CloudFormation User Guide.)

getStackPolicyResponse_httpStatus :: Lens' GetStackPolicyResponse Int

The response's http status code.

GetTemplate

getTemplate_changeSetName :: Lens' GetTemplate (Maybe Text)

The name or Amazon Resource Name (ARN) of a change set for which CloudFormation returns the associated template. If you specify a name, you must also specify the StackName.

getTemplate_stackName :: Lens' GetTemplate (Maybe Text)

The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:

• Running stacks: You can specify either the stack's name or its unique stack ID.
• Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

getTemplate_templateStage :: Lens' GetTemplate (Maybe TemplateStage)

For templates that include transforms, the stage of the template that CloudFormation returns. To get the user-submitted template, specify Original. To get the template after CloudFormation has processed all transforms, specify Processed.

If the template doesn't include transforms, Original and Processed return the same template. By default, CloudFormation specifies Processed.

getTemplateResponse_stagesAvailable :: Lens' GetTemplateResponse (Maybe [TemplateStage])

The stage of the template that you can retrieve. For stacks, the Original and Processed templates are always available. For change sets, the Original template is always available. After CloudFormation finishes creating the change set, the Processed template becomes available.

getTemplateResponse_templateBody :: Lens' GetTemplateResponse (Maybe Text)

Structure containing the template body. (For more information, go to Template Anatomy in the CloudFormation User Guide.)

CloudFormation returns the same template that was used when the stack was created.

getTemplateResponse_httpStatus :: Lens' GetTemplateResponse Int

The response's http status code.

GetTemplateSummary

getTemplateSummary_callAs :: Lens' GetTemplateSummary (Maybe CallAs)

Service-managed permissions

Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

• If you are signed in to the management account, specify SELF.

• If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

  Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

getTemplateSummary_stackName :: Lens' GetTemplateSummary (Maybe Text)

The name or the stack ID that's associated with the stack, which aren't always interchangeable. For running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the unique stack ID.

Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

getTemplateSummary_stackSetName :: Lens' GetTemplateSummary (Maybe Text)

The name or unique ID of the stack set from which the stack was created.

Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

getTemplateSummary_templateBody :: Lens' GetTemplateSummary (Maybe Text)

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.

getTemplateSummary_templateURL :: Lens' GetTemplateSummary (Maybe Text)

Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information about templates, see Template anatomy in the CloudFormation User Guide.

Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

getTemplateSummaryResponse_capabilities :: Lens' GetTemplateSummaryResponse (Maybe [Capability])

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.

getTemplateSummaryResponse_capabilitiesReason :: Lens' GetTemplateSummaryResponse (Maybe Text)

The list of resources that generated the values in the Capabilities response element.

getTemplateSummaryResponse_declaredTransforms :: Lens' GetTemplateSummaryResponse (Maybe [Text])

A list of the transforms that are declared in the template.

getTemplateSummaryResponse_description :: Lens' GetTemplateSummaryResponse (Maybe Text)

The value that's defined in the Description property of the template.

getTemplateSummaryResponse_metadata :: Lens' GetTemplateSummaryResponse (Maybe Text)

The value that's defined for the Metadata property of the template.

getTemplateSummaryResponse_parameters :: Lens' GetTemplateSummaryResponse (Maybe [ParameterDeclaration])

A list of parameter declarations that describe various properties for each parameter.

getTemplateSummaryResponse_resourceIdentifierSummaries :: Lens' GetTemplateSummaryResponse (Maybe [ResourceIdentifierSummary])

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.

getTemplateSummaryResponse_resourceTypes :: Lens' GetTemplateSummaryResponse (Maybe [Text])

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.

getTemplateSummaryResponse_version :: Lens' GetTemplateSummaryResponse (Maybe Text)

The Amazon Web Services template format version, which identifies the capabilities of the template.

getTemplateSummaryResponse_httpStatus :: Lens' GetTemplateSummaryResponse Int

The response's http status code.

ImportStacksToStackSet

importStacksToStackSet_callAs :: Lens' ImportStacksToStackSet (Maybe CallAs)

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

• If you are signed in to the management account, specify SELF.
• For service managed stack sets, specify DELEGATED_ADMIN.

importStacksToStackSet_operationId :: Lens' ImportStacksToStackSet (Maybe Text)

A unique, user defined, identifier for the stack set operation.

importStacksToStackSet_operationPreferences :: Lens' ImportStacksToStackSet (Maybe StackSetOperationPreferences)

Undocumented member.

importStacksToStackSet_organizationalUnitIds :: Lens' ImportStacksToStackSet (Maybe [Text])

The list of OU ID's to which the stacks being imported has to be mapped as deployment target.

importStacksToStackSet_stackIds :: Lens' ImportStacksToStackSet (Maybe [Text])

The IDs of the stacks you are importing into a stack set. You import up to 10 stacks per stack set at a time.

Specify either StackIds or StackIdsUrl.

importStacksToStackSet_stackIdsUrl :: Lens' ImportStacksToStackSet (Maybe Text)

The Amazon S3 URL which contains list of stack ids to be inputted.

Specify either StackIds or StackIdsUrl.

importStacksToStackSet_stackSetName :: Lens' ImportStacksToStackSet Text

The name of the stack set. The name must be unique in the Region where you create your stack set.

importStacksToStackSetResponse_operationId :: Lens' ImportStacksToStackSetResponse (Maybe Text)

The unique identifier for the stack set operation.

importStacksToStackSetResponse_httpStatus :: Lens' ImportStacksToStackSetResponse Int

The response's http status code.

ListChangeSets

listChangeSets_nextToken :: Lens' ListChangeSets (Maybe Text)

A string (provided by the ListChangeSets response output) that identifies the next page of change sets that you want to retrieve.

listChangeSets_stackName :: Lens' ListChangeSets Text

The name or the Amazon Resource Name (ARN) of the stack for which you want to list change sets.

listChangeSetsResponse_nextToken :: Lens' ListChangeSetsResponse (Maybe Text)

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.

listChangeSetsResponse_summaries :: Lens' ListChangeSetsResponse (Maybe [ChangeSetSummary])

A list of ChangeSetSummary structures that provides the ID and status of each change set for the specified stack.

listChangeSetsResponse_httpStatus :: Lens' ListChangeSetsResponse Int

The response's http status code.

ListExports

listExports_nextToken :: Lens' ListExports (Maybe Text)

A string (provided by the ListExports response output) that identifies the next page of exported output values that you asked to retrieve.

listExportsResponse_exports :: Lens' ListExportsResponse (Maybe [Export])

The output for the ListExports action.

listExportsResponse_nextToken :: Lens' ListExportsResponse (Maybe Text)

If the output exceeds 100 exported output values, a string that identifies the next page of exports. If there is no additional page, this value is null.

listExportsResponse_httpStatus :: Lens' ListExportsResponse Int

The response's http status code.

ListImports

listImports_nextToken :: Lens' ListImports (Maybe Text)

A string (provided by the ListImports response output) that identifies the next page of stacks that are importing the specified exported output value.

listImports_exportName :: Lens' ListImports Text

The name of the exported output value. CloudFormation returns the stack names that are importing this value.

listImportsResponse_imports :: Lens' ListImportsResponse (Maybe [Text])

A list of stack names that are importing the specified exported output value.

listImportsResponse_nextToken :: Lens' ListImportsResponse (Maybe Text)

A string that identifies the next page of exports. If there is no additional page, this value is null.

listImportsResponse_httpStatus :: Lens' ListImportsResponse Int

The response's http status code.

ListStackInstances

listStackInstances_callAs :: Lens' ListStackInstances (Maybe 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.

listStackInstances_filters :: Lens' ListStackInstances (Maybe [StackInstanceFilter])

The filter to apply to stack instances

listStackInstances_maxResults :: Lens' ListStackInstances (Maybe Natural)

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

listStackInstances_nextToken :: Lens' ListStackInstances (Maybe Text)

If the previous request didn't return all the remaining results, the response's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

listStackInstances_stackInstanceAccount :: Lens' ListStackInstances (Maybe Text)

The name of the Amazon Web Services account that you want to list stack instances for.

listStackInstances_stackInstanceRegion :: Lens' ListStackInstances (Maybe Text)

The name of the Region where you want to list stack instances.

listStackInstances_stackSetName :: Lens' ListStackInstances Text

The name or unique ID of the stack set that you want to list stack instances for.

listStackInstancesResponse_nextToken :: Lens' ListStackInstancesResponse (Maybe Text)

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

listStackInstancesResponse_summaries :: Lens' ListStackInstancesResponse (Maybe [StackInstanceSummary])

A list of StackInstanceSummary structures that contain information about the specified stack instances.

listStackInstancesResponse_httpStatus :: Lens' ListStackInstancesResponse Int

The response's http status code.

ListStackResources

listStackResources_nextToken :: Lens' ListStackResources (Maybe Text)

A string that identifies the next page of stack resources that you want to retrieve.

listStackResources_stackName :: Lens' ListStackResources Text

The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:

• Running stacks: You can specify either the stack's name or its unique stack ID.
• Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

listStackResourcesResponse_nextToken :: Lens' ListStackResourcesResponse (Maybe Text)

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.

listStackResourcesResponse_stackResourceSummaries :: Lens' ListStackResourcesResponse (Maybe [StackResourceSummary])

A list of StackResourceSummary structures.

listStackResourcesResponse_httpStatus :: Lens' ListStackResourcesResponse Int

The response's http status code.

ListStackSetOperationResults

listStackSetOperationResults_callAs :: Lens' ListStackSetOperationResults (Maybe 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.

listStackSetOperationResults_filters :: Lens' ListStackSetOperationResults (Maybe [OperationResultFilter])

The filter to apply to operation results.

listStackSetOperationResults_maxResults :: Lens' ListStackSetOperationResults (Maybe Natural)

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

listStackSetOperationResults_nextToken :: Lens' ListStackSetOperationResults (Maybe Text)

If the previous request didn't return all the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackSetOperationResults again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

listStackSetOperationResults_stackSetName :: Lens' ListStackSetOperationResults Text

The name or unique ID of the stack set that you want to get operation results for.

listStackSetOperationResults_operationId :: Lens' ListStackSetOperationResults Text

The ID of the stack set operation.

listStackSetOperationResultsResponse_nextToken :: Lens' ListStackSetOperationResultsResponse (Maybe Text)

If the request doesn't return all results, NextToken is set to a token. To retrieve the next set of results, call ListOperationResults again and assign that token to the request object's NextToken parameter. If there are no remaining results, NextToken is set to null.

listStackSetOperationResultsResponse_summaries :: Lens' ListStackSetOperationResultsResponse (Maybe [StackSetOperationResultSummary])

A list of StackSetOperationResultSummary structures that contain information about the specified operation results, for accounts and Amazon Web Services Regions that are included in the operation.

listStackSetOperationResultsResponse_httpStatus :: Lens' ListStackSetOperationResultsResponse Int

The response's http status code.

ListStackSetOperations

listStackSetOperations_callAs :: Lens' ListStackSetOperations (Maybe 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.

listStackSetOperations_maxResults :: Lens' ListStackSetOperations (Maybe Natural)

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

listStackSetOperations_nextToken :: Lens' ListStackSetOperations (Maybe Text)

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackSetOperations again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

listStackSetOperations_stackSetName :: Lens' ListStackSetOperations Text

The name or unique ID of the stack set that you want to get operation summaries for.

listStackSetOperationsResponse_nextToken :: Lens' ListStackSetOperationsResponse (Maybe Text)

If the request doesn't return all results, NextToken is set to a token. To retrieve the next set of results, call ListOperationResults again and assign that token to the request object's NextToken parameter. If there are no remaining results, NextToken is set to null.

listStackSetOperationsResponse_summaries :: Lens' ListStackSetOperationsResponse (Maybe [StackSetOperationSummary])

A list of StackSetOperationSummary structures that contain summary information about operations for the specified stack set.

listStackSetOperationsResponse_httpStatus :: Lens' ListStackSetOperationsResponse Int

The response's http status code.

ListStackSets

listStackSets_callAs :: Lens' ListStackSets (Maybe CallAs)

Service-managed permissions

Specifies whether you are acting as an account administrator in the management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

• If you are signed in to the management account, specify SELF.

• If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

  Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

listStackSets_maxResults :: Lens' ListStackSets (Maybe Natural)

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

listStackSets_nextToken :: Lens' ListStackSets (Maybe Text)

If the previous paginated request didn't return all the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackSets again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

listStackSets_status :: Lens' ListStackSets (Maybe StackSetStatus)

The status of the stack sets that you want to get summary information about.

listStackSetsResponse_nextToken :: Lens' ListStackSetsResponse (Maybe Text)

If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

listStackSetsResponse_summaries :: Lens' ListStackSetsResponse (Maybe [StackSetSummary])

A list of StackSetSummary structures that contain information about the user's stack sets.

listStackSetsResponse_httpStatus :: Lens' ListStackSetsResponse Int

The response's http status code.

ListStacks

listStacks_nextToken :: Lens' ListStacks (Maybe Text)

A string that identifies the next page of stacks that you want to retrieve.

listStacks_stackStatusFilter :: Lens' ListStacks (Maybe [StackStatus])

Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified status codes. For a complete list of stack status codes, see the StackStatus parameter of the Stack data type.

listStacksResponse_nextToken :: Lens' ListStacksResponse (Maybe Text)

If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, this value is null.

listStacksResponse_stackSummaries :: Lens' ListStacksResponse (Maybe [StackSummary])

A list of StackSummary structures containing information about the specified stacks.

listStacksResponse_httpStatus :: Lens' ListStacksResponse Int

The response's http status code.

ListTypeRegistrations

listTypeRegistrations_maxResults :: Lens' ListTypeRegistrations (Maybe Natural)

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

listTypeRegistrations_nextToken :: Lens' ListTypeRegistrations (Maybe Text)

If the previous paginated request didn't return all the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

listTypeRegistrations_registrationStatusFilter :: Lens' ListTypeRegistrations (Maybe RegistrationStatus)

The current status of the extension registration request.

The default is IN_PROGRESS.

listTypeRegistrations_type :: Lens' ListTypeRegistrations (Maybe RegistryType)

The kind of extension.

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

listTypeRegistrations_typeArn :: Lens' ListTypeRegistrations (Maybe Text)

The Amazon Resource Name (ARN) of the extension.

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

listTypeRegistrations_typeName :: Lens' ListTypeRegistrations (Maybe Text)

The name of the extension.

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

listTypeRegistrationsResponse_nextToken :: Lens' ListTypeRegistrationsResponse (Maybe Text)

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

listTypeRegistrationsResponse_registrationTokenList :: Lens' ListTypeRegistrationsResponse (Maybe [Text])

A list of extension registration tokens.

Use DescribeTypeRegistration to return detailed information about a type registration request.

listTypeRegistrationsResponse_httpStatus :: Lens' ListTypeRegistrationsResponse Int

The response's http status code.

ListTypeVersions

listTypeVersions_arn :: Lens' ListTypeVersions (Maybe Text)

The Amazon Resource Name (ARN) of the extension for which you want version summary information.

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

listTypeVersions_deprecatedStatus :: Lens' ListTypeVersions (Maybe DeprecatedStatus)

The deprecation status of the extension versions that you want to get summary information about.

Valid values include:

• LIVE: The extension version is registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.
• DEPRECATED: The extension version has been deregistered and can no longer be used in CloudFormation operations.

The default is LIVE.

listTypeVersions_maxResults :: Lens' ListTypeVersions (Maybe Natural)

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

listTypeVersions_nextToken :: Lens' ListTypeVersions (Maybe Text)

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

listTypeVersions_publisherId :: Lens' ListTypeVersions (Maybe Text)

The publisher ID of the extension publisher.

Extensions published by Amazon aren't assigned a publisher ID.

listTypeVersions_type :: Lens' ListTypeVersions (Maybe RegistryType)

The kind of the extension.

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

listTypeVersions_typeName :: Lens' ListTypeVersions (Maybe Text)

The name of the extension for which you want version summary information.

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

listTypeVersionsResponse_nextToken :: Lens' ListTypeVersionsResponse (Maybe Text)

If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

listTypeVersionsResponse_typeVersionSummaries :: Lens' ListTypeVersionsResponse (Maybe [TypeVersionSummary])

A list of TypeVersionSummary structures that contain information about the specified extension's versions.

listTypeVersionsResponse_httpStatus :: Lens' ListTypeVersionsResponse Int

The response's http status code.

ListTypes

listTypes_deprecatedStatus :: Lens' ListTypes (Maybe DeprecatedStatus)

The deprecation status of the extension that you want to get summary information about.

Valid values include:

• LIVE: The extension is registered for use in CloudFormation operations.
• DEPRECATED: The extension has been deregistered and can no longer be used in CloudFormation operations.

listTypes_filters :: Lens' ListTypes (Maybe TypeFilters)

Filter criteria to use in determining which extensions to return.

Filters must be compatible with Visibility to return valid results. For example, specifying AWS_TYPES for Category and PRIVATE for Visibility returns an empty list of types, but specifying PUBLIC for Visibility returns the desired list.

listTypes_maxResults :: Lens' ListTypes (Maybe Natural)

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

listTypes_nextToken :: Lens' ListTypes (Maybe Text)

If the previous paginated request didn't return all the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

listTypes_provisioningType :: Lens' ListTypes (Maybe ProvisioningType)

For resource types, the provisioning behavior of the resource type. CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

Valid values include:

• FULLY_MUTABLE: The resource type includes an update handler to process updates to the type during stack update operations.
• IMMUTABLE: The resource type doesn't include an update handler, so the type can't be updated and must instead be replaced during stack update operations.
• NON_PROVISIONABLE: The resource type doesn't include create, read, and delete handlers, and therefore can't actually be provisioned.

The default is FULLY_MUTABLE.

listTypes_type :: Lens' ListTypes (Maybe RegistryType)

The type of extension.

listTypes_visibility :: Lens' ListTypes (Maybe Visibility)

The scope at which the extensions are visible and usable in CloudFormation operations.

Valid values include:

• PRIVATE: Extensions that are visible and usable within this account and region. This includes:

  • Private extensions you have registered in this account and region.
  • Public extensions that you have activated in this account and region.
• PUBLIC: Extensions that are publicly visible and available to be activated within any Amazon Web Services account. This includes extensions from Amazon Web Services, in addition to third-party publishers.

The default is PRIVATE.

listTypesResponse_nextToken :: Lens' ListTypesResponse (Maybe Text)

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

listTypesResponse_typeSummaries :: Lens' ListTypesResponse (Maybe [TypeSummary])

A list of TypeSummary structures that contain information about the specified extensions.

listTypesResponse_httpStatus :: Lens' ListTypesResponse Int

The response's http status code.

PublishType

publishType_arn :: Lens' PublishType (Maybe Text)

The Amazon Resource Name (ARN) of the extension.

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

publishType_publicVersionNumber :: Lens' PublishType (Maybe Text)

The version number to assign to this version of the extension.

Use the following format, and adhere to semantic versioning when assigning a version number to your extension:

MAJOR.MINOR.PATCH

For more information, see Semantic Versioning 2.0.0.

If you don't specify a version number, CloudFormation increments the version number by one minor version release.

You cannot specify a version number the first time you publish a type. CloudFormation automatically sets the first version number to be 1.0.0.

publishType_type :: Lens' PublishType (Maybe ThirdPartyType)

The type of the extension.

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

publishType_typeName :: Lens' PublishType (Maybe Text)

The name of the extension.

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

publishTypeResponse_publicTypeArn :: Lens' PublishTypeResponse (Maybe Text)

The Amazon Resource Name (ARN) assigned to the public extension upon publication.

publishTypeResponse_httpStatus :: Lens' PublishTypeResponse Int

The response's http status code.

RecordHandlerProgress

recordHandlerProgress_clientRequestToken :: Lens' RecordHandlerProgress (Maybe Text)

Reserved for use by the CloudFormation CLI.

recordHandlerProgress_currentOperationStatus :: Lens' RecordHandlerProgress (Maybe OperationStatus)

Reserved for use by the CloudFormation CLI.

recordHandlerProgress_errorCode :: Lens' RecordHandlerProgress (Maybe HandlerErrorCode)

Reserved for use by the CloudFormation CLI.

recordHandlerProgress_resourceModel :: Lens' RecordHandlerProgress (Maybe Text)

Reserved for use by the CloudFormation CLI.

recordHandlerProgress_statusMessage :: Lens' RecordHandlerProgress (Maybe Text)

Reserved for use by the CloudFormation CLI.

recordHandlerProgress_bearerToken :: Lens' RecordHandlerProgress Text

Reserved for use by the CloudFormation CLI.

recordHandlerProgress_operationStatus :: Lens' RecordHandlerProgress OperationStatus

Reserved for use by the CloudFormation CLI.

recordHandlerProgressResponse_httpStatus :: Lens' RecordHandlerProgressResponse Int

The response's http status code.

RegisterPublisher

registerPublisher_acceptTermsAndConditions :: Lens' RegisterPublisher (Maybe Bool)

Whether you accept the Terms and Conditions for publishing extensions in the CloudFormation registry. You must accept the terms and conditions in order to register to publish public extensions to the CloudFormation registry.

The default is false.

registerPublisher_connectionArn :: Lens' RegisterPublisher (Maybe Text)

If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for your connection to that account.

For more information, see Registering your account to publish CloudFormation extensions in the CloudFormation CLI User Guide.

registerPublisherResponse_publisherId :: Lens' RegisterPublisherResponse (Maybe Text)

The ID assigned this account by CloudFormation for publishing extensions.

registerPublisherResponse_httpStatus :: Lens' RegisterPublisherResponse Int

The response's http status code.

RegisterType

registerType_clientRequestToken :: Lens' RegisterType (Maybe Text)

A unique identifier that acts as an idempotency key for this registration request. Specifying a client request token prevents CloudFormation from generating more than one version of an extension from the same registration request, even if the request is submitted multiple times.

registerType_executionRoleArn :: Lens' RegisterType (Maybe Text)

The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.

For CloudFormation to assume the specified execution role, the role must contain a trust relationship with the CloudFormation service principle (resources.cloudformation.amazonaws.com). For more information about adding trust relationships, see Modifying a role trust policy in the Identity and Access Management User Guide.

If your extension calls Amazon Web Services APIs in any of its handlers, you must create an <https:docs.aws.amazon.comIAMlatestUserGuideid_roles.html IAM execution role> that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource type handler, thereby supplying your resource type with the appropriate credentials.

registerType_loggingConfig :: Lens' RegisterType (Maybe LoggingConfig)

Specifies logging configuration information for an extension.

registerType_type :: Lens' RegisterType (Maybe RegistryType)

The kind of extension.

registerType_typeName :: Lens' RegisterType Text

The name of the extension being registered.

We suggest that extension names adhere to the following patterns:

• For resource types, company_or_organization::service::type.
• For modules, company_or_organization::service::type::MODULE.
• For hooks, MyCompany::Testing::MyTestHook.

The following organization namespaces are reserved and can't be used in your extension names:

• Alexa

• AMZN

• Amazon

• AWS

• Custom

• Dev

registerType_schemaHandlerPackage :: Lens' RegisterType Text

A URL to the S3 bucket containing the extension project package that contains the necessary files for the extension you want to register.

For information about generating a schema handler package for the extension you want to register, see submit in the CloudFormation CLI User Guide.

The user registering the extension must be able to access the package in the S3 bucket. That's, the user needs to have GetObject permissions for the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Identity and Access Management User Guide.

registerTypeResponse_registrationToken :: Lens' RegisterTypeResponse (Maybe Text)

The identifier for this registration request.

Use this registration token when calling DescribeTypeRegistration , which returns information about the status and IDs of the extension registration.

registerTypeResponse_httpStatus :: Lens' RegisterTypeResponse Int

The response's http status code.

RollbackStack

rollbackStack_clientRequestToken :: Lens' RollbackStack (Maybe Text)

A unique identifier for this RollbackStack request.

rollbackStack_roleARN :: Lens' RollbackStack (Maybe Text)

The Amazon Resource Name (ARN) of an Identity and Access Management role that CloudFormation assumes to rollback the stack.

rollbackStack_stackName :: Lens' RollbackStack Text

The name that's associated with the stack.

rollbackStackResponse_stackId :: Lens' RollbackStackResponse (Maybe Text)

Unique identifier of the stack.

rollbackStackResponse_httpStatus :: Lens' RollbackStackResponse Int

The response's http status code.

SetStackPolicy

setStackPolicy_stackPolicyBody :: Lens' SetStackPolicy (Maybe Text)

Structure containing the stack policy body. For more information, go to Prevent updates to stack resources in the CloudFormation User Guide. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

setStackPolicy_stackPolicyURL :: Lens' SetStackPolicy (Maybe Text)

Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an Amazon S3 bucket in the same Amazon Web Services Region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

setStackPolicy_stackName :: Lens' SetStackPolicy Text

The name or unique stack ID that you want to associate a policy with.

SetTypeConfiguration

setTypeConfiguration_configurationAlias :: Lens' SetTypeConfiguration (Maybe Text)

An alias by which to refer to this extension configuration data.

Conditional: Specifying a configuration alias is required when setting a configuration for a resource type extension.

setTypeConfiguration_type :: Lens' SetTypeConfiguration (Maybe ThirdPartyType)

The type of extension.

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

setTypeConfiguration_typeArn :: Lens' SetTypeConfiguration (Maybe Text)

The Amazon Resource Name (ARN) for the extension, in this account and region.

For public extensions, this will be the ARN assigned when you activate the type in this account and region. For private extensions, this will be the ARN assigned when you register the type in this account and region.

Do not include the extension versions suffix at the end of the ARN. You can set the configuration for an extension, but not for a specific extension version.

setTypeConfiguration_typeName :: Lens' SetTypeConfiguration (Maybe Text)

The name of the extension.

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

setTypeConfiguration_configuration :: Lens' SetTypeConfiguration Text

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.

setTypeConfigurationResponse_configurationArn :: Lens' SetTypeConfigurationResponse (Maybe Text)

The Amazon Resource Name (ARN) for the configuration data, in this account and region.

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

setTypeConfigurationResponse_httpStatus :: Lens' SetTypeConfigurationResponse Int

The response's http status code.

SetTypeDefaultVersion

setTypeDefaultVersion_arn :: Lens' SetTypeDefaultVersion (Maybe Text)

The Amazon Resource Name (ARN) of the extension for which you want version summary information.

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

setTypeDefaultVersion_type :: Lens' SetTypeDefaultVersion (Maybe RegistryType)

The kind of extension.

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

setTypeDefaultVersion_typeName :: Lens' SetTypeDefaultVersion (Maybe Text)

The name of the extension.

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

setTypeDefaultVersion_versionId :: Lens' SetTypeDefaultVersion (Maybe Text)

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.

setTypeDefaultVersionResponse_httpStatus :: Lens' SetTypeDefaultVersionResponse Int

The response's http status code.

SignalResource

signalResource_stackName :: Lens' SignalResource Text

The stack name or unique stack ID that includes the resource that you want to signal.

signalResource_logicalResourceId :: Lens' SignalResource Text

The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in the template.

signalResource_uniqueId :: Lens' SignalResource Text

A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as signaling a wait condition), each signal requires a different unique ID.

signalResource_status :: Lens' SignalResource ResourceSignalStatus

The status of the signal, which is either success or failure. A failure signal causes CloudFormation to immediately fail the stack creation or update.

StopStackSetOperation

stopStackSetOperation_callAs :: Lens' StopStackSetOperation (Maybe CallAs)

Service-managed permissions

Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

• If you are signed in to the management account, specify SELF.

• If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

  Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

stopStackSetOperation_stackSetName :: Lens' StopStackSetOperation Text

The name or unique ID of the stack set that you want to stop the operation for.

stopStackSetOperation_operationId :: Lens' StopStackSetOperation Text

The ID of the stack operation.

stopStackSetOperationResponse_httpStatus :: Lens' StopStackSetOperationResponse Int

The response's http status code.

TestType

testType_arn :: Lens' TestType (Maybe Text)

The Amazon Resource Name (ARN) of the extension.

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

testType_logDeliveryBucket :: Lens' TestType (Maybe Text)

The S3 bucket to which CloudFormation delivers the contract test execution logs.

CloudFormation delivers the logs by the time contract testing has completed and the extension has been assigned a test type status of PASSED or FAILED.

The user calling TestType must be able to access items in the specified S3 bucket. Specifically, the user needs the following permissions:

• GetObject

• PutObject

For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Amazon Web Services Identity and Access Management User Guide.

testType_type :: Lens' TestType (Maybe ThirdPartyType)

The type of the extension to test.

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

testType_typeName :: Lens' TestType (Maybe Text)

The name of the extension to test.

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

testType_versionId :: Lens' TestType (Maybe Text)

The version of the extension to test.

You can specify the version id with either Arn, or with TypeName and Type.

If you don't specify a version, CloudFormation uses the default version of the extension in this account and region for testing.

testTypeResponse_typeVersionArn :: Lens' TestTypeResponse (Maybe Text)

The Amazon Resource Name (ARN) of the extension.

testTypeResponse_httpStatus :: Lens' TestTypeResponse Int

The response's http status code.

UpdateStack

updateStack_capabilities :: Lens' UpdateStack (Maybe [Capability])

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 suggest that you review all permissions associated with them and edit their permissions if necessary.

  • AWS::IAM::AccessKey
  • AWS::IAM::Group
  • AWS::IAM::InstanceProfile
  • AWS::IAM::Policy
  • AWS::IAM::Role
  • AWS::IAM::User
  • AWS::IAM::UserToGroupAddition

  For more information, see Acknowledging IAM Resources in CloudFormation Templates.

• CAPABILITY_AUTO_EXPAND

  Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually updating the stack. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.

  If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.

  You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.

  Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.

  For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.

updateStack_clientRequestToken :: Lens' UpdateStack (Maybe Text)

A unique identifier for this UpdateStack request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to update a stack with the same name. You might retry UpdateStack requests to ensure that CloudFormation successfully received them.

All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.

In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

updateStack_disableRollback :: Lens' UpdateStack (Maybe Bool)

Preserve the state of previously provisioned resources when an operation fails.

Default: False

updateStack_notificationARNs :: Lens' UpdateStack (Maybe [Text])

Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with the stack. Specify an empty list to remove all notification topics.

updateStack_parameters :: Lens' UpdateStack (Maybe [Parameter])

A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.

updateStack_resourceTypes :: Lens' UpdateStack (Maybe [Text])

The template resource types that you have permissions to work with for this update stack action, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.

If the list of resource types doesn't include a resource that you're updating, the stack update fails. By default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.

updateStack_roleARN :: Lens' UpdateStack (Maybe Text)

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to update the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.

If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.

updateStack_rollbackConfiguration :: Lens' UpdateStack (Maybe RollbackConfiguration)

The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

updateStack_stackPolicyBody :: Lens' UpdateStack (Maybe Text)

Structure containing a new stack policy body. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you don't specify a stack policy, the current policy that is associated with the stack is unchanged.

updateStack_stackPolicyDuringUpdateBody :: Lens' UpdateStack (Maybe Text)

Structure containing the temporary overriding stack policy body. You can specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both.

If you want to update protected resources, specify a temporary overriding stack policy during this update. If you don't specify a stack policy, the current policy that is associated with the stack will be used.

updateStack_stackPolicyDuringUpdateURL :: Lens' UpdateStack (Maybe Text)

Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. You can specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both.

If you want to update protected resources, specify a temporary overriding stack policy during this update. If you don't specify a stack policy, the current policy that is associated with the stack will be used.

updateStack_stackPolicyURL :: Lens' UpdateStack (Maybe Text)

Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you don't specify a stack policy, the current policy that is associated with the stack is unchanged.

updateStack_tags :: Lens' UpdateStack (Maybe [Tag])

Key-value pairs to associate with this stack. CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 50 tags.

If you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you specify an empty value, CloudFormation removes all associated tags.

updateStack_templateBody :: Lens' UpdateStack (Maybe Text)

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.

updateStack_templateURL :: Lens' UpdateStack (Maybe Text)

Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the CloudFormation User Guide.

Conditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.

updateStack_usePreviousTemplate :: Lens' UpdateStack (Maybe Bool)

Reuse the existing template that is associated with the stack that you are updating.

Conditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.

updateStack_stackName :: Lens' UpdateStack Text

The name or unique stack ID of the stack to update.

updateStackResponse_stackId :: Lens' UpdateStackResponse (Maybe Text)

Unique identifier of the stack.

updateStackResponse_httpStatus :: Lens' UpdateStackResponse Int

The response's http status code.

UpdateStackInstances

updateStackInstances_accounts :: Lens' UpdateStackInstances (Maybe [Text])

Self-managed permissions

The names of one or more Amazon Web Services accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions.

You can specify Accounts or DeploymentTargets, but not both.

updateStackInstances_callAs :: Lens' UpdateStackInstances (Maybe CallAs)

Service-managed permissions

Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

• If you are signed in to the management account, specify SELF.

• If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

  Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

updateStackInstances_deploymentTargets :: Lens' UpdateStackInstances (Maybe DeploymentTargets)

Service-managed permissions

The Organizations accounts for which you want to update parameter values for stack instances. If your update targets OUs, the overridden parameter values only apply to the accounts that are currently in the target OUs and their child OUs. Accounts added to the target OUs and their child OUs in the future won't use the overridden values.

You can specify Accounts or DeploymentTargets, but not both.

updateStackInstances_operationId :: Lens' UpdateStackInstances (Maybe Text)

The unique identifier for this stack set operation.

The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.

If you don't specify an operation ID, the SDK generates one automatically.

updateStackInstances_operationPreferences :: Lens' UpdateStackInstances (Maybe StackSetOperationPreferences)

Preferences for how CloudFormation performs this stack set operation.

updateStackInstances_parameterOverrides :: Lens' UpdateStackInstances (Maybe [Parameter])

A list of input parameters whose values you want to update for the specified stack instances.

Any overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance update operations:

• To override the current value for a parameter, include the parameter and specify its value.
• To leave an overridden parameter set to its present value, include the parameter and specify UsePreviousValue as true. (You can't 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 don't include the parameter in the list.
• To leave all parameters set to their present values, don't specify this property at all.

During stack set updates, any parameter values overridden for a stack instance aren't updated, but retain their overridden value.

You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.

updateStackInstances_stackSetName :: Lens' UpdateStackInstances Text

The name or unique ID of the stack set associated with the stack instances.

updateStackInstances_regions :: Lens' UpdateStackInstances [Text]

The names of one or more Amazon Web Services Regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions.

updateStackInstancesResponse_operationId :: Lens' UpdateStackInstancesResponse (Maybe Text)

The unique identifier for this stack set operation.

updateStackInstancesResponse_httpStatus :: Lens' UpdateStackInstancesResponse Int

The response's http status code.

UpdateStackSet

updateStackSet_accounts :: Lens' UpdateStackSet (Maybe [Text])

Self-managed permissions

The accounts in which to update associated stack instances. If you specify accounts, you must also specify the Amazon Web Services Regions in which to update stack set instances.

To update all the stack instances associated with this stack set, don't specify the Accounts or Regions properties.

If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Amazon Web Services Regions. If the stack set update does not include changes to the template or parameters, CloudFormation updates the stack instances in the specified accounts and Amazon Web Services Regions, while leaving all other stack instances with their existing stack instance status.

updateStackSet_administrationRoleARN :: Lens' UpdateStackSet (Maybe Text)

The Amazon Resource Name (ARN) of the IAM role to use to update this stack set.

Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Granting Permissions for Stack Set Operations in the CloudFormation User Guide.

If you specified a customized administrator role when you created the stack set, you must specify a customized administrator role, even if it is the same customized administrator role used with this stack set previously.

updateStackSet_autoDeployment :: Lens' UpdateStackSet (Maybe AutoDeployment)

Service-managed permissions

Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU).

If you specify AutoDeployment, don't specify DeploymentTargets or Regions.

updateStackSet_callAs :: Lens' UpdateStackSet (Maybe CallAs)

Service-managed permissions

Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

• If you are signed in to the management account, specify SELF.

• If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

  Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

updateStackSet_capabilities :: Lens' UpdateStackSet (Maybe [Capability])

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack set and its associated stack instances.

• CAPABILITY_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 sets, 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.

  • AWS::IAM::AccessKey
  • AWS::IAM::Group
  • AWS::IAM::InstanceProfile
  • AWS::IAM::Policy
  • AWS::IAM::Role
  • AWS::IAM::User
  • AWS::IAM::UserToGroupAddition

  For more information, see Acknowledging IAM Resources in CloudFormation Templates.

• CAPABILITY_AUTO_EXPAND

  Some templates reference macros. If your stack set template references one or more macros, you must update the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To update the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.

  Stack sets with service-managed permissions do not currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.

updateStackSet_deploymentTargets :: Lens' UpdateStackSet (Maybe DeploymentTargets)

Service-managed permissions

The Organizations accounts in which to update associated stack instances.

To update all the stack instances associated with this stack set, do not specify DeploymentTargets or Regions.

If the stack set update includes changes to the template (that is, if TemplateBody or TemplateURL is specified), or the Parameters, CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Amazon Web Services Regions. If the stack set update doesn't include changes to the template or parameters, CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.

updateStackSet_description :: Lens' UpdateStackSet (Maybe Text)

A brief description of updates that you are making.

updateStackSet_executionRoleName :: Lens' UpdateStackSet (Maybe Text)

The name of the IAM execution role to use to update the stack set. If you do not specify an execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.

Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.

If you specify a customized execution role, CloudFormation uses that role to update the stack. If you do not specify a customized execution role, CloudFormation performs the update using the role previously associated with the stack set, so long as you have permissions to perform operations on the stack set.

updateStackSet_managedExecution :: Lens' UpdateStackSet (Maybe ManagedExecution)

Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.

updateStackSet_operationId :: Lens' UpdateStackSet (Maybe Text)

The unique ID for this stack set operation.

The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.

If you don't specify an operation ID, CloudFormation generates one automatically.

Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.

updateStackSet_operationPreferences :: Lens' UpdateStackSet (Maybe StackSetOperationPreferences)

Preferences for how CloudFormation performs this stack set operation.

updateStackSet_parameters :: Lens' UpdateStackSet (Maybe [Parameter])

A list of input parameters for the stack set template.

updateStackSet_permissionModel :: Lens' UpdateStackSet (Maybe PermissionModels)

Describes how the IAM roles required for stack set operations are created. You cannot modify PermissionModel if there are stack instances associated with your stack set.

• With self-managed permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant Self-Managed Stack Set Permissions.
• With service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set Permissions.

updateStackSet_regions :: Lens' UpdateStackSet (Maybe [Text])

The Amazon Web Services Regions in which to update associated stack instances. If you specify Regions, you must also specify accounts in which to update stack set instances.

To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.

If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.

updateStackSet_tags :: Lens' UpdateStackSet (Maybe [Tag])

The key-value pairs to associate with this stack set and the stacks created from it. CloudFormation also propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags.

If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this stack set. This means:

• If you don't specify this parameter, CloudFormation doesn't modify the stack's tags.
• If you specify any tags using this parameter, you must specify all the tags that you want associated with this stack set, even tags you've specified before (for example, when creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the updated list of tags are removed from the stack set, and therefore from the stacks and resources as well.
• If you specify an empty value, CloudFormation removes all currently associated tags.

If you specify new tags as part of an UpdateStackSet action, CloudFormation checks to see if you have the required IAM permission to tag resources. If you omit tags that are currently associated with the stack set from the list of tags you specify, CloudFormation assumes that you want to remove those tags from the stack set, and checks to see if you have permission to untag resources. If you don't have the necessary permission(s), the entire UpdateStackSet action fails with an access denied error, and the stack set is not updated.

updateStackSet_templateBody :: Lens' UpdateStackSet (Maybe Text)

The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the CloudFormation User Guide.

Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.

updateStackSet_templateURL :: Lens' UpdateStackSet (Maybe Text)

The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. For more information, see Template Anatomy in the CloudFormation User Guide.

Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.

updateStackSet_usePreviousTemplate :: Lens' UpdateStackSet (Maybe Bool)

Use the existing template that's associated with the stack set that you're updating.

Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.

updateStackSet_stackSetName :: Lens' UpdateStackSet Text

The name or unique ID of the stack set that you want to update.

updateStackSetResponse_operationId :: Lens' UpdateStackSetResponse (Maybe Text)

The unique ID for this stack set operation.

updateStackSetResponse_httpStatus :: Lens' UpdateStackSetResponse Int

The response's http status code.

UpdateTerminationProtection

updateTerminationProtection_enableTerminationProtection :: Lens' UpdateTerminationProtection Bool

Whether to enable termination protection on the specified stack.

updateTerminationProtection_stackName :: Lens' UpdateTerminationProtection Text

The name or unique ID of the stack for which you want to set termination protection.

updateTerminationProtectionResponse_stackId :: Lens' UpdateTerminationProtectionResponse (Maybe Text)

The unique ID of the stack.

updateTerminationProtectionResponse_httpStatus :: Lens' UpdateTerminationProtectionResponse Int

The response's http status code.

ValidateTemplate

validateTemplate_templateBody :: Lens' ValidateTemplate (Maybe Text)

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template Anatomy in the CloudFormation User Guide.

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

validateTemplate_templateURL :: Lens' ValidateTemplate (Maybe Text)

Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the CloudFormation User Guide.

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

validateTemplateResponse_capabilities :: Lens' ValidateTemplateResponse (Maybe [Capability])

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.

validateTemplateResponse_capabilitiesReason :: Lens' ValidateTemplateResponse (Maybe Text)

The list of resources that generated the values in the Capabilities response element.

validateTemplateResponse_declaredTransforms :: Lens' ValidateTemplateResponse (Maybe [Text])

A list of the transforms that are declared in the template.

validateTemplateResponse_description :: Lens' ValidateTemplateResponse (Maybe Text)

The description found within the template.

validateTemplateResponse_parameters :: Lens' ValidateTemplateResponse (Maybe [TemplateParameter])

A list of TemplateParameter structures.

validateTemplateResponse_httpStatus :: Lens' ValidateTemplateResponse Int

The response's http status code.

Types

AccountGateResult

accountGateResult_status :: Lens' AccountGateResult (Maybe AccountGateStatus)

The status of the account gate function.

• SUCCEEDED: The account gate function has determined that the account and Region passes any requirements for a stack set operation to occur. CloudFormation proceeds with the stack operation in that account and Region.
• FAILED: The account gate function has determined that the account and Region doesn't meet the requirements for a stack set operation to occur. CloudFormation cancels the stack set operation in that account and Region, and sets the stack set operation result status for that account and Region to FAILED.

• SKIPPED: CloudFormation has skipped calling the account gate function for this account and Region, for one of the following reasons:

  • An account gate function hasn't been specified for the account and Region. CloudFormation proceeds with the stack set operation in this account and Region.
  • The AWSCloudFormationStackSetExecutionRole of the stack set administration account lacks permissions to invoke the function. CloudFormation proceeds with the stack set operation in this account and Region.
  • Either no action is necessary, or no action is possible, on the stack. CloudFormation skips the stack set operation in this account and Region.

accountGateResult_statusReason :: Lens' AccountGateResult (Maybe Text)

The reason for the account gate status assigned to this account and Region for the stack set operation.

AccountLimit

accountLimit_name :: Lens' AccountLimit (Maybe Text)

The name of the account limit.

Values: ConcurrentResourcesLimit | StackLimit | StackOutputsLimit

accountLimit_value :: Lens' AccountLimit (Maybe Int)

The value that's associated with the account limit name.

AutoDeployment

autoDeployment_enabled :: Lens' AutoDeployment (Maybe Bool)

If set to true, StackSets automatically deploys additional stack instances to Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions. If an account is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified Regions.

autoDeployment_retainStacksOnAccountRemoval :: Lens' AutoDeployment (Maybe Bool)

If set to true, stack resources are retained when an account is removed from a target organization or OU. If set to false, stack resources are deleted. Specify only if Enabled is set to True.

BatchDescribeTypeConfigurationsError

batchDescribeTypeConfigurationsError_errorCode :: Lens' BatchDescribeTypeConfigurationsError (Maybe Text)

The error code.

batchDescribeTypeConfigurationsError_errorMessage :: Lens' BatchDescribeTypeConfigurationsError (Maybe Text)

The error message.

batchDescribeTypeConfigurationsError_typeConfigurationIdentifier :: Lens' BatchDescribeTypeConfigurationsError (Maybe TypeConfigurationIdentifier)

Undocumented member.

Change

change_hookInvocationCount :: Lens' Change (Maybe Natural)

Is either null, if no hooks invoke for the resource, or contains the number of hooks that will invoke for the resource.

change_resourceChange :: Lens' Change (Maybe ResourceChange)

A ResourceChange structure that describes the resource and action that CloudFormation will perform.

change_type :: Lens' Change (Maybe ChangeType)

The type of entity that CloudFormation changes. Currently, the only entity type is Resource.

ChangeSetHook

changeSetHook_failureMode :: Lens' ChangeSetHook (Maybe HookFailureMode)

Specify the hook failure mode for non-compliant resources in the followings ways.

• FAIL Stops provisioning resources.
• WARN Allows provisioning to continue with a warning message.

changeSetHook_invocationPoint :: Lens' ChangeSetHook (Maybe HookInvocationPoint)

Specifies the points in provisioning logic where a hook is invoked.

changeSetHook_targetDetails :: Lens' ChangeSetHook (Maybe ChangeSetHookTargetDetails)

Specifies details about the target that the hook will run against.

changeSetHook_typeConfigurationVersionId :: Lens' ChangeSetHook (Maybe Text)

The version ID of the type configuration.

changeSetHook_typeName :: Lens' ChangeSetHook (Maybe Text)

The unique name for your hook. Specifies a three-part namespace for your hook, with a recommended pattern of Organization::Service::Hook.

The following organization namespaces are reserved and can't be used in your hook type names:

• Alexa

• AMZN

• Amazon

• ASK

• AWS

• Custom

• Dev

changeSetHook_typeVersionId :: Lens' ChangeSetHook (Maybe Text)

The version ID of the type specified.

ChangeSetHookResourceTargetDetails

changeSetHookResourceTargetDetails_logicalResourceId :: Lens' ChangeSetHookResourceTargetDetails (Maybe Text)

The resource's logical ID, which is defined in the stack's template.

changeSetHookResourceTargetDetails_resourceAction :: Lens' ChangeSetHookResourceTargetDetails (Maybe ChangeAction)

Specifies the action of the resource.

changeSetHookResourceTargetDetails_resourceType :: Lens' ChangeSetHookResourceTargetDetails (Maybe Text)

The type of CloudFormation resource, such as AWS::S3::Bucket.

ChangeSetHookTargetDetails

changeSetHookTargetDetails_resourceTargetDetails :: Lens' ChangeSetHookTargetDetails (Maybe ChangeSetHookResourceTargetDetails)

Required if TargetType is RESOURCE.

changeSetHookTargetDetails_targetType :: Lens' ChangeSetHookTargetDetails (Maybe HookTargetType)

The name of the type.

ChangeSetSummary

changeSetSummary_changeSetId :: Lens' ChangeSetSummary (Maybe Text)

The ID of the change set.

changeSetSummary_changeSetName :: Lens' ChangeSetSummary (Maybe Text)

The name of the change set.

changeSetSummary_creationTime :: Lens' ChangeSetSummary (Maybe UTCTime)

The start time when the change set was created, in UTC.

changeSetSummary_description :: Lens' ChangeSetSummary (Maybe Text)

Descriptive information about the change set.

changeSetSummary_executionStatus :: Lens' ChangeSetSummary (Maybe ExecutionStatus)

If the change set execution status is AVAILABLE, you can execute the change set. If you can't execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE state because CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.

changeSetSummary_includeNestedStacks :: Lens' ChangeSetSummary (Maybe Bool)

Specifies the current setting of IncludeNestedStacks for the change set.

changeSetSummary_parentChangeSetId :: Lens' ChangeSetSummary (Maybe Text)

The parent change set ID.

changeSetSummary_rootChangeSetId :: Lens' ChangeSetSummary (Maybe Text)

The root change set ID.

changeSetSummary_stackId :: Lens' ChangeSetSummary (Maybe Text)

The ID of the stack with which the change set is associated.

changeSetSummary_stackName :: Lens' ChangeSetSummary (Maybe Text)

The name of the stack with which the change set is associated.

changeSetSummary_status :: Lens' ChangeSetSummary (Maybe ChangeSetStatus)

The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.

changeSetSummary_statusReason :: Lens' ChangeSetSummary (Maybe Text)

A description of the change set's status. For example, if your change set is in the FAILED state, CloudFormation shows the error message.

DeploymentTargets

deploymentTargets_accountFilterType :: Lens' DeploymentTargets (Maybe AccountFilterType)

Limit deployment targets to individual accounts or include additional accounts with provided OUs.

The following is a list of possible values for the AccountFilterType operation.

• INTERSECTION: StackSets deploys to the accounts specified in Accounts parameter.
• DIFFERENCE: StackSets excludes the accounts specified in Accounts parameter. This enables user to avoid certain accounts within an OU such as suspended accounts.

• UNION: StackSets includes additional accounts deployment targets.

  This is the default value if AccountFilterType is not provided. This enables user to update an entire OU and individual accounts from a different OU in one request, which used to be two separate requests.

• NONE: Deploys to all the accounts in specified organizational units (OU).

deploymentTargets_accounts :: Lens' DeploymentTargets (Maybe [Text])

The names of one or more Amazon Web Services accounts for which you want to deploy stack set updates.

deploymentTargets_accountsUrl :: Lens' DeploymentTargets (Maybe Text)

Returns the value of the AccountsUrl property.

deploymentTargets_organizationalUnitIds :: Lens' DeploymentTargets (Maybe [Text])

The organization root ID or organizational unit (OU) IDs to which StackSets deploys.

Export

export_exportingStackId :: Lens' Export (Maybe Text)

The stack that contains the exported output name and value.

export_name :: Lens' Export (Maybe Text)

The name of exported output value. Use this name and the Fn::ImportValue function to import the associated value into other stacks. The name is defined in the Export field in the associated stack's Outputs section.

export_value :: Lens' Export (Maybe Text)

The value of the exported output, such as a resource physical ID. This value is defined in the Export field in the associated stack's Outputs section.

LoggingConfig

loggingConfig_logRoleArn :: Lens' LoggingConfig Text

The Amazon Resource Name (ARN) of the role that CloudFormation should assume when sending log entries to CloudWatch Logs.

loggingConfig_logGroupName :: Lens' LoggingConfig Text

The Amazon CloudWatch Logs group to which CloudFormation sends error logging information when invoking the extension's handlers.

ManagedExecution

managedExecution_active :: Lens' ManagedExecution (Maybe Bool)

When true, StackSets performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, StackSets starts queued operations in request order.

If there are already running or queued operations, StackSets queues all incoming operations even if they are non-conflicting.

You can't modify your stack set's execution configuration while there are running or queued operations for that stack set.

When false (default), StackSets performs one operation at a time in request order.

ModuleInfo

moduleInfo_logicalIdHierarchy :: Lens' ModuleInfo (Maybe Text)

A concatenated list of the logical IDs of the module or modules containing the resource. Modules are listed starting with the inner-most nested module, and separated by /.

In the following example, the resource was created from a module, moduleA, that's nested inside a parent module, moduleB.

moduleA/moduleB

For more information, see Referencing resources in a module in the CloudFormation User Guide.

moduleInfo_typeHierarchy :: Lens' ModuleInfo (Maybe Text)

A concatenated list of the module type or types containing the resource. Module types are listed starting with the inner-most nested module, and separated by /.

In the following example, the resource was created from a module of type AWS::First::Example::MODULE, that's nested inside a parent module of type AWS::Second::Example::MODULE.

AWS::First::Example::MODULE/AWS::Second::Example::MODULE

OperationResultFilter

operationResultFilter_name :: Lens' OperationResultFilter (Maybe OperationResultFilterName)

The type of filter to apply.

operationResultFilter_values :: Lens' OperationResultFilter (Maybe Text)

The value to filter by.

Output

output_description :: Lens' Output (Maybe Text)

User defined description associated with the output.

output_exportName :: Lens' Output (Maybe Text)

The name of the export associated with the output.

output_outputKey :: Lens' Output (Maybe Text)

The key associated with the output.

output_outputValue :: Lens' Output (Maybe Text)

The value associated with the output.

Parameter

parameter_parameterKey :: Lens' Parameter (Maybe Text)

The key associated with the parameter. If you don't specify a key and value for a particular parameter, CloudFormation uses the default value that's specified in your template.

parameter_parameterValue :: Lens' Parameter (Maybe Text)

The input value associated with the parameter.

parameter_resolvedValue :: Lens' Parameter (Maybe Text)

Read-only. The value that corresponds to a SSM parameter key. This field is returned only for SSM parameter types in the template.

parameter_usePreviousValue :: Lens' Parameter (Maybe Bool)

During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true, do not specify a parameter value.

ParameterConstraints

parameterConstraints_allowedValues :: Lens' ParameterConstraints (Maybe [Text])

A list of values that are permitted for a parameter.

ParameterDeclaration

parameterDeclaration_defaultValue :: Lens' ParameterDeclaration (Maybe Text)

The default value of the parameter.

parameterDeclaration_description :: Lens' ParameterDeclaration (Maybe Text)

The description that's associate with the parameter.

parameterDeclaration_noEcho :: Lens' ParameterDeclaration (Maybe Bool)

Flag that indicates whether the parameter value is shown as plain text in logs and in the Amazon Web Services Management Console.

parameterDeclaration_parameterConstraints :: Lens' ParameterDeclaration (Maybe ParameterConstraints)

The criteria that CloudFormation uses to validate parameter values.

parameterDeclaration_parameterKey :: Lens' ParameterDeclaration (Maybe Text)

The name that's associated with the parameter.

parameterDeclaration_parameterType :: Lens' ParameterDeclaration (Maybe Text)

The type of parameter.

PhysicalResourceIdContextKeyValuePair

physicalResourceIdContextKeyValuePair_key :: Lens' PhysicalResourceIdContextKeyValuePair Text

The resource context key.

physicalResourceIdContextKeyValuePair_value :: Lens' PhysicalResourceIdContextKeyValuePair Text

The resource context value.

PropertyDifference

propertyDifference_propertyPath :: Lens' PropertyDifference Text

The fully-qualified path to the resource property.

propertyDifference_expectedValue :: Lens' PropertyDifference Text

The expected property value of the resource property, as defined in the stack template and any values specified as template parameters.

propertyDifference_actualValue :: Lens' PropertyDifference Text

The actual property value of the resource property.

propertyDifference_differenceType :: Lens' PropertyDifference DifferenceType

The type of property difference.

• ADD: A value has been added to a resource property that's an array or list data type.
• REMOVE: The property has been removed from the current resource configuration.
• NOT_EQUAL: The current property value differs from its expected value (as defined in the stack template and any values specified as template parameters).

RequiredActivatedType

requiredActivatedType_originalTypeName :: Lens' RequiredActivatedType (Maybe Text)

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.

requiredActivatedType_publisherId :: Lens' RequiredActivatedType (Maybe Text)

The publisher ID of the extension publisher.

requiredActivatedType_supportedMajorVersions :: Lens' RequiredActivatedType (Maybe [Natural])

A list of the major versions of the extension type that the macro supports.

requiredActivatedType_typeNameAlias :: Lens' RequiredActivatedType (Maybe Text)

An alias assigned to the public extension, in this account and region. If you specify an alias for the extension, CloudFormation treats the alias as the extension type name within this account and region. You must use the alias to refer to the extension in your templates, API calls, and CloudFormation console.

ResourceChange

resourceChange_action :: Lens' ResourceChange (Maybe ChangeAction)

The action that CloudFormation takes on the resource, such as Add (adds a new resource), Modify (changes a resource), Remove (deletes a resource), Import (imports a resource), or Dynamic (exact action for the resource can't be determined).

resourceChange_changeSetId :: Lens' ResourceChange (Maybe Text)

The change set ID of the nested change set.

resourceChange_details :: Lens' ResourceChange (Maybe [ResourceChangeDetail])

For the Modify action, a list of ResourceChangeDetail structures that describes the changes that CloudFormation will make to the resource.

resourceChange_logicalResourceId :: Lens' ResourceChange (Maybe Text)

The resource's logical ID, which is defined in the stack's template.

resourceChange_moduleInfo :: Lens' ResourceChange (Maybe ModuleInfo)

Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

resourceChange_physicalResourceId :: Lens' ResourceChange (Maybe Text)

The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they haven't been created.

resourceChange_replacement :: Lens' ResourceChange (Maybe Replacement)

For the Modify action, indicates whether CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of the RequiresRecreation property in the ResourceTargetDefinition structure. For example, if the RequiresRecreation field is Always and the Evaluation field is Static, Replacement is True. If the RequiresRecreation field is Always and the Evaluation field is Dynamic, Replacement is Conditionally.

If you have multiple changes with different RequiresRecreation values, the Replacement value depends on the change with the most impact. A RequiresRecreation value of Always has the most impact, followed by Conditionally, and then Never.

resourceChange_resourceType :: Lens' ResourceChange (Maybe Text)

The type of CloudFormation resource, such as AWS::S3::Bucket.

resourceChange_scope :: Lens' ResourceChange (Maybe [ResourceAttribute])

For the Modify action, indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.

ResourceChangeDetail

resourceChangeDetail_causingEntity :: Lens' ResourceChangeDetail (Maybe Text)

The identity of the entity that triggered this change. This entity is a member of the group that's specified by the ChangeSource field. For example, if you modified the value of the KeyPairName parameter, the CausingEntity is the name of the parameter (KeyPairName).

If the ChangeSource value is DirectModification, no value is given for CausingEntity.

resourceChangeDetail_changeSource :: Lens' ResourceChangeDetail (Maybe ChangeSource)

The group to which the CausingEntity value belongs. There are five entity groups:

• ResourceReference entities are Ref intrinsic functions that refer to resources in the template, such as { "Ref" : "MyEC2InstanceResource" }.
• ParameterReference entities are Ref intrinsic functions that get template parameter values, such as { "Ref" : "MyPasswordParameter" }.
• ResourceAttribute entities are Fn::GetAtt intrinsic functions that get resource attribute values, such as { "Fn::GetAtt" : [ "MyEC2InstanceResource", "PublicDnsName" ] }.
• DirectModification entities are changes that are made directly to the template.
• Automatic entities are AWS::CloudFormation::Stack resource types, which are also known as nested stacks. If you made no changes to the AWS::CloudFormation::Stack resource, CloudFormation sets the ChangeSource to Automatic because the nested stack's template might have changed. Changes to a nested stack's template aren't visible to CloudFormation until you run an update on the parent stack.

resourceChangeDetail_evaluation :: Lens' ResourceChangeDetail (Maybe EvaluationType)

Indicates whether CloudFormation can determine the target value, and whether the target value will change before you execute a change set.

For Static evaluations, CloudFormation can determine that the target value will change, and its value. For example, if you directly modify the InstanceType property of an EC2 instance, CloudFormation knows that this property value will change, and its value, so this is a Static evaluation.

For Dynamic evaluations, can't determine the target value because it depends on the result of an intrinsic function, such as a Ref or Fn::GetAtt intrinsic function, when the stack is updated. For example, if your template includes a reference to a resource that's conditionally recreated, the value of the reference (the physical ID of the resource) might change, depending on if the resource is recreated. If the resource is recreated, it will have a new physical ID, so all references to that resource will also be updated.

resourceChangeDetail_target :: Lens' ResourceChangeDetail (Maybe ResourceTargetDefinition)

A ResourceTargetDefinition structure that describes the field that CloudFormation will change and whether the resource will be recreated.

ResourceIdentifierSummary

resourceIdentifierSummary_logicalResourceIds :: Lens' ResourceIdentifierSummary (Maybe (NonEmpty Text))

The logical IDs of the target resources of the specified ResourceType, as defined in the import template.

resourceIdentifierSummary_resourceIdentifiers :: Lens' ResourceIdentifierSummary (Maybe [Text])

The resource properties you can provide during the import to identify your target resources. For example, BucketName is a possible identifier property for AWS::S3::Bucket resources.

resourceIdentifierSummary_resourceType :: Lens' ResourceIdentifierSummary (Maybe Text)

The template resource type of the target resources, such as AWS::S3::Bucket.

ResourceTargetDefinition

resourceTargetDefinition_attribute :: Lens' ResourceTargetDefinition (Maybe ResourceAttribute)

Indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.

resourceTargetDefinition_name :: Lens' ResourceTargetDefinition (Maybe Text)

If the Attribute value is Properties, the name of the property. For all other attributes, the value is null.

resourceTargetDefinition_requiresRecreation :: Lens' ResourceTargetDefinition (Maybe RequiresRecreation)

If the Attribute value is Properties, indicates whether a change to this property causes the resource to be recreated. The value can be Never, Always, or Conditionally. To determine the conditions for a Conditionally recreation, see the update behavior for that property in the CloudFormation User Guide.

ResourceToImport

resourceToImport_resourceType :: Lens' ResourceToImport Text

The type of resource to import into your stack, such as AWS::S3::Bucket. For a list of supported resource types, see Resources that support import operations in the CloudFormation User Guide.

resourceToImport_logicalResourceId :: Lens' ResourceToImport Text

The logical ID of the target resource as specified in the template.

resourceToImport_resourceIdentifier :: Lens' ResourceToImport (HashMap Text Text)

A key-value pair that identifies the target resource. The key is an identifier property (for example, BucketName for AWS::S3::Bucket resources) and the value is the actual property value (for example, MyS3Bucket).

RollbackConfiguration

rollbackConfiguration_monitoringTimeInMinutes :: Lens' RollbackConfiguration (Maybe Natural)

The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources.

The default is 0 minutes.

If you specify a monitoring period but don't specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources after update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary.

If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes.

rollbackConfiguration_rollbackTriggers :: Lens' RollbackConfiguration (Maybe [RollbackTrigger])

The triggers to monitor during stack creation or update actions.

By default, CloudFormation saves the rollback triggers specified for a stack and applies them to any subsequent update operations for the stack, unless you specify otherwise. If you do specify rollback triggers for this parameter, those triggers replace any list of triggers previously specified for the stack. This means:

• To use the rollback triggers previously specified for this stack, if any, don't specify this parameter.
• To specify new or updated rollback triggers, you must specify all the triggers that you want used for this stack, even triggers you've specified before (for example, when creating the stack or during a previous stack update). Any triggers that you don't include in the updated list of triggers are no longer applied to the stack.
• To remove all currently specified triggers, specify an empty list for this parameter.

If a specified trigger is missing, the entire stack operation fails and is rolled back.

RollbackTrigger

rollbackTrigger_arn :: Lens' RollbackTrigger Text

The Amazon Resource Name (ARN) of the rollback trigger.

If a specified trigger is missing, the entire stack operation fails and is rolled back.

rollbackTrigger_type :: Lens' RollbackTrigger Text

The resource type of the rollback trigger. Specify either AWS::CloudWatch::Alarm or AWS::CloudWatch::CompositeAlarm resource types.

Stack

stack_capabilities :: Lens' Stack (Maybe [Capability])

The capabilities allowed in the stack.

stack_changeSetId :: Lens' Stack (Maybe Text)

The unique ID of the change set.

stack_deletionTime :: Lens' Stack (Maybe UTCTime)

The time the stack was deleted.

stack_description :: Lens' Stack (Maybe Text)

A user-defined description associated with the stack.

stack_disableRollback :: Lens' Stack (Maybe Bool)

Boolean to enable or disable rollback on stack creation failures:

• true: disable rollback.
• false: enable rollback.

stack_driftInformation :: Lens' Stack (Maybe StackDriftInformation)

Information about whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

stack_enableTerminationProtection :: Lens' Stack (Maybe Bool)

Whether termination protection is enabled for the stack.

For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the CloudFormation User Guide.

stack_lastUpdatedTime :: Lens' Stack (Maybe UTCTime)

The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

stack_notificationARNs :: Lens' Stack (Maybe [Text])

Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.

stack_outputs :: Lens' Stack (Maybe [Output])

A list of output structures.

stack_parameters :: Lens' Stack (Maybe [Parameter])

A list of Parameter structures.

stack_parentId :: Lens' Stack (Maybe Text)

For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.

For more information, see Working with Nested Stacks in the CloudFormation User Guide.

stack_roleARN :: Lens' Stack (Maybe Text)

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that's associated with the stack. During a stack operation, CloudFormation uses this role's credentials to make calls on your behalf.

stack_rollbackConfiguration :: Lens' Stack (Maybe RollbackConfiguration)

The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

stack_rootId :: Lens' Stack (Maybe Text)

For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which the nested stack ultimately belongs.

For more information, see Working with Nested Stacks in the CloudFormation User Guide.

stack_stackId :: Lens' Stack (Maybe Text)

Unique identifier of the stack.

stack_stackStatusReason :: Lens' Stack (Maybe Text)

Success/failure message associated with the stack status.

stack_tags :: Lens' Stack (Maybe [Tag])

A list of Tags that specify information about the stack.

stack_timeoutInMinutes :: Lens' Stack (Maybe Natural)

The amount of time within which stack creation should complete.

stack_stackName :: Lens' Stack Text

The name associated with the stack.

stack_creationTime :: Lens' Stack UTCTime

The time at which the stack was created.

stack_stackStatus :: Lens' Stack StackStatus

Current status of the stack.

StackDriftInformation

stackDriftInformation_lastCheckTimestamp :: Lens' StackDriftInformation (Maybe UTCTime)

Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources that support drift detection.

stackDriftInformation_stackDriftStatus :: Lens' StackDriftInformation StackDriftStatus

Status of the stack's actual configuration compared to its expected template configuration.

• DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.
• NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected template configuration.
• IN_SYNC: The stack's actual configuration matches its expected template configuration.
• UNKNOWN: This value is reserved for future use.

StackDriftInformationSummary

stackDriftInformationSummary_lastCheckTimestamp :: Lens' StackDriftInformationSummary (Maybe UTCTime)

Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources that support drift detection.

stackDriftInformationSummary_stackDriftStatus :: Lens' StackDriftInformationSummary StackDriftStatus

Status of the stack's actual configuration compared to its expected template configuration.

• DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.
• NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected template configuration.
• IN_SYNC: The stack's actual configuration matches its expected template configuration.
• UNKNOWN: This value is reserved for future use.

StackEvent

stackEvent_clientRequestToken :: Lens' StackEvent (Maybe Text)

The token passed to the operation that generated this event.

All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.

In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

stackEvent_hookFailureMode :: Lens' StackEvent (Maybe HookFailureMode)

Specify the hook failure mode for non-compliant resources in the followings ways.

• FAIL Stops provisioning resources.
• WARN Allows provisioning to continue with a warning message.

stackEvent_hookInvocationPoint :: Lens' StackEvent (Maybe HookInvocationPoint)

Invocation points are points in provisioning logic where hooks are initiated.

stackEvent_hookStatus :: Lens' StackEvent (Maybe HookStatus)

Provides the status of the change set hook.

stackEvent_hookStatusReason :: Lens' StackEvent (Maybe Text)

Provides the reason for the hook status.

stackEvent_hookType :: Lens' StackEvent (Maybe Text)

The name of the hook.

stackEvent_logicalResourceId :: Lens' StackEvent (Maybe Text)

The logical name of the resource specified in the template.

stackEvent_physicalResourceId :: Lens' StackEvent (Maybe Text)

The name or unique identifier associated with the physical instance of the resource.

stackEvent_resourceProperties :: Lens' StackEvent (Maybe Text)

BLOB of the properties used to create the resource.

stackEvent_resourceStatus :: Lens' StackEvent (Maybe ResourceStatus)

Current status of the resource.

stackEvent_resourceStatusReason :: Lens' StackEvent (Maybe Text)

Success/failure message associated with the resource.

stackEvent_resourceType :: Lens' StackEvent (Maybe Text)

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

stackEvent_stackId :: Lens' StackEvent Text

The unique ID name of the instance of the stack.

stackEvent_eventId :: Lens' StackEvent Text

The unique ID of this event.

stackEvent_stackName :: Lens' StackEvent Text

The name associated with a stack.

stackEvent_timestamp :: Lens' StackEvent UTCTime

Time the status was updated.

StackInstance

stackInstance_account :: Lens' StackInstance (Maybe Text)

Self-managed permissions

The name of the Amazon Web Services account that the stack instance is associated with.

stackInstance_driftStatus :: Lens' StackInstance (Maybe StackDriftStatus)

Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the stack set to which it belongs.

• DRIFTED: The stack differs from the expected template and parameter configuration of the stack set to which it belongs. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.
• NOT_CHECKED: CloudFormation hasn't checked if the stack instance differs from its expected stack set configuration.
• IN_SYNC: The stack instance's actual configuration matches its expected stack set configuration.
• UNKNOWN: This value is reserved for future use.

stackInstance_lastDriftCheckTimestamp :: Lens' StackInstance (Maybe UTCTime)

Most recent time when CloudFormation performed a drift detection operation on the stack instance. This value will be NULL for any stack instance on which drift detection hasn't yet been performed.

stackInstance_lastOperationId :: Lens' StackInstance (Maybe Text)

The last unique ID of a StackSet operation performed on a stack instance.

stackInstance_organizationalUnitId :: Lens' StackInstance (Maybe Text)

Service-managed permissions

The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

stackInstance_parameterOverrides :: Lens' StackInstance (Maybe [Parameter])

A list of parameters from the stack set template whose values have been overridden in this stack instance.

stackInstance_region :: Lens' StackInstance (Maybe Text)

The name of the Amazon Web Services Region that the stack instance is associated with.

stackInstance_stackId :: Lens' StackInstance (Maybe Text)

The ID of the stack instance.

stackInstance_stackInstanceStatus :: Lens' StackInstance (Maybe StackInstanceComprehensiveStatus)

The detailed status of the stack instance.

stackInstance_stackSetId :: Lens' StackInstance (Maybe Text)

The name or unique ID of the stack set that the stack instance is associated with.

stackInstance_status :: Lens' StackInstance (Maybe StackInstanceStatus)

The status of the stack instance, in terms of its synchronization with its associated stack set.

• INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually.

• OUTDATED: The stack isn't currently up to date with the stack set because:

  • The associated stack failed during a CreateStackSet or UpdateStackSet operation.
  • The stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated.
• CURRENT: The stack is currently up to date with the stack set.

stackInstance_statusReason :: Lens' StackInstance (Maybe Text)

The explanation for the specific status code that's assigned to this stack instance.

StackInstanceComprehensiveStatus

stackInstanceComprehensiveStatus_detailedStatus :: Lens' StackInstanceComprehensiveStatus (Maybe StackInstanceDetailedStatus)

• CANCELLED: The operation in the specified account and Region has been canceled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded.
• FAILED: The operation in the specified account and Region failed. If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded.
• INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually.
• PENDING: The operation in the specified account and Region has yet to start.
• RUNNING: The operation in the specified account and Region is currently in progress.
• SUCCEEDED: The operation in the specified account and Region completed successfully.

StackInstanceFilter

stackInstanceFilter_name :: Lens' StackInstanceFilter (Maybe StackInstanceFilterName)

The type of filter to apply.

stackInstanceFilter_values :: Lens' StackInstanceFilter (Maybe Text)

The status to filter by.

StackInstanceSummary

stackInstanceSummary_account :: Lens' StackInstanceSummary (Maybe Text)

Self-managed permissions

The name of the Amazon Web Services account that the stack instance is associated with.

stackInstanceSummary_driftStatus :: Lens' StackInstanceSummary (Maybe StackDriftStatus)

Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the stack set to which it belongs.

• DRIFTED: The stack differs from the expected template and parameter configuration of the stack set to which it belongs. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.
• NOT_CHECKED: CloudFormation hasn't checked if the stack instance differs from its expected stack set configuration.
• IN_SYNC: The stack instance's actual configuration matches its expected stack set configuration.
• UNKNOWN: This value is reserved for future use.

stackInstanceSummary_lastDriftCheckTimestamp :: Lens' StackInstanceSummary (Maybe UTCTime)

Most recent time when CloudFormation performed a drift detection operation on the stack instance. This value will be NULL for any stack instance on which drift detection hasn't yet been performed.

stackInstanceSummary_lastOperationId :: Lens' StackInstanceSummary (Maybe Text)

The last unique ID of a StackSet operation performed on a stack instance.

stackInstanceSummary_organizationalUnitId :: Lens' StackInstanceSummary (Maybe Text)

Service-managed permissions

The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

stackInstanceSummary_region :: Lens' StackInstanceSummary (Maybe Text)

The name of the Amazon Web Services Region that the stack instance is associated with.

stackInstanceSummary_stackId :: Lens' StackInstanceSummary (Maybe Text)

The ID of the stack instance.

stackInstanceSummary_stackInstanceStatus :: Lens' StackInstanceSummary (Maybe StackInstanceComprehensiveStatus)

The detailed status of the stack instance.

stackInstanceSummary_stackSetId :: Lens' StackInstanceSummary (Maybe Text)

The name or unique ID of the stack set that the stack instance is associated with.

stackInstanceSummary_status :: Lens' StackInstanceSummary (Maybe StackInstanceStatus)

The status of the stack instance, in terms of its synchronization with its associated stack set.

• INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually.

• OUTDATED: The stack isn't currently up to date with the stack set because:

  • The associated stack failed during a CreateStackSet or UpdateStackSet operation.
  • The stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated.
• CURRENT: The stack is currently up to date with the stack set.

stackInstanceSummary_statusReason :: Lens' StackInstanceSummary (Maybe Text)

The explanation for the specific status code assigned to this stack instance.

StackResource

stackResource_description :: Lens' StackResource (Maybe Text)

User defined description associated with the resource.

stackResource_driftInformation :: Lens' StackResource (Maybe StackResourceDriftInformation)

Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

stackResource_moduleInfo :: Lens' StackResource (Maybe ModuleInfo)

Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

stackResource_physicalResourceId :: Lens' StackResource (Maybe Text)

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

stackResource_resourceStatusReason :: Lens' StackResource (Maybe Text)

Success/failure message associated with the resource.

stackResource_stackId :: Lens' StackResource (Maybe Text)

Unique identifier of the stack.

stackResource_stackName :: Lens' StackResource (Maybe Text)

The name associated with the stack.

stackResource_logicalResourceId :: Lens' StackResource Text

The logical name of the resource specified in the template.

stackResource_resourceType :: Lens' StackResource Text

Type of resource. For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.

stackResource_timestamp :: Lens' StackResource UTCTime

Time the status was updated.

stackResource_resourceStatus :: Lens' StackResource ResourceStatus

Current status of the resource.

StackResourceDetail

stackResourceDetail_description :: Lens' StackResourceDetail (Maybe Text)

User defined description associated with the resource.

stackResourceDetail_driftInformation :: Lens' StackResourceDetail (Maybe StackResourceDriftInformation)

Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

stackResourceDetail_metadata :: Lens' StackResourceDetail (Maybe Text)

The content of the Metadata attribute declared for the resource. For more information, see Metadata Attribute in the CloudFormation User Guide.

stackResourceDetail_moduleInfo :: Lens' StackResourceDetail (Maybe ModuleInfo)

Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

stackResourceDetail_physicalResourceId :: Lens' StackResourceDetail (Maybe Text)

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

stackResourceDetail_resourceStatusReason :: Lens' StackResourceDetail (Maybe Text)

Success/failure message associated with the resource.

stackResourceDetail_stackId :: Lens' StackResourceDetail (Maybe Text)

Unique identifier of the stack.

stackResourceDetail_stackName :: Lens' StackResourceDetail (Maybe Text)

The name associated with the stack.

stackResourceDetail_logicalResourceId :: Lens' StackResourceDetail Text

The logical name of the resource specified in the template.

stackResourceDetail_resourceType :: Lens' StackResourceDetail Text

Type of resource. For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.

stackResourceDetail_lastUpdatedTimestamp :: Lens' StackResourceDetail UTCTime

Time the status was updated.

stackResourceDetail_resourceStatus :: Lens' StackResourceDetail ResourceStatus

Current status of the resource.

StackResourceDrift

stackResourceDrift_actualProperties :: Lens' StackResourceDrift (Maybe Text)

A JSON structure containing the actual property values of the stack resource.

For resources whose StackResourceDriftStatus is DELETED, this structure will not be present.

stackResourceDrift_expectedProperties :: Lens' StackResourceDrift (Maybe Text)

A JSON structure containing the expected property values of the stack resource, as defined in the stack template and any values specified as template parameters.

For resources whose StackResourceDriftStatus is DELETED, this structure will not be present.

stackResourceDrift_moduleInfo :: Lens' StackResourceDrift (Maybe ModuleInfo)

Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

stackResourceDrift_physicalResourceId :: Lens' StackResourceDrift (Maybe Text)

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

stackResourceDrift_physicalResourceIdContext :: Lens' StackResourceDrift (Maybe [PhysicalResourceIdContextKeyValuePair])

Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses context key-value pairs in cases where a resource's logical and physical IDs aren't enough to uniquely identify that resource. Each context key-value pair specifies a unique resource that contains the targeted resource.

stackResourceDrift_propertyDifferences :: Lens' StackResourceDrift (Maybe [PropertyDifference])

A collection of the resource properties whose actual values differ from their expected values. These will be present only for resources whose StackResourceDriftStatus is MODIFIED.

stackResourceDrift_stackId :: Lens' StackResourceDrift Text

The ID of the stack.

stackResourceDrift_logicalResourceId :: Lens' StackResourceDrift Text

The logical name of the resource specified in the template.

stackResourceDrift_resourceType :: Lens' StackResourceDrift Text

The type of the resource.

stackResourceDrift_stackResourceDriftStatus :: Lens' StackResourceDrift StackResourceDriftStatus

Status of the resource's actual configuration compared to its expected configuration.

• DELETED: The resource differs from its expected template configuration because the resource has been deleted.
• MODIFIED: One or more resource properties differ from their expected values (as defined in the stack template and any values specified as template parameters).
• IN_SYNC: The resource's actual configuration matches its expected template configuration.
• NOT_CHECKED: CloudFormation does not currently return this value.

stackResourceDrift_timestamp :: Lens' StackResourceDrift UTCTime

Time at which CloudFormation performed drift detection on the stack resource.

StackResourceDriftInformation

stackResourceDriftInformation_lastCheckTimestamp :: Lens' StackResourceDriftInformation (Maybe UTCTime)

When CloudFormation last checked if the resource had drifted from its expected configuration.

stackResourceDriftInformation_stackResourceDriftStatus :: Lens' StackResourceDriftInformation StackResourceDriftStatus

Status of the resource's actual configuration compared to its expected configuration

• DELETED: The resource differs from its expected configuration in that it has been deleted.
• MODIFIED: The resource differs from its expected configuration.

• NOT_CHECKED: CloudFormation has not checked if the resource differs from its expected configuration.

  Any resources that do not currently support drift detection have a status of NOT_CHECKED. For more information, see Resources that Support Drift Detection.

• IN_SYNC: The resource's actual configuration matches its expected configuration.

StackResourceDriftInformationSummary

stackResourceDriftInformationSummary_lastCheckTimestamp :: Lens' StackResourceDriftInformationSummary (Maybe UTCTime)

When CloudFormation last checked if the resource had drifted from its expected configuration.

stackResourceDriftInformationSummary_stackResourceDriftStatus :: Lens' StackResourceDriftInformationSummary StackResourceDriftStatus

Status of the resource's actual configuration compared to its expected configuration.

• DELETED: The resource differs from its expected configuration in that it has been deleted.
• MODIFIED: The resource differs from its expected configuration.

• NOT_CHECKED: CloudFormation hasn't checked if the resource differs from its expected configuration.

  Any resources that don't currently support drift detection have a status of NOT_CHECKED. For more information, see Resources that Support Drift Detection. If you performed an ContinueUpdateRollback operation on a stack, any resources included in ResourcesToSkip will also have a status of NOT_CHECKED. For more information about skipping resources during rollback operations, see Continue Rolling Back an Update in the CloudFormation User Guide.

• IN_SYNC: The resource's actual configuration matches its expected configuration.

StackResourceSummary

stackResourceSummary_driftInformation :: Lens' StackResourceSummary (Maybe StackResourceDriftInformationSummary)

Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

stackResourceSummary_moduleInfo :: Lens' StackResourceSummary (Maybe ModuleInfo)

Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

stackResourceSummary_physicalResourceId :: Lens' StackResourceSummary (Maybe Text)

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

stackResourceSummary_resourceStatusReason :: Lens' StackResourceSummary (Maybe Text)

Success/failure message associated with the resource.

stackResourceSummary_logicalResourceId :: Lens' StackResourceSummary Text

The logical name of the resource specified in the template.

stackResourceSummary_resourceType :: Lens' StackResourceSummary Text

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

stackResourceSummary_lastUpdatedTimestamp :: Lens' StackResourceSummary UTCTime

Time the status was updated.

stackResourceSummary_resourceStatus :: Lens' StackResourceSummary ResourceStatus

Current status of the resource.

StackSet

stackSet_administrationRoleARN :: Lens' StackSet (Maybe Text)

The Amazon Resource Name (ARN) of the IAM role used to create or update the stack set.

Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the CloudFormation User Guide.

stackSet_autoDeployment :: Lens' StackSet (Maybe AutoDeployment)

Service-managed permissions

Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU).

stackSet_capabilities :: Lens' StackSet (Maybe [Capability])

The capabilities that are allowed in the stack set. Some stack set templates might include resources that can affect permissions in your Amazon Web Services account—for example, by creating new Identity and Access Management (IAM) users. For more information, see Acknowledging IAM Resources in CloudFormation Templates.

stackSet_description :: Lens' StackSet (Maybe Text)

A description of the stack set that you specify when the stack set is created or updated.

stackSet_executionRoleName :: Lens' StackSet (Maybe Text)

The name of the IAM execution role used to create or update the stack set.

Use customized execution roles to control which stack resources users and groups can include in their stack sets.

stackSet_managedExecution :: Lens' StackSet (Maybe ManagedExecution)

Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.

stackSet_organizationalUnitIds :: Lens' StackSet (Maybe [Text])

Service-managed permissions

The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

stackSet_parameters :: Lens' StackSet (Maybe [Parameter])

A list of input parameters for a stack set.

stackSet_permissionModel :: Lens' StackSet (Maybe PermissionModels)

Describes how the IAM roles required for stack set operations are created.

• With self-managed permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant Self-Managed Stack Set Permissions.
• With service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set Permissions.

stackSet_stackSetARN :: Lens' StackSet (Maybe Text)

The Amazon Resource Name (ARN) of the stack set.

stackSet_stackSetDriftDetectionDetails :: Lens' StackSet (Maybe StackSetDriftDetectionDetails)

Detailed information about the drift status of the stack set.

For stack sets, contains information about the last completed drift operation performed on the stack set. Information about drift operations currently in progress isn't included.

stackSet_stackSetId :: Lens' StackSet (Maybe Text)

The ID of the stack set.

stackSet_stackSetName :: Lens' StackSet (Maybe Text)

The name that's associated with the stack set.

stackSet_status :: Lens' StackSet (Maybe StackSetStatus)

The status of the stack set.

stackSet_tags :: Lens' StackSet (Maybe [Tag])

A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.

stackSet_templateBody :: Lens' StackSet (Maybe Text)

The structure that contains the body of the template that was used to create or update the stack set.

StackSetDriftDetectionDetails

stackSetDriftDetectionDetails_driftDetectionStatus :: Lens' StackSetDriftDetectionDetails (Maybe StackSetDriftDetectionStatus)

The status of the stack set drift detection operation.

• COMPLETED: The drift detection operation completed without failing on any stack instances.
• FAILED: The drift detection operation exceeded the specified failure tolerance.
• PARTIAL_SUCCESS: The drift detection operation completed without exceeding the failure tolerance for the operation.
• IN_PROGRESS: The drift detection operation is currently being performed.
• STOPPED: The user has canceled the drift detection operation.

stackSetDriftDetectionDetails_driftStatus :: Lens' StackSetDriftDetectionDetails (Maybe StackSetDriftStatus)

Status of the stack set's actual configuration compared to its expected template and parameter configuration. A stack set is considered to have drifted if one or more of its stack instances have drifted from their expected template and parameter configuration.

• DRIFTED: One or more of the stack instances belonging to the stack set stack differs from the expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.
• NOT_CHECKED: CloudFormation hasn't checked the stack set for drift.
• IN_SYNC: All of the stack instances belonging to the stack set stack match from the expected template and parameter configuration.

stackSetDriftDetectionDetails_driftedStackInstancesCount :: Lens' StackSetDriftDetectionDetails (Maybe Natural)

The number of stack instances that have drifted from the expected template and parameter configuration of the stack set. A stack instance is considered to have drifted if one or more of the resources in the associated stack don't match their expected configuration.

stackSetDriftDetectionDetails_failedStackInstancesCount :: Lens' StackSetDriftDetectionDetails (Maybe Natural)

The number of stack instances for which the drift detection operation failed.

stackSetDriftDetectionDetails_inProgressStackInstancesCount :: Lens' StackSetDriftDetectionDetails (Maybe Natural)

The number of stack instances that are currently being checked for drift.

stackSetDriftDetectionDetails_inSyncStackInstancesCount :: Lens' StackSetDriftDetectionDetails (Maybe Natural)

The number of stack instances which match the expected template and parameter configuration of the stack set.

stackSetDriftDetectionDetails_lastDriftCheckTimestamp :: Lens' StackSetDriftDetectionDetails (Maybe UTCTime)

Most recent time when CloudFormation performed a drift detection operation on the stack set. This value will be NULL for any stack set on which drift detection hasn't yet been performed.

stackSetDriftDetectionDetails_totalStackInstancesCount :: Lens' StackSetDriftDetectionDetails (Maybe Natural)

The total number of stack instances belonging to this stack set.

The total number of stack instances is equal to the total of:

• Stack instances that match the stack set configuration.
• Stack instances that have drifted from the stack set configuration.
• Stack instances where the drift detection operation has failed.
• Stack instances currently being checked for drift.

StackSetOperation

stackSetOperation_action :: Lens' StackSetOperation (Maybe StackSetOperationAction)

The type of stack set operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack set instances that are associated with the specified stack set. Update operations affect both the stack set itself, in addition to all associated stack set instances.

stackSetOperation_administrationRoleARN :: Lens' StackSetOperation (Maybe Text)

The Amazon Resource Name (ARN) of the IAM role used to perform this stack set operation.

Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Define Permissions for Multiple Administrators in the CloudFormation User Guide.

stackSetOperation_creationTimestamp :: Lens' StackSetOperation (Maybe UTCTime)

The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested Regions, before actually creating the first stacks.

stackSetOperation_deploymentTargets :: Lens' StackSetOperation (Maybe DeploymentTargets)

Service-managed permissions

The Organizations accounts affected by the stack operation.

stackSetOperation_endTimestamp :: Lens' StackSetOperation (Maybe UTCTime)

The time at which the stack set operation ended, across all accounts and Regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or Region.

stackSetOperation_executionRoleName :: Lens' StackSetOperation (Maybe Text)

The name of the IAM execution role used to create or update the stack set.

Use customized execution roles to control which stack resources users and groups can include in their stack sets.

stackSetOperation_operationId :: Lens' StackSetOperation (Maybe Text)

The unique ID of a stack set operation.

stackSetOperation_operationPreferences :: Lens' StackSetOperation (Maybe StackSetOperationPreferences)

The preferences for how CloudFormation performs this stack set operation.

stackSetOperation_retainStacks :: Lens' StackSetOperation (Maybe Bool)

For stack set operations of action type DELETE, specifies whether to remove the stack instances from the specified stack set, but doesn't delete the stacks. You can't re-associate a retained stack, or add an existing, saved stack to a new stack set.

stackSetOperation_stackSetDriftDetectionDetails :: Lens' StackSetOperation (Maybe StackSetDriftDetectionDetails)

Detailed information about the drift status of the stack set. This includes information about drift operations currently being performed on the stack set.

This information will only be present for stack set operations whose Action type is DETECT_DRIFT.

For more information, see Detecting Unmanaged Changes in Stack Sets in the CloudFormation User Guide.

stackSetOperation_stackSetId :: Lens' StackSetOperation (Maybe Text)

The ID of the stack set.

stackSetOperation_status :: Lens' StackSetOperation (Maybe StackSetOperationStatus)

The status of the operation.

• FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.
• QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the CloudFormation User Guide.
• RUNNING: The operation is currently being performed.
• STOPPED: The user has canceled the operation.
• STOPPING: The operation is in the process of stopping, at user request.
• SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.

stackSetOperation_statusDetails :: Lens' StackSetOperation (Maybe StackSetOperationStatusDetails)

Detailed information about the StackSet operation.

stackSetOperation_statusReason :: Lens' StackSetOperation (Maybe Text)

The status of the operation in details.

StackSetOperationPreferences

stackSetOperationPreferences_failureToleranceCount :: Lens' StackSetOperationPreferences (Maybe Natural)

The number of accounts, per Region, for which this operation can fail before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent Regions.

Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage (but not both).

By default, 0 is specified.

stackSetOperationPreferences_failureTolerancePercentage :: Lens' StackSetOperationPreferences (Maybe Natural)

The percentage of accounts, per Region, for which this stack operation can fail before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent Regions.

When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number.

Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage, but not both.

By default, 0 is specified.

stackSetOperationPreferences_maxConcurrentCount :: Lens' StackSetOperationPreferences (Maybe Natural)

The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of FailureToleranceCount.MaxConcurrentCount is at most one more than the FailureToleranceCount.

Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

By default, 1 is specified.

stackSetOperationPreferences_maxConcurrentPercentage :: Lens' StackSetOperationPreferences (Maybe Natural)

The maximum percentage of accounts in which to perform this operation at one time.

When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead.

Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

By default, 1 is specified.

stackSetOperationPreferences_regionConcurrencyType :: Lens' StackSetOperationPreferences (Maybe RegionConcurrencyType)

The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.

stackSetOperationPreferences_regionOrder :: Lens' StackSetOperationPreferences (Maybe [Text])

The order of the Regions in where you want to perform the stack operation.

StackSetOperationResultSummary

stackSetOperationResultSummary_account :: Lens' StackSetOperationResultSummary (Maybe Text)

Self-managed permissions

The name of the Amazon Web Services account for this operation result.

stackSetOperationResultSummary_accountGateResult :: Lens' StackSetOperationResultSummary (Maybe AccountGateResult)

The results of the account gate function CloudFormation invokes, if present, before proceeding with stack set operations in an account.

stackSetOperationResultSummary_organizationalUnitId :: Lens' StackSetOperationResultSummary (Maybe Text)

Service-managed permissions

The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

stackSetOperationResultSummary_region :: Lens' StackSetOperationResultSummary (Maybe Text)

The name of the Amazon Web Services Region for this operation result.

stackSetOperationResultSummary_status :: Lens' StackSetOperationResultSummary (Maybe StackSetOperationResultStatus)

The result status of the stack set operation for the given account in the given Region.

• CANCELLED: The operation in the specified account and Region has been canceled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded.

• FAILED: The operation in the specified account and Region failed.

  If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded.

• RUNNING: The operation in the specified account and Region is currently in progress.
• PENDING: The operation in the specified account and Region has yet to start.
• SUCCEEDED: The operation in the specified account and Region completed successfully.

stackSetOperationResultSummary_statusReason :: Lens' StackSetOperationResultSummary (Maybe Text)

The reason for the assigned result status.

StackSetOperationStatusDetails

stackSetOperationStatusDetails_failedStackInstancesCount :: Lens' StackSetOperationStatusDetails (Maybe Natural)

The number of stack instances for which the StackSet operation failed.

StackSetOperationSummary

stackSetOperationSummary_action :: Lens' StackSetOperationSummary (Maybe StackSetOperationAction)

The type of operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified stack set. Update operations affect both the stack set itself and all associated stack set instances.

stackSetOperationSummary_creationTimestamp :: Lens' StackSetOperationSummary (Maybe UTCTime)

The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested Regions, before actually creating the first stacks.

stackSetOperationSummary_endTimestamp :: Lens' StackSetOperationSummary (Maybe UTCTime)

The time at which the stack set operation ended, across all accounts and Regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or Region.

stackSetOperationSummary_operationId :: Lens' StackSetOperationSummary (Maybe Text)

The unique ID of the stack set operation.

stackSetOperationSummary_operationPreferences :: Lens' StackSetOperationSummary (Maybe StackSetOperationPreferences)

Undocumented member.

stackSetOperationSummary_status :: Lens' StackSetOperationSummary (Maybe StackSetOperationStatus)

The overall status of the operation.

• FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.
• QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the CloudFormation User Guide.
• RUNNING: The operation is currently being performed.
• STOPPED: The user has canceled the operation.
• STOPPING: The operation is in the process of stopping, at user request.
• SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.

stackSetOperationSummary_statusDetails :: Lens' StackSetOperationSummary (Maybe StackSetOperationStatusDetails)

Detailed information about the stack set operation.

stackSetOperationSummary_statusReason :: Lens' StackSetOperationSummary (Maybe Text)

The status of the operation in details.

StackSetSummary

stackSetSummary_autoDeployment :: Lens' StackSetSummary (Maybe AutoDeployment)

Service-managed permissions

Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organizational unit (OU).

stackSetSummary_description :: Lens' StackSetSummary (Maybe Text)

A description of the stack set that you specify when the stack set is created or updated.

stackSetSummary_driftStatus :: Lens' StackSetSummary (Maybe StackDriftStatus)

Status of the stack set's actual configuration compared to its expected template and parameter configuration. A stack set is considered to have drifted if one or more of its stack instances have drifted from their expected template and parameter configuration.

• DRIFTED: One or more of the stack instances belonging to the stack set stack differs from the expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.
• NOT_CHECKED: CloudFormation hasn't checked the stack set for drift.
• IN_SYNC: All the stack instances belonging to the stack set stack match from the expected template and parameter configuration.
• UNKNOWN: This value is reserved for future use.

stackSetSummary_lastDriftCheckTimestamp :: Lens' StackSetSummary (Maybe UTCTime)

Most recent time when CloudFormation performed a drift detection operation on the stack set. This value will be NULL for any stack set on which drift detection hasn't yet been performed.

stackSetSummary_managedExecution :: Lens' StackSetSummary (Maybe ManagedExecution)

Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.

stackSetSummary_permissionModel :: Lens' StackSetSummary (Maybe PermissionModels)

Describes how the IAM roles required for stack set operations are created.

• With self-managed permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant Self-Managed Stack Set Permissions.
• With service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set Permissions.

stackSetSummary_stackSetId :: Lens' StackSetSummary (Maybe Text)

The ID of the stack set.

stackSetSummary_stackSetName :: Lens' StackSetSummary (Maybe Text)

The name of the stack set.

stackSetSummary_status :: Lens' StackSetSummary (Maybe StackSetStatus)

The status of the stack set.

StackSummary

stackSummary_deletionTime :: Lens' StackSummary (Maybe UTCTime)

The time the stack was deleted.

stackSummary_driftInformation :: Lens' StackSummary (Maybe StackDriftInformationSummary)

Summarizes information about whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

stackSummary_lastUpdatedTime :: Lens' StackSummary (Maybe UTCTime)

The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

stackSummary_parentId :: Lens' StackSummary (Maybe Text)

For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.

For more information, see Working with Nested Stacks in the CloudFormation User Guide.

stackSummary_rootId :: Lens' StackSummary (Maybe Text)

For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which the nested stack ultimately belongs.

For more information, see Working with Nested Stacks in the CloudFormation User Guide.

stackSummary_stackId :: Lens' StackSummary (Maybe Text)

Unique stack identifier.

stackSummary_stackStatusReason :: Lens' StackSummary (Maybe Text)

Success/Failure message associated with the stack status.

stackSummary_templateDescription :: Lens' StackSummary (Maybe Text)

The template description of the template used to create the stack.

stackSummary_stackName :: Lens' StackSummary Text

The name associated with the stack.

stackSummary_creationTime :: Lens' StackSummary UTCTime

The time the stack was created.

stackSummary_stackStatus :: Lens' StackSummary StackStatus

The current status of the stack.

Tag

tag_key :: Lens' Tag Text

Required. A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (Amazon Web Services) have the reserved prefix: aws:.

tag_value :: Lens' Tag Text

Required. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.

TemplateParameter

templateParameter_defaultValue :: Lens' TemplateParameter (Maybe Text)

The default value associated with the parameter.

templateParameter_description :: Lens' TemplateParameter (Maybe Text)

User defined description associated with the parameter.

templateParameter_noEcho :: Lens' TemplateParameter (Maybe Bool)

Flag indicating whether the parameter should be displayed as plain text in logs and UIs.

templateParameter_parameterKey :: Lens' TemplateParameter (Maybe Text)

The name associated with the parameter.

TypeConfigurationDetails

typeConfigurationDetails_alias :: Lens' TypeConfigurationDetails (Maybe Text)

The alias specified for this configuration, if one was specified when the configuration was set.

typeConfigurationDetails_arn :: Lens' TypeConfigurationDetails (Maybe Text)

The Amazon Resource Name (ARN) for the configuration data, in this account and region.

typeConfigurationDetails_configuration :: Lens' TypeConfigurationDetails (Maybe Text)

A JSON string specifying the configuration data for the extension, in this account and region.

If a configuration hasn't been set for a specified extension, CloudFormation returns {}.

typeConfigurationDetails_isDefaultConfiguration :: Lens' TypeConfigurationDetails (Maybe Bool)

Whether this configuration data is the default configuration for the extension.

typeConfigurationDetails_lastUpdated :: Lens' TypeConfigurationDetails (Maybe UTCTime)

When the configuration data was last updated for this extension.

If a configuration hasn't been set for a specified extension, CloudFormation returns null.

typeConfigurationDetails_typeArn :: Lens' TypeConfigurationDetails (Maybe Text)

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.

typeConfigurationDetails_typeName :: Lens' TypeConfigurationDetails (Maybe Text)

The name of the extension.

TypeConfigurationIdentifier

typeConfigurationIdentifier_type :: Lens' TypeConfigurationIdentifier (Maybe ThirdPartyType)

The type of extension.

typeConfigurationIdentifier_typeArn :: Lens' TypeConfigurationIdentifier (Maybe Text)

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.

typeConfigurationIdentifier_typeConfigurationAlias :: Lens' TypeConfigurationIdentifier (Maybe Text)

The alias specified for this configuration, if one was specified when the configuration was set.

typeConfigurationIdentifier_typeConfigurationArn :: Lens' TypeConfigurationIdentifier (Maybe Text)

The Amazon Resource Name (ARN) for the configuration, in this account and region.

typeConfigurationIdentifier_typeName :: Lens' TypeConfigurationIdentifier (Maybe Text)

The name of the extension type to which this configuration applies.

TypeFilters

typeFilters_category :: Lens' TypeFilters (Maybe Category)

The category of extensions to return.

• REGISTERED: Private extensions that have been registered for this account and region.
• ACTIVATED: Public extensions that have been activated for this account and region.

• THIRD_PARTY: Extensions available for use from publishers other than Amazon. This includes:

  • Private extensions registered in the account.
  • Public extensions from publishers other than Amazon, whether activated or not.
• AWS_TYPES: Extensions available for use from Amazon.

typeFilters_publisherId :: Lens' TypeFilters (Maybe Text)

The id of the publisher of the extension.

Extensions published by Amazon aren't assigned a publisher ID. Use the AWS_TYPES category to specify a list of types published by Amazon.

typeFilters_typeNamePrefix :: Lens' TypeFilters (Maybe Text)

A prefix to use as a filter for results.

TypeSummary

typeSummary_defaultVersionId :: Lens' TypeSummary (Maybe Text)

The ID of the default version of the extension. The default version is used when the extension version isn't specified.

This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon and published by third parties, CloudFormation returns null. For more information, see RegisterType.

To set the default version of an extension, use SetTypeDefaultVersion .

typeSummary_description :: Lens' TypeSummary (Maybe Text)

The description of the extension.

typeSummary_isActivated :: Lens' TypeSummary (Maybe Bool)

Whether the extension is activated for this account and region.

This applies only to third-party public extensions. Extensions published by Amazon are activated by default.

typeSummary_lastUpdated :: Lens' TypeSummary (Maybe UTCTime)

When the specified extension version was registered. This applies only to:

• Private extensions you have registered in your account. For more information, see RegisterType.
• Public extensions you have activated in your account with auto-update specified. For more information, see ActivateType.

For all other extension types, CloudFormation returns null.

typeSummary_latestPublicVersion :: Lens' TypeSummary (Maybe Text)

For public extensions that have been activated for this account and region, the latest version of the public extension that is available. For any extensions other than activated third-arty extensions, CloudFormation returns null.

How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically updates the extension in this account and region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions in the CloudFormation User Guide.

typeSummary_originalTypeName :: Lens' TypeSummary (Maybe Text)

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.

typeSummary_publicVersionNumber :: Lens' TypeSummary (Maybe Text)

For public extensions that have been activated for this account and region, the version of the public extension to be used for CloudFormation operations in this account and Region.

How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically updates the extension in this account and region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions in the CloudFormation User Guide.

typeSummary_publisherId :: Lens' TypeSummary (Maybe Text)

The ID of the extension publisher, if the extension is published by a third party. Extensions published by Amazon don't return a publisher ID.

typeSummary_publisherIdentity :: Lens' TypeSummary (Maybe IdentityProvider)

The service used to verify the publisher identity.

For more information, see Registering your account to publish CloudFormation extensions in the CFN-CLI User Guide for Extension Development.

typeSummary_publisherName :: Lens' TypeSummary (Maybe Text)

The publisher name, as defined in the public profile for that publisher in the service used to verify the publisher identity.

typeSummary_type :: Lens' TypeSummary (Maybe RegistryType)

The kind of extension.

typeSummary_typeArn :: Lens' TypeSummary (Maybe Text)

The Amazon Resource Name (ARN) of the extension.

typeSummary_typeName :: Lens' TypeSummary (Maybe Text)

The name of the extension.

If you specified a TypeNameAlias when you activate this extension in your account and region, CloudFormation considers that alias as the type name.

TypeVersionSummary

typeVersionSummary_arn :: Lens' TypeVersionSummary (Maybe Text)

The Amazon Resource Name (ARN) of the extension version.

typeVersionSummary_description :: Lens' TypeVersionSummary (Maybe Text)

The description of the extension version.

typeVersionSummary_isDefaultVersion :: Lens' TypeVersionSummary (Maybe Bool)

Whether the specified extension version is set as the default version.

This applies only to private extensions you have registered in your account, and extensions published by Amazon. For public third-party extensions, CloudFormation returns null.

typeVersionSummary_publicVersionNumber :: Lens' TypeVersionSummary (Maybe Text)

For public extensions that have been activated for this account and region, the version of the public extension to be used for CloudFormation operations in this account and region. For any extensions other than activated third-arty extensions, CloudFormation returns null.

How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically updates the extension in this account and region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions in the CloudFormation User Guide.

typeVersionSummary_timeCreated :: Lens' TypeVersionSummary (Maybe UTCTime)

When the version was registered.

typeVersionSummary_type :: Lens' TypeVersionSummary (Maybe RegistryType)

The kind of extension.

typeVersionSummary_typeName :: Lens' TypeVersionSummary (Maybe Text)

The name of the extension.

typeVersionSummary_versionId :: Lens' TypeVersionSummary (Maybe Text)

The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it's registered.