The status of the account gate function.
\n\n SUCCEEDED: The account gate function has determined that the account and\n Region passes any requirements for a stack set operation to occur. CloudFormation\n proceeds with the stack operation in that account and Region.
\n FAILED: The account gate function has determined that the account and Region\n doesn't meet the requirements for a stack set operation to occur. CloudFormation cancels\n the stack set operation in that account and Region, and sets the stack set operation result\n status for that account and Region to FAILED.
\n SKIPPED: CloudFormation has skipped calling the account gate function for\n 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.
\nThe AWSCloudFormationStackSetExecutionRole of the stack set administration\n account lacks permissions to invoke the function. CloudFormation proceeds with the\n 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.
\nThe status of the account gate function.
\n\n SUCCEEDED: The account gate function has determined that the account and Region passes any\n requirements for a stack set operation to occur. CloudFormation proceeds with the stack operation in that account and\n Region.
\n FAILED: The account gate function has determined that the account and Region doesn't meet the\n requirements for a stack set operation to occur. CloudFormation cancels the stack set operation in that account and Region,\n and sets the stack set operation result status for that account and Region to FAILED.
\n SKIPPED: CloudFormation has skipped calling the account gate function for this account and Region, for one\n of the following reasons:
An account gate function hasn't been specified for the account and Region. CloudFormation proceeds with the stack set\n operation in this account and Region.
\nThe AWSCloudFormationStackSetExecutionRole of the stack set administration account lacks\n permissions to invoke the function. CloudFormation proceeds with the stack set operation in this account and\n Region.
Either no action is necessary, or no action is possible, on the stack. CloudFormation skips the stack set operation\n in this account and Region.
\nThe reason for the account gate status assigned to this account and Region for the stack set\n operation.
" + "smithy.api#documentation": "The reason for the account gate status assigned to this account and Region for the stack set operation.
" } } }, "traits": { - "smithy.api#documentation": "Structure that contains the results of the account gate function which CloudFormation\n invokes, if present, before proceeding with a stack set operation in an account and\n Region.
\nFor each account and Region, CloudFormation lets you specify a Lambda\n function that encapsulates any requirements that must be met before CloudFormation can\n proceed with a stack set operation in that account and Region. CloudFormation invokes\n the function each time a stack set operation is requested for that account and Region; if the\n function returns FAILED, CloudFormation cancels the operation in that\n account and Region, and sets the stack set operation result status for that account and Region to\n FAILED.
For more information, see Configuring a target\n account gate.
" + "smithy.api#documentation": "Structure that contains the results of the account gate function which CloudFormation invokes, if present, before\n proceeding with a stack set operation in an account and Region.
\nFor each account and Region, CloudFormation lets you specify a Lambda function that encapsulates any\n requirements that must be met before CloudFormation can proceed with a stack set operation in that account and Region.\n CloudFormation invokes the function each time a stack set operation is requested for that account and Region; if the\n function returns FAILED, CloudFormation cancels the operation in that account and Region, and sets the stack\n set operation result status for that account and Region to FAILED.
For more information, see Configuring a target account\n gate.
" } }, "com.amazonaws.cloudformation#AccountGateStatus": { @@ -130,7 +130,7 @@ } }, "traits": { - "smithy.api#documentation": "The AccountLimit data type.
\nCloudFormation has the following limits per account:
\nNumber of concurrent resources
\nNumber of stacks
\nNumber of stack outputs
\nFor more information about these account limits, and other CloudFormation limits, see CloudFormation\n quotas in the CloudFormation User Guide.
" + "smithy.api#documentation": "The AccountLimit data type.
\nCloudFormation has the following limits per account:
\nNumber of concurrent resources
\nNumber of stacks
\nNumber of stack outputs
\nFor more information about these account limits, and other CloudFormation limits, see CloudFormation quotas in the\n CloudFormation User Guide.
" } }, "com.amazonaws.cloudformation#AccountLimitList": { @@ -172,7 +172,7 @@ } ], "traits": { - "smithy.api#documentation": "Activate trusted access with Organizations. With trusted access between StackSets\n and Organizations activated, the management account has permissions to create\n and manage StackSets for your organization.
" + "smithy.api#documentation": "Activate trusted access with Organizations. With trusted access between StackSets and Organizations\n activated, the management account has permissions to create and manage StackSets for your\n organization.
" } }, "com.amazonaws.cloudformation#ActivateOrganizationsAccessInput": { @@ -206,7 +206,7 @@ } ], "traits": { - "smithy.api#documentation": "Activates a public third-party extension, making it available for use in stack templates. For more information,\n see Using public\n extensions in the CloudFormation User Guide.
\nOnce you have activated a public third-party extension in your account and Region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see\n Configuring extensions at\n the account level in the CloudFormation User Guide.
", + "smithy.api#documentation": "Activates a public third-party extension, making it available for use in stack templates. For more information,\n see Using public\n extensions in the CloudFormation User Guide.
\nOnce you have activated a public third-party extension in your account and Region, use \n SetTypeConfiguration\n to specify configuration properties for the extension. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
The extension type.
\nConditional: You must specify PublicTypeArn, or TypeName, Type, and\n PublisherId.
The extension type.
\nConditional: You must specify PublicTypeArn, or TypeName, Type, and\n PublisherId.
The Amazon Resource Name (ARN) of the public extension.
\nConditional: You must specify PublicTypeArn, or TypeName, Type, and\n PublisherId.
The Amazon Resource Name (ARN) of the public extension.
\nConditional: You must specify PublicTypeArn, or TypeName, Type, and\n PublisherId.
The ID of the extension publisher.
\nConditional: You must specify PublicTypeArn, or TypeName, Type, and\n PublisherId.
The ID of the extension publisher.
\nConditional: You must specify PublicTypeArn, or TypeName, Type, and\n PublisherId.
The name of the extension.
\nConditional: You must specify PublicTypeArn, or TypeName, Type, and\n PublisherId.
The name of the extension.
\nConditional: You must specify PublicTypeArn, or TypeName, Type, and\n PublisherId.
An alias to assign to the public extension, in this account and Region. If you specify an alias for the\n extension, CloudFormation treats the alias as the extension type name within this account and Region. You\n must use the alias to refer to the extension in your templates, API calls, and CloudFormation\n console.
\nAn extension alias must be unique within a given account and Region. You can activate the same public resource\n multiple times in the same account and Region, using different type name aliases.
" + "smithy.api#documentation": "An alias to assign to the public extension, in this account and Region. If you specify an alias for the\n extension, CloudFormation treats the alias as the extension type name within this account and Region. You must use the\n alias to refer to the extension in your templates, API calls, and CloudFormation console.
\nAn extension alias must be unique within a given account and Region. You can activate the same public resource\n multiple times in the same account and Region, using different type name aliases.
" } }, "AutoUpdate": { @@ -264,13 +264,13 @@ "VersionBump": { "target": "com.amazonaws.cloudformation#VersionBump", "traits": { - "smithy.api#documentation": "Manually updates a previously-activated type to a new major or minor version, if available. You can also use\n this parameter to update the value of AutoUpdate.
\n MAJOR: CloudFormation updates the extension to the newest major version, if one is\n available.
\n MINOR: CloudFormation updates the extension to the newest minor version, if one is\n available.
Manually updates a previously-activated type to a new major or minor version, if available. You can also use\n this parameter to update the value of AutoUpdate.
\n MAJOR: CloudFormation updates the extension to the newest major version, if one is available.
\n MINOR: CloudFormation updates the extension to the newest minor version, if one is available.
The major version of this extension you want to activate, if multiple major versions are available. The default\n is the latest major version. CloudFormation uses the latest available minor version of\n the major version selected.
\nYou can specify MajorVersion or VersionBump, but not both.
The major version of this extension you want to activate, if multiple major versions are available. The default\n is the latest major version. CloudFormation uses the latest available minor version of the major\n version selected.
\nYou can specify MajorVersion or VersionBump, but not both.
If set to true, StackSets automatically deploys additional stack instances to\n Organizations accounts that are added to a target organization or organizational unit\n (OU) in the specified Regions. If an account is removed from a target organization or OU,\n StackSets deletes stack instances from the account in the specified Regions.
If set to true, StackSets automatically deploys additional stack instances to Organizations\n accounts that are added to a target organization or organizational unit (OU) in the specified Regions. If an account\n is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified\n Regions.
If set to true, stack resources are retained when an account is removed from a\n target organization or OU. If set to false, stack resources are deleted. Specify\n only if Enabled is set to True.
If set to true, stack resources are retained when an account is removed from a target organization\n or OU. If set to false, stack resources are deleted. Specify only if Enabled is set to\n True.
[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit\n (OU).
" + "smithy.api#documentation": "[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations\n accounts that are added to a target organization or organizational unit (OU).
" } }, "com.amazonaws.cloudformation#AutoDeploymentNullable": { @@ -364,7 +364,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and Region.
\nFor more information, see Configuring extensions at\n the account level in the CloudFormation User Guide.
" + "smithy.api#documentation": "Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry\n for the account and Region.
\nFor more information, see Configuring extensions at\n the account level in the CloudFormation User Guide.
" } }, "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsError": { @@ -427,7 +427,7 @@ "UnprocessedTypeConfigurations": { "target": "com.amazonaws.cloudformation#UnprocessedTypeConfigurations", "traits": { - "smithy.api#documentation": "A list of any of the specified extension configurations that CloudFormation could not process for any\n reason.
" + "smithy.api#documentation": "A list of any of the specified extension configurations that CloudFormation could not process for any reason.
" } }, "TypeConfigurations": { @@ -514,14 +514,14 @@ "target": "com.amazonaws.cloudformation#StackName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "If you don't pass a parameter to StackName, the API returns a response that describes\n all resources in the account.
The IAM policy below can be added to\n IAM policies when you want to limit resource-level permissions and\n avoid returning a response when no parameter is sent in the request:
\n\n { \"Version\": \"2012-10-17\", \"Statement\": [{ \"Effect\": \"Deny\", \"Action\":\n \"cloudformation:DescribeStacks\", \"NotResource\":\n \"arn:aws:cloudformation:*:*:stack/*/*\" }] }\n
The name or the unique stack ID that's associated with the stack.
", + "smithy.api#documentation": "If you don't pass a parameter to StackName, the API returns a response that describes all\n resources in the account.
The IAM policy below can be added to IAM policies when you want to limit resource-level permissions and\n avoid returning a response when no parameter is sent in the request:
\n\n { \"Version\": \"2012-10-17\", \"Statement\": [{ \"Effect\": \"Deny\", \"Action\": \"cloudformation:DescribeStacks\",\n \"NotResource\": \"arn:aws:cloudformation:*:*:stack/*/*\" }] }\n
The name or the unique stack ID that's associated with the stack.
", "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "A unique identifier for this CancelUpdateStack request. Specify this token if you plan to retry\n requests so that CloudFormation knows that you're not attempting to cancel an update on a stack with the same\n name. You might retry CancelUpdateStack requests to ensure that CloudFormation successfully received\n them.
A unique identifier for this CancelUpdateStack request. Specify this token if you plan to retry\n requests so that CloudFormation knows that you're not attempting to cancel an update on a stack with the same name. You might\n retry CancelUpdateStack requests to ensure that CloudFormation successfully received them.
The type of entity that CloudFormation changes. Currently, the only entity type is\n Resource.
The type of entity that CloudFormation changes. Currently, the only entity type is Resource.
A ResourceChange structure that describes the resource and action that CloudFormation will\n perform.
A ResourceChange structure that describes the resource and action that CloudFormation will perform.
The Change structure describes the changes CloudFormation will perform if you execute the\n change set.
The Change structure describes the changes CloudFormation will perform if you execute the change set.
The unique name for your hook. Specifies a three-part namespace for your hook, with a recommended pattern of\n Organization::Service::Hook.
The following organization namespaces are reserved and can't be used in your hook type names:
\n\n Alexa\n
\n AMZN\n
\n Amazon\n
\n ASK\n
\n AWS\n
\n Custom\n
\n Dev\n
The unique name for your hook. Specifies a three-part namespace for your hook, with a recommended pattern of\n Organization::Service::Hook.
The following organization namespaces are reserved and can't be used in your hook type names:
\n\n Alexa\n
\n AMZN\n
\n Amazon\n
\n ASK\n
\n AWS\n
\n Custom\n
\n Dev\n
The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the\n ListChangeSets operation.
The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the\n ListChangeSets operation.
If the change set execution status is AVAILABLE, you can execute the change set. If you can't\n execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE\n state because CloudFormation is still creating it or in an OBSOLETE state because the stack was\n already updated.
If the change set execution status is AVAILABLE, you can execute the change set. If you can't\n execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE\n state because CloudFormation is still creating it or in an OBSOLETE state because the stack was already\n updated.
The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or\n FAILED.
The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or\n FAILED.
A description of the change set's status. For example, if your change set is in the FAILED state,\n CloudFormation shows the error message.
A description of the change set's status. For example, if your change set is in the FAILED state,\n CloudFormation shows the error message.
CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably\n and repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build\n highly reliable, highly scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services infrastructure.
\nWith CloudFormation, you declare all your resources and dependencies in a template file. The template\n defines a collection of resources as a single unit called a stack. CloudFormation creates and deletes all member\n resources of the stack together and manages all dependencies between the resources for you.
\nFor more information about CloudFormation, see the CloudFormation product page.
\nCloudFormation makes use of other Amazon Web Services products. If you need additional technical information\n about a specific Amazon Web Services product, you can find the product's technical documentation at docs.aws.amazon.com.
", + "smithy.api#documentation": "CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably and\n repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly reliable, highly\n scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services\n infrastructure.
\nWith CloudFormation, you declare all your resources and dependencies in a template file. The template defines a\n collection of resources as a single unit called a stack. CloudFormation creates and deletes all member resources of the stack\n together and manages all dependencies between the resources for you.
\nFor more information about CloudFormation, see the CloudFormation\n product page.
\nCloudFormation makes use of other Amazon Web Services products. If you need additional technical information about a\n specific Amazon Web Services product, you can find the product's technical documentation at docs.aws.amazon.com.
", "smithy.api#title": "AWS CloudFormation", "smithy.api#xmlNamespace": { "uri": "http://cloudformation.amazonaws.com/doc/2010-05-15/" @@ -2414,7 +2414,7 @@ } ], "traits": { - "smithy.api#documentation": "For a specified stack that's in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the\n UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can manually fix the\n error and continue the rollback. By continuing the rollback, you can return your stack to a working state\n (the UPDATE_ROLLBACK_COMPLETE state), and then try to update the stack again.
A stack goes into the UPDATE_ROLLBACK_FAILED state when CloudFormation can't roll back all\n changes after a failed stack update. For example, you might have a stack that's rolling back to an old database\n instance that was deleted outside of CloudFormation. Because CloudFormation doesn't know the database was\n deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update\n rollback to fail.
For a specified stack that's in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the\n UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can manually fix the\n error and continue the rollback. By continuing the rollback, you can return your stack to a working state\n (the UPDATE_ROLLBACK_COMPLETE state), and then try to update the stack again.
A stack goes into the UPDATE_ROLLBACK_FAILED state when CloudFormation can't roll back all changes after\n a failed stack update. For example, you might have a stack that's rolling back to an old database instance that was\n deleted outside of CloudFormation. Because CloudFormation doesn't know the database was deleted, it assumes that the database instance\n still exists and attempts to roll back to it, causing the update rollback to fail.
The name or the unique ID of the stack that you want to continue rolling back.
\nDon't specify the name of a nested stack (a stack that was created by using the\n AWS::CloudFormation::Stack resource). Instead, use this operation on the parent stack (the stack that\n contains the AWS::CloudFormation::Stack resource).
The name or the unique ID of the stack that you want to continue rolling back.
\nDon't specify the name of a nested stack (a stack that was created by using the\n AWS::CloudFormation::Stack resource). Instead, use this operation on the parent stack (the stack that\n contains the AWS::CloudFormation::Stack resource).
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.\n CloudFormation always uses this role for all future operations on the stack. Provided that users have\n permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to\n pass it. Ensure that the role grants least permission.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with the\n stack. If no role is available, CloudFormation uses a temporary session that's generated from your user\n credentials.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to\n roll back the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this\n role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation\n uses this role even if the users don't have permission to pass it. Ensure that the role grants least\n permission.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role\n is available, CloudFormation uses a temporary session that's generated from your user credentials.
" } }, "ResourcesToSkip": { "target": "com.amazonaws.cloudformation#ResourcesToSkip", "traits": { - "smithy.api#documentation": "A list of the logical IDs of the resources that CloudFormation skips during the continue update rollback\n operation. You can specify only resources that are in the UPDATE_FAILED state because a rollback failed.\n You can't specify resources that are in the UPDATE_FAILED state for other reasons, for example, because\n an update was canceled. To check why a resource update failed, use the DescribeStackResources\n action, and view the resource status reason.
Specify this property to skip rolling back resources that CloudFormation can't successfully roll back.\n We recommend that you \n troubleshoot resources before skipping them. CloudFormation sets the status of the specified\n resources to UPDATE_COMPLETE and continues to roll back the stack. After the rollback is complete, the\n state of the skipped resources will be inconsistent with the state of the resources in the stack template. Before\n performing another stack update, you must update the stack or resources to be consistent with each other. If you\n 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\n resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the\n dependent resources.
\nTo skip resources that are part of nested stacks, use the following format:\n NestedStackName.ResourceLogicalID. If you want to specify the logical ID of a stack resource\n (Type: AWS::CloudFormation::Stack) in the ResourcesToSkip list, then its corresponding\n embedded stack must be in one of the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE,\n or DELETE_FAILED.
Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an\n example of a continue update rollback operation with nested stacks, see Using\n ResourcesToSkip to recover a nested stacks hierarchy.
\nA list of the logical IDs of the resources that CloudFormation skips during the continue update rollback operation.\n You can specify only resources that are in the UPDATE_FAILED state because a rollback failed. You can't\n specify resources that are in the UPDATE_FAILED state for other reasons, for example, because an update\n was canceled. To check why a resource update failed, use the DescribeStackResources action, and\n view the resource status reason.
Specify this property to skip rolling back resources that CloudFormation can't successfully roll back. We recommend\n that you \n troubleshoot resources before skipping them. CloudFormation sets the status of the specified resources to\n UPDATE_COMPLETE and continues to roll back the stack. After the rollback is complete, the state of the\n skipped resources will be inconsistent with the state of the resources in the stack template. Before performing\n another stack update, you must update the stack or resources to be consistent with each other. If you don't,\n 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\n resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the\n dependent resources.
\nTo skip resources that are part of nested stacks, use the following format:\n NestedStackName.ResourceLogicalID. If you want to specify the logical ID of a stack resource\n (Type: AWS::CloudFormation::Stack) in the ResourcesToSkip list, then its corresponding\n embedded stack must be in one of the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE,\n or DELETE_FAILED.
Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an\n example of a continue update rollback operation with nested stacks, see Using\n ResourcesToSkip to recover a nested stacks hierarchy.
\nA unique identifier for this ContinueUpdateRollback request. Specify this token if you plan to\n retry requests so that CloudFormation knows that you're not attempting to continue the rollback to a stack with\n the same name. You might retry ContinueUpdateRollback requests to ensure that CloudFormation\n successfully received them.
A unique identifier for this ContinueUpdateRollback request. Specify this token if you plan to\n retry requests so that CloudFormation knows that you're not attempting to continue the rollback to a stack with the same name.\n You might retry ContinueUpdateRollback requests to ensure that CloudFormation successfully received\n them.
Creates a list of changes that will be applied to a stack so that you can review the changes before executing\n them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set for\n a stack that doesn't exist, the change set shows all of the resources that CloudFormation will create. If you\n create a change set for an existing stack, CloudFormation compares the stack's information with the information\n that you submit in the change set and lists the differences. Use change sets to understand which resources CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update\n a stack.
\nTo create a change set for a stack that doesn't exist, for the ChangeSetType parameter, specify\n CREATE. To create a change set for an existing stack, specify UPDATE for the\n ChangeSetType parameter. To create a change set for an import operation, specify IMPORT\n for the ChangeSetType parameter. After the CreateChangeSet call successfully completes,\n CloudFormation starts creating the change set. To check the status of the change set or to review it, use the\n DescribeChangeSet action.
When you are satisfied with the changes the change set will make, execute the change set by using the ExecuteChangeSet action. CloudFormation doesn't make changes until you execute the change\n set.
\nTo create a change set for the entire stack hierarchy, set IncludeNestedStacks to\n True.
Creates a list of changes that will be applied to a stack so that you can review the changes before executing\n them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set for\n a stack that doesn't exist, the change set shows all of the resources that CloudFormation will create. If you create a change\n set for an existing stack, CloudFormation compares the stack's information with the information that you submit in the change\n set and lists the differences. Use change sets to understand which resources CloudFormation will create or\n change, and how it will change resources in an existing stack, before you create or update a stack.
\nTo create a change set for a stack that doesn't exist, for the ChangeSetType parameter, specify\n CREATE. To create a change set for an existing stack, specify UPDATE for the\n ChangeSetType parameter. To create a change set for an import operation, specify IMPORT for\n the ChangeSetType parameter. After the CreateChangeSet call successfully completes, CloudFormation starts creating the change set. To check the status of the change set or to review it, use the DescribeChangeSet action.
When you are satisfied with the changes the change set will make, execute the change set by using the ExecuteChangeSet action. CloudFormation doesn't make changes until you execute the change set.
\nTo create a change set for the entire stack hierarchy, set IncludeNestedStacks to\n True.
The name or the unique ID of the stack for which you are creating a change set. CloudFormation generates the\n change set by comparing this stack's information with the information that you submit, such as a modified template or\n different parameter input values.
", + "smithy.api#documentation": "The name or the unique ID of the stack for which you are creating a change set. CloudFormation generates the change set\n by comparing this stack's information with the information that you submit, such as a modified template or different\n parameter input values.
", "smithy.api#required": {} } }, "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { - "smithy.api#documentation": "A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length\n of 51,200 bytes. CloudFormation generates the change set by comparing this template with the template of the\n stack that you specified.
\nConditional: You must specify only TemplateBody or TemplateURL.
A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length\n of 51,200 bytes. CloudFormation generates the change set by comparing this template with the template of the stack that you\n specified.
\nConditional: You must specify only TemplateBody or TemplateURL.
The location of the file that contains the revised template. The URL must point to a template (max size: 460,800\n bytes) that's located in an Amazon S3 bucket or a Systems Manager document. CloudFormation generates the\n change set by comparing this template with the stack that you specified.
\nConditional: You must specify only TemplateBody or TemplateURL.
The location of the file that contains the revised template. The URL must point to a template (max size: 460,800\n bytes) that's located in an Amazon S3 bucket or a Systems Manager document. CloudFormation generates the change set by\n comparing this template with the stack that you specified. The location for an Amazon S3 bucket must start with\n https://.
Conditional: You must specify only TemplateBody or TemplateURL.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order\n for CloudFormation to create the stack.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must\n explicitly acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all permissions associated with\n them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM\n resources in CloudFormation templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some template contain macros. Macros perform custom processing on templates; this can include simple actions\n like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this,\n users typically create a change set from the processed template, so that they can review the changes resulting from\n the macros before actually creating the stack. If your stack template contains one or more macros, and you choose\n to create a stack directly from the processed template, without first reviewing the resulting changes in a change\n set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which\n are macros hosted by CloudFormation.
\nThis capacity doesn't apply to creating change sets, and specifying it when creating change sets has no\n effect.
\nIf you want to create a stack from a stack template that contains macros and nested\n stacks, you must create or update the stack directly from the template using the CreateStack or\n UpdateStack action, and specifying this capability.
\nFor more information about macros, see Using CloudFormation macros to perform custom\n processing on templates.
\nOnly one of the Capabilities and ResourceType parameters can be specified.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order\n for CloudFormation to create the stack.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly\n acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all permissions associated with\n them and edit their permissions if necessary.
\n\n \n AWS::IAM::AccessKey\n \n
\n \n AWS::IAM::Group\n \n
\n \n AWS::IAM::Policy\n \n
\n \n AWS::IAM::Role\n \n
\n \n AWS::IAM::User\n \n
For more information, see Acknowledging IAM resources in\n CloudFormation templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some template contain macros. Macros perform custom processing on templates; this can include simple actions\n like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this,\n users typically create a change set from the processed template, so that they can review the changes resulting from\n the macros before actually creating the stack. If your stack template contains one or more macros, and you choose\n to create a stack directly from the processed template, without first reviewing the resulting changes in a change\n set, you must acknowledge this capability. This includes the \n AWS::Include\n and \n AWS::Serverless\n transforms, which\n are macros hosted by CloudFormation.
This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no\n effect.
\nIf you want to create a stack from a stack template that contains macros and nested\n stacks, you must create or update the stack directly from the template using the CreateStack or\n UpdateStack action, and specifying this capability.
\nFor more information about macros, see Using CloudFormation macros to perform custom processing on\n templates.
\nOnly one of the Capabilities and ResourceType parameters can be specified.
The template resource types that you have permissions to work with if you execute this change set, such as\n 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\n default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM)\n uses this parameter for condition keys in IAM policies for CloudFormation. For more information,\n see Controlling access\n with Identity and Access Management in the CloudFormation User Guide.
\nOnly one of the Capabilities and ResourceType parameters can be specified.
The template resource types that you have permissions to work with if you execute this change set, such as\n 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\n default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for\n condition keys in IAM policies for CloudFormation. For more information, see Controlling access with Identity and Access Management in the CloudFormation User Guide.
\nOnly one of the Capabilities and ResourceType parameters can be specified.
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation\n assumes when executing the change set. CloudFormation uses the role's credentials to make calls on your behalf.\n CloudFormation uses this role for all future operations on the stack. Provided that users have permission to\n operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure\n that the role grants least permission.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If\n no role is available, CloudFormation uses a temporary session that is generated from your user\n credentials.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes when executing the\n change set. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation uses this role for all future\n operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if\n the users don't have permission to pass it. Ensure that the role grants least permission.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is\n available, CloudFormation uses a temporary session that is generated from your user credentials.
" } }, "RollbackConfiguration": { "target": "com.amazonaws.cloudformation#RollbackConfiguration", "traits": { - "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for\n the specified monitoring period afterwards.
" + "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified\n monitoring period afterwards.
" } }, "NotificationARNs": { "target": "com.amazonaws.cloudformation#NotificationARNs", "traits": { - "smithy.api#documentation": "The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that CloudFormation\n associates with the stack. To remove all associated notification topics, specify an empty list.
" + "smithy.api#documentation": "The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that CloudFormation associates\n with the stack. To remove all associated notification topics, specify an empty list.
" } }, "Tags": { "target": "com.amazonaws.cloudformation#Tags", "traits": { - "smithy.api#documentation": "Key-value pairs to associate with this stack. CloudFormation also propagates these tags to resources in the\n stack. You can specify a maximum of 50 tags.
" + "smithy.api#documentation": "Key-value pairs to associate with this stack. CloudFormation also propagates these tags to resources in the stack. You\n can specify a maximum of 50 tags.
" } }, "ChangeSetName": { @@ -2565,7 +2565,7 @@ "ClientToken": { "target": "com.amazonaws.cloudformation#ClientToken", "traits": { - "smithy.api#documentation": "A unique identifier for this CreateChangeSet request. Specify this token if you plan to retry\n requests so that CloudFormation knows that you're not attempting to create another change set with the same name.\n You might retry CreateChangeSet requests to ensure that CloudFormation successfully received\n them.
A unique identifier for this CreateChangeSet request. Specify this token if you plan to retry\n requests so that CloudFormation knows that you're not attempting to create another change set with the same name. You might\n retry CreateChangeSet requests to ensure that CloudFormation successfully received them.
The type of change set operation. To create a change set for a new stack, specify CREATE. To create\n a change set for an existing stack, specify UPDATE. To create a change set for an import operation,\n specify IMPORT.
If you create a change set for a new stack, CloudFormation creates a stack with a unique stack ID, but no\n template or resources. The stack will be in the REVIEW_IN_PROGRESS state\n until you execute the change set.
\nBy default, CloudFormation specifies UPDATE. You can't use the UPDATE type to\n create a change set for a new stack or the CREATE type to create a change set for an existing\n stack.
The type of change set operation. To create a change set for a new stack, specify CREATE. To create\n a change set for an existing stack, specify UPDATE. To create a change set for an import operation,\n 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\n resources. The stack will be in the REVIEW_IN_PROGRESS state\n until you execute the change set.
\nBy default, CloudFormation specifies UPDATE. You can't use the UPDATE type to create a change\n set for a new stack or the CREATE type to create a change set for an existing stack.
Determines what action will be taken if stack creation fails. If this parameter is specified, the\n DisableRollback parameter to the ExecuteChangeSet API operation must not\n be specified. This must be one of these values:
\n DELETE - Deletes the change set if the stack creation fails. This is only valid when the\n ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status\n of the stack is DELETE_FAILED.
\n DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying\n true for the DisableRollback parameter to the ExecuteChangeSet API\n operation.
\n ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying\n false for the DisableRollback parameter to the ExecuteChangeSet API\n operation.
For nested stacks, when the OnStackFailure parameter is set to DELETE for the change\n set for the parent stack, any failure in a child stack will cause the parent stack creation to fail and all stacks to\n be deleted.
Determines what action will be taken if stack creation fails. If this parameter is specified, the\n DisableRollback parameter to the \n ExecuteChangeSet\n API operation must not\n be specified. This must be one of these values:
\n DELETE - Deletes the change set if the stack creation fails. This is only valid when the\n ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status\n of the stack is DELETE_FAILED.
\n DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying\n true for the DisableRollback parameter to the \n ExecuteChangeSet\n API\n operation.
\n ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying\n false for the DisableRollback parameter to the \n ExecuteChangeSet\n API\n operation.
For nested stacks, when the OnStackFailure parameter is set to DELETE for the change\n set for the parent stack, any failure in a child stack will cause the parent stack creation to fail and all stacks to\n be deleted.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's\n located in an Amazon S3 bucket or a Systems Manager document. For more information, go to the Template anatomy in the\n CloudFormation User Guide.
\nConditional: You must specify either the TemplateBody or the TemplateURL parameter,\n but not both.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's\n located in an Amazon S3 bucket or a Systems Manager document. For more information, go to the Template anatomy in the\n CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter,\n but not both.
A list of Parameter structures that specify input parameters for the stack. For more information,\n see the Parameter\n data type.
A list of Parameter structures that specify input parameters for the stack. For more information,\n see the \n Parameter\n \n data type.
Set to true to disable rollback of the stack if stack creation failed. You can specify either\n DisableRollback or OnFailure, but not both.
Default: false\n
Set to true to disable rollback of the stack if stack creation failed. You can specify either\n DisableRollback or OnFailure, but not both.
Default: false\n
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and\n for the specified monitoring period afterwards.
" + "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the\n specified monitoring period afterwards.
" } }, "TimeoutInMinutes": { @@ -2804,55 +2804,55 @@ "NotificationARNs": { "target": "com.amazonaws.cloudformation#NotificationARNs", "traits": { - "smithy.api#documentation": "The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events. You can find your\n Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).
" + "smithy.api#documentation": "The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events. You can find your\n Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).
" } }, "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order\n for CloudFormation to create the stack.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must\n explicitly acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with\n them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM\n Resources in CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some template contain macros. Macros perform custom processing on templates; this can include simple actions\n like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this,\n users typically create a change set from the processed template, so that they can review the changes resulting from\n the macros before actually creating the stack. If your stack template contains one or more macros, and you choose\n to create a stack directly from the processed template, without first reviewing the resulting changes in a change\n set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which\n are macros hosted by CloudFormation.
\nIf you want to create a stack from a stack template that contains macros and nested\n stacks, you must create the stack directly from the template using this capability.
\nYou should only create stacks directly from a stack template that contains macros if you know what processing\n the macro performs.
\nEach macro relies on an underlying Lambda service function for processing stack templates. Be\n aware that the Lambda function owner can update the function operation without CloudFormation being\n notified.
\nFor more information, see Using CloudFormation macros to perform custom\n processing on templates.
\nOnly one of the Capabilities and ResourceType parameters can be specified.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order\n for CloudFormation to create the stack.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly\n acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with\n them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n \n
\n \n AWS::IAM::Policy\n \n
\n \n AWS::IAM::Role\n \n
\n \n AWS::IAM::User\n \n
For more information, see Acknowledging IAM Resources in\n CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some template contain macros. Macros perform custom processing on templates; this can include simple actions\n like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this,\n users typically create a change set from the processed template, so that they can review the changes resulting from\n the macros before actually creating the stack. If your stack template contains one or more macros, and you choose\n to create a stack directly from the processed template, without first reviewing the resulting changes in a change\n set, you must acknowledge this capability. This includes the \n AWS::Include\n and \n AWS::Serverless\n transforms, which\n are macros hosted by CloudFormation.
If you want to create a stack from a stack template that contains macros and nested\n stacks, you must create the stack directly from the template using this capability.
\nYou should only create stacks directly from a stack template that contains macros if you know what processing\n the macro performs.
\nEach macro relies on an underlying Lambda service function for processing stack templates. Be\n aware that the Lambda function owner can update the function operation without CloudFormation being\n notified.
\nFor more information, see Using CloudFormation macros to perform custom processing\n on templates.
\nOnly one of the Capabilities and ResourceType parameters can be specified.
The template resource types that you have permissions to work with for this create stack action, such as\n AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. Use the\n following syntax to describe template resource types: AWS::* (for all Amazon Web Services resources),\n Custom::* (for all custom resources), Custom::logical_ID\n (for a specific custom resource), AWS::service_name::* (for all resources\n of a particular Amazon Web Services service), and\n AWS::service_name::resource_logical_ID\n (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\n default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM)\n uses this parameter for CloudFormation-specific condition keys in IAM policies. For more\n information, see Controlling Access with Identity and Access Management.
\nOnly one of the Capabilities and ResourceType parameters can be specified.
The template resource types that you have permissions to work with for this create stack action, such as\n AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. Use the\n following syntax to describe template resource types: AWS::* (for all Amazon Web Services resources),\n Custom::* (for all custom resources), Custom::logical_ID\n (for a\n specific custom resource), AWS::service_name::* (for all resources of a particular\n Amazon Web Services service), and\n AWS::service_name::resource_logical_ID\n (for a specific\n Amazon Web Services resource).
If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By\n default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for\n CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.
\nOnly one of the Capabilities and ResourceType parameters can be specified.
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.\n CloudFormation always uses this role for all future operations on the stack. Provided that users have\n permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to\n pass it. Ensure that the role grants least privilege.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with the\n stack. If no role is available, CloudFormation uses a temporary session that's generated from your user\n credentials.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to\n create the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role\n for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses\n this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role\n is available, CloudFormation uses a temporary session that's generated from your user credentials.
" } }, "OnFailure": { "target": "com.amazonaws.cloudformation#OnFailure", "traits": { - "smithy.api#documentation": "Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING,\n ROLLBACK, or DELETE. You can specify either OnFailure or\n DisableRollback, but not both.
Default: ROLLBACK\n
Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING,\n ROLLBACK, or DELETE. You can specify either OnFailure or\n DisableRollback, but not both.
Default: ROLLBACK\n
Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources in\n the CloudFormation User Guide. You can specify either the StackPolicyBody or the\n StackPolicyURL parameter, but not both.
Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources in\n the CloudFormation User Guide. You can specify either the StackPolicyBody or the\n StackPolicyURL parameter, but not both.
Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in\n an S3 bucket in the same Region as the stack. You can specify either the StackPolicyBody or the\n StackPolicyURL parameter, but not both.
Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in\n an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start with https://.\n You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not\n both.
Key-value pairs to associate with this stack. CloudFormation also propagates these tags to the resources\n created in the stack. A maximum number of 50 tags can be specified.
" + "smithy.api#documentation": "Key-value pairs to associate with this stack. CloudFormation also propagates these tags to the resources created in\n the stack. A maximum number of 50 tags can be specified.
" } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "A unique identifier for this CreateStack request. Specify this token if you plan to retry requests\n so that CloudFormation knows that you're not attempting to create a stack with the same name. You might retry\n 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\n track operations. For example, if you execute a CreateStack operation with the token\n token1, then all the StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that are\n initiated from the console use the token format Console-StackOperation-ID, which helps you\n easily identify the stack operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
A unique identifier for this CreateStack request. Specify this token if you plan to retry requests\n so that CloudFormation knows that you're not attempting to create a stack with the same name. You might retry\n 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\n track operations. For example, if you execute a CreateStack operation with the token\n token1, then all the StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that are\n initiated from the console use the token format Console-StackOperation-ID, which helps you\n easily identify the stack operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
When set to true, newly created resources are deleted when the operation rolls back. This includes newly\n created resources marked with a deletion policy of Retain.
Default: false\n
When set to true, newly created resources are deleted when the operation rolls back. This includes\n newly created resources marked with a deletion policy of Retain.
Default: false\n
Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack\n instance refers to a stack in a specific account and Region. You must specify at least one value for either\n Accounts or DeploymentTargets, and you must specify at least one value for\n Regions.
Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack\n instance refers to a stack in a specific account and Region. You must specify at least one value for either\n Accounts or DeploymentTargets, and you must specify at least one value for\n Regions.
The names of one or more Amazon Web Services Regions where you want to create stack instances using the specified\n Amazon Web Services accounts.
", + "smithy.api#documentation": "The names of one or more Amazon Web Services Regions where you want to create stack instances using the specified\n Amazon Web Services accounts.
", "smithy.api#required": {} } }, "ParameterOverrides": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "A list of stack set parameters whose values you want to override in the selected stack instances.
\nAny 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\n parameter values during stack instance operations:
\nTo override the current value for a parameter, include the parameter and specify its value.
\nTo leave an overridden parameter set to its present value, include the parameter and specify\n UsePreviousValue as true. (You can't specify both a value and set\n UsePreviousValue to true.)
To set an overridden parameter back to the value specified in the stack set, specify a parameter list but\n don't include the parameter in the list.
\nTo leave all parameters set to their present values, don't specify this property at all.
\nDuring stack set updates, any parameter values overridden for a stack instance aren't updated, but retain their\n overridden value.
\nYou can only override the parameter values that are specified in the stack set; to add or\n delete a parameter itself, use UpdateStackSet to update the stack set\n template.
" + "smithy.api#documentation": "A list of stack set parameters whose values you want to override in the selected stack instances.
\nAny 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\n during stack instance operations:
\nTo override the current value for a parameter, include the parameter and specify its value.
\nTo leave an overridden parameter set to its present value, include the parameter and specify\n UsePreviousValue as true. (You can't specify both a value and set\n UsePreviousValue to true.)
To set an overridden parameter back to the value specified in the stack set, specify a parameter list but\n don't include the parameter in the list.
\nTo leave all parameters set to their present values, don't specify this property at all.
\nDuring stack set updates, any parameter values overridden for a stack instance aren't updated, but retain their\n overridden value.
\nYou can only override the parameter values that are specified in the stack set; to add or\n delete a parameter itself, use \n UpdateStackSet\n to update the stack set\n template.
The unique identifier for this stack set operation.
\nThe operation ID also functions as an idempotency token, to ensure that CloudFormation performs the\n stack set operation only once, even if you retry the request multiple times. You might retry stack set operation\n requests to ensure that CloudFormation successfully received them.
\nIf you don't specify an operation ID, the SDK generates one automatically.
\nRepeating this stack set operation with a new operation ID retries all stack instances whose status is\n OUTDATED.
The unique identifier for this stack set operation.
\nThe operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set\n operation only once, even if you retry the request multiple times. You might retry stack set operation requests to\n ensure that CloudFormation successfully received them.
\nIf you don't specify an operation ID, the SDK generates one automatically.
\nRepeating this stack set operation with a new operation ID retries all stack instances whose status is\n OUTDATED.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\nThe location of the file that contains the template body. The URL must point to a template (maximum size:\n 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information, see\n Template Anatomy\n in the CloudFormation User Guide.
\nConditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
" + "smithy.api#documentation": "The location of the file that contains the template body. The URL must point to a template (maximum size:\n 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information, see\n Template Anatomy\n in the CloudFormation User Guide.
\nConditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
" } }, "StackId": { @@ -3062,49 +3062,49 @@ "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in\n order for CloudFormation to create the stack set and related stack instances.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stack sets, you must\n explicitly acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with\n them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM Resources in CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some templates reference macros. If your stack set template references one or more macros, you must create the\n stack set directly from the processed template, without first reviewing the resulting changes in a change set. To\n create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform\n Custom Processing on Templates.
\nStack sets with service-managed permissions don't currently support the use of macros in templates. (This\n includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a\n stack set with service-managed permissions, if you reference a macro in your template the stack set operation will\n fail.
\nIn some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in\n order for CloudFormation to create the stack set and related stack instances.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stack sets, you must explicitly\n acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with\n them and edit their permissions if necessary.
\n\n \n AWS::IAM::AccessKey\n \n
\n \n AWS::IAM::Group\n \n
\n \n AWS::IAM::Policy\n \n
\n \n AWS::IAM::Role\n \n
\n \n AWS::IAM::User\n \n
For more information, see Acknowledging IAM Resources in\n CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some templates reference macros. If your stack set template references one or more macros, you must create the\n stack set directly from the processed template, without first reviewing the resulting changes in a change set. To\n create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to\n Perform Custom Processing on Templates.
\nStack sets with service-managed permissions don't currently support the use of macros in templates. (This\n includes the \n AWS::Include\n and \n AWS::Serverless\n transforms, which\n are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions,\n if you reference a macro in your template the stack set operation will fail.
The key-value pairs to associate with this stack set and the stacks created from it. CloudFormation also\n propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be\n specified.
\nIf you specify tags as part of a CreateStackSet action, CloudFormation checks to see if you\n have the required IAM permission to tag resources. If you don't, the entire\n CreateStackSet action fails with an access denied error, and the stack set is not\n created.
The key-value pairs to associate with this stack set and the stacks created from it. CloudFormation also propagates\n these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be\n specified.
\nIf you specify tags as part of a CreateStackSet action, CloudFormation checks to see if you have the\n required IAM permission to tag resources. If you don't, the entire CreateStackSet action fails with an\n access denied error, and the stack set is not created.
The Amazon Resource Name (ARN) of the IAM role to use to create this stack set.
\nSpecify an IAM role only if you are using customized administrator roles to control which users\n or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set\n Operations in the CloudFormation User Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to use to create this stack set.
\nSpecify an IAM role only if you are using customized administrator roles to control which users or groups can\n manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting\n Permissions for Stack Set Operations in the CloudFormation User Guide.
" } }, "ExecutionRoleName": { "target": "com.amazonaws.cloudformation#ExecutionRoleName", "traits": { - "smithy.api#documentation": "The name of the IAM execution role to use to create the stack set. If you do not specify an\n execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set\n operation.
Specify an IAM role only if you are using customized execution roles to control which stack\n resources users and groups can include in their stack sets.
" + "smithy.api#documentation": "The name of the IAM execution role to use to create the stack set. If you do not specify an execution role,\n 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\n and groups can include in their stack sets.
" } }, "PermissionModel": { "target": "com.amazonaws.cloudformation#PermissionModels", "traits": { - "smithy.api#documentation": "Describes how the IAM roles required for stack set operations are created. By default,\n SELF-MANAGED is specified.
With self-managed permissions, you must create the administrator and execution roles required to\n deploy to target accounts. For more information, see Grant Self-Managed Stack Set\n Permissions.
With service-managed permissions, StackSets automatically creates the IAM roles\n required to deploy to accounts managed by Organizations. For more information, see Grant\n Service-Managed Stack Set Permissions.
Describes how the IAM roles required for stack set operations are created. By default,\n SELF-MANAGED is specified.
With self-managed permissions, you must create the administrator and execution roles required to\n deploy to target accounts. For more information, see Grant Self-Managed Stack Set\n Permissions.
With service-managed permissions, StackSets automatically creates the IAM roles required to\n deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set\n Permissions.
Describes whether StackSets automatically deploys to Organizations accounts that are added to the target\n organization or organizational unit (OU). Specify only if PermissionModel is\n SERVICE_MANAGED.
Describes whether StackSets automatically deploys to Organizations accounts that are added to the target\n organization or organizational unit (OU). Specify only if PermissionModel is\n SERVICE_MANAGED.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
To create a stack set with service-managed permissions while signed in to the management account,\n specify SELF.
To create a stack set with service-managed permissions while signed in to a delegated administrator account,\n specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated admin in the management account.\n For more information, see Register a delegated\n administrator in the CloudFormation User Guide.
\nStack sets with service-managed permissions are created in the management account, including stack\n sets that are created by delegated administrators.
" + "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
To create a stack set with service-managed permissions while signed in to the management account,\n specify SELF.
To create a stack set with service-managed permissions while signed in to a delegated administrator account,\n specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated admin in the management account.\n For more information, see Register a delegated\n administrator in the CloudFormation User Guide.
\nStack sets with service-managed permissions are created in the management account, including stack\n sets that are created by delegated administrators.
" } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "A unique identifier for this CreateStackSet request. Specify this token if you plan to retry\n requests so that CloudFormation knows that you're not attempting to create another stack set with the same\n name. You might retry CreateStackSet requests to ensure that CloudFormation successfully\n received them.
If you don't specify an operation ID, the SDK generates one automatically.
", + "smithy.api#documentation": "A unique identifier for this CreateStackSet request. Specify this token if you plan to retry\n requests so that CloudFormation knows that you're not attempting to create another stack set with the same name. You might\n retry CreateStackSet requests to ensure that CloudFormation successfully received them.
If you don't specify an operation ID, the SDK generates one automatically.
", "smithy.api#idempotencyToken": {} } }, @@ -3170,7 +3170,7 @@ } ], "traits": { - "smithy.api#documentation": "Deactivates trusted access with Organizations. If trusted access is deactivated,\n the management account does not have permissions to create and manage\n service-managed StackSets for your organization.
" + "smithy.api#documentation": "Deactivates trusted access with Organizations. If trusted access is deactivated, the management account does not have permissions to create and manage service-managed StackSets for your\n organization.
" } }, "com.amazonaws.cloudformation#DeactivateOrganizationsAccessInput": { @@ -3204,7 +3204,7 @@ } ], "traits": { - "smithy.api#documentation": "Deactivates a public extension that was previously activated in this account and Region.
\nOnce deactivated, an extension can't be used in any CloudFormation operation. This includes stack\n update operations where the stack template includes the extension, even if no updates are being made to the\n extension. In addition, deactivated extensions aren't automatically updated if a new version of the extension is\n released.
", + "smithy.api#documentation": "Deactivates a public extension that was previously activated in this account and Region.
\nOnce deactivated, an extension can't be used in any CloudFormation operation. This includes stack update operations\n where the stack template includes the extension, even if no updates are being made to the extension. In addition,\n deactivated extensions aren't automatically updated if a new version of the extension is released.
", "smithy.api#idempotent": {} } }, @@ -3365,19 +3365,19 @@ "RetainResources": { "target": "com.amazonaws.cloudformation#RetainResources", "traits": { - "smithy.api#documentation": "For stacks in the DELETE_FAILED state, a list of resource logical IDs that are associated with the\n resources you want to retain. During deletion, CloudFormation deletes the stack but doesn't delete the\n retained resources.
Retaining resources is useful when you can't delete a resource, such as a non-empty S3 bucket, but you want to\n delete the stack.
" + "smithy.api#documentation": "For stacks in the DELETE_FAILED state, a list of resource logical IDs that are associated with the\n resources you want to retain. During deletion, CloudFormation deletes the stack but doesn't delete the retained\n resources.
Retaining resources is useful when you can't delete a resource, such as a non-empty S3 bucket, but you want to\n delete the stack.
" } }, "RoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "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\n behalf.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with the\n stack. If no role is available, CloudFormation uses a temporary session that's generated from your user\n credentials.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to\n delete the stack. CloudFormation uses the role's credentials to make calls on your behalf.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role\n is available, CloudFormation uses a temporary session that's generated from your user credentials.
" } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "A unique identifier for this DeleteStack request. Specify this token if you plan to retry requests\n so that CloudFormation knows that you're not attempting to delete a stack with the same name. You might retry\n 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\n track operations. For example, if you execute a CreateStack operation with the token\n token1, then all the StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that are\n initiated from the console use the token format Console-StackOperation-ID, which helps you\n easily identify the stack operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
A unique identifier for this DeleteStack request. Specify this token if you plan to retry requests\n so that CloudFormation knows that you're not attempting to delete a stack with the same name. You might retry\n 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\n track operations. For example, if you execute a CreateStack operation with the token\n token1, then all the StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that are\n initiated from the console use the token format Console-StackOperation-ID, which helps you\n easily identify the stack operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a\n retained stack or add an existing, saved stack to a new stack set.
\nFor more information, see Stack set operation\n options.
", + "smithy.api#documentation": "Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a\n retained stack or add an existing, saved stack to a new stack set.
\nFor more information, see Stack set operation\n options.
", "smithy.api#required": {} } }, "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "The unique identifier for this stack set operation.
\nIf you don't specify an operation ID, the SDK generates one automatically.
\nThe operation ID also functions as an idempotency token, to ensure that CloudFormation performs the\n stack set operation only once, even if you retry the request multiple times. You can retry stack set operation\n requests to ensure that CloudFormation successfully received them.
\nRepeating this stack set operation with a new operation ID retries all stack instances whose status is\n OUTDATED.
The unique identifier for this stack set operation.
\nIf you don't specify an operation ID, the SDK generates one automatically.
\nThe operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set\n operation only once, even if you retry the request multiple times. You can retry stack set operation requests to\n ensure that CloudFormation successfully received them.
\nRepeating this stack set operation with a new operation ID retries all stack instances whose status is\n OUTDATED.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\nThe names of one or more Amazon Web Services accounts for which you want to deploy stack set\n updates.
" + "smithy.api#documentation": "The names of one or more Amazon Web Services accounts for which you want to deploy stack set updates.
" } }, "AccountsUrl": { @@ -3568,12 +3568,12 @@ "AccountFilterType": { "target": "com.amazonaws.cloudformation#AccountFilterType", "traits": { - "smithy.api#documentation": "Limit deployment targets to individual accounts or include additional accounts with provided\n OUs.
\nThe following is a list of possible values for the AccountFilterType\n operation.
\n INTERSECTION: StackSets deploys to the accounts specified in\n Accounts parameter.
\n DIFFERENCE: StackSets excludes the accounts specified in\n Accounts parameter. This enables user to avoid certain accounts within an OU such\n as suspended accounts.
\n UNION: StackSets includes additional accounts deployment targets.
This is the default value if AccountFilterType is not provided. This enables\n user to update an entire OU and individual accounts from a different OU in one request, which\n used to be two separate requests.
\n NONE: Deploys to all the accounts in specified organizational units\n (OU).
Limit deployment targets to individual accounts or include additional accounts with provided OUs.
\nThe following is a list of possible values for the AccountFilterType operation.
\n INTERSECTION: StackSets deploys to the accounts specified in Accounts parameter.\n
\n DIFFERENCE: StackSets excludes the accounts specified in Accounts parameter. This\n enables user to avoid certain accounts within an OU such as suspended accounts.
\n UNION: StackSets includes additional accounts deployment targets.
This is the default value if AccountFilterType is not provided. This enables user to update an\n entire OU and individual accounts from a different OU in one request, which used to be two separate\n requests.
\n NONE: Deploys to all the accounts in specified organizational units (OU).
[Service-managed permissions] The Organizations accounts to which StackSets deploys.\n StackSets doesn't deploy stack instances to the organization management account, even\n if the organization management account is in your organization or in an OU in your\n organization.
\nFor update operations, you can specify either Accounts or\n OrganizationalUnitIds. For create and delete operations, specify\n OrganizationalUnitIds.
[Service-managed permissions] The Organizations accounts to which StackSets deploys. StackSets doesn't\n deploy stack instances to the organization management account, even if the organization management account is in your organization or in an OU in your organization.
\nFor update operations, you can specify either Accounts or OrganizationalUnitIds. For\n create and delete operations, specify OrganizationalUnitIds.
Marks an extension or extension version as DEPRECATED in the CloudFormation registry,\n removing it from active use. Deprecated extensions or extension versions cannot be used in CloudFormation\n operations.
To deregister an entire extension, you must individually deregister all active versions of that extension. If an\n extension has only a single active version, deregistering that version results in the extension itself being\n deregistered and marked as deprecated in the registry.
\nYou can't deregister the default version of an extension if there are other active version of that extension. If\n you do deregister the default version of an extension, the extension type itself is deregistered as well and marked\n as deprecated.
\nTo view the deprecation status of an extension or extension version, use DescribeType.
", + "smithy.api#documentation": "Marks an extension or extension version as DEPRECATED in the CloudFormation registry, removing it from\n active use. Deprecated extensions or extension versions cannot be used in CloudFormation operations.
To deregister an entire extension, you must individually deregister all active versions of that extension. If an\n extension has only a single active version, deregistering that version results in the extension itself being\n deregistered and marked as deprecated in the registry.
\nYou can't deregister the default version of an extension if there are other active version of that extension. If\n you do deregister the default version of an extension, the extension type itself is deregistered as well and marked\n as deprecated.
\nTo view the deprecation status of an extension or extension version, use \n DescribeType\n .
Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in\n your account. For more information about account limits, see CloudFormation Quotas in the\n CloudFormation User Guide.
", + "smithy.api#documentation": "Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your account.\n For more information about account limits, see CloudFormation Quotas in the\n CloudFormation User Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3720,7 +3720,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the\n change set. For more information, see Updating Stacks Using Change\n Sets in the CloudFormation User Guide.
", + "smithy.api#documentation": "Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set.\n For more information, see Updating Stacks Using Change\n Sets in the CloudFormation User Guide.
", "smithy.api#suppress": [ "WaitableTraitInvalidErrorType" ], @@ -3774,7 +3774,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns hook-related information for the change set and a list of changes that CloudFormation makes when you\n run the change set.
" + "smithy.api#documentation": "Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the\n change set.
" } }, "com.amazonaws.cloudformation#DescribeChangeSetHooksInput": { @@ -3926,7 +3926,7 @@ "Parameters": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "A list of Parameter structures that describes the input parameters and their values used to create\n the change set. For more information, see the Parameter data type.
A list of Parameter structures that describes the input parameters and their values used to create\n the change set. For more information, see the \n Parameter\n data type.
If the change set execution status is AVAILABLE, you can execute the change set. If you can't\n execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE\n state because CloudFormation is still creating it or in an OBSOLETE state because the stack was\n already updated.
If the change set execution status is AVAILABLE, you can execute the change set. If you can't\n execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE\n state because CloudFormation is still creating it or in an OBSOLETE state because the stack was already\n updated.
The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or\n FAILED.
The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or\n FAILED.
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for\n the specified monitoring period afterwards.
" + "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified\n monitoring period afterwards.
" } }, "Capabilities": { @@ -3980,7 +3980,7 @@ "Changes": { "target": "com.amazonaws.cloudformation#Changes", "traits": { - "smithy.api#documentation": "A list of Change structures that describes the resources CloudFormation changes if you execute\n the change set.
A list of Change structures that describes the resources CloudFormation changes if you execute the change\n set.
Determines what action will be taken if stack creation fails. When this parameter is specified, the\n DisableRollback parameter to the ExecuteChangeSet API operation must not\n be specified. This must be one of these values:
\n DELETE - Deletes the change set if the stack creation fails. This is only valid when the\n ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status\n of the stack is DELETE_FAILED.
\n DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying\n true for the DisableRollback parameter to the ExecuteChangeSet API\n operation.
\n ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying\n false for the DisableRollback parameter to the ExecuteChangeSet API\n operation.
Determines what action will be taken if stack creation fails. When this parameter is specified, the\n DisableRollback parameter to the \n ExecuteChangeSet\n API operation must not\n be specified. This must be one of these values:
\n DELETE - Deletes the change set if the stack creation fails. This is only valid when the\n ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status\n of the stack is DELETE_FAILED.
\n DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying\n true for the DisableRollback parameter to the \n ExecuteChangeSet\n API\n operation.
\n ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying\n false for the DisableRollback parameter to the \n ExecuteChangeSet\n API\n operation.
Retrieves information about the account's OrganizationAccess status. This API\n can be called either by the management account or the delegated administrator by using the\n CallAs parameter. This API can also be called without the CallAs\n parameter by the management account.
Retrieves information about the account's OrganizationAccess status. This API can be called either\n by the management account or the delegated administrator by using the CallAs parameter. This API can\n also be called without the CallAs parameter by the management account.
[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.
\nBy default, SELF is specified.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the\n management account. For more information, see Register a\n delegated administrator in the CloudFormation User\n Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified.
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\n administrator in the CloudFormation User Guide.
\nReturns information about a CloudFormation extension publisher.
\nIf you don't supply a PublisherId, and you have registered as an extension publisher,\n DescribePublisher returns information about your own publisher account.
For more information about registering as a publisher, see:
\n\n RegisterPublisher\n
\n\n Publishing\n extensions to make them available for public use in the CloudFormation CLI User\n Guide\n
\nReturns information about a CloudFormation extension publisher.
\nIf you don't supply a PublisherId, and you have registered as an extension publisher,\n DescribePublisher returns information about your own publisher account.
For more information about registering as a publisher, see:
\n\n \n RegisterPublisher\n \n
\n Publishing\n extensions to make them available for public use in the CloudFormation CLI User\n Guide\n
\nThe ID of the extension publisher.
\nIf you don't supply a PublisherId, and you have registered as an extension publisher,\n DescribePublisher returns information about your own publisher account.
The ID of the extension publisher.
\nIf you don't supply a PublisherId, and you have registered as an extension publisher,\n DescribePublisher returns information about your own publisher account.
Returns information about a stack drift detection operation. A stack drift detection operation detects whether a\n stack's actual configuration differs, or has drifted, from its expected configuration, as\n defined in the stack template and any values specified as template parameters. A stack is considered to have drifted\n if one or more of its resources have drifted. For more information about stack and resource drift, see Detecting Unregulated\n Configuration Changes to Stacks and Resources.
\nUse DetectStackDrift to initiate a stack drift detection operation.\n DetectStackDrift returns a StackDriftDetectionId you can use to monitor the progress of\n the operation using DescribeStackDriftDetectionStatus. Once the drift detection operation has completed,\n use DescribeStackResourceDrifts to return drift information about the stack and its\n resources.
Returns information about a stack drift detection operation. A stack drift detection operation detects whether a\n stack's actual configuration differs, or has drifted, from its expected configuration, as\n defined in the stack template and any values specified as template parameters. A stack is considered to have drifted\n if one or more of its resources have drifted. For more information about stack and resource drift, see Detecting Unregulated\n Configuration Changes to Stacks and Resources.
\nUse DetectStackDrift to initiate a stack drift detection operation.\n DetectStackDrift returns a StackDriftDetectionId you can use to monitor the progress of the\n operation using DescribeStackDriftDetectionStatus. Once the drift detection operation has completed, use\n DescribeStackResourceDrifts to return drift information about the stack and its resources.
Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and\n Amazon Web Services Region.
\nFor a list of stack instances that are associated with a specific StackSet, use ListStackInstances.
" + "smithy.api#documentation": "Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and\n Amazon Web Services Region.
\nFor a list of stack instances that are associated with a specific StackSet, use ListStackInstances.
" } }, "com.amazonaws.cloudformation#DescribeStackInstanceInput": { @@ -4534,7 +4534,7 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\nIf the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call DescribeStackResourceDrifts again and assign that token to the request\n object's NextToken parameter. If the request returns all results, NextToken is set to\n null.
If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call DescribeStackResourceDrifts again and assign that token to the request\n object's NextToken parameter. If the request returns all results, NextToken is set to\n null.
Returns Amazon Web Services resource descriptions for running and deleted stacks. If StackName is\n specified, all the associated resources that are part of the stack are returned. If PhysicalResourceId\n is specified, the associated resources of the stack that the resource belongs to are returned.
Only the first 100 resources will be returned. If your stack has more resources than this, you should use\n ListStackResources instead.
For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the\n stack has been deleted.
You must specify either StackName or PhysicalResourceId, but not both. In addition,\n you can specify LogicalResourceId to filter the returned result. For more information about resources,\n the LogicalResourceId and PhysicalResourceId, go to the CloudFormation User Guide.
A ValidationError is returned if you specify both StackName and\n PhysicalResourceId in the same request.
Returns Amazon Web Services resource descriptions for running and deleted stacks. If StackName is\n specified, all the associated resources that are part of the stack are returned. If PhysicalResourceId\n is specified, the associated resources of the stack that the resource belongs to are returned.
Only the first 100 resources will be returned. If your stack has more resources than this, you should use\n ListStackResources instead.
For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the\n stack has been deleted.
You must specify either StackName or PhysicalResourceId, but not both. In addition,\n you can specify LogicalResourceId to filter the returned result. For more information about resources,\n the LogicalResourceId and PhysicalResourceId, go to the CloudFormation User Guide.
A ValidationError is returned if you specify both StackName and\n PhysicalResourceId in the same request.
The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
\nRequired: Conditional. If you don't specify StackName, you must specify\n PhysicalResourceId.
The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
\nRequired: Conditional. If you don't specify StackName, you must specify\n PhysicalResourceId.
The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.
\nFor example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to\n the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to\n 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\n StackName.
Default: There is no default value.
" + "smithy.api#documentation": "The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.
\nFor example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to\n the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to\n 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\n StackName.
Default: There is no default value.
" } } }, @@ -4766,7 +4766,7 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\nIf you don't pass a parameter to StackName, the API returns a response that describes all\n resources in the account, which can impact performance. This requires ListStacks and DescribeStacks permissions.
Consider using the ListStacks API if you're not passing a parameter to StackName.
The IAM policy below can be added to IAM policies when you want to limit\n resource-level permissions and avoid returning a response when no parameter is sent in the request:
\n{ \"Version\": \"2012-10-17\", \"Statement\": [{ \"Effect\": \"Deny\", \"Action\": \"cloudformation:DescribeStacks\",\n \"NotResource\": \"arn:aws:cloudformation:*:*:stack/*/*\" }] }
\nThe name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
" + "smithy.api#documentation": "If you don't pass a parameter to StackName, the API returns a response that describes all\n resources in the account, which can impact performance. This requires ListStacks and\n DescribeStacks permissions.
Consider using the ListStacks API if you're not passing a parameter to\n StackName.
The IAM policy below can be added to IAM policies when you want to limit resource-level permissions and\n avoid returning a response when no parameter is sent in the request:
\n{ \"Version\": \"2012-10-17\", \"Statement\": [{ \"Effect\": \"Deny\", \"Action\": \"cloudformation:DescribeStacks\",\n \"NotResource\": \"arn:aws:cloudformation:*:*:stack/*/*\" }] }
\nThe name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
" } }, "NextToken": { @@ -5436,31 +5436,31 @@ "TypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "The name of the extension.
\nIf the extension is a public third-party type you have activated with a type name alias, CloudFormation\n returns the type name alias. For more information, see ActivateType.
" + "smithy.api#documentation": "The name of the extension.
\nIf the extension is a public third-party type you have activated with a type name alias, CloudFormation returns the\n type name alias. For more information, see \n ActivateType\n .
The ID of the default version of the extension. The default version is used when the extension version isn't\n specified.
\nThis applies only to private extensions you have registered in your account. For public extensions, both those\n provided by Amazon Web Services and published by third parties, CloudFormation returns null. For\n more information, see RegisterType.
To set the default version of an extension, use SetTypeDefaultVersion.
" + "smithy.api#documentation": "The ID of the default version of the extension. The default version is used when the extension version isn't\n specified.
\nThis applies only to private extensions you have registered in your account. For public extensions, both those\n provided by Amazon Web Services and published by third parties, CloudFormation returns null. For more\n information, see \n RegisterType\n .
To set the default version of an extension, use SetTypeDefaultVersion.
" } }, "IsDefaultVersion": { "target": "com.amazonaws.cloudformation#IsDefaultVersion", "traits": { - "smithy.api#documentation": "Whether the specified extension version is set as the default version.
\nThis 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\n returns null.
Whether the specified extension version is set as the default version.
\nThis 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\n null.
The contract test status of the registered extension version. To return the extension test status of a specific\n extension version, you must specify VersionId.
This applies only to registered private extension versions. CloudFormation doesn't return this\n information for public extensions, whether they are activated in your account.
\n\n 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,\n see Publishing\n extensions to make them available for public use in the CloudFormation Command Line\n Interface User Guide.
\n FAILED: The extension has failed one or more contract tests.
\n IN_PROGRESS: Contract tests are currently being performed on the extension.
\n NOT_TESTED: Contract tests haven't been performed on the extension.
The contract test status of the registered extension version. To return the extension test status of a specific\n extension version, you must specify VersionId.
This applies only to registered private extension versions. CloudFormation doesn't return this information for\n public extensions, whether they are activated in your account.
\n\n 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,\n see Publishing\n extensions to make them available for public use in the CloudFormation Command Line Interface User\n Guide.
\n FAILED: The extension has failed one or more contract tests.
\n IN_PROGRESS: Contract tests are currently being performed on the extension.
\n NOT_TESTED: Contract tests haven't been performed on the extension.
The description of the test status. To return the extension test status of a specific extension version, you\n must specify VersionId.
This applies only to registered private extension versions. CloudFormation doesn't return this\n information for public extensions, whether they are activated in your account.
" + "smithy.api#documentation": "The description of the test status. To return the extension test status of a specific extension version, you\n must specify VersionId.
This applies only to registered private extension versions. CloudFormation doesn't return this information for\n public extensions, whether they are activated in your account.
" } }, "Description": { @@ -5472,7 +5472,7 @@ "Schema": { "target": "com.amazonaws.cloudformation#TypeSchema", "traits": { - "smithy.api#documentation": "The schema that defines the extension.
\nFor more information about extension schemas, see Resource Provider Schema in the\n CloudFormation CLI User Guide.
" + "smithy.api#documentation": "The schema that defines the extension.
\nFor more information about extension schemas, see Resource Provider Schema in the\n CloudFormation CLI User Guide.
" } }, "ProvisioningType": { @@ -5484,13 +5484,13 @@ "DeprecatedStatus": { "target": "com.amazonaws.cloudformation#DeprecatedStatus", "traits": { - "smithy.api#documentation": "The deprecation status of the extension version.
\nValid values include:
\n\n LIVE: The extension is activated or registered and can be used in CloudFormation\n operations, dependent on its provisioning behavior and visibility scope.
\n DEPRECATED: The extension has been deactivated or deregistered and can no longer be used in\n CloudFormation operations.
For public third-party extensions, CloudFormation returns null.
The deprecation status of the extension version.
\nValid values include:
\n\n LIVE: The extension is activated or registered and can be used in CloudFormation operations,\n dependent on its provisioning behavior and visibility scope.
\n DEPRECATED: The extension has been deactivated or deregistered and can no longer be used in\n CloudFormation operations.
For public third-party extensions, CloudFormation returns null.
Contains logging configuration information for private extensions. This applies only to private extensions you\n have registered in your account. For public extensions, both those provided by Amazon Web Services and published by\n third parties, CloudFormation returns null. For more information, see RegisterType.
Contains logging configuration information for private extensions. This applies only to private extensions you\n have registered in your account. For public extensions, both those provided by Amazon Web Services and published by\n third parties, CloudFormation returns null. For more information, see \n RegisterType\n .
The Amazon Resource Name (ARN) of the IAM execution role used to register the extension. This\n applies only to private extensions you have registered in your account. For more information, see RegisterType.
\nIf the registered extension calls any Amazon Web Services APIs, you must create an \n IAM execution role\n \n that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in\n your account. CloudFormation then assumes that execution role to provide your extension with the appropriate\n credentials.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM execution role used to register the extension. This applies only to\n private extensions you have registered in your account. For more information, see \n RegisterType\n .
If the registered extension calls any Amazon Web Services APIs, you must create an \n IAM execution role\n that includes\n the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account.\n CloudFormation then assumes that execution role to provide your extension with the appropriate credentials.
" } }, "Visibility": { @@ -5526,7 +5526,7 @@ "LastUpdated": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#documentation": "When the specified extension version was registered. This applies only to:
\nPrivate extensions you have registered in your account. For more information, see RegisterType.
\nPublic extensions you have activated in your account with auto-update specified. For more information, see\n ActivateType.
\nWhen the specified extension version was registered. This applies only to:
\nPrivate extensions you have registered in your account. For more information, see \n RegisterType\n .
Public extensions you have activated in your account with auto-update specified. For more information, see\n \n ActivateType\n .
A JSON string that represent the current configuration data for the extension in this account and Region.
\nTo set the configuration data for an extension, use SetTypeConfiguration. For more\n information, see Configuring extensions at\n the account level in the CloudFormation User Guide.
" + "smithy.api#documentation": "A JSON string that represent the current configuration data for the extension in this account and Region.
\nTo set the configuration data for an extension, use \n SetTypeConfiguration\n . For more\n information, see Configuring extensions at\n the account level in the CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the type name of the public\n extension.
\nIf 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\n the public extension. For more information, see Specifying aliases to\n refer to extensions in the CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the type name of the public\n extension.
\nIf 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\n the public extension. For more information, see Specifying aliases to\n refer to extensions in the CloudFormation User Guide.
The version number of a public third-party extension.
\nThis applies only if you specify a public extension you have activated in your account, or specify a public\n extension without specifying a version. For all other extensions, CloudFormation returns\n null.
The version number of a public third-party extension.
\nThis applies only if you specify a public extension you have activated in your account, or specify a public\n extension without specifying a version. For all other extensions, CloudFormation returns null.
The latest version of a public extension that is available for use.
\nThis only applies if you specify a public extension, and you don't specify a version. For all other requests,\n CloudFormation returns null.
The latest version of a public extension that is available for use.
\nThis only applies if you specify a public extension, and you don't specify a version. For all other requests,\n CloudFormation returns null.
Whether the extension is activated in the account and Region.
\nThis only applies to public third-party extensions. For all other extensions, CloudFormation returns\n null.
Whether the extension is activated in the account and Region.
\nThis only applies to public third-party extensions. For all other extensions, CloudFormation returns\n null.
Whether CloudFormation automatically updates the extension in this account and Region when a new\n minor version is published by the extension publisher. Major versions released by the publisher\n must be manually updated. For more information, see Activating public extensions\n for use in your account in the CloudFormation User Guide.
" + "smithy.api#documentation": "Whether CloudFormation automatically updates the extension in this account and Region when a new\n minor version is published by the extension publisher. Major versions released by the publisher\n must be manually updated. For more information, see Activating public extensions for\n use in your account in the CloudFormation User Guide.
" } } }, @@ -5641,7 +5641,7 @@ "target": "com.amazonaws.cloudformation#RegistrationToken", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The identifier for this registration request.
\nThis registration token is generated by CloudFormation when you initiate a registration request using\n RegisterType.
", + "smithy.api#documentation": "The identifier for this registration request.
\nThis registration token is generated by CloudFormation when you initiate a registration request using RegisterType.
", "smithy.api#required": {} } } @@ -5668,13 +5668,13 @@ "TypeArn": { "target": "com.amazonaws.cloudformation#TypeArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the extension being registered.
\nFor registration requests with a ProgressStatus of other than COMPLETE, this will be\n null.
The Amazon Resource Name (ARN) of the extension being registered.
\nFor registration requests with a ProgressStatus of other than COMPLETE, this will be\n null.
The Amazon Resource Name (ARN) of this specific version of the extension being registered.
\nFor registration requests with a ProgressStatus of other than COMPLETE, this will be\n null.
The Amazon Resource Name (ARN) of this specific version of the extension being registered.
\nFor registration requests with a ProgressStatus of other than COMPLETE, this will be\n null.
Detects whether a stack's actual configuration differs, or has drifted, from its expected\n configuration, as defined in the stack template and any values specified as template parameters. For each resource in\n the stack that supports drift detection, CloudFormation compares the actual configuration of the resource with its expected\n template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A\n stack is considered to have drifted if one or more of its resources differ from their expected template\n configurations. For more information, see Detecting Unregulated Configuration Changes to\n Stacks and Resources.
\nUse DetectStackDrift to detect drift on all supported resources for a given stack, or DetectStackResourceDrift to detect drift on individual resources.
For a list of stack resources that currently support drift detection, see Resources that Support Drift\n Detection.
\n\n DetectStackDrift can take up to several minutes, depending on the number of resources contained\n within the stack. Use DescribeStackDriftDetectionStatus to monitor the progress of a detect stack\n drift operation. Once the drift detection operation has completed, use DescribeStackResourceDrifts\n to return drift information about the stack and its resources.
When detecting drift on a stack, CloudFormation doesn't detect drift on any nested stacks belonging to that stack.\n Perform DetectStackDrift directly on the nested stack itself.
Detects whether a stack's actual configuration differs, or has drifted, from its expected\n configuration, as defined in the stack template and any values specified as template parameters. For each resource in\n the stack that supports drift detection, CloudFormation compares the actual configuration of the resource with its expected\n template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A\n stack is considered to have drifted if one or more of its resources differ from their expected template\n configurations. For more information, see Detecting Unregulated Configuration Changes to\n Stacks and Resources.
\nUse DetectStackDrift to detect drift on all supported resources for a given stack, or DetectStackResourceDrift to detect drift on individual resources.
For a list of stack resources that currently support drift detection, see Resources that Support Drift\n Detection.
\n\n DetectStackDrift can take up to several minutes, depending on the number of resources contained\n within the stack. Use DescribeStackDriftDetectionStatus to monitor the progress of a detect stack\n drift operation. Once the drift detection operation has completed, use DescribeStackResourceDrifts\n to return drift information about the stack and its resources.
When detecting drift on a stack, CloudFormation doesn't detect drift on any nested stacks belonging to that stack.\n Perform DetectStackDrift directly on the nested stack itself.
Returns information about whether a resource's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template and any values\n specified as template parameters. This information includes actual and expected property values for resources in\n which CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift.\n For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to\n Stacks and Resources.
\nUse DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.
Resources that don't currently support drift detection can't be checked. For a list of resources that support\n drift detection, see Resources that Support Drift\n Detection.
" + "smithy.api#documentation": "Returns information about whether a resource's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template and any values\n specified as template parameters. This information includes actual and expected property values for resources in\n which CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift.\n For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to\n Stacks and Resources.
\nUse DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.
Resources that don't currently support drift detection can't be checked. For a list of resources that support\n drift detection, see Resources that Support Drift\n Detection.
" } }, "com.amazonaws.cloudformation#DetectStackResourceDriftInput": { @@ -5813,7 +5830,7 @@ } ], "traits": { - "smithy.api#documentation": "Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs\n drift detection on the stack associated with each stack instance in the stack set. For more information, see How CloudFormation\n performs drift detection on a stack set.
\n\n DetectStackSetDrift returns the OperationId of the stack set drift detection\n operation. Use this operation id with DescribeStackSetOperation to monitor the progress of the\n drift detection operation. The drift detection operation may take some time, depending on the number of stack\n instances included in the stack set, in addition to the number of resources included in each stack.
Once the operation has completed, use the following actions to return drift information:
\nUse DescribeStackSet to return detailed information about the stack set, including detailed\n information about the last completed drift operation performed on the stack set. (Information\n about drift operations that are in progress isn't included.)
\nUse ListStackInstances to return a list of stack instances belonging to the stack set,\n including the drift status and last drift time checked of each instance.
\nUse DescribeStackInstance to return detailed information about a specific stack instance,\n including its drift status and last drift time checked.
\nFor more information about performing a drift detection operation on a stack set, see Detecting unmanaged changes in\n stack sets.
\nYou can only run a single drift detection operation on a given stack set at one time.
\nTo stop a drift detection stack set operation, use StopStackSetOperation.
" + "smithy.api#documentation": "Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs drift\n detection on the stack associated with each stack instance in the stack set. For more information, see How CloudFormation performs drift\n detection on a stack set.
\n\n DetectStackSetDrift returns the OperationId of the stack set drift detection\n operation. Use this operation id with DescribeStackSetOperation to monitor the progress of the\n drift detection operation. The drift detection operation may take some time, depending on the number of stack\n instances included in the stack set, in addition to the number of resources included in each stack.
Once the operation has completed, use the following actions to return drift information:
\nUse DescribeStackSet to return detailed information about the stack set, including detailed\n information about the last completed drift operation performed on the stack set. (Information\n about drift operations that are in progress isn't included.)
\nUse ListStackInstances to return a list of stack instances belonging to the stack set,\n including the drift status and last drift time checked of each instance.
\nUse DescribeStackInstance to return detailed information about a specific stack instance,\n including its drift status and last drift time checked.
\nFor more information about performing a drift detection operation on a stack set, see Detecting unmanaged changes in\n stack sets.
\nYou can only run a single drift detection operation on a given stack set at one time.
\nTo stop a drift detection stack set operation, use StopStackSetOperation.
" } }, "com.amazonaws.cloudformation#DetectStackSetDriftInput": { @@ -5830,7 +5847,7 @@ "OperationPreferences": { "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", "traits": { - "smithy.api#documentation": "The user-specified preferences for how CloudFormation performs a stack set operation.
\nFor more information about maximum concurrent accounts and failure tolerance, see Stack set operation\n options.
" + "smithy.api#documentation": "The user-specified preferences for how CloudFormation performs a stack set operation.
\nFor more information about maximum concurrent accounts and failure tolerance, see Stack set operation\n options.
" } }, "OperationId": { @@ -5843,7 +5860,7 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\nStructure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.\n (For more information, go to Template Anatomy in the\n CloudFormation User Guide.)
\nConditional: You must pass TemplateBody or TemplateURL. If both are passed, only\n TemplateBody is used.
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.\n (For more information, go to Template Anatomy in the\n CloudFormation User Guide.)
\nConditional: You must pass TemplateBody or TemplateURL. If both are passed, only\n TemplateBody is used.
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\n CloudFormation User Guide.
\nConditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.
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\n CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://.
Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.
Updates a stack using the input information that was provided when the specified change set was created. After\n the call successfully completes, CloudFormation starts updating the stack. Use the DescribeStacks action to view the status of the update.
\nWhen you execute a change set, CloudFormation deletes all other change sets associated with the stack\n because they aren't valid for the updated stack.
\nIf a stack policy is associated with the stack, CloudFormation enforces the policy during the update. You\n can't specify a temporary stack policy that overrides the current policy.
\nTo create a change set for the entire stack hierarchy, IncludeNestedStacks must have been set to\n True.
Updates a stack using the input information that was provided when the specified change set was created. After\n the call successfully completes, CloudFormation starts updating the stack. Use the DescribeStacks action to\n view the status of the update.
\nWhen you execute a change set, CloudFormation deletes all other change sets associated with the stack because they aren't\n valid for the updated stack.
\nIf a stack policy is associated with the stack, CloudFormation enforces the policy during the update. You can't specify a\n temporary stack policy that overrides the current policy.
\nTo create a change set for the entire stack hierarchy, IncludeNestedStacks must have been set to\n True.
A unique identifier for this ExecuteChangeSet request. Specify this token if you plan to retry\n requests so that CloudFormation knows that you're not attempting to execute a change set to update a stack with\n the same name. You might retry ExecuteChangeSet requests to ensure that CloudFormation successfully\n received them.
A unique identifier for this ExecuteChangeSet request. Specify this token if you plan to retry\n requests so that CloudFormation knows that you're not attempting to execute a change set to update a stack with the same name.\n You might retry ExecuteChangeSet requests to ensure that CloudFormation successfully received them.
Preserves the state of previously provisioned resources when an operation\n fails. This parameter can't be specified when\n the OnStackFailure parameter to the CreateChangeSet API operation was\n specified.
\n True - if the stack creation fails, do nothing. This is equivalent to specifying\n DO_NOTHING for the OnStackFailure parameter to the CreateChangeSet API operation.
\n False - if the stack creation fails, roll back the stack. This is equivalent to specifying\n ROLLBACK for the OnStackFailure parameter to the CreateChangeSet API operation.
Default: True\n
Preserves the state of previously provisioned resources when an operation fails. This parameter can't be\n specified when the OnStackFailure parameter to the \n CreateChangeSet\n API operation was\n specified.
\n True - if the stack creation fails, do nothing. This is equivalent to specifying\n DO_NOTHING for the OnStackFailure parameter to the \n CreateChangeSet\n API operation.
\n False - if the stack creation fails, roll back the stack. This is equivalent to specifying\n ROLLBACK for the OnStackFailure parameter to the \n CreateChangeSet\n API operation.
Default: True\n
When set to true, newly created resources are deleted when the operation rolls back. This includes newly\n created resources marked with a deletion policy of Retain.
Default: false\n
When set to true, newly created resources are deleted when the operation rolls back. This includes\n newly created resources marked with a deletion policy of Retain.
Default: false\n
The name of exported output value. Use this name and the Fn::ImportValue function to import the\n associated value into other stacks. The name is defined in the Export field in the associated stack's\n Outputs section.
The name of exported output value. Use this name and the Fn::ImportValue function to import the\n associated value into other stacks. The name is defined in the Export field in the associated stack's\n Outputs section.
The value of the exported output, such as a resource physical ID. This value is defined in the\n Export field in the associated stack's Outputs section.
The value of the exported output, such as a resource physical ID. This value is defined in the\n Export field in the associated stack's Outputs section.
The name or Amazon Resource Name (ARN) of a change set for which CloudFormation returns the associated\n template. If you specify a name, you must also specify the StackName.
The name or Amazon Resource Name (ARN) of a change set for which CloudFormation returns the associated template. If\n you specify a name, you must also specify the StackName.
For templates that include transforms, the stage of the template that CloudFormation returns. To get the\n user-submitted template, specify Original. To get the template after CloudFormation has\n processed all transforms, specify Processed.
If the template doesn't include transforms, Original and Processed return the same\n template. By default, CloudFormation specifies Processed.
For templates that include transforms, the stage of the template that CloudFormation returns. To get the\n user-submitted template, specify Original. To get the template after CloudFormation has processed all\n transforms, specify Processed.
If the template doesn't include transforms, Original and Processed return the same\n template. By default, CloudFormation specifies Processed.
The stage of the template that you can retrieve. For stacks, the Original and\n Processed templates are always available. For change sets, the Original template is always\n available. After CloudFormation finishes creating the change set, the Processed template becomes\n available.
The stage of the template that you can retrieve. For stacks, the Original and\n Processed templates are always available. For change sets, the Original template is always\n available. After CloudFormation finishes creating the change set, the Processed template becomes\n available.
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For\n more information about templates, see Template anatomy in the\n CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For\n more information about templates, see Template anatomy in the\n CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's\n located in an Amazon S3 bucket or a Systems Manager document. For more information about templates, see\n Template anatomy\n in the CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's\n located in an Amazon S3 bucket or a Systems Manager document. For more information about templates, see\n Template anatomy\n in the CloudFormation User Guide. The location for an Amazon S3 bucket must start with\n https://.
Conditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.
The name or the stack ID that's associated with the stack, which aren't always interchangeable. For running\n stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the\n unique stack ID.
\nConditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.
The name or the stack ID that's associated with the stack, which aren't always interchangeable. For running\n stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the\n unique stack ID.
\nConditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.
The name or unique ID of the stack set from which the stack was created.
\nConditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.
The name or unique ID of the stack set from which the stack was created.
\nConditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\nThe capabilities found within the template. If your template contains IAM resources, you must\n specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use\n the CreateStack or UpdateStack actions with your template; otherwise, those\n actions return an InsufficientCapabilities error.
For more information, see Acknowledging IAM\n Resources in CloudFormation Templates.
" + "smithy.api#documentation": "The capabilities found within the template. If your template contains IAM resources, you must specify the\n 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\n an InsufficientCapabilities error.
For more information, see Acknowledging IAM Resources in\n CloudFormation Templates.
" } }, "CapabilitiesReason": { @@ -6619,7 +6636,7 @@ "ResourceTypes": { "target": "com.amazonaws.cloudformation#ResourceTypes", "traits": { - "smithy.api#documentation": "A list of all the template resource types that are defined in the template, such as\n AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.
A list of all the template resource types that are defined in the template, such as\n AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.
The user-specified preferences for how CloudFormation performs a stack set operation.
\nFor more information about maximum concurrent accounts and failure tolerance, see Stack set operation\n options.
" + "smithy.api#documentation": "The user-specified preferences for how CloudFormation performs a stack set operation.
\nFor more information about maximum concurrent accounts and failure tolerance, see Stack set operation\n options.
" } }, "OperationId": { @@ -7093,7 +7110,7 @@ "code": "InvalidChangeSetStatus", "httpResponseCode": 400 }, - "smithy.api#documentation": "The specified change set can't be used to update the stack. For example, the change set status might be\n CREATE_IN_PROGRESS, or the stack status might be UPDATE_IN_PROGRESS.
The specified change set can't be used to update the stack. For example, the change set status might be\n CREATE_IN_PROGRESS, or the stack status might be UPDATE_IN_PROGRESS.
Error reserved for use by the CloudFormation CLI.\n CloudFormation doesn't return this error to users.
", + "smithy.api#documentation": "Error reserved for use by the CloudFormation CLI. CloudFormation doesn't\n return this error to users.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -7186,7 +7203,7 @@ "code": "LimitExceededException", "httpResponseCode": 400 }, - "smithy.api#documentation": "The quota for the resource has already been reached.
\nFor information about resource and stack limitations, see CloudFormation quotas in the\n CloudFormation User Guide.
", + "smithy.api#documentation": "The quota for the resource has already been reached.
\nFor information about resource and stack limitations, see CloudFormation quotas in the\n CloudFormation User Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -7206,7 +7223,7 @@ "target": "com.amazonaws.cloudformation#ListChangeSetsOutput" }, "traits": { - "smithy.api#documentation": "Returns the ID and status of each active change set for a stack. For example, CloudFormation lists change\n sets that are in the CREATE_IN_PROGRESS or CREATE_PENDING state.
Returns the ID and status of each active change set for a stack. For example, CloudFormation lists change sets that are\n in the CREATE_IN_PROGRESS or CREATE_PENDING state.
Lists all exported output values in the account and Region in which you call this action. Use this action to see\n the exported output values that you can import into other stacks. To import values, use the \n Fn::ImportValue function.
\nFor more information, see \n CloudFormation export stack output values.
", + "smithy.api#documentation": "Lists all exported output values in the account and Region in which you call this action. Use this action to see\n the exported output values that you can import into other stacks. To import values, use the \n Fn::ImportValue function.
\nFor more information, see CloudFormation export stack output\n values.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -7391,7 +7408,7 @@ "target": "com.amazonaws.cloudformation#ExportName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the exported output value. CloudFormation returns the stack names that are importing this\n value.
", + "smithy.api#documentation": "The name of the exported output value. CloudFormation returns the stack names that are importing this value.
", "smithy.api#required": {} } }, @@ -7797,7 +7814,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns drift information for resources in a stack instance.
\n\n ListStackInstanceResourceDrifts returns drift information for the most\n recent drift detection operation. If an operation is in progress, it may only return\n partial results.
Returns drift information for resources in a stack instance.
\n\n ListStackInstanceResourceDrifts returns drift information for the most recent drift detection\n operation. If an operation is in progress, it may only return partial results.
The name or unique ID of the stack set that you want to list drifted resources\n for.
", + "smithy.api#documentation": "The name or unique ID of the stack set that you want to list drifted resources for.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "If the previous paginated request didn't return all of the remaining results, the\n response object's NextToken parameter value is set to a token. To retrieve the\n next set of results, call this action again and assign that token to the request object's\n NextToken parameter. If there are no remaining results, the previous\n response object's NextToken parameter is set to null.
If the previous paginated request didn't return all of the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call this action again\n and assign that token to the request object's NextToken parameter. If there are no remaining results,\n the previous response object's NextToken parameter is set to null.
The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken\n value that you can assign to the NextToken request parameter to get the next\n set of results.
The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.
The resource drift status of the stack instance.
\n\n DELETED: The resource differs from its expected template\n configuration in that the resource has been deleted.
\n MODIFIED: One or more resource properties differ from their expected\n template values.
\n IN_SYNC: The resource's actual configuration matches its expected\n template configuration.
\n NOT_CHECKED: CloudFormation doesn't currently return this value.
The resource drift status of the stack instance.
\n\n DELETED: The resource differs from its expected template configuration in that the resource has\n been deleted.
\n MODIFIED: One or more resource properties differ from their expected template values.
\n IN_SYNC: The resource's actual configuration matches its expected template configuration.
\n NOT_CHECKED: CloudFormation doesn't currently return this value.
[Service-managed permissions] Specifies whether you are acting as an account\n administrator in the organization's management account or as a delegated\n administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in\n the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\nA list of StackInstanceResourceDriftSummary structures that contain\n information about the specified stack instances.
A list of StackInstanceResourceDriftSummary structures that contain information about the specified\n stack instances.
If the previous paginated request didn't return all of the remaining results, the\n response object's NextToken parameter value is set to a token. To retrieve the\n next set of results, call this action again and assign that token to the request object's\n NextToken parameter. If there are no remaining results, the previous\n response object's NextToken parameter is set to null.
If the previous paginated request didn't return all of the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call this action again\n and assign that token to the request object's NextToken parameter. If there are no remaining results,\n the previous response object's NextToken parameter is set to null.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\nIf the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call ListStackInstances again and assign that token to the request object's\n NextToken parameter. If the request returns all results, NextToken is set to\n null.
If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call ListStackInstances again and assign that token to the request object's\n NextToken parameter. If the request returns all results, NextToken is set to\n null.
If the previous request didn't return all the remaining results, the response object's NextToken\n parameter value is set to a token. To retrieve the next set of results, call\n ListStackSetOperationResults again and assign that token to the request object's NextToken\n parameter. If there are no remaining results, the previous response object's NextToken parameter is set\n to null.
If the previous request didn't return all the remaining results, the response object's NextToken\n parameter value is set to a token. To retrieve the next set of results, call\n ListStackSetOperationResults again and assign that token to the request object's NextToken\n parameter. If there are no remaining results, the previous response object's NextToken parameter is set\n to null.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\nIf the request doesn't return all results, NextToken is set to a token. To retrieve the next set of\n results, call ListOperationResults again and assign that token to the request object's\n NextToken parameter. If there are no remaining results, NextToken is set to\n null.
If the request doesn't return all results, NextToken is set to a token. To retrieve the next set of\n results, call ListOperationResults again and assign that token to the request object's\n NextToken parameter. If there are no remaining results, NextToken is set to\n null.
If the previous paginated request didn't return all of the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call\n ListStackSetOperations again and assign that token to the request object's NextToken\n parameter. If there are no remaining results, the previous response object's NextToken parameter is set\n to null.
If the previous paginated request didn't return all of the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call\n ListStackSetOperations again and assign that token to the request object's NextToken\n parameter. If there are no remaining results, the previous response object's NextToken parameter is set\n to null.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\nIf the request doesn't return all results, NextToken is set to a token. To retrieve the next set of\n results, call ListOperationResults again and assign that token to the request object's\n NextToken parameter. If there are no remaining results, NextToken is set to\n null.
If the request doesn't return all results, NextToken is set to a token. To retrieve the next set of\n results, call ListOperationResults again and assign that token to the request object's\n NextToken parameter. If there are no remaining results, NextToken is set to\n null.
If the previous paginated request didn't return all the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call\n ListStackSets again and assign that token to the request object's NextToken parameter. If\n there are no remaining results, the previous response object's NextToken parameter is set to\n null.
If the previous paginated request didn't return all the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call\n ListStackSets again and assign that token to the request object's NextToken parameter. If\n there are no remaining results, the previous response object's NextToken parameter is set to\n null.
[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.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[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.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\nIf the request doesn't return all of the remaining results, NextToken is set to a token. To\n retrieve the next set of results, call ListStackInstances again and assign that token to the request\n object's NextToken parameter. If the request returns all results, NextToken is set to\n null.
If the request doesn't return all of the remaining results, NextToken is set to a token. To\n retrieve the next set of results, call ListStackInstances again and assign that token to the request\n object's NextToken parameter. If the request returns all results, NextToken is set to\n null.
If the previous paginated request didn't return all the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call this action\n again and assign that token to the request object's NextToken parameter. If there are no remaining\n results, the previous response object's NextToken parameter is set to null.
If the previous paginated request didn't return all the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call this action again\n and assign that token to the request object's NextToken parameter. If there are no remaining results,\n the previous response object's NextToken parameter is set to null.
If the previous paginated request didn't return all of the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call this action\n again and assign that token to the request object's NextToken parameter. If there are no remaining\n results, the previous response object's NextToken parameter is set to null.
If the previous paginated request didn't return all of the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call this action again\n and assign that token to the request object's NextToken parameter. If there are no remaining results,\n the previous response object's NextToken parameter is set to null.
The deprecation status of the extension versions that you want to get summary information about.
\nValid values include:
\n\n LIVE: The extension version is registered and can be used in CloudFormation operations,\n dependent on its provisioning behavior and visibility scope.
\n DEPRECATED: The extension version has been deregistered and can no longer be used in CloudFormation operations.
The default is LIVE.
The deprecation status of the extension versions that you want to get summary information about.
\nValid values include:
\n\n LIVE: The extension version is registered and can be used in CloudFormation operations, dependent on\n its provisioning behavior and visibility scope.
\n DEPRECATED: The extension version has been deregistered and can no longer be used in CloudFormation operations.
The default is LIVE.
If the request doesn't return all of the remaining results, NextToken is set to a token. To\n retrieve the next set of results, call this action again and assign that token to the request object's\n NextToken parameter. If the request returns all results, NextToken is set to\n null.
If the request doesn't return all of the remaining results, NextToken is set to a token. To\n retrieve the next set of results, call this action again and assign that token to the request object's\n NextToken parameter. If the request returns all results, NextToken is set to\n null.
The scope at which the extensions are visible and usable in CloudFormation operations.
\nValid values include:
\n\n PRIVATE: Extensions that are visible and usable within this account and Region. This\n includes:
Private extensions you have registered in this account and Region.
\nPublic extensions that you have activated in this account and Region.
\n\n 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\n publishers.
The default is PRIVATE.
The scope at which the extensions are visible and usable in CloudFormation operations.
\nValid values include:
\n\n PRIVATE: Extensions that are visible and usable within this account and Region. This\n includes:
Private extensions you have registered in this account and Region.
\nPublic extensions that you have activated in this account and Region.
\n\n 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.
Filter criteria to use in determining which extensions to return.
\nFilters must be compatible with Visibility to return valid results. For example, specifying\n AWS_TYPES for Category and PRIVATE for Visibility returns an\n empty list of types, but specifying PUBLIC for Visibility returns the desired list.
Filter criteria to use in determining which extensions to return.
\nFilters must be compatible with Visibility to return valid results. For example, specifying\n AWS_TYPES for Category and PRIVATE for Visibility returns an\n empty list of types, but specifying PUBLIC for Visibility returns the desired list.
If the previous paginated request didn't return all the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call this action\n again and assign that token to the request object's NextToken parameter. If there are no remaining\n results, the previous response object's NextToken parameter is set to null.
If the previous paginated request didn't return all the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call this action again\n and assign that token to the request object's NextToken parameter. If there are no remaining results,\n the previous response object's NextToken parameter is set to null.
The Amazon Resource Name (ARN) of the role that CloudFormation should assume when sending log entries\n to CloudWatch Logs.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role that CloudFormation should assume when sending log entries to CloudWatch Logs.
", "smithy.api#required": {} } }, @@ -8639,7 +8656,7 @@ "target": "com.amazonaws.cloudformation#LogGroupName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon CloudWatch Logs group to which CloudFormation sends error logging information when invoking\n the extension's handlers.
", + "smithy.api#documentation": "The Amazon CloudWatch Logs group to which CloudFormation sends error logging information when invoking the\n extension's handlers.
", "smithy.api#required": {} } } @@ -8684,12 +8701,12 @@ "Active": { "target": "com.amazonaws.cloudformation#ManagedExecutionNullable", "traits": { - "smithy.api#documentation": "When true, StackSets performs non-conflicting operations concurrently and\n queues conflicting operations. After conflicting operations finish, StackSets starts queued\n operations in request order.
If there are already running or queued operations, StackSets queues all incoming operations\n even if they are non-conflicting.
\nYou can't modify your stack set's execution configuration while there are running or queued\n operations for that stack set.
\nWhen false (default), StackSets performs one operation at a time in request\n order.
When true, StackSets performs non-conflicting operations concurrently and queues conflicting\n 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\n non-conflicting.
\nYou can't modify your stack set's execution configuration while there are running or queued operations for that\n stack set.
\nWhen false (default), StackSets performs one operation at a time in request order.
Describes whether StackSets performs non-conflicting operations concurrently and queues\n conflicting operations.
" + "smithy.api#documentation": "Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting\n operations.
" } }, "com.amazonaws.cloudformation#ManagedExecutionNullable": { @@ -8730,7 +8747,7 @@ "TypeHierarchy": { "target": "com.amazonaws.cloudformation#TypeHierarchy", "traits": { - "smithy.api#documentation": "A concatenated list of the module type or types containing the resource. Module types are listed starting with\n the inner-most nested module, and separated by /.
In the following example, the resource was created from a module of type\n AWS::First::Example::MODULE, that's nested inside a parent module of type\n AWS::Second::Example::MODULE.
\n AWS::First::Example::MODULE/AWS::Second::Example::MODULE\n
A concatenated list of the module type or types containing the resource. Module types are listed starting with\n the inner-most nested module, and separated by /.
In the following example, the resource was created from a module of type\n AWS::First::Example::MODULE, that's nested inside a parent module of type\n AWS::Second::Example::MODULE.
\n AWS::First::Example::MODULE/AWS::Second::Example::MODULE\n
Contains information about the module from which the resource was created, if the resource was created from a\n module included in the stack template.
\nFor more information about modules, see Using modules to encapsulate and reuse resource\n configurations in the CloudFormation User Guide.
" + "smithy.api#documentation": "Contains information about the module from which the resource was created, if the resource was created from a\n module included in the stack template.
\nFor more information about modules, see Using modules to encapsulate and reuse resource\n configurations in the CloudFormation User Guide.
" } }, "com.amazonaws.cloudformation#MonitoringTimeInMinutes": { @@ -8996,7 +9013,7 @@ "code": "ConditionalCheckFailed", "httpResponseCode": 400 }, - "smithy.api#documentation": "Error reserved for use by the CloudFormation CLI.\n CloudFormation doesn't return this error to users.
", + "smithy.api#documentation": "Error reserved for use by the CloudFormation CLI. CloudFormation doesn't\n return this error to users.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -9113,7 +9130,7 @@ "ResolvedValue": { "target": "com.amazonaws.cloudformation#ParameterValue", "traits": { - "smithy.api#documentation": "Read-only. The value that corresponds to a SSM parameter key. This field is returned only for\n SSM\n parameter types in the template.
" + "smithy.api#documentation": "Read-only. The value that corresponds to a SSM parameter key. This field is returned only for\n SSM\n parameter types in the template.
" } } }, @@ -9132,7 +9149,7 @@ } }, "traits": { - "smithy.api#documentation": "A set of criteria that CloudFormation uses to validate parameter values. Although other constraints might be\n defined in the stack template, CloudFormation returns only the AllowedValues property.
A set of criteria that CloudFormation uses to validate parameter values. Although other constraints might be defined in\n the stack template, CloudFormation returns only the AllowedValues property.
Information about a resource property whose actual value differs from its expected value, as defined in the\n stack template and any values specified as template parameters. These will be present only for resources whose\n StackResourceDriftStatus is MODIFIED. For more information, see Detecting Unregulated\n Configuration Changes to Stacks and Resources.
Information about a resource property whose actual value differs from its expected value, as defined in the\n stack template and any values specified as template parameters. These will be present only for resources whose\n StackResourceDriftStatus is MODIFIED. For more information, see Detecting Unregulated Configuration Changes to\n Stacks and Resources.
Publishes the specified extension to the CloudFormation registry as a public extension in this Region.\n Public extensions are available for use by all CloudFormation users. For more information about publishing\n extensions, see Publishing extensions to make them available for public use in the CloudFormation CLI\n User Guide.
\nTo publish an extension, you must be registered as a publisher with CloudFormation. For more\n information, see RegisterPublisher.
", + "smithy.api#documentation": "Publishes the specified extension to the CloudFormation registry as a public extension in this Region. Public\n extensions are available for use by all CloudFormation users. For more information about publishing extensions, see\n Publishing extensions to\n make them available for public use in the CloudFormation CLI User Guide.
\nTo publish an extension, you must be registered as a publisher with CloudFormation. For more information, see \n RegisterPublisher\n .
The version number to assign to this version of the extension.
\nUse the following format, and adhere to semantic versioning when assigning a version number to your\n extension:
\n\n MAJOR.MINOR.PATCH\n
For more information, see Semantic Versioning 2.0.0.
\nIf you don't specify a version number, CloudFormation increments the version number by one minor\n version release.
\nYou cannot specify a version number the first time you publish a type. CloudFormation automatically sets the first\n version number to be 1.0.0.
The version number to assign to this version of the extension.
\nUse the following format, and adhere to semantic versioning when assigning a version number to your\n extension:
\n\n MAJOR.MINOR.PATCH\n
For more information, see Semantic Versioning 2.0.0.
\nIf you don't specify a version number, CloudFormation increments the version number by one minor version\n release.
\nYou cannot specify a version number the first time you publish a type. CloudFormation automatically sets the first\n version number to be 1.0.0.
Reports progress of a resource handler to CloudFormation.
\nReserved for use by the CloudFormation CLI. Don't\n use this API in your code.
", + "smithy.api#documentation": "Reports progress of a resource handler to CloudFormation.
\nReserved for use by the CloudFormation CLI. Don't use this API\n in your code.
", "smithy.api#idempotent": {} } }, @@ -9507,7 +9524,7 @@ "target": "com.amazonaws.cloudformation#ClientToken", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
", + "smithy.api#documentation": "Reserved for use by the CloudFormation CLI.
", "smithy.api#required": {} } }, @@ -9515,38 +9532,38 @@ "target": "com.amazonaws.cloudformation#OperationStatus", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
", + "smithy.api#documentation": "Reserved for use by the CloudFormation CLI.
", "smithy.api#required": {} } }, "CurrentOperationStatus": { "target": "com.amazonaws.cloudformation#OperationStatus", "traits": { - "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
" + "smithy.api#documentation": "Reserved for use by the CloudFormation CLI.
" } }, "StatusMessage": { "target": "com.amazonaws.cloudformation#StatusMessage", "traits": { - "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
" + "smithy.api#documentation": "Reserved for use by the CloudFormation CLI.
" } }, "ErrorCode": { "target": "com.amazonaws.cloudformation#HandlerErrorCode", "traits": { - "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
" + "smithy.api#documentation": "Reserved for use by the CloudFormation CLI.
" } }, "ResourceModel": { "target": "com.amazonaws.cloudformation#ResourceModel", "traits": { - "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
" + "smithy.api#documentation": "Reserved for use by the CloudFormation CLI.
" } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
" + "smithy.api#documentation": "Reserved for use by the CloudFormation CLI.
" } } }, @@ -9607,7 +9624,7 @@ } ], "traits": { - "smithy.api#documentation": "Registers your account as a publisher of public extensions in the CloudFormation registry. Public\n extensions are available for use by all CloudFormation users. This publisher ID applies to your account in\n all Amazon Web Services Regions.
\nFor information about requirements for registering as a public extension publisher, see Registering your account to publish CloudFormation extensions in the CloudFormation CLI User Guide.
\n ", + "smithy.api#documentation": "Registers your account as a publisher of public extensions in the CloudFormation registry. Public extensions are\n available for use by all CloudFormation users. This publisher ID applies to your account in all Amazon Web Services Regions.
\nFor information about requirements for registering as a public extension publisher, see Registering your account to publish CloudFormation extensions in the CloudFormation CLI User\n Guide.
\n ", "smithy.api#idempotent": {} } }, @@ -9617,13 +9634,13 @@ "AcceptTermsAndConditions": { "target": "com.amazonaws.cloudformation#AcceptTermsAndConditions", "traits": { - "smithy.api#documentation": "Whether you accept the Terms and Conditions for publishing extensions in the CloudFormation registry. You must accept the\n terms and conditions in order to register to publish public extensions to the CloudFormation\n registry.
\nThe default is false.
Whether you accept the Terms and Conditions for publishing extensions in the CloudFormation registry. You must accept the terms and\n conditions in order to register to publish public extensions to the CloudFormation registry.
\nThe default is false.
If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for\n your connection to that account.
\nFor more information, see Registering your account\n to publish CloudFormation extensions in the CloudFormation CLI User\n Guide.
" + "smithy.api#documentation": "If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for\n your connection to that account.
\nFor more information, see Registering your account\n to publish CloudFormation extensions in the CloudFormation CLI User Guide.
" } } }, @@ -9659,7 +9676,7 @@ } ], "traits": { - "smithy.api#documentation": "Registers an extension with the CloudFormation service. Registering an extension makes it available for\n use in CloudFormation templates in your Amazon Web Services account, and includes:
\nValidating the extension schema.
\nDetermining which handlers, if any, have been specified for the extension.
\nMaking the extension available for use in your account.
\nFor more information about how to develop extensions and ready them for registration, see Creating Resource\n Providers in the CloudFormation CLI User Guide.
\nYou can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and\n per Region. Use DeregisterType to deregister specific extension versions if necessary.
\nOnce you have initiated a registration request using RegisterType, you can use DescribeTypeRegistration to monitor the progress of the registration request.
\nOnce you have registered a private extension in your account and Region, use SetTypeConfiguration to specify\n configuration properties for the extension. For more information, see Configuring extensions at\n the account level in the CloudFormation User Guide.
", + "smithy.api#documentation": "Registers an extension with the CloudFormation service. Registering an extension makes it available for use in\n CloudFormation templates in your Amazon Web Services account, and includes:
\nValidating the extension schema.
\nDetermining which handlers, if any, have been specified for the extension.
\nMaking the extension available for use in your account.
\nFor more information about how to develop extensions and ready them for registration, see Creating Resource\n Providers in the CloudFormation CLI User Guide.
\nYou can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and\n per Region. Use \n DeregisterType\n to deregister specific extension versions if necessary.
Once you have initiated a registration request using RegisterType, you can use DescribeTypeRegistration to monitor the progress of the registration request.
\nOnce you have registered a private extension in your account and Region, use \n SetTypeConfiguration\n to specify\n configuration properties for the extension. For more information, see Configuring extensions at\n the account level in the CloudFormation User Guide.
The name of the extension being registered.
\nWe suggest that extension names adhere to the following patterns:
\nFor resource types,\n company_or_organization::service::type.
\nFor modules,\n company_or_organization::service::type::MODULE.
\nFor hooks,\n MyCompany::Testing::MyTestHook.
\nThe following organization namespaces are reserved and can't be used in your extension names:
\n\n Alexa\n
\n AMZN\n
\n Amazon\n
\n AWS\n
\n Custom\n
\n Dev\n
The name of the extension being registered.
\nWe suggest that extension names adhere to the following patterns:
\nFor resource types,\n company_or_organization::service::type.
\nFor modules,\n company_or_organization::service::type::MODULE.
\nFor hooks,\n MyCompany::Testing::MyTestHook.
\nThe following organization namespaces are reserved and can't be used in your extension names:
\n\n Alexa\n
\n AMZN\n
\n Amazon\n
\n AWS\n
\n Custom\n
\n Dev\n
A URL to the S3 bucket containing the extension project package that contains the necessary files for the\n extension you want to register.
\nFor information about generating a schema handler package for the extension you want to register, see submit in the\n CloudFormation CLI User Guide.
\nThe user registering the extension must be able to access the package in the S3 bucket. That's, the user needs\n to have GetObject permissions for\n the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3\n in the Identity and Access Management User Guide.
\nA URL to the S3 bucket containing the extension project package that contains the necessary files for the\n extension you want to register.
\nFor information about generating a schema handler package for the extension you want to register, see submit in the\n CloudFormation CLI User Guide.
\nThe user registering the extension must be able to access the package in the S3 bucket. That's, the user needs\n to have GetObject permissions for\n the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3\n in the Identity and Access Management User Guide.
\nThe Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when\n invoking the extension.
\nFor CloudFormation to assume the specified execution role, the role must contain a trust relationship\n with the CloudFormation service principal (resources.cloudformation.amazonaws.com). For more\n information about adding trust relationships, see Modifying a\n 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 \n IAM execution role\n \n that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in\n your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this\n execution role to create a temporary session token, which it then passes to the resource type handler, thereby\n supplying your resource type with the appropriate credentials.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.
\nFor CloudFormation to assume the specified execution role, the role must contain a trust relationship with the\n CloudFormation service principal (resources.cloudformation.amazonaws.com). For more information about adding\n trust relationships, see Modifying a\n 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 \n IAM execution role\n that includes\n the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account.\n When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this execution role to create a temporary\n session token, which it then passes to the resource type handler, thereby supplying your resource type with the\n appropriate credentials.
" } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#RequestToken", "traits": { - "smithy.api#documentation": "A unique identifier that acts as an idempotency key for this registration request. Specifying a client request\n token prevents CloudFormation from generating more than one version of an extension from the same\n registration request, even if the request is submitted multiple times.
" + "smithy.api#documentation": "A unique identifier that acts as an idempotency key for this registration request. Specifying a client request\n token prevents CloudFormation from generating more than one version of an extension from the same registration request,\n even if the request is submitted multiple times.
" } } }, @@ -9832,13 +9849,13 @@ "TypeNameAlias": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "An alias assigned to the public extension, in this account and Region. If you specify an alias for the\n extension, CloudFormation treats the alias as the extension type name within this account and Region. You\n must use the alias to refer to the extension in your templates, API calls, and CloudFormation\n console.
" + "smithy.api#documentation": "An alias assigned to the public extension, in this account and Region. If you specify an alias for the\n extension, CloudFormation treats the alias as the extension type name within this account and Region. You must use the\n alias to refer to the extension in your templates, API calls, and CloudFormation console.
" } }, "OriginalTypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "The type name of the public extension.
\nIf 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\n the public extension. For more information, see Specifying aliases to\n refer to extensions in the CloudFormation User Guide.
The type name of the public extension.
\nIf 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\n the public extension. For more information, see Specifying aliases to\n refer to extensions in the CloudFormation User Guide.
For extensions that are modules, a public third-party extension that must be activated in your account in order\n for the module itself to be activated.
\nFor more information, see Activating public modules for use in your\n account in the CloudFormation User Guide.
" + "smithy.api#documentation": "For extensions that are modules, a public third-party extension that must be activated in your account in order\n for the module itself to be activated.
\nFor more information, see Activating public modules for use in your\n account in the CloudFormation User Guide.
" } }, "com.amazonaws.cloudformation#RequiredActivatedTypes": { @@ -9943,7 +9960,7 @@ "Action": { "target": "com.amazonaws.cloudformation#ChangeAction", "traits": { - "smithy.api#documentation": "The action that CloudFormation takes on the resource, such as Add (adds a new resource),\n Modify (changes a resource), Remove (deletes a resource), Import (imports a\n resource), or Dynamic (exact action for the resource can't be determined).
The action that CloudFormation takes on the resource, such as Add (adds a new resource), Modify\n (changes a resource), Remove (deletes a resource), Import (imports a resource), or\n Dynamic (exact action for the resource can't be determined).
For the Modify action, indicates whether CloudFormation will replace the resource by creating a\n new one and deleting the old one. This value depends on the value of the RequiresRecreation property in\n the ResourceTargetDefinition structure. For example, if the RequiresRecreation field is\n Always and the Evaluation field is Static, Replacement is\n True. If the RequiresRecreation field is Always and the\n Evaluation field is Dynamic, Replacement is\n Conditionally.
If you have multiple changes with different RequiresRecreation values, the Replacement\n value depends on the change with the most impact. A RequiresRecreation value of Always has\n the most impact, followed by Conditionally, and then Never.
For the Modify action, indicates whether CloudFormation will replace the resource by creating a new one and\n deleting the old one. This value depends on the value of the RequiresRecreation property in the\n ResourceTargetDefinition structure. For example, if the RequiresRecreation field is\n Always and the Evaluation field is Static, Replacement is\n True. If the RequiresRecreation field is Always and the\n Evaluation field is Dynamic, Replacement is Conditionally.
If you have multiple changes with different RequiresRecreation values, the Replacement\n value depends on the change with the most impact. A RequiresRecreation value of Always has\n the most impact, followed by Conditionally, and then Never.
The ResourceChange structure describes the resource and the action that CloudFormation will\n perform on it if you execute this change set.
The ResourceChange structure describes the resource and the action that CloudFormation will perform on it if\n you execute this change set.
A ResourceTargetDefinition structure that describes the field that CloudFormation will change\n and whether the resource will be recreated.
A ResourceTargetDefinition structure that describes the field that CloudFormation will change and whether\n the resource will be recreated.
Indicates whether CloudFormation can determine the target value, and whether the target value will change\n before you execute a change set.
\nFor Static evaluations, CloudFormation can determine that the target value will change, and its\n 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\n evaluation.
For Dynamic evaluations, can't determine the target value because it depends on the result of an\n intrinsic function, such as a Ref or Fn::GetAtt intrinsic function, when the stack is\n updated. For example, if your template includes a reference to a resource that's conditionally recreated, the value\n of the reference (the physical ID of the resource) might change, depending on if the resource is recreated. If the\n resource is recreated, it will have a new physical ID, so all references to that resource will also be\n updated.
Indicates whether CloudFormation can determine the target value, and whether the target value will change before you\n execute a change set.
\nFor Static evaluations, CloudFormation can determine that the target value will change, and its value. For\n example, if you directly modify the InstanceType property of an EC2 instance, CloudFormation knows\n 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\n intrinsic function, such as a Ref or Fn::GetAtt intrinsic function, when the stack is\n updated. For example, if your template includes a reference to a resource that's conditionally recreated, the value\n of the reference (the physical ID of the resource) might change, depending on if the resource is recreated. If the\n resource is recreated, it will have a new physical ID, so all references to that resource will also be\n updated.
The group to which the CausingEntity value belongs. There are five entity groups:
\n ResourceReference entities are Ref intrinsic functions that refer to resources in the\n template, such as { \"Ref\" : \"MyEC2InstanceResource\" }.
\n ParameterReference entities are Ref intrinsic functions that get template parameter\n values, such as { \"Ref\" : \"MyPasswordParameter\" }.
\n ResourceAttribute entities are Fn::GetAtt intrinsic functions that get resource attribute\n values, such as { \"Fn::GetAtt\" : [ \"MyEC2InstanceResource\", \"PublicDnsName\" ] }.
\n DirectModification entities are changes that are made directly to the template.
\n Automatic entities are AWS::CloudFormation::Stack resource types, which are also known as\n nested stacks. If you made no changes to the AWS::CloudFormation::Stack resource, CloudFormation\n sets the ChangeSource to Automatic because the nested stack's template might have\n changed. Changes to a nested stack's template aren't visible to CloudFormation until you run an update on the\n parent stack.
The group to which the CausingEntity value belongs. There are five entity groups:
\n ResourceReference entities are Ref intrinsic functions that refer to resources in\n the template, such as { \"Ref\" : \"MyEC2InstanceResource\" }.
\n ParameterReference entities are Ref intrinsic functions that get template parameter\n values, such as { \"Ref\" : \"MyPasswordParameter\" }.
\n ResourceAttribute entities are Fn::GetAtt intrinsic functions that get resource\n attribute values, such as { \"Fn::GetAtt\" : [ \"MyEC2InstanceResource\", \"PublicDnsName\" ] }.
\n DirectModification entities are changes that are made directly to the template.
\n Automatic entities are AWS::CloudFormation::Stack resource types, which are also\n 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\n have changed. Changes to a nested stack's template aren't visible to CloudFormation until you run an update on the parent\n stack.
The identity of the entity that triggered this change. This entity is a member of the group that's specified by\n the ChangeSource field. For example, if you modified the value of the KeyPairName\n parameter, the CausingEntity is the name of the parameter (KeyPairName).
If the ChangeSource value is DirectModification, no value is given for\n CausingEntity.
The identity of the entity that triggered this change. This entity is a member of the group that's specified by\n the ChangeSource field. For example, if you modified the value of the KeyPairName\n parameter, the CausingEntity is the name of the parameter (KeyPairName).
If the ChangeSource value is DirectModification, no value is given for\n CausingEntity.
The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see\n IaC\n generator supported resource types in the CloudFormation User Guide\n
The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see\n IaC\n generator supported resource types in the CloudFormation User Guide\n
The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see\n IaC\n generator supported resource types In the CloudFormation User Guide\n
The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see\n IaC\n generator supported resource types In the CloudFormation User Guide\n
The resource properties you can provide during the import to identify your target resources. For example,\n BucketName is a possible identifier property for AWS::S3::Bucket resources.
The resource properties you can provide during the import to identify your target resources. For example,\n BucketName is a possible identifier property for AWS::S3::Bucket resources.
Describes the target resources of a specific type in your import template (for example, all\n AWS::S3::Bucket resources) and the properties you can provide during the import to identify resources\n of that type.
Describes the target resources of a specific type in your import template (for example, all\n AWS::S3::Bucket resources) and the properties you can provide during the import to identify resources of\n that type.
Indicates which resource attribute is triggering this update, such as a change in the resource attribute's\n Metadata, Properties, or Tags.
Indicates which resource attribute is triggering this update, such as a change in the resource attribute's\n Metadata, Properties, or Tags.
If the Attribute value is Properties, indicates whether a change to this property\n causes the resource to be recreated. The value can be Never, Always, or\n Conditionally. To determine the conditions for a Conditionally recreation, see the update\n behavior for that property in the\n CloudFormation User Guide.
If the Attribute value is Properties, indicates whether a change to this property\n causes the resource to be recreated. The value can be Never, Always, or\n Conditionally. To determine the conditions for a Conditionally recreation, see the update\n behavior for that property in the\n CloudFormation User Guide.
The field that CloudFormation will change, such as the name of a resource's property, and whether the\n resource will be recreated.
" + "smithy.api#documentation": "The field that CloudFormation will change, such as the name of a resource's property, and whether the resource will be\n recreated.
" } }, "com.amazonaws.cloudformation#ResourceToImport": { @@ -10559,7 +10576,7 @@ "target": "com.amazonaws.cloudformation#ResourceType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The type of resource to import into your stack, such as AWS::S3::Bucket. For a list of supported\n resource types, see Resources that support import\n operations in the CloudFormation User Guide.
The type of resource to import into your stack, such as AWS::S3::Bucket. For a list of supported\n resource types, see Resources that support import\n operations in the CloudFormation User Guide.
A key-value pair that identifies the target resource. The key is an identifier property (for example,\n BucketName for AWS::S3::Bucket resources) and the value is the actual property value (for\n example, MyS3Bucket).
A key-value pair that identifies the target resource. The key is an identifier property (for example,\n BucketName for AWS::S3::Bucket resources) and the value is the actual property value (for\n example, MyS3Bucket).
The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers\n after the stack creation or update operation deploys all necessary resources.
\nThe default is 0 minutes.
\nIf you specify a monitoring period but don't specify any rollback triggers, CloudFormation still waits\n the specified period of time before cleaning up old resources after update operations. You can use this monitoring\n period to perform any manual stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary.
\nIf you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers\n during stack creation and update operations. Then, for update operations, it begins disposing of old resources\n immediately once the operation completes.
" + "smithy.api#documentation": "The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack\n creation or update operation deploys all necessary resources.
\nThe default is 0 minutes.
\nIf you specify a monitoring period but don't specify any rollback triggers, CloudFormation still waits the specified\n period of time before cleaning up old resources after update operations. You can use this monitoring period to\n perform any manual stack validation desired, and manually cancel the stack creation or update (using \n CancelUpdateStack\n , for example) as necessary.
If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack\n creation and update operations. Then, for update operations, it begins disposing of old resources immediately once\n the operation completes.
" } } }, @@ -10735,7 +10752,7 @@ } ], "traits": { - "smithy.api#documentation": "When specifying RollbackStack, you preserve the state of previously provisioned resources when an\n operation fails. You can check the status of the stack through the DescribeStacks operation.
Rolls back the specified stack to the last known stable state from CREATE_FAILED or\n UPDATE_FAILED stack statuses.
This operation will delete a stack if it doesn't contain a last known stable state. A last known stable state\n includes any status in a *_COMPLETE. This includes the following stack statuses.
\n CREATE_COMPLETE\n
\n UPDATE_COMPLETE\n
\n UPDATE_ROLLBACK_COMPLETE\n
\n IMPORT_COMPLETE\n
\n IMPORT_ROLLBACK_COMPLETE\n
When specifying RollbackStack, you preserve the state of previously provisioned resources when an\n operation fails. You can check the status of the stack through the DescribeStacks operation.
Rolls back the specified stack to the last known stable state from CREATE_FAILED or\n UPDATE_FAILED stack statuses.
This operation will delete a stack if it doesn't contain a last known stable state. A last known stable state\n includes any status in a *_COMPLETE. This includes the following stack statuses.
\n CREATE_COMPLETE\n
\n UPDATE_COMPLETE\n
\n UPDATE_ROLLBACK_COMPLETE\n
\n IMPORT_COMPLETE\n
\n IMPORT_ROLLBACK_COMPLETE\n
When set to true, newly created resources are deleted when the operation rolls back. This includes newly\n created resources marked with a deletion policy of Retain.
Default: false\n
When set to true, newly created resources are deleted when the operation rolls back. This includes\n newly created resources marked with a deletion policy of Retain.
Default: false\n
The resource type of the rollback trigger. Specify either AWS::CloudWatch::Alarm or AWS::CloudWatch::CompositeAlarm resource types.
", + "smithy.api#documentation": "The resource type of the rollback trigger. Specify either \n AWS::CloudWatch::Alarm\n or \n AWS::CloudWatch::CompositeAlarm\n resource types.
The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see\n IaC\n generator supported resource types In the CloudFormation User Guide\n
The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see\n Resource type support In the CloudFormation User Guide\n
The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see\n IaC\n generator supported resource types In the CloudFormation User Guide\n
The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see\n IaC\n generator supported resource types In the CloudFormation User Guide.
Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in\n an Amazon S3 bucket in the same Amazon Web Services Region as the stack. You can specify either the\n StackPolicyBody or the StackPolicyURL parameter, but not both.
Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in\n an Amazon S3 bucket in the same Amazon Web Services Region as the stack. The location for an Amazon S3 bucket must\n start with https://. You can specify either the StackPolicyBody or the\n StackPolicyURL parameter, but not both.
Specifies the configuration data for a registered CloudFormation extension, in the given account and\n Region.
\nTo view the current configuration data for an extension, refer to the ConfigurationSchema element\n of DescribeType. For more information, see Configuring extensions at\n the account level in the CloudFormation User Guide.
It's strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such\n as third-party credentials. For more details on dynamic references, see Using\n dynamic references to specify template values in the CloudFormation User\n Guide.
\nSpecifies the configuration data for a registered CloudFormation extension, in the given account and Region.
\nTo view the current configuration data for an extension, refer to the ConfigurationSchema element\n of \n DescribeType\n . For more information, see Configuring extensions at\n the account level in the CloudFormation User Guide.
It's strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such\n as third-party credentials. For more details on dynamic references, see Using\n dynamic references to specify template values in the CloudFormation User Guide.
\nThe Amazon Resource Name (ARN) for the extension, in this account and Region.
\nFor public extensions, this will be the ARN assigned when you activate the type in this account and\n Region. For private extensions, this will be the ARN assigned when you register the type in this account and\n Region.
\nDo not include the extension versions suffix at the end of the ARN. You can set the configuration for an\n extension, but not for a specific extension version.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the extension, in this account and Region.
\nFor public extensions, this will be the ARN assigned when you call the \n ActivateType\n API operation\n in this account and Region. For private extensions, this will be the ARN assigned when you call the \n RegisterType\n API operation 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\n extension, but not for a specific extension version.
" } }, "Configuration": { "target": "com.amazonaws.cloudformation#TypeConfiguration", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The configuration data for the extension, in this account and Region.
\nThe configuration data must be formatted as JSON, and validate against the schema returned in the\n ConfigurationSchema response element of DescribeType. For more information, see\n Defining\n account-level configuration data for an extension in the CloudFormation CLI User\n Guide.
The configuration data for the extension, in this account and Region.
\nThe configuration data must be formatted as JSON, and validate against the schema returned in the\n ConfigurationSchema response element of \n DescribeType\n . For more information, see\n Defining\n account-level configuration data for an extension in the CloudFormation CLI User\n Guide.
Sends a signal to the specified resource with a success or failure status. You can use the\n SignalResource operation in conjunction with a creation policy or update policy. CloudFormation\n doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout\n period is exceeded. The SignalResource operation is useful in cases where you want to send signals from\n anywhere other than an Amazon EC2 instance.
Sends a signal to the specified resource with a success or failure status. You can use the\n SignalResource operation in conjunction with a creation policy or update policy. CloudFormation doesn't\n proceed with a stack creation or update until resources receive the required number of signals or the timeout period\n is exceeded. The SignalResource operation is useful in cases where you want to send signals from\n anywhere other than an Amazon EC2 instance.
The status of the signal, which is either success or failure. A failure signal causes CloudFormation to\n immediately fail the stack creation or update.
", + "smithy.api#documentation": "The status of the signal, which is either success or failure. A failure signal causes CloudFormation to immediately\n fail the stack creation or update.
", "smithy.api#required": {} } } @@ -11195,7 +11212,7 @@ "RollbackConfiguration": { "target": "com.amazonaws.cloudformation#RollbackConfiguration", "traits": { - "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for\n the specified monitoring period afterwards.
" + "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified\n monitoring period afterwards.
" } }, "StackStatus": { @@ -11245,7 +11262,7 @@ "RoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that's associated with the\n stack. During a stack operation, CloudFormation uses this role's credentials to make calls on your behalf.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that's associated with the stack.\n During a stack operation, CloudFormation uses this role's credentials to make calls on your behalf.
" } }, "Tags": { @@ -11281,7 +11298,13 @@ "RetainExceptOnCreate": { "target": "com.amazonaws.cloudformation#RetainExceptOnCreate", "traits": { - "smithy.api#documentation": "When set to true, newly created resources are deleted when the operation rolls back. This includes newly\n created resources marked with a deletion policy of Retain.
Default: false\n
When set to true, newly created resources are deleted when the operation rolls back. This includes\n newly created resources marked with a deletion policy of Retain.
Default: false\n
The detailed status of the resource or stack. If CONFIGURATION_COMPLETE is present, the resource or\n resource configuration phase has completed and the stabilization of the resources is in progress. The stack sets\n CONFIGURATION_COMPLETE when all of the resources in the stack have reached that event. For more\n information, see CloudFormation stack deployment in\n the CloudFormation User Guide.
Type of resource. (For more information, go to Amazon Web Services Resource Types\n Reference in the CloudFormation User Guide.)
" + "smithy.api#documentation": "Type of resource. (For more information, go to Amazon Web Services Resource Types\n Reference in the CloudFormation User Guide.)
" } }, "Timestamp": { @@ -11471,7 +11494,7 @@ "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "The token passed to the operation that generated this event.
\nAll events triggered by a given stack operation are assigned the same client request token, which you can use to\n track operations. For example, if you execute a CreateStack operation with the token\n token1, then all the StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that are\n initiated from the console use the token format Console-StackOperation-ID, which helps you\n easily identify the stack operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
The token passed to the operation that generated this event.
\nAll events triggered by a given stack operation are assigned the same client request token, which you can use to\n track operations. For example, if you execute a CreateStack operation with the token\n token1, then all the StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that are\n initiated from the console use the token format Console-StackOperation-ID, which helps you\n easily identify the stack operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
Specify the hook failure mode for non-compliant resources in the followings ways.
\n\n FAIL Stops provisioning resources.
\n WARN Allows provisioning to continue with a warning message.
An optional field containing information about the detailed status of the stack event.
\n\n CONFIGURATION_COMPLETE - all of the resources in the stack have reached that event. For more\n information, see CloudFormation stack deployment\n in the CloudFormation User Guide.
\n VALIDATION_FAILED - template validation failed because of invalid properties in the template. The\n ResourceStatusReason field shows what properties are defined incorrectly.
[Self-managed permissions] The name of the Amazon Web Services account that the stack\n instance is associated with.
" + "smithy.api#documentation": "[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated\n with.
" } }, "StackId": { @@ -11564,13 +11593,13 @@ "ParameterOverrides": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "A list of parameters from the stack set template whose values have been overridden in this\n stack instance.
" + "smithy.api#documentation": "A list of parameters from the stack set template whose values have been overridden in this stack\n instance.
" } }, "Status": { "target": "com.amazonaws.cloudformation#StackInstanceStatus", "traits": { - "smithy.api#documentation": "The status of the stack instance, in terms of its synchronization with its associated stack\n set.
\n\n INOPERABLE: A DeleteStackInstances operation has failed and left\n the stack in an unstable state. Stacks in this state are excluded from further\n UpdateStackSet operations. You might need to perform a\n DeleteStackInstances operation, with RetainStacks set to\n true, to delete the stack instance, and then delete the stack manually.
\n OUTDATED: The stack isn't currently up to date with the stack set\n because:
The associated stack failed during a CreateStackSet or\n UpdateStackSet operation.
The stack was part of a CreateStackSet or UpdateStackSet\n operation that failed or was stopped before the stack was created or updated.
\n CURRENT: The stack is currently up to date with the stack set.
The status of the stack instance, in terms of its synchronization with its associated stack set.
\n\n INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an\n unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might\n need to perform a DeleteStackInstances operation, with RetainStacks set to\n true, to delete the stack instance, and then delete the stack manually. INOPERABLE can be\n returned here when the cause is a failed import. If it's due to a failed import, the operation can be retried once\n the failures are fixed. To see if this is due to a failed import, look at the DetailedStatus member in\n the StackInstanceSummary member that is a peer to this Status\n member.
\n OUTDATED: The stack isn't currently up to date with the stack set because:
The associated stack failed during a CreateStackSet or UpdateStackSet\n operation.
The stack was part of a CreateStackSet or UpdateStackSet operation that failed or\n was stopped before the stack was created or updated.
\n CURRENT: The stack is currently up to date with the stack set.
[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that\n you specified for DeploymentTargets.
" + "smithy.api#documentation": "[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for\n \n DeploymentTargets\n .
Status of the stack instance's actual configuration compared to the expected template and\n parameter configuration of the stack set to which it belongs.
\n\n DRIFTED: The stack differs from the expected template and parameter\n configuration of the stack set to which it belongs. A stack instance is considered to have\n drifted if one or more of the resources in the associated stack have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked if the stack instance differs from its\n expected stack set configuration.
\n IN_SYNC: The stack instance's actual configuration matches its expected stack\n set configuration.
\n UNKNOWN: This value is reserved for future use.
Status of the stack instance's actual configuration compared to the expected template and parameter\n configuration of the stack set to which it belongs.
\n\n DRIFTED: The stack differs from the expected template and parameter configuration of the stack\n set to which it belongs. A stack instance is considered to have drifted if one or more of the resources in the\n associated stack have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked if the stack instance differs from its expected stack set\n configuration.
\n IN_SYNC: The stack instance's actual configuration matches its expected stack set\n configuration.
\n UNKNOWN: This value is reserved for future use.
Most recent time when CloudFormation performed a drift detection operation on the\n stack instance. This value will be NULL for any stack instance on which drift\n detection hasn't yet been performed.
Most recent time when CloudFormation performed a drift detection operation on the stack instance. This value will be\n NULL for any stack instance on which drift detection hasn't yet been performed.
An CloudFormation stack, in a specific account and Region, that's part of a stack set\n operation. A stack instance is a reference to an attempted or actual stack in a given account\n within a given Region. A stack instance can exist without a stack—for example, if the stack\n couldn't be created for some reason. A stack instance is associated with only one stack set. Each\n stack instance contains the ID of its associated stack set, in addition to the ID of the actual\n stack and the stack status.
" + "smithy.api#documentation": "An CloudFormation stack, in a specific account and Region, that's part of a stack set operation. A stack instance is a\n reference to an attempted or actual stack in a given account within a given Region. A stack instance can exist\n without a stack—for example, if the stack couldn't be created for some reason. A stack instance is associated with\n only one stack set. Each stack instance contains the ID of its associated stack set, in addition to the ID of the\n actual stack and the stack status.
" } }, "com.amazonaws.cloudformation#StackInstanceComprehensiveStatus": { @@ -11620,7 +11649,7 @@ "DetailedStatus": { "target": "com.amazonaws.cloudformation#StackInstanceDetailedStatus", "traits": { - "smithy.api#documentation": "\n CANCELLED: The operation in the specified account and Region has been\n canceled. This is either because a user has stopped the stack set operation, or because the\n failure tolerance of the stack set operation has been exceeded.
\n FAILED: The operation in the specified account and Region failed. If the\n stack set operation fails in enough accounts within a Region, the failure tolerance for the\n stack set operation as a whole might be exceeded.
\n INOPERABLE: A DeleteStackInstances operation has failed and left\n the stack in an unstable state. Stacks in this state are excluded from further\n UpdateStackSet operations. You might need to perform a\n DeleteStackInstances operation, with RetainStacks set to\n true, to delete the stack instance, and then delete the stack manually.
\n PENDING: The operation in the specified account and Region has yet to\n start.
\n RUNNING: The operation in the specified account and Region is currently in\n progress.
\n SKIPPED_SUSPENDED_ACCOUNT: The operation in the specified account and Region\n has been skipped because the account was suspended at the time of the operation.
\n SUCCEEDED: The operation in the specified account and Region completed\n successfully.
\n CANCELLED: The operation in the specified account and Region has been canceled. This is either\n because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has\n been exceeded.
\n FAILED: The operation in the specified account and Region failed. If the stack set operation\n fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be\n exceeded.
\n FAILED_IMPORT: The import of the stack instance in the specified account and Region failed and\n left the stack in an unstable state. Once the issues causing the failure are fixed, the import operation can be\n retried. If enough stack set operations fail in enough accounts within a Region, the failure tolerance for the\n stack set operation as a whole might be exceeded.
\n INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an\n unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might\n need to perform a DeleteStackInstances operation, with RetainStacks set to\n true, to delete the stack instance, and then delete the stack manually.
\n PENDING: The operation in the specified account and Region has yet to start.
\n RUNNING: The operation in the specified account and Region is currently in progress.
\n SKIPPED_SUSPENDED_ACCOUNT: The operation in the specified account and Region has been skipped\n because the account was suspended at the time of the operation.
\n SUCCEEDED: The operation in the specified account and Region completed successfully.
The name or unique identifier that corresponds to a physical instance ID of a resource\n supported by CloudFormation.
" + "smithy.api#documentation": "The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.
" } }, "PhysicalResourceIdContext": { "target": "com.amazonaws.cloudformation#PhysicalResourceIdContext", "traits": { - "smithy.api#documentation": "Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses\n context key-value pairs in cases where a resource's logical and physical IDs aren't enough\n to uniquely identify that resource. Each context key-value pair specifies a unique resource\n that contains the targeted resource.
" + "smithy.api#documentation": "Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses context key-value pairs in\n cases where a resource's logical and physical IDs aren't enough to uniquely identify that resource. Each context\n key-value pair specifies a unique resource that contains the targeted resource.
" } }, "ResourceType": { "target": "com.amazonaws.cloudformation#ResourceType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Type of resource. For more information, go to Amazon Web Services\n Resource Types Reference in the CloudFormation User Guide.
", + "smithy.api#documentation": "Type of resource. For more information, go to Amazon Web Services Resource Types\n Reference in the CloudFormation User Guide.
", "smithy.api#required": {} } }, "PropertyDifferences": { "target": "com.amazonaws.cloudformation#PropertyDifferences", "traits": { - "smithy.api#documentation": "Status of the actual configuration of the resource compared to its expected\n configuration. These will be present only for resources whose\n StackInstanceResourceDriftStatus is MODIFIED.
Status of the actual configuration of the resource compared to its expected configuration. These will be present\n only for resources whose StackInstanceResourceDriftStatus is MODIFIED.
The drift status of the resource in a stack instance.
\n\n DELETED: The resource differs from its expected template configuration in\n that the resource has been deleted.
\n MODIFIED: One or more resource properties differ from their expected template\n values.
\n IN_SYNC: The resource's actual configuration matches its expected template\n configuration.
\n NOT_CHECKED: CloudFormation doesn't currently return this value.
The drift status of the resource in a stack instance.
\n\n DELETED: The resource differs from its expected template configuration in that the resource has\n been deleted.
\n MODIFIED: One or more resource properties differ from their expected template values.
\n IN_SYNC: The resource's actual configuration matches its expected template configuration.
\n NOT_CHECKED: CloudFormation doesn't currently return this value.
The structure containing summary information about resource drifts for a stack\n instance.
" + "smithy.api#documentation": "The structure containing summary information about resource drifts for a stack instance.
" } }, "com.amazonaws.cloudformation#StackInstanceStatus": { @@ -11876,7 +11911,7 @@ "Account": { "target": "com.amazonaws.cloudformation#Account", "traits": { - "smithy.api#documentation": "[Self-managed permissions] The name of the Amazon Web Services account that the stack\n instance is associated with.
" + "smithy.api#documentation": "[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated\n with.
" } }, "StackId": { @@ -11888,7 +11923,7 @@ "Status": { "target": "com.amazonaws.cloudformation#StackInstanceStatus", "traits": { - "smithy.api#documentation": "The status of the stack instance, in terms of its synchronization with its associated stack\n set.
\n\n INOPERABLE: A DeleteStackInstances operation has failed and left\n the stack in an unstable state. Stacks in this state are excluded from further\n UpdateStackSet operations. You might need to perform a\n DeleteStackInstances operation, with RetainStacks set to\n true, to delete the stack instance, and then delete the stack manually.
\n OUTDATED: The stack isn't currently up to date with the stack set\n because:
The associated stack failed during a CreateStackSet or\n UpdateStackSet operation.
The stack was part of a CreateStackSet or UpdateStackSet\n operation that failed or was stopped before the stack was created or updated.
\n CURRENT: The stack is currently up to date with the stack set.
The status of the stack instance, in terms of its synchronization with its associated stack set.
\n\n INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an\n unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might\n need to perform a DeleteStackInstances operation, with RetainStacks set to\n true, to delete the stack instance, and then delete the stack manually. INOPERABLE can be\n returned here when the cause is a failed import. If it's due to a failed import, the operation can be retried once\n the failures are fixed. To see if this is due to a failed import, call the DescribeStackInstance\n API operation, look at the DetailedStatus member returned in the StackInstanceSummary\n member.
\n OUTDATED: The stack isn't currently up to date with the stack set because:
The associated stack failed during a CreateStackSet or UpdateStackSet\n operation.
The stack was part of a CreateStackSet or UpdateStackSet operation that failed or\n was stopped before the stack was created or updated.
\n CURRENT: The stack is currently up to date with the stack set.
[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that\n you specified for DeploymentTargets.
" + "smithy.api#documentation": "[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for\n \n DeploymentTargets\n .
Status of the stack instance's actual configuration compared to the expected template and\n parameter configuration of the stack set to which it belongs.
\n\n DRIFTED: The stack differs from the expected template and parameter\n configuration of the stack set to which it belongs. A stack instance is considered to have\n drifted if one or more of the resources in the associated stack have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked if the stack instance differs from its\n expected stack set configuration.
\n IN_SYNC: The stack instance's actual configuration matches its expected stack\n set configuration.
\n UNKNOWN: This value is reserved for future use.
Status of the stack instance's actual configuration compared to the expected template and parameter\n configuration of the stack set to which it belongs.
\n\n DRIFTED: The stack differs from the expected template and parameter configuration of the stack\n set to which it belongs. A stack instance is considered to have drifted if one or more of the resources in the\n associated stack have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked if the stack instance differs from its expected stack set\n configuration.
\n IN_SYNC: The stack instance's actual configuration matches its expected stack set\n configuration.
\n UNKNOWN: This value is reserved for future use.
Most recent time when CloudFormation performed a drift detection operation on the\n stack instance. This value will be NULL for any stack instance on which drift\n detection hasn't yet been performed.
Most recent time when CloudFormation performed a drift detection operation on the stack instance. This value will be\n NULL for any stack instance on which drift detection hasn't yet been performed.
Type of resource. For more information, go to Amazon Web Services Resource Types\n Reference in the CloudFormation User Guide.
", + "smithy.api#documentation": "Type of resource. For more information, go to Amazon Web Services Resource Types\n Reference in the CloudFormation User Guide.
", "smithy.api#required": {} } }, @@ -12112,7 +12147,7 @@ "target": "com.amazonaws.cloudformation#ResourceType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Type of resource. For more information, go to Amazon Web Services Resource Types\n Reference in the CloudFormation User Guide.
", + "smithy.api#documentation": "Type of resource. For more information, go to Amazon Web Services Resource Types\n Reference in the CloudFormation User Guide.
", "smithy.api#required": {} } }, @@ -12248,7 +12283,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains the drift information for a resource that has been checked for drift. This includes actual and expected\n property values for resources in which CloudFormation has detected drift. Only resource properties explicitly defined in the\n stack template are checked for drift. For more information, see Detecting Unregulated Configuration Changes to\n Stacks and Resources.
\nResources that don't currently support drift detection can't be checked. For a list of resources that support\n drift detection, see Resources that Support Drift\n Detection.
\nUse DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.
" + "smithy.api#documentation": "Contains the drift information for a resource that has been checked for drift. This includes actual and expected\n property values for resources in which CloudFormation has detected drift. Only resource properties explicitly defined in the\n stack template are checked for drift. For more information, see Detecting Unregulated Configuration Changes to\n Stacks and Resources.
\nResources that don't currently support drift detection can't be checked. For a list of resources that support\n drift detection, see Resources that Support Drift\n Detection.
\nUse DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.
" } }, "com.amazonaws.cloudformation#StackResourceDriftInformation": { @@ -12258,7 +12293,7 @@ "target": "com.amazonaws.cloudformation#StackResourceDriftStatus", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Status of the resource's actual configuration compared to its expected configuration
\n\n DELETED: The resource differs from its expected configuration in that it has been deleted.
\n MODIFIED: The resource differs from its expected configuration.
\n NOT_CHECKED: CloudFormation has not checked if the resource differs from its expected\n configuration.
Any resources that do not currently support drift detection have a status of NOT_CHECKED. For\n more information, see Resources that Support Drift\n Detection.
\n IN_SYNC: The resource's actual configuration matches its expected configuration.
Status of the resource's actual configuration compared to its expected configuration
\n\n DELETED: The resource differs from its expected configuration in that it has been deleted.
\n MODIFIED: The resource differs from its expected configuration.
\n NOT_CHECKED: CloudFormation has not checked if the resource differs from its expected\n configuration.
Any resources that do not currently support drift detection have a status of NOT_CHECKED. For\n more information, see Resources that Support Drift\n Detection.
\n IN_SYNC: The resource's actual configuration matches its expected configuration.
Contains information about whether the resource's actual configuration differs, or has\n drifted, from its expected configuration.
" + "smithy.api#documentation": "Contains information about whether the resource's actual configuration differs, or has\n drifted, from its expected configuration.
" } }, "com.amazonaws.cloudformation#StackResourceDriftInformationSummary": { @@ -12280,7 +12315,7 @@ "target": "com.amazonaws.cloudformation#StackResourceDriftStatus", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Status of the resource's actual configuration compared to its expected configuration.
\n\n DELETED: The resource differs from its expected configuration in that it has been deleted.
\n MODIFIED: The resource differs from its expected configuration.
\n 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\n information, see Resources that Support Drift\n Detection. If you performed an ContinueUpdateRollback operation on a stack, any\n resources included in ResourcesToSkip will also have a status of NOT_CHECKED. For more\n information about skipping resources during rollback operations, see Continue Rolling\n Back an Update in the CloudFormation User Guide.
\n IN_SYNC: The resource's actual configuration matches its expected configuration.
Status of the resource's actual configuration compared to its expected configuration.
\n\n DELETED: The resource differs from its expected configuration in that it has been deleted.
\n MODIFIED: The resource differs from its expected configuration.
\n 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\n information, see Resources that Support Drift\n Detection. If you performed an ContinueUpdateRollback operation on a stack, any resources\n included in ResourcesToSkip will also have a status of NOT_CHECKED. For more information\n about skipping resources during rollback operations, see Continue Rolling\n Back an Update in the CloudFormation User Guide.
\n IN_SYNC: The resource's actual configuration matches its expected configuration.
Summarizes information about whether the resource's actual configuration differs, or has\n drifted, from its expected configuration.
" + "smithy.api#documentation": "Summarizes information about whether the resource's actual configuration differs, or has\n drifted, from its expected configuration.
" } }, "com.amazonaws.cloudformation#StackResourceDriftStatus": { @@ -12369,7 +12404,7 @@ "target": "com.amazonaws.cloudformation#ResourceType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Type of resource. (For more information, go to Amazon Web Services Resource Types\n Reference in the CloudFormation User Guide.)
", + "smithy.api#documentation": "Type of resource. (For more information, go to Amazon Web Services Resource Types\n Reference in the CloudFormation User Guide.)
", "smithy.api#required": {} } }, @@ -12436,7 +12471,7 @@ "Description": { "target": "com.amazonaws.cloudformation#Description", "traits": { - "smithy.api#documentation": "A description of the stack set that you specify when the stack set is created or\n updated.
" + "smithy.api#documentation": "A description of the stack set that you specify when the stack set is created or updated.
" } }, "Status": { @@ -12448,7 +12483,7 @@ "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { - "smithy.api#documentation": "The structure that contains the body of the template that was used to create or update the\n stack set.
" + "smithy.api#documentation": "The structure that contains the body of the template that was used to create or update the stack set.
" } }, "Parameters": { @@ -12460,13 +12495,13 @@ "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "The capabilities that are allowed in the stack set. Some stack set templates might include\n resources that can affect permissions in your Amazon Web Services account—for example, by creating\n new Identity and Access Management (IAM) users. For more information, see Acknowledging\n IAM Resources in CloudFormation Templates.\n
" + "smithy.api#documentation": "The capabilities that are allowed in the stack set. Some stack set templates might include resources that can\n 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\n Templates.\n
" } }, "Tags": { "target": "com.amazonaws.cloudformation#Tags", "traits": { - "smithy.api#documentation": "A list of tags that specify information about the stack set. A maximum number of 50 tags can\n be specified.
" + "smithy.api#documentation": "A list of tags that specify information about the stack set. A maximum number of 50 tags can be\n specified.
" } }, "StackSetARN": { @@ -12478,54 +12513,54 @@ "AdministrationRoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role used to create or update the\n stack set.
\nUse customized administrator roles to control which users or groups can manage specific\n stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the\n CloudFormation User Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role used to create or update the stack set.
\nUse customized administrator roles to control which users or groups can manage specific stack sets within the\n same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set\n Operations in the CloudFormation User Guide.
" } }, "ExecutionRoleName": { "target": "com.amazonaws.cloudformation#ExecutionRoleName", "traits": { - "smithy.api#documentation": "The name of the IAM execution role used to create or update the stack\n set.
\nUse customized execution roles to control which stack resources users and groups can include\n in their stack sets.
" + "smithy.api#documentation": "The name of the IAM execution role used to create or update the stack set.
\nUse customized execution roles to control which stack resources users and groups can include in their stack\n sets.
" } }, "StackSetDriftDetectionDetails": { "target": "com.amazonaws.cloudformation#StackSetDriftDetectionDetails", "traits": { - "smithy.api#documentation": "Detailed information about the drift status of the stack set.
\nFor stack sets, contains information about the last completed drift\n operation performed on the stack set. Information about drift operations currently in progress\n isn't included.
" + "smithy.api#documentation": "Detailed information about the drift status of the stack set.
\nFor stack sets, contains information about the last completed drift operation performed on\n the stack set. Information about drift operations currently in progress isn't included.
" } }, "AutoDeployment": { "target": "com.amazonaws.cloudformation#AutoDeployment", "traits": { - "smithy.api#documentation": "[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit\n (OU).
" + "smithy.api#documentation": "[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations\n accounts that are added to a target organization or organizational unit (OU).
" } }, "PermissionModel": { "target": "com.amazonaws.cloudformation#PermissionModels", "traits": { - "smithy.api#documentation": "Describes how the IAM roles required for stack set operations are\n created.
\nWith self-managed permissions, you must create the administrator and\n execution roles required to deploy to target accounts. For more information, see Grant\n 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\n information, see Grant\n Service-Managed Stack Set Permissions.
Describes how the IAM roles required for stack set operations are created.
\nWith self-managed permissions, you must create the administrator and execution roles required to\n deploy to target accounts. For more information, see Grant Self-Managed Stack Set\n Permissions.
With service-managed permissions, StackSets automatically creates the IAM roles required to\n deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set\n Permissions.
[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that\n you specified for DeploymentTargets.
" + "smithy.api#documentation": "[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for\n \n DeploymentTargets\n .
Describes whether StackSets performs non-conflicting operations concurrently and queues\n conflicting operations.
" + "smithy.api#documentation": "Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting\n operations.
" } }, "Regions": { "target": "com.amazonaws.cloudformation#RegionList", "traits": { - "smithy.api#documentation": "Returns a list of all Amazon Web Services Regions the given StackSet has stack instances\n deployed in. The Amazon Web Services Regions list output is in no particular order.
" + "smithy.api#documentation": "Returns a list of all Amazon Web Services Regions the given StackSet has stack instances deployed in. The Amazon Web Services Regions list output is in no particular order.
" } } }, "traits": { - "smithy.api#documentation": "A structure that contains information about a stack set. A stack set enables you to\n provision stacks into Amazon Web Services accounts and across Regions by using a single CloudFormation template. In the stack set, you specify the template to use, in addition to any\n parameters and capabilities that the template requires.
" + "smithy.api#documentation": "A structure that contains information about a stack set. A stack set enables you to provision stacks into\n Amazon Web Services accounts and across Regions by using a single CloudFormation template. In the stack set, you specify\n the template to use, in addition to any parameters and capabilities that the template requires.
" } }, "com.amazonaws.cloudformation#StackSetARN": { @@ -12537,19 +12572,19 @@ "DriftStatus": { "target": "com.amazonaws.cloudformation#StackSetDriftStatus", "traits": { - "smithy.api#documentation": "Status of the stack set's actual configuration compared to its expected template and\n parameter configuration. A stack set is considered to have drifted if one or more of its stack\n instances have drifted from their expected template and parameter configuration.
\n\n DRIFTED: One or more of the stack instances belonging to the stack set stack\n differs from the expected template and parameter configuration. A stack instance is considered\n to have drifted if one or more of the resources in the associated stack have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked the stack set for drift.
\n IN_SYNC: All of the stack instances belonging to the stack set stack match\n from the expected template and parameter configuration.
Status of the stack set's actual configuration compared to its expected template and parameter configuration. A\n stack set is considered to have drifted if one or more of its stack instances have drifted from their expected\n template and parameter configuration.
\n\n DRIFTED: One or more of the stack instances belonging to the stack set stack differs from the\n expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the\n resources in the associated stack have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked the stack set for drift.
\n IN_SYNC: All of the stack instances belonging to the stack set stack match from the expected\n template and parameter configuration.
The status of the stack set drift detection operation.
\n\n COMPLETED: The drift detection operation completed without failing on any\n stack instances.
\n FAILED: The drift detection operation exceeded the specified failure\n tolerance.
\n PARTIAL_SUCCESS: The drift detection operation completed without exceeding\n the failure tolerance for the operation.
\n IN_PROGRESS: The drift detection operation is currently being\n performed.
\n STOPPED: The user has canceled the drift detection operation.
The status of the stack set drift detection operation.
\n\n COMPLETED: The drift detection operation completed without failing on any stack instances.
\n FAILED: The drift detection operation exceeded the specified failure tolerance.
\n PARTIAL_SUCCESS: The drift detection operation completed without exceeding the failure tolerance\n for the operation.
\n IN_PROGRESS: The drift detection operation is currently being performed.
\n STOPPED: The user has canceled the drift detection operation.
Most recent time when CloudFormation performed a drift detection operation on the\n stack set. This value will be NULL for any stack set on which drift detection hasn't\n yet been performed.
Most recent time when CloudFormation performed a drift detection operation on the stack set. This value will be\n NULL for any stack set on which drift detection hasn't yet been performed.
The number of stack instances that have drifted from the expected template and parameter\n configuration of the stack set. A stack instance is considered to have drifted if one or more of\n the resources in the associated stack don't match their expected configuration.
" + "smithy.api#documentation": "The number of stack instances that have drifted from the expected template and parameter configuration of the\n stack set. A stack instance is considered to have drifted if one or more of the resources in the associated stack\n don't match their expected configuration.
" } }, "InSyncStackInstancesCount": { "target": "com.amazonaws.cloudformation#InSyncStackInstancesCount", "traits": { - "smithy.api#documentation": "The number of stack instances which match the expected template and parameter configuration\n of the stack set.
" + "smithy.api#documentation": "The number of stack instances which match the expected template and parameter configuration of the stack\n set.
" } }, "InProgressStackInstancesCount": { @@ -12584,7 +12619,7 @@ } }, "traits": { - "smithy.api#documentation": "Detailed information about the drift status of the stack set.
\nFor stack sets, contains information about the last completed drift\n operation performed on the stack set. Information about drift operations in-progress isn't\n included.
\nFor stack set operations, includes information about drift operations currently being\n performed on the stack set.
\nFor more information, see Detecting unmanaged changes in\n stack sets in the CloudFormation User Guide.
" + "smithy.api#documentation": "Detailed information about the drift status of the stack set.
\nFor stack sets, contains information about the last completed drift operation performed on\n the stack set. Information about drift operations in-progress isn't included.
\nFor stack set operations, includes information about drift operations currently being performed on the stack\n set.
\nFor more information, see Detecting unmanaged changes in stack sets in\n the CloudFormation User Guide.
" } }, "com.amazonaws.cloudformation#StackSetDriftDetectionStatus": { @@ -12709,13 +12744,13 @@ "Action": { "target": "com.amazonaws.cloudformation#StackSetOperationAction", "traits": { - "smithy.api#documentation": "The type of stack set operation: CREATE, UPDATE, or\n DELETE. Create and delete operations affect only the specified stack set instances\n that are associated with the specified stack set. Update operations affect both the stack set\n itself, in addition to all associated stack set instances.
The type of stack set operation: CREATE, UPDATE, or DELETE. Create and\n delete operations affect only the specified stack set instances that are associated with the specified stack set.\n Update operations affect both the stack set itself, in addition to all associated stack set\n instances.
The status of the operation.
\n\n FAILED: The operation exceeded the specified failure tolerance. The failure\n tolerance value that you've set for an operation is applied for each Region during stack create\n and update operations. If the number of failed stacks within a Region exceeds the failure\n tolerance, the status of the operation in the Region is set to FAILED. This in\n turn sets the status of the operation as a whole to FAILED, and CloudFormation\n cancels the operation in any remaining Regions.
\n QUEUED: [Service-managed permissions] For automatic deployments that require\n a sequence of operations, the operation is queued to be performed. For more information, see\n the stack\n set operation status codes in the CloudFormation User Guide.
\n RUNNING: The operation is currently being performed.
\n STOPPED: The user has canceled the operation.
\n STOPPING: The operation is in the process of stopping, at user\n request.
\n SUCCEEDED: The operation completed creating or updating all the specified\n stacks without exceeding the failure tolerance for the operation.
The status of the operation.
\n\n FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that\n you've set for an operation is applied for each Region during stack create and update operations. If the number of\n failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to\n FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.
\n QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of\n operations, the operation is queued to be performed. For more information, see the stack set operation status\n codes in the CloudFormation User Guide.
\n RUNNING: The operation is currently being performed.
\n STOPPED: The user has canceled the operation.
\n STOPPING: The operation is in the process of stopping, at user request.
\n SUCCEEDED: The operation completed creating or updating all the specified stacks without\n exceeding the failure tolerance for the operation.
For stack set operations of action type DELETE, specifies whether to remove the\n stack instances from the specified stack set, but doesn't delete the stacks. You can't\n re-associate a retained stack, or add an existing, saved stack to a new stack set.
For stack set operations of action type DELETE, specifies whether to remove the stack instances\n from the specified stack set, but doesn't delete the stacks. You can't re-associate a retained stack, or add an\n existing, saved stack to a new stack set.
The Amazon Resource Name (ARN) of the IAM role used to perform this stack set\n operation.
\nUse customized administrator roles to control which users or groups can manage specific\n stack sets within the same administrator account. For more information, see Define\n Permissions for Multiple Administrators in the\n CloudFormation User Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role used to perform this stack set operation.
\nUse customized administrator roles to control which users or groups can manage specific stack sets within the\n same administrator account. For more information, see Define Permissions for Multiple\n Administrators in the CloudFormation User Guide.
" } }, "ExecutionRoleName": { "target": "com.amazonaws.cloudformation#ExecutionRoleName", "traits": { - "smithy.api#documentation": "The name of the IAM execution role used to create or update the stack\n set.
\nUse customized execution roles to control which stack resources users and groups can include\n in their stack sets.
" + "smithy.api#documentation": "The name of the IAM execution role used to create or update the stack set.
\nUse customized execution roles to control which stack resources users and groups can include in their stack\n sets.
" } }, "CreationTimestamp": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#documentation": "The time at which the operation was initiated. Note that the creation times for the stack\n set operation might differ from the creation time of the individual stacks themselves. This is\n because CloudFormation needs to perform preparatory work for the operation, such as\n dispatching the work to the requested Regions, before actually creating the first stacks.
" + "smithy.api#documentation": "The time at which the operation was initiated. Note that the creation times for the stack set operation might\n differ from the creation time of the individual stacks themselves. This is because CloudFormation needs to perform preparatory\n work for the operation, such as dispatching the work to the requested Regions, before actually creating the first\n stacks.
" } }, "EndTimestamp": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#documentation": "The time at which the stack set operation ended, across all accounts and Regions specified.\n Note that this doesn't necessarily mean that the stack set operation was successful, or even\n attempted, in each account or Region.
" + "smithy.api#documentation": "The time at which the stack set operation ended, across all accounts and Regions specified. Note that this\n doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or\n Region.
" } }, "DeploymentTargets": { "target": "com.amazonaws.cloudformation#DeploymentTargets", "traits": { - "smithy.api#documentation": "[Service-managed permissions] The Organizations accounts affected by the stack\n operation.
" + "smithy.api#documentation": "[Service-managed permissions] The Organizations accounts affected by the stack operation.
" } }, "StackSetDriftDetectionDetails": { "target": "com.amazonaws.cloudformation#StackSetDriftDetectionDetails", "traits": { - "smithy.api#documentation": "Detailed information about the drift status of the stack set. This includes information\n about drift operations currently being performed on the stack set.
\nThis information will only be present for stack set operations whose Action\n type is DETECT_DRIFT.
For more information, see Detecting Unmanaged Changes in\n Stack Sets in the CloudFormation User Guide.
" + "smithy.api#documentation": "Detailed information about the drift status of the stack set. This includes information about drift operations\n currently being performed on the stack set.
\nThis information will only be present for stack set operations whose Action type is\n DETECT_DRIFT.
For more information, see Detecting Unmanaged Changes in Stack Sets in\n the CloudFormation User Guide.
" } }, "StatusReason": { @@ -12818,7 +12853,7 @@ "RegionConcurrencyType": { "target": "com.amazonaws.cloudformation#RegionConcurrencyType", "traits": { - "smithy.api#documentation": "The concurrency type of deploying StackSets operations in Regions, could be in parallel or\n one Region at a time.
" + "smithy.api#documentation": "The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a\n time.
" } }, "RegionOrder": { @@ -12830,36 +12865,36 @@ "FailureToleranceCount": { "target": "com.amazonaws.cloudformation#FailureToleranceCount", "traits": { - "smithy.api#documentation": "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,\n CloudFormation doesn't attempt the operation in any subsequent Regions.
\nConditional: You must specify either FailureToleranceCount or\n FailureTolerancePercentage (but not both).
By default, 0 is specified.
The number of accounts, per Region, for which this operation can fail before CloudFormation stops the operation in\n that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent\n Regions.
\nConditional: You must specify either FailureToleranceCount or\n FailureTolerancePercentage (but not both).
By default, 0 is specified.
The percentage of accounts, per Region, for which this stack operation can fail before\n CloudFormation stops the operation in that Region. If the operation is stopped in a Region,\n CloudFormation doesn't attempt the operation in any subsequent Regions.
\nWhen calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number.
\nConditional: You must specify either FailureToleranceCount or\n FailureTolerancePercentage, but not both.
By default, 0 is specified.
The percentage of accounts, per Region, for which this stack operation can fail before CloudFormation stops the operation\n in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent\n Regions.
\nWhen calculating the number of accounts based on the specified percentage, CloudFormation rounds\n down to the next whole number.
\nConditional: You must specify either FailureToleranceCount or\n FailureTolerancePercentage, but not both.
By default, 0 is specified.
The maximum number of accounts in which to perform this operation at one time. This can\n depend on the value of FailureToleranceCount depending on your\n ConcurrencyMode. MaxConcurrentCount is at most one more than the\n FailureToleranceCount if you're using STRICT_FAILURE_TOLERANCE.
Note that this setting lets you specify the maximum for operations. For\n large deployments, under certain circumstances the actual number of accounts acted upon\n concurrently may be lower due to service throttling.
\nConditional: You must specify either MaxConcurrentCount or\n MaxConcurrentPercentage, but not both.
By default, 1 is specified.
The maximum number of accounts in which to perform this operation at one time. This can depend on the value of\n FailureToleranceCount depending on your ConcurrencyMode. MaxConcurrentCount is\n at most one more than the FailureToleranceCount if you're using\n STRICT_FAILURE_TOLERANCE.
Note that this setting lets you specify the maximum for operations. For large deployments,\n under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service\n throttling.
\nConditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage,\n but not both.
By default, 1 is specified.
The maximum percentage of accounts in which to perform this operation at one time.
\nWhen 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\n down would result is zero. In this case, CloudFormation sets the number as one\n instead.
\nNote that this setting lets you specify the maximum for operations. For\n large deployments, under certain circumstances the actual number of accounts acted upon\n concurrently may be lower due to service throttling.
\nConditional: You must specify either MaxConcurrentCount or\n MaxConcurrentPercentage, but not both.
By default, 1 is specified.
The maximum percentage of accounts in which to perform this operation at one time.
\nWhen calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next\n 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.
\nNote that this setting lets you specify the maximum for operations. For large deployments,\n under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service\n throttling.
\nConditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage,\n but not both.
By default, 1 is specified.
Specifies how the concurrency level behaves during the operation execution.
\n\n STRICT_FAILURE_TOLERANCE: This option dynamically lowers the concurrency\n level to ensure the number of failed accounts never exceeds the value of\n FailureToleranceCount +1. The initial actual concurrency is set to the lower of\n either the value of the MaxConcurrentCount, or the value of\n MaxConcurrentCount +1. The actual concurrency is then reduced proportionally by\n the number of failures. This is the default behavior.
If failure tolerance or Maximum concurrent accounts are set to percentages, the behavior\n is similar.
\n\n SOFT_FAILURE_TOLERANCE: This option decouples\n FailureToleranceCount from the actual concurrency. This allows stack set\n operations to run at the concurrency level set by the MaxConcurrentCount value, or\n MaxConcurrentPercentage, regardless of the number of failures.
Specifies how the concurrency level behaves during the operation execution.
\n\n STRICT_FAILURE_TOLERANCE: This option dynamically lowers the concurrency level to ensure the\n number of failed accounts never exceeds the value of FailureToleranceCount +1. The initial actual\n concurrency is set to the lower of either the value of the MaxConcurrentCount, or the value of\n MaxConcurrentCount +1. The actual concurrency is then reduced proportionally by the number of\n failures. This is the default behavior.
If failure tolerance or Maximum concurrent accounts are set to percentages, the behavior is similar.
\n\n SOFT_FAILURE_TOLERANCE: This option decouples FailureToleranceCount from the actual\n concurrency. This allows stack set operations to run at the concurrency level set by the\n MaxConcurrentCount value, or MaxConcurrentPercentage, regardless of the number of\n failures.
The user-specified preferences for how CloudFormation performs a stack set\n operation.
\nFor more information about maximum concurrent accounts and failure tolerance, see Stack set\n operation options.
" + "smithy.api#documentation": "The user-specified preferences for how CloudFormation performs a stack set operation.
\nFor more information about maximum concurrent accounts and failure tolerance, see Stack set operation\n options.
" } }, "com.amazonaws.cloudformation#StackSetOperationResultStatus": { @@ -12909,7 +12944,7 @@ "Account": { "target": "com.amazonaws.cloudformation#Account", "traits": { - "smithy.api#documentation": "[Self-managed permissions] The name of the Amazon Web Services account for this operation\n result.
" + "smithy.api#documentation": "[Self-managed permissions] The name of the Amazon Web Services account for this operation result.
" } }, "Region": { @@ -12921,7 +12956,7 @@ "Status": { "target": "com.amazonaws.cloudformation#StackSetOperationResultStatus", "traits": { - "smithy.api#documentation": "The result status of the stack set operation for the given account in the given\n Region.
\n\n CANCELLED: The operation in the specified account and Region has been\n canceled. This is either because a user has stopped the stack set operation, or because the\n failure tolerance of the stack set operation has been exceeded.
\n 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\n for the stack set operation as a whole might be exceeded.
\n\n RUNNING: The operation in the specified account and Region is currently in\n progress.
\n PENDING: The operation in the specified account and Region has yet to\n start.
\n SUCCEEDED: The operation in the specified account and Region completed\n successfully.
The result status of the stack set operation for the given account in the given Region.
\n\n CANCELLED: The operation in the specified account and Region has been canceled. This is either\n because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has\n been exceeded.
\n 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\n operation as a whole might be exceeded.
\n\n RUNNING: The operation in the specified account and Region is currently in progress.
\n PENDING: The operation in the specified account and Region has yet to start.
\n SUCCEEDED: The operation in the specified account and Region completed successfully.
The results of the account gate function CloudFormation invokes, if present, before\n proceeding with stack set operations in an account.
" + "smithy.api#documentation": "The results of the account gate function CloudFormation invokes, if present, before proceeding with stack set operations\n in an account.
" } }, "OrganizationalUnitId": { "target": "com.amazonaws.cloudformation#OrganizationalUnitId", "traits": { - "smithy.api#documentation": "[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that\n you specified for DeploymentTargets.
" + "smithy.api#documentation": "[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for\n \n DeploymentTargets\n .
The structure that contains information about a specified operation's results for a given\n account in a given Region.
" + "smithy.api#documentation": "The structure that contains information about a specified operation's results for a given account in a given\n Region.
" } }, "com.amazonaws.cloudformation#StackSetOperationStatus": { @@ -13023,25 +13058,25 @@ "Action": { "target": "com.amazonaws.cloudformation#StackSetOperationAction", "traits": { - "smithy.api#documentation": "The type of operation: CREATE, UPDATE, or DELETE.\n Create and delete operations affect only the specified stack instances that are associated with\n the specified stack set. Update operations affect both the stack set itself and\n all associated stack set instances.
The type of operation: CREATE, UPDATE, or DELETE. Create and delete\n operations affect only the specified stack instances that are associated with the specified stack set. Update\n operations affect both the stack set itself and all associated stack set instances.
The overall status of the operation.
\n\n FAILED: The operation exceeded the specified failure tolerance. The failure\n tolerance value that you've set for an operation is applied for each Region during stack create\n and update operations. If the number of failed stacks within a Region exceeds the failure\n tolerance, the status of the operation in the Region is set to FAILED. This in\n turn sets the status of the operation as a whole to FAILED, and CloudFormation\n cancels the operation in any remaining Regions.
\n QUEUED: [Service-managed permissions] For automatic deployments that require\n a sequence of operations, the operation is queued to be performed. For more information, see\n the stack\n set operation status codes in the CloudFormation User Guide.
\n RUNNING: The operation is currently being performed.
\n STOPPED: The user has canceled the operation.
\n STOPPING: The operation is in the process of stopping, at user\n request.
\n SUCCEEDED: The operation completed creating or updating all the specified\n stacks without exceeding the failure tolerance for the operation.
The overall status of the operation.
\n\n FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that\n you've set for an operation is applied for each Region during stack create and update operations. If the number of\n failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to\n FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.
\n QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of\n operations, the operation is queued to be performed. For more information, see the stack set operation status\n codes in the CloudFormation User Guide.
\n RUNNING: The operation is currently being performed.
\n STOPPED: The user has canceled the operation.
\n STOPPING: The operation is in the process of stopping, at user request.
\n SUCCEEDED: The operation completed creating or updating all the specified stacks without\n exceeding the failure tolerance for the operation.
The time at which the operation was initiated. Note that the creation times for the stack\n set operation might differ from the creation time of the individual stacks themselves. This is\n because CloudFormation needs to perform preparatory work for the operation, such as\n dispatching the work to the requested Regions, before actually creating the first stacks.
" + "smithy.api#documentation": "The time at which the operation was initiated. Note that the creation times for the stack set operation might\n differ from the creation time of the individual stacks themselves. This is because CloudFormation needs to perform preparatory\n work for the operation, such as dispatching the work to the requested Regions, before actually creating the first\n stacks.
" } }, "EndTimestamp": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#documentation": "The time at which the stack set operation ended, across all accounts and Regions specified.\n Note that this doesn't necessarily mean that the stack set operation was successful, or even\n attempted, in each account or Region.
" + "smithy.api#documentation": "The time at which the stack set operation ended, across all accounts and Regions specified. Note that this\n doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or\n Region.
" } }, "StatusReason": { @@ -13059,7 +13094,7 @@ "OperationPreferences": { "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", "traits": { - "smithy.api#documentation": "The user-specified preferences for how CloudFormation performs a stack set\n operation.
\nFor more information about maximum concurrent accounts and failure tolerance, see Stack set\n operation options.
" + "smithy.api#documentation": "The user-specified preferences for how CloudFormation performs a stack set operation.
\nFor more information about maximum concurrent accounts and failure tolerance, see Stack set operation\n options.
" } } }, @@ -13108,7 +13143,7 @@ "Description": { "target": "com.amazonaws.cloudformation#Description", "traits": { - "smithy.api#documentation": "A description of the stack set that you specify when the stack set is created or\n updated.
" + "smithy.api#documentation": "A description of the stack set that you specify when the stack set is created or updated.
" } }, "Status": { @@ -13120,31 +13155,31 @@ "AutoDeployment": { "target": "com.amazonaws.cloudformation#AutoDeployment", "traits": { - "smithy.api#documentation": "[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organizational unit (OU).
" + "smithy.api#documentation": "[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations\n accounts that are added to a target organizational unit (OU).
" } }, "PermissionModel": { "target": "com.amazonaws.cloudformation#PermissionModels", "traits": { - "smithy.api#documentation": "Describes how the IAM roles required for stack set operations are\n created.
\nWith self-managed permissions, you must create the administrator and\n execution roles required to deploy to target accounts. For more information, see Grant\n 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\n information, see Grant\n Service-Managed Stack Set Permissions.
Describes how the IAM roles required for stack set operations are created.
\nWith self-managed permissions, you must create the administrator and execution roles required to\n deploy to target accounts. For more information, see Grant Self-Managed Stack Set\n Permissions.
With service-managed permissions, StackSets automatically creates the IAM roles required to\n deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set\n Permissions.
Status of the stack set's actual configuration compared to its expected template and\n parameter configuration. A stack set is considered to have drifted if one or more of its stack\n instances have drifted from their expected template and parameter configuration.
\n\n DRIFTED: One or more of the stack instances belonging to the stack set stack\n differs from the expected template and parameter configuration. A stack instance is considered\n to have drifted if one or more of the resources in the associated stack have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked the stack set for drift.
\n IN_SYNC: All the stack instances belonging to the stack set stack match from\n the expected template and parameter configuration.
\n UNKNOWN: This value is reserved for future use.
Status of the stack set's actual configuration compared to its expected template and parameter configuration. A\n stack set is considered to have drifted if one or more of its stack instances have drifted from their expected\n template and parameter configuration.
\n\n DRIFTED: One or more of the stack instances belonging to the stack set stack differs from the\n expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the\n resources in the associated stack have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked the stack set for drift.
\n IN_SYNC: All the stack instances belonging to the stack set stack match from the expected\n template and parameter configuration.
\n UNKNOWN: This value is reserved for future use.
Most recent time when CloudFormation performed a drift detection operation on the\n stack set. This value will be NULL for any stack set on which drift detection hasn't\n yet been performed.
Most recent time when CloudFormation performed a drift detection operation on the stack set. This value will be\n NULL for any stack set on which drift detection hasn't yet been performed.
Describes whether StackSets performs non-conflicting operations concurrently and queues\n conflicting operations.
" + "smithy.api#documentation": "Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting\n operations.
" } } }, @@ -13505,7 +13540,7 @@ } ], "traits": { - "smithy.api#documentation": "Stops an in-progress operation on a stack set and its associated stack instances. StackSets\n will cancel all the unstarted stack instance deployments and wait for those are in-progress to\n complete.
" + "smithy.api#documentation": "Stops an in-progress operation on a stack set and its associated stack instances. StackSets will cancel all the\n unstarted stack instance deployments and wait for those are in-progress to complete.
" } }, "com.amazonaws.cloudformation#StopStackSetOperationInput": { @@ -13530,7 +13565,7 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a member\n account.
\nBy default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the\n management account. For more information, see Register a\n delegated administrator in the CloudFormation User\n Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n\n Required. A string used to identify this tag. You can specify a maximum of 128 characters for a\n tag key. Tags owned by Amazon Web Services (Amazon Web Services) have the reserved prefix: aws:.
\n Required. A string used to identify this tag. You can specify a maximum of 128 characters\n for a tag key. Tags owned by Amazon Web Services (Amazon Web Services) have the reserved prefix:\n aws:.
Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.
\nFor resource types, this includes passing all contracts tests defined for the type.
\nFor modules, this includes determining if the module's model meets all necessary requirements.
\nFor more information, see Testing your public\n extension prior to publishing in the CloudFormation CLI User Guide.
\nIf you don't specify a version, CloudFormation uses the default version of the extension in your\n account and Region for testing.
\nTo perform testing, CloudFormation assumes the execution role specified when the type was registered.\n For more information, see RegisterType.
\nOnce you've initiated testing on an extension using TestType, you can pass the returned\n TypeVersionArn into DescribeType to monitor the current test\n status and test status description for the extension.
An extension must have a test status of PASSED before it can be published. For more information,\n see Publishing\n extensions to make them available for public use in the CloudFormation CLI User\n Guide.
Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.
\nFor resource types, this includes passing all contracts tests defined for the type.
\nFor modules, this includes determining if the module's model meets all necessary requirements.
\nFor more information, see Testing your public\n extension prior to publishing in the CloudFormation CLI User Guide.
\nIf you don't specify a version, CloudFormation uses the default version of the extension in your account and Region\n for testing.
\nTo perform testing, CloudFormation assumes the execution role specified when the type was registered. For more\n information, see \n RegisterType\n .
Once you've initiated testing on an extension using TestType, you can pass the returned\n TypeVersionArn into \n DescribeType\n to monitor the current test\n status and test status description for the extension.
An extension must have a test status of PASSED before it can be published. For more information,\n see Publishing\n extensions to make them available for public use in the CloudFormation CLI User\n Guide.
The version of the extension to test.
\nYou can specify the version id with either Arn, or with TypeName and\n Type.
If you don't specify a version, CloudFormation uses the default version of the extension in this\n account and Region for testing.
" + "smithy.api#documentation": "The version of the extension to test.
\nYou can specify the version id with either Arn, or with TypeName and\n Type.
If you don't specify a version, CloudFormation uses the default version of the extension in this account and Region\n for testing.
" } }, "LogDeliveryBucket": { "target": "com.amazonaws.cloudformation#S3Bucket", "traits": { - "smithy.api#documentation": "The S3 bucket to which CloudFormation delivers the contract test execution logs.
\nCloudFormation delivers the logs by the time contract testing has completed and the extension has been\n 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,\n the user needs the following permissions:
\n GetObject\n
\n PutObject\n
For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Amazon Web Services Identity and Access Management User Guide.
" + "smithy.api#documentation": "The S3 bucket to which CloudFormation delivers the contract test execution logs.
\nCloudFormation delivers the logs by the time contract testing has completed and the extension has been assigned a\n test type status of PASSED or FAILED.
The user calling TestType must be able to access items in the specified S3 bucket. Specifically,\n the user needs the following permissions:
\n GetObject\n
\n PutObject\n
For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Amazon Web Services Identity and Access Management User Guide.
" } } }, @@ -14060,19 +14095,19 @@ "Configuration": { "target": "com.amazonaws.cloudformation#TypeConfiguration", "traits": { - "smithy.api#documentation": "A JSON string specifying the configuration data for the extension, in this account and Region.
\nIf a configuration hasn't been set for a specified extension, CloudFormation returns\n {}.
A JSON string specifying the configuration data for the extension, in this account and Region.
\nIf a configuration hasn't been set for a specified extension, CloudFormation returns {}.
When the configuration data was last updated for this extension.
\nIf a configuration hasn't been set for a specified extension, CloudFormation returns\n null.
When the configuration data was last updated for this extension.
\nIf a configuration hasn't been set for a specified extension, CloudFormation returns null.
The Amazon Resource Name (ARN) for the extension, in this account and Region.
\nFor public extensions, this will be the ARN assigned when you activate the type in this account and\n Region. For private extensions, this will be the ARN assigned when you register the type in this account and\n Region.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the extension, in this account and Region.
\nFor public extensions, this will be the ARN assigned when you call the \n ActivateType\n API operation in\n this account and Region. For private extensions, this will be the ARN assigned when you call the \n RegisterType\n API operation in this account and Region.
Detailed information concerning the specification of a CloudFormation extension in a given account and\n Region.
\nFor more information, see Configuring extensions at\n the account level in the CloudFormation User Guide.
" + "smithy.api#documentation": "Detailed information concerning the specification of a CloudFormation extension in a given account and\n Region.
\nFor more information, see Configuring extensions at\n the account level in the CloudFormation User Guide.
" } }, "com.amazonaws.cloudformation#TypeConfigurationDetailsList": { @@ -14104,7 +14139,7 @@ "TypeArn": { "target": "com.amazonaws.cloudformation#TypeArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the extension, in this account and Region.
\nFor public extensions, this will be the ARN assigned when you activate the type in this account and\n Region. For private extensions, this will be the ARN assigned when you register the type in this account and\n Region.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the extension, in this account and Region.
\nFor public extensions, this will be the ARN assigned when you call the \n ActivateType\n API operation in\n this account and Region. For private extensions, this will be the ARN assigned when you call the \n RegisterType\n API operation in this account and Region.
The name of the extension.
\nIf you specified a TypeNameAlias when you activate this extension in your account\n and Region, CloudFormation considers that alias as the type name.
The name of the extension.
\nIf you specified a TypeNameAlias when you call the \n ActivateType\n API operation in\n your account and Region, CloudFormation considers that alias as the type name.
The ID of the default version of the extension. The default version is used when the extension version isn't\n specified.
\nThis applies only to private extensions you have registered in your account. For public extensions, both those\n provided by Amazon and published by third parties, CloudFormation returns null. For more\n information, see RegisterType.
To set the default version of an extension, use SetTypeDefaultVersion.
" + "smithy.api#documentation": "The ID of the default version of the extension. The default version is used when the extension version isn't\n specified.
\nThis applies only to private extensions you have registered in your account. For public extensions, both those\n provided by Amazon and published by third parties, CloudFormation returns null. For more information, see\n \n RegisterType\n .
To set the default version of an extension, use SetTypeDefaultVersion.
" } }, "TypeArn": { @@ -14281,7 +14316,7 @@ "LastUpdated": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#documentation": "When the specified extension version was registered. This applies only to:
\nPrivate extensions you have registered in your account. For more information, see RegisterType.
\nPublic extensions you have activated in your account with auto-update specified. For more information, see\n ActivateType.
\nFor all other extension types, CloudFormation returns null.
When the specified extension version was registered. This applies only to:
\nPrivate extensions you have registered in your account. For more information, see \n RegisterType\n .
Public extensions you have activated in your account with auto-update specified. For more information, see\n \n ActivateType\n .
For all other extension types, CloudFormation returns null.
For public extensions that have been activated for this account and Region, the type name of the public\n extension.
\nIf 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\n the public extension. For more information, see Specifying aliases to\n refer to extensions in the CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the type name of the public\n extension.
\nIf 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\n the public extension. For more information, see Specifying aliases to\n refer to extensions in the CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the version of the public extension\n to be used for CloudFormation operations in this account and Region.
\nHow you specified AutoUpdate when enabling the extension affects whether CloudFormation\n automatically updates the extension in this account and Region when a new version is released. For more information,\n see Setting CloudFormation to automatically use new versions of extensions in the\n CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the version of the public extension\n to be used for CloudFormation operations in this account and Region.
\nHow you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically\n 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\n CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the latest version of the public\n extension that is available. For any extensions other than activated third-arty extensions,\n CloudFormation returns null.
How you specified AutoUpdate when enabling the extension affects whether CloudFormation\n automatically updates the extension in this account and Region when a new version is released. For more information,\n see Setting CloudFormation to automatically use new versions of extensions in the\n CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the latest version of the public\n extension that is available. For any extensions other than activated third-arty extensions,\n CloudFormation returns null.
How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically\n 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\n CloudFormation User Guide.
The service used to verify the publisher identity.
\nFor more information, see Registering your account to publish CloudFormation extensions in the CFN-CLI User Guide for Extension\n Development.
" + "smithy.api#documentation": "The service used to verify the publisher identity.
\nFor more information, see Registering your account to publish CloudFormation extensions in the CFN-CLI User Guide for Extension Development.
" } }, "PublisherName": { @@ -14440,7 +14475,7 @@ "PublicVersionNumber": { "target": "com.amazonaws.cloudformation#PublicVersionNumber", "traits": { - "smithy.api#documentation": "For public extensions that have been activated for this account and Region, the version of the public extension\n to be used for CloudFormation operations in this account and Region. For any extensions other than activated\n third-arty extensions, CloudFormation returns null.
How you specified AutoUpdate when enabling the extension affects whether CloudFormation\n automatically updates the extension in this account and Region when a new version is released. For more information,\n see Setting CloudFormation to automatically use new versions of extensions in the\n CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the version of the public extension\n to be used for CloudFormation operations in this account and Region. For any extensions other than activated third-arty\n extensions, CloudFormation returns null.
How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically\n 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\n CloudFormation User Guide.
The configuration details of the generated template, including the DeletionPolicy and UpdateReplacePolicy.
The configuration details of the generated template, including the DeletionPolicy and\n UpdateReplacePolicy.
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.\n (For more information, go to Template Anatomy in the\n CloudFormation User Guide.)
\nConditional: You must specify only one of the following parameters: TemplateBody,\n TemplateURL, or set the UsePreviousTemplate to true.
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.\n (For more information, go to Template Anatomy in the\n CloudFormation User Guide.)
\nConditional: You must specify only one of the following parameters: TemplateBody,\n TemplateURL, or set the UsePreviousTemplate to true.
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\n CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters: TemplateBody,\n TemplateURL, or set the UsePreviousTemplate to true.
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\n CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://.
Conditional: You must specify only one of the following parameters: TemplateBody,\n TemplateURL, or set the UsePreviousTemplate to true.
Reuse the existing template that is associated with the stack that you are updating.
\nConditional: You must specify only one of the following parameters: TemplateBody,\n TemplateURL, or set the UsePreviousTemplate to true.
Reuse the existing template that is associated with the stack that you are updating.
\nConditional: You must specify only one of the following parameters: TemplateBody,\n TemplateURL, or set the UsePreviousTemplate to true.
Structure containing the temporary overriding stack policy body. You can specify either the\n StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not\n both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If\n you don't specify a stack policy, the current policy that is associated with the stack will be used.
" + "smithy.api#documentation": "Structure containing the temporary overriding stack policy body. You can specify either the\n StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not\n both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If\n you don't specify a stack policy, the current policy that is associated with the stack will be used.
" } }, "StackPolicyDuringUpdateURL": { "target": "com.amazonaws.cloudformation#StackPolicyDuringUpdateURL", "traits": { - "smithy.api#documentation": "Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size:\n 16KB) located in an S3 bucket in the same Region as the stack. You can specify either the\n StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not\n both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If\n you don't specify a stack policy, the current policy that is associated with the stack will be used.
" + "smithy.api#documentation": "Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size:\n 16KB) located in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start with\n https://. You can specify either the StackPolicyDuringUpdateBody or the\n StackPolicyDuringUpdateURL parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If\n you don't specify a stack policy, the current policy that is associated with the stack will be used.
" } }, "Parameters": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "A list of Parameter structures that specify input parameters for the stack. For more information,\n see the Parameter\n data type.
A list of Parameter structures that specify input parameters for the stack. For more information,\n see the \n Parameter\n \n data type.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order\n for CloudFormation to update the stack.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must\n explicitly acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all permissions associated with\n them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM\n Resources in CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some template contain macros. Macros perform custom processing on templates; this can include simple actions\n like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this,\n users typically create a change set from the processed template, so that they can review the changes resulting from\n the macros before actually updating the stack. If your stack template contains one or more macros, and you choose\n to update a stack directly from the processed template, without first reviewing the resulting changes in a change\n set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which\n are macros hosted by CloudFormation.
\nIf you want to update a stack from a stack template that contains macros and nested\n stacks, you must update the stack directly from the template using this capability.
\nYou should only update stacks directly from a stack template that contains macros if you know what processing\n the macro performs.
\nEach macro relies on an underlying Lambda service function for processing stack templates. Be\n aware that the Lambda function owner can update the function operation without CloudFormation being\n notified.
\nFor more information, see Using CloudFormation Macros to Perform Custom\n Processing on Templates.
\nOnly one of the Capabilities and ResourceType parameters can be specified.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order\n for CloudFormation to update the stack.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly\n acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all permissions associated with\n them and edit their permissions if necessary.
\n\n \n AWS::IAM::AccessKey\n \n
\n \n AWS::IAM::Group\n \n
\n \n \n AWS::IAM::Policy\n \n
\n \n AWS::IAM::Role\n \n
\n \n AWS::IAM::User\n \n
For more information, see Acknowledging IAM Resources in\n CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some template contain macros. Macros perform custom processing on templates; this can include simple actions\n like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this,\n users typically create a change set from the processed template, so that they can review the changes resulting from\n the macros before actually updating the stack. If your stack template contains one or more macros, and you choose\n to update a stack directly from the processed template, without first reviewing the resulting changes in a change\n set, you must acknowledge this capability. This includes the \n AWS::Include\n and \n AWS::Serverless\n transforms, which\n are macros hosted by CloudFormation.
If you want to update a stack from a stack template that contains macros and nested\n stacks, you must update the stack directly from the template using this capability.
\nYou should only update stacks directly from a stack template that contains macros if you know what processing\n the macro performs.
\nEach macro relies on an underlying Lambda service function for processing stack templates. Be\n aware that the Lambda function owner can update the function operation without CloudFormation being\n notified.
\nFor more information, see Using CloudFormation Macros to Perform Custom Processing\n on Templates.
\nOnly one of the Capabilities and ResourceType parameters can be specified.
The template resource types that you have permissions to work with for this update stack action, such as\n 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\n default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM)\n uses this parameter for CloudFormation-specific condition keys in IAM policies. For more\n information, see Controlling Access with Identity and Access Management.
\nOnly one of the Capabilities and ResourceType parameters can be specified.
The template resource types that you have permissions to work with for this update stack action, such as\n 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\n default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for\n CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.
\nOnly one of the Capabilities and ResourceType parameters can be specified.
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.\n CloudFormation always uses this role for all future operations on the stack. Provided that users have\n permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to\n pass it. Ensure that the role grants least privilege.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with the\n stack. If no role is available, CloudFormation uses a temporary session that is generated from your user\n credentials.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to\n update the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role\n for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses\n this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role\n is available, CloudFormation uses a temporary session that is generated from your user credentials.
" } }, "RollbackConfiguration": { "target": "com.amazonaws.cloudformation#RollbackConfiguration", "traits": { - "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and\n for the specified monitoring period afterwards.
" + "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the\n specified monitoring period afterwards.
" } }, "StackPolicyBody": { "target": "com.amazonaws.cloudformation#StackPolicyBody", "traits": { - "smithy.api#documentation": "Structure containing a new stack policy body. You can specify either the StackPolicyBody or the\n 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\n stack update. If you don't specify a stack policy, the current policy that is associated with the stack is\n unchanged.
" + "smithy.api#documentation": "Structure containing a new stack policy body. You can specify either the StackPolicyBody or the\n 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\n stack update. If you don't specify a stack policy, the current policy that is associated with the stack is\n unchanged.
" } }, "StackPolicyURL": { "target": "com.amazonaws.cloudformation#StackPolicyURL", "traits": { - "smithy.api#documentation": "Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located\n in an S3 bucket in the same Region as the stack. You can specify either the StackPolicyBody or the\n 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\n stack update. If you don't specify a stack policy, the current policy that is associated with the stack is\n unchanged.
" + "smithy.api#documentation": "Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located\n in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start with\n https://. You can specify either the StackPolicyBody or the StackPolicyURL\n parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that you created during a\n stack update. If you don't specify a stack policy, the current policy that is associated with the stack is\n unchanged.
" } }, "NotificationARNs": { "target": "com.amazonaws.cloudformation#NotificationARNs", "traits": { - "smithy.api#documentation": "Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates\n with the stack. Specify an empty list to remove all notification topics.
" + "smithy.api#documentation": "Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with the stack.\n Specify an empty list to remove all notification topics.
" } }, "Tags": { "target": "com.amazonaws.cloudformation#Tags", "traits": { - "smithy.api#documentation": "Key-value pairs to associate with this stack. CloudFormation also propagates these tags to supported\n resources in the stack. You can specify a maximum number of 50 tags.
\nIf you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you specify an\n empty value, CloudFormation removes all associated tags.
" + "smithy.api#documentation": "Key-value pairs to associate with this stack. CloudFormation also propagates these tags to supported resources in the\n stack. You can specify a maximum number of 50 tags.
\nIf you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you specify an empty value,\n CloudFormation removes all associated tags.
" } }, "DisableRollback": { @@ -14712,13 +14747,13 @@ "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "A unique identifier for this UpdateStack request. Specify this token if you plan to retry requests\n so that CloudFormation knows that you're not attempting to update a stack with the same name. You might retry\n 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\n track operations. For example, if you execute a CreateStack operation with the token\n token1, then all the StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that are\n initiated from the console use the token format Console-StackOperation-ID, which helps you\n easily identify the stack operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
A unique identifier for this UpdateStack request. Specify this token if you plan to retry requests\n so that CloudFormation knows that you're not attempting to update a stack with the same name. You might retry\n 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\n track operations. For example, if you execute a CreateStack operation with the token\n token1, then all the StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that are\n initiated from the console use the token format Console-StackOperation-ID, which helps you\n easily identify the stack operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
When set to true, newly created resources are deleted when the operation rolls back. This includes newly\n created resources marked with a deletion policy of Retain.
Default: false\n
When set to true, newly created resources are deleted when the operation rolls back. This includes\n newly created resources marked with a deletion policy of Retain.
Default: false\n
Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region.
\nYou can only update stack instances in Amazon Web Services Regions and accounts where they already exist; to\n create additional stack instances, use CreateStackInstances.
\nDuring stack set updates, any parameters overridden for a stack instance aren't updated, but retain their\n overridden value.
\nYou can only update the parameter values that are specified in the stack set; to add or\n delete a parameter itself, use UpdateStackSet to update the stack set\n template. If you add a parameter to a template, before you can override the parameter value specified in the stack\n set you must first use UpdateStackSet to update all stack\n instances with the updated template and parameter value specified in the stack set. Once a stack instance has been\n updated with the new parameter, you can then override the parameter value using\n UpdateStackInstances.
Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region.
\nYou can only update stack instances in Amazon Web Services Regions and accounts where they already exist; to\n create additional stack instances, use \n CreateStackInstances\n .
During stack set updates, any parameters overridden for a stack instance aren't updated, but retain their\n overridden value.
\nYou can only update the parameter values that are specified in the stack set; to add or\n delete a parameter itself, use \n UpdateStackSet\n to update the stack set\n template. If you add a parameter to a template, before you can override the parameter value specified in the stack\n set you must first use \n UpdateStackSet\n to update all stack\n instances with the updated template and parameter value specified in the stack set. Once a stack instance has been\n updated with the new parameter, you can then override the parameter value using\n UpdateStackInstances.
The names of one or more Amazon Web Services Regions in which you want to update parameter values for stack\n instances. The overridden parameter values will be applied to all stack instances in the specified accounts and\n Amazon Web Services Regions.
", + "smithy.api#documentation": "The names of one or more Amazon Web Services Regions in which you want to update parameter values for stack\n instances. The overridden parameter values will be applied to all stack instances in the specified accounts and\n Amazon Web Services Regions.
", "smithy.api#required": {} } }, "ParameterOverrides": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "A list of input parameters whose values you want to update for the specified stack instances.
\nAny 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\n parameter values during stack instance update operations:
\nTo override the current value for a parameter, include the parameter and specify its value.
\nTo leave an overridden parameter set to its present value, include the parameter and specify\n UsePreviousValue as true. (You can't specify both a value and set\n UsePreviousValue to true.)
To set an overridden parameter back to the value specified in the stack set, specify a parameter list but\n don't include the parameter in the list.
\nTo leave all parameters set to their present values, don't specify this property at all.
\nDuring stack set updates, any parameter values overridden for a stack instance aren't updated, but retain their\n overridden value.
\nYou can only override the parameter values that are specified in the stack set; to add or\n delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter\n to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to\n update all stack instances with the updated template and parameter value specified in the stack set. Once a stack\n instance has been updated with the new parameter, you can then override the parameter value using\n UpdateStackInstances.
A list of input parameters whose values you want to update for the specified stack instances.
\nAny 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\n during stack instance update operations:
\nTo override the current value for a parameter, include the parameter and specify its value.
\nTo leave an overridden parameter set to its present value, include the parameter and specify\n UsePreviousValue as true. (You can't specify both a value and set\n UsePreviousValue to true.)
To set an overridden parameter back to the value specified in the stack set, specify a parameter list but\n don't include the parameter in the list.
\nTo leave all parameters set to their present values, don't specify this property at all.
\nDuring stack set updates, any parameter values overridden for a stack instance aren't updated, but retain their\n overridden value.
\nYou can only override the parameter values that are specified in the stack set; to add or\n delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter\n to a template, before you can override the parameter value specified in the stack set you must first use \n UpdateStackSet\n to\n update all stack instances with the updated template and parameter value specified in the stack set. Once a stack\n instance has been updated with the new parameter, you can then override the parameter value using\n UpdateStackInstances.
The unique identifier for this stack set operation.
\nThe operation ID also functions as an idempotency token, to ensure that CloudFormation performs the\n stack set operation only once, even if you retry the request multiple times. You might retry stack set operation\n requests to ensure that CloudFormation successfully received them.
\nIf you don't specify an operation ID, the SDK generates one automatically.
", + "smithy.api#documentation": "The unique identifier for this stack set operation.
\nThe operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set\n operation only once, even if you retry the request multiple times. You might retry stack set operation requests to\n ensure that CloudFormation successfully received them.
\nIf you don't specify an operation ID, the SDK generates one automatically.
", "smithy.api#idempotencyToken": {} } }, "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\nThe structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200\n bytes. For more information, see Template Anatomy in the\n CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters: TemplateBody or\n TemplateURL—or set UsePreviousTemplate to true.
The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200\n bytes. For more information, see Template Anatomy in the\n CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters: TemplateBody or\n TemplateURL—or set UsePreviousTemplate to true.
The location of the file that contains the template body. The URL must point to a template (maximum size:\n 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. For more information,\n see Template\n Anatomy in the CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters: TemplateBody or\n TemplateURL—or set UsePreviousTemplate to true.
The location of the file that contains the template body. The URL must point to a template (maximum size:\n 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. For more information,\n see Template\n Anatomy in the CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters: TemplateBody or\n TemplateURL—or set UsePreviousTemplate to true.
Use the existing template that's associated with the stack set that you're updating.
\nConditional: You must specify only one of the following parameters: TemplateBody or\n TemplateURL—or set UsePreviousTemplate to true.
Use the existing template that's associated with the stack set that you're updating.
\nConditional: You must specify only one of the following parameters: TemplateBody or\n TemplateURL—or set UsePreviousTemplate to true.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order\n for CloudFormation to update the stack set and its associated stack instances.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stacks sets, you must\n explicitly acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with\n them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM Resources in CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some templates reference macros. If your stack set template references one or more macros, you must update the\n stack set directly from the processed template, without first reviewing the resulting changes in a change set. To\n update the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform\n Custom Processing on Templates.
\nStack sets with service-managed permissions do not currently support the use of macros in templates. (This\n includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a\n stack set with service-managed permissions, if you reference a macro in your template the stack set operation will\n fail.
\nIn some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order\n for CloudFormation to update the stack set and its associated stack instances.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stacks sets, you must explicitly\n acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with\n them and edit their permissions if necessary.
\n\n \n AWS::IAM::AccessKey\n \n
\n \n AWS::IAM::Group\n \n
\n \n AWS::IAM::Policy\n \n
\n \n AWS::IAM::Role\n \n
\n \n AWS::IAM::User\n \n
For more information, see Acknowledging IAM Resources in\n CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some templates reference macros. If your stack set template references one or more macros, you must update the\n stack set directly from the processed template, without first reviewing the resulting changes in a change set. To\n update the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to\n Perform Custom Processing on Templates.
\nStack sets with service-managed permissions do not currently support the use of macros in templates. (This\n includes the \n AWS::Include\n and \n AWS::Serverless\n transforms, which\n are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions,\n if you reference a macro in your template the stack set operation will fail.
The key-value pairs to associate with this stack set and the stacks created from it. CloudFormation also\n propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50\n tags.
\nIf you specify tags for this parameter, those tags replace any list of tags that are currently associated with\n this stack set. This means:
\nIf you don't specify this parameter, CloudFormation doesn't modify the stack's tags.
\nIf you specify any tags using this parameter, you must specify all\n the tags that you want associated with this stack set, even tags you've specified before (for example, when\n creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the\n updated list of tags are removed from the stack set, and therefore from the stacks and resources as well.
\nIf you specify an empty value, CloudFormation removes all currently associated tags.
\nIf you specify new tags as part of an UpdateStackSet action, CloudFormation checks to see if\n you have the required IAM permission to tag resources. If you omit tags that are currently associated\n with the stack set from the list of tags you specify, CloudFormation assumes that you want to remove those tags\n from the stack set, and checks to see if you have permission to untag resources. If you don't have the necessary\n permission(s), the entire UpdateStackSet action fails with an access denied error, and the\n stack set is not updated.
The key-value pairs to associate with this stack set and the stacks created from it. CloudFormation also propagates these\n tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags.
\nIf you specify tags for this parameter, those tags replace any list of tags that are currently associated with\n this stack set. This means:
\nIf you don't specify this parameter, CloudFormation doesn't modify the stack's tags.
\nIf you specify any tags using this parameter, you must specify all\n the tags that you want associated with this stack set, even tags you've specified before (for example, when\n creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the\n updated list of tags are removed from the stack set, and therefore from the stacks and resources as well.
\nIf you specify an empty value, CloudFormation removes all currently associated tags.
\nIf you specify new tags as part of an UpdateStackSet action, CloudFormation checks to see if you have the\n required IAM permission to tag resources. If you omit tags that are currently associated with the stack set from\n the list of tags you specify, CloudFormation assumes that you want to remove those tags from the stack set, and checks to see\n if you have permission to untag resources. If you don't have the necessary permission(s), the entire\n UpdateStackSet action fails with an access denied error, and the stack set is not\n updated.
The Amazon Resource Name (ARN) of the IAM role to use to update this stack set.
\nSpecify an IAM role only if you are using customized administrator roles to control which users\n or groups can manage specific stack sets within the same administrator account. For more information, see Granting Permissions for Stack Set\n Operations in the CloudFormation User Guide.
\nIf you specified a customized administrator role when you created the stack set, you must specify a customized\n administrator role, even if it is the same customized administrator role used with this stack set previously.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to use to update this stack set.
\nSpecify an IAM role only if you are using customized administrator roles to control which users or groups can\n manage specific stack sets within the same administrator account. For more information, see Granting Permissions for Stack\n Set Operations in the CloudFormation User Guide.
\nIf you specified a customized administrator role when you created the stack set, you must specify a customized\n administrator role, even if it is the same customized administrator role used with this stack set previously.
" } }, "ExecutionRoleName": { "target": "com.amazonaws.cloudformation#ExecutionRoleName", "traits": { - "smithy.api#documentation": "The name of the IAM execution role to use to update the stack set. If you do not specify an\n execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set\n operation.
Specify an IAM role only if you are using customized execution roles to control which stack\n resources users and groups can include in their stack sets.
\nIf you specify a customized execution role, CloudFormation uses that role to update the stack. If you do not specify a\n customized execution role, CloudFormation performs the update using the role previously associated with the stack set, so long\n as you have permissions to perform operations on the stack set.
" + "smithy.api#documentation": "The name of the IAM execution role to use to update the stack set. If you do not specify an execution role,\n 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\n and groups can include in their stack sets.
\nIf you specify a customized execution role, CloudFormation uses that role to update the stack. If you do not specify a\n customized execution role, CloudFormation performs the update using the role previously associated with the stack set, so long\n as you have permissions to perform operations on the stack set.
" } }, "DeploymentTargets": { "target": "com.amazonaws.cloudformation#DeploymentTargets", "traits": { - "smithy.api#documentation": "[Service-managed permissions] The Organizations accounts in which to update associated stack\n instances.
\nTo update all the stack instances associated with this stack set, do not specify DeploymentTargets\n or Regions.
If the stack set update includes changes to the template (that is, if TemplateBody or\n TemplateURL is specified), or the Parameters, CloudFormation marks all stack instances\n 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\n their existing stack instance status.
[Service-managed permissions] The Organizations accounts in which to update associated stack\n instances.
\nTo update all the stack instances associated with this stack set, do not specify DeploymentTargets\n or Regions.
If the stack set update includes changes to the template (that is, if TemplateBody or\n TemplateURL is specified), or the Parameters, CloudFormation marks all stack instances with a status\n 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\n in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance\n status.
Describes how the IAM roles required for stack set operations are created. You cannot modify\n 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\n deploy to target accounts. For more information, see Grant Self-Managed Stack Set\n Permissions.
With service-managed permissions, StackSets automatically creates the IAM roles\n required to deploy to accounts managed by Organizations. For more information, see Grant\n Service-Managed Stack Set Permissions.
Describes how the IAM roles required for stack set operations are created. You cannot modify\n 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\n deploy to target accounts. For more information, see Grant Self-Managed Stack Set\n Permissions.
With service-managed permissions, StackSets automatically creates the IAM roles required to\n deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set\n Permissions.
The unique ID for this stack set operation.
\nThe operation ID also functions as an idempotency token, to ensure that CloudFormation performs the\n stack set operation only once, even if you retry the request multiple times. You might retry stack set operation\n requests to ensure that CloudFormation successfully received them.
\nIf you don't specify an operation ID, CloudFormation generates one automatically.
\nRepeating this stack set operation with a new operation ID retries all stack instances whose status is\n OUTDATED.
The unique ID for this stack set operation.
\nThe operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set\n operation only once, even if you retry the request multiple times. You might retry stack set operation requests to\n ensure that CloudFormation successfully received them.
\nIf you don't specify an operation ID, CloudFormation generates one automatically.
\nRepeating this stack set operation with a new operation ID retries all stack instances whose status is\n OUTDATED.
[Self-managed permissions] The accounts in which to update associated stack instances. If you specify accounts,\n you must also specify the Amazon Web Services Regions in which to update stack set instances.
\nTo update all the stack instances associated with this stack set, don't specify the\n Accounts or Regions properties.
If the stack set update includes changes to the template (that is, if the TemplateBody or\n TemplateURL properties are specified), or the Parameters property, CloudFormation marks all stack\n instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and\n Amazon Web Services Regions. If the stack set update does not include changes to the template or parameters, CloudFormation\n updates the stack instances in the specified accounts and Amazon Web Services Regions, while leaving all other stack\n instances with their existing stack instance status.
[Self-managed permissions] The accounts in which to update associated stack instances. If you specify accounts,\n you must also specify the Amazon Web Services Regions in which to update stack set instances.
\nTo update all the stack instances associated with this stack set, don't specify the\n Accounts or Regions properties.
If the stack set update includes changes to the template (that is, if the TemplateBody or\n TemplateURL properties are specified), or the Parameters property, CloudFormation marks all stack\n instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and\n Amazon Web Services Regions. If the stack set update does not include changes to the template or parameters, CloudFormation\n updates the stack instances in the specified accounts and Amazon Web Services Regions, while leaving all other stack\n instances with their existing stack instance status.
The Amazon Web Services Regions in which to update associated stack instances. If you specify Regions, you must\n also specify accounts in which to update stack set instances.
\nTo update all the stack instances associated with this stack set, do not specify the\n Accounts or Regions properties.
If the stack set update includes changes to the template (that is, if the TemplateBody or\n TemplateURL properties are specified), or the Parameters property, CloudFormation marks all stack\n instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and\n Regions. If the stack set update does not include changes to the template or parameters, CloudFormation updates the stack\n instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack\n instance status.
The Amazon Web Services Regions in which to update associated stack instances. If you specify Regions, you must\n also specify accounts in which to update stack set instances.
\nTo update all the stack instances associated with this stack set, do not specify the\n Accounts or Regions properties.
If the stack set update includes changes to the template (that is, if the TemplateBody or\n TemplateURL properties are specified), or the Parameters property, CloudFormation marks all stack\n instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and\n Regions. If the stack set update does not include changes to the template or parameters, CloudFormation updates the stack\n instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack\n instance status.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\nUpdates termination protection for the specified stack. If a user attempts to delete a stack with termination\n protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From\n Being Deleted in the CloudFormation User Guide.
\nFor nested\n stacks, termination protection is set on the root stack and can't be changed directly on the nested\n stack.
" + "smithy.api#documentation": "Updates termination protection for the specified stack. If a user attempts to delete a stack with termination\n protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From\n Being Deleted in the CloudFormation User Guide.
\nFor nested\n stacks, termination protection is set on the root stack and can't be changed directly on the nested\n stack.
" } }, "com.amazonaws.cloudformation#UpdateTerminationProtectionInput": { @@ -15088,7 +15123,7 @@ "target": "com.amazonaws.cloudformation#ValidateTemplateOutput" }, "traits": { - "smithy.api#documentation": "Validates a specified template. CloudFormation first checks if the template is valid JSON. If it isn't,\n CloudFormation checks if the template is valid YAML. If both these checks fail, CloudFormation\n returns a template validation error.
" + "smithy.api#documentation": "Validates a specified template. CloudFormation first checks if the template is valid JSON. If it isn't, CloudFormation\n checks if the template is valid YAML. If both these checks fail, CloudFormation returns a template validation\n error.
" } }, "com.amazonaws.cloudformation#ValidateTemplateInput": { @@ -15097,13 +15132,13 @@ "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { - "smithy.api#documentation": "Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For\n more information, go to Template Anatomy in the CloudFormation User Guide.
\nConditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For\n more information, go to Template Anatomy in the CloudFormation User Guide.
\nConditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that\n is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the\n CloudFormation User Guide.
\nConditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that\n is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the\n CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://.
Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.
The capabilities found within the template. If your template contains IAM resources, you must\n 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\n an InsufficientCapabilities error.
\nFor more information, see Acknowledging IAM\n Resources in CloudFormation Templates.
" + "smithy.api#documentation": "The capabilities found within the template. If your template contains IAM resources, you must specify the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or\n UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities\n error.
\nFor more information, see Acknowledging IAM Resources in\n CloudFormation Templates.
" } }, "CapabilitiesReason": { diff --git a/codegen/sdk-codegen/aws-models/fsx.json b/codegen/sdk-codegen/aws-models/fsx.json index 03c645b432a..42c5e7570be 100644 --- a/codegen/sdk-codegen/aws-models/fsx.json +++ b/codegen/sdk-codegen/aws-models/fsx.json @@ -2494,7 +2494,7 @@ } }, "traits": { - "smithy.api#documentation": "Used to specify the configuration options for a volume's storage aggregate or aggregates.
" + "smithy.api#documentation": "Used to specify the configuration options for an FSx for ONTAP volume's storage aggregate or aggregates.
" } }, "com.amazonaws.fsx#CreateBackup": { @@ -3284,7 +3284,7 @@ "RouteTableIds": { "target": "com.amazonaws.fsx#RouteTableIds", "traits": { - "smithy.api#documentation": "(Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules\n for routing traffic to the correct file server. You should specify all virtual private cloud\n (VPC) route tables associated with the subnets in which your clients are located. By default,\n Amazon FSx selects your VPC's default route table.
" + "smithy.api#documentation": "(Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules\n for routing traffic to the correct file server. You should specify all virtual private cloud\n (VPC) route tables associated with the subnets in which your clients are located. By default,\n Amazon FSx selects your VPC's default route table.
\nAmazon FSx manages these route tables for Multi-AZ file systems using tag-based authentication. \n These route tables are tagged with Key: AmazonFSx; Value: ManagedByAmazonFSx. \n When creating FSx for ONTAP Multi-AZ file systems using CloudFormation we recommend that you add the \n Key: AmazonFSx; Value: ManagedByAmazonFSx tag manually.
Specifies how many high-availability (HA) pairs the file system will have. The default value is 1. The value of this property affects the values of StorageCapacity, Iops, and ThroughputCapacity. For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
\nThe value of HAPairs is less than 1 or greater than 6.
The value of HAPairs is greater than 1 and the value of DeploymentType is SINGLE_AZ_1 or MULTI_AZ_1.
Specifies how many high-availability (HA) pairs of file servers will power your file system. Scale-up file systems are powered by 1 HA pair. The default value is 1. \n FSx for ONTAP scale-out file systems are powered by up to 12 HA pairs. The value of this property affects the values of StorageCapacity, \n Iops, and ThroughputCapacity. For more information, see \n High-availability (HA) pairs in the FSx for ONTAP user guide.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
\nThe value of HAPairs is less than 1 or greater than 12.
The value of HAPairs is greater than 1 and the value of DeploymentType is SINGLE_AZ_1 or MULTI_AZ_1.
Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system.
\nThis field and ThroughputCapacity cannot be defined in the same API call, but one is required.
This field and ThroughputCapacity are the same for file systems with one HA pair.
For SINGLE_AZ_1 and MULTI_AZ_1, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.
For SINGLE_AZ_2, valid values are 3072 or 6144 MBps.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
\nThe value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value for file systems with one HA pair.
The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is a valid HA pair (a value between 2 and 6).
The value of ThroughputCapacityPerHAPair is not a valid value.
Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system.
\nYou can define either the ThroughputCapacityPerHAPair or the ThroughputCapacity when creating a file system, but not both.
This field and ThroughputCapacity are the same for scale-up file systems powered by one HA pair.
For SINGLE_AZ_1 and MULTI_AZ_1 file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.
For SINGLE_AZ_2 file systems, valid values are 3072 or 6144 MBps.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
\nThe value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value for file systems with one HA pair.
The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is a valid HA pair (a value between 2 and 12).
The value of ThroughputCapacityPerHAPair is not a valid value.
Sets the storage capacity of the file system that you're creating, in gibibytes (GiB).
\n\n FSx for Lustre file systems - The amount of\n storage capacity that you can configure depends on the value that you set for\n StorageType and the Lustre DeploymentType, as\n follows:
For SCRATCH_2, PERSISTENT_2 and PERSISTENT_1 deployment types \n using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
For PERSISTENT_1 HDD file systems, valid values are increments of 6000 GiB for \n 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems.
For SCRATCH_1 deployment type, valid values are \n 1200 GiB, 2400 GiB, and increments of 3600 GiB.
\n FSx for ONTAP file systems - The amount of storage capacity \n that you can configure depends on the value of the HAPairs property. The minimum value is calculated as 1,024 * HAPairs and the maxium is calculated as 524,288 * HAPairs..
\n FSx for OpenZFS file systems - The amount of storage capacity that \n you can configure is from 64 GiB up to 524,288 GiB (512 TiB).
\n\n FSx for Windows File Server file systems - The amount\n of storage capacity that you can configure depends on the value that you set for\n StorageType as follows:
For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB).
\nFor HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB).
\nSets the storage capacity of the file system that you're creating, in gibibytes (GiB).
\n\n FSx for Lustre file systems - The amount of\n storage capacity that you can configure depends on the value that you set for\n StorageType and the Lustre DeploymentType, as\n follows:
For SCRATCH_2, PERSISTENT_2 and PERSISTENT_1 deployment types \n using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
For PERSISTENT_1 HDD file systems, valid values are increments of 6000 GiB for \n 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems.
For SCRATCH_1 deployment type, valid values are \n 1200 GiB, 2400 GiB, and increments of 3600 GiB.
\n FSx for ONTAP file systems - The amount of storage capacity \n that you can configure depends on the value of the HAPairs property. The minimum value is calculated as 1,024 * HAPairs and the maximum is calculated as 524,288 * HAPairs.
\n FSx for OpenZFS file systems - The amount of storage capacity that \n you can configure is from 64 GiB up to 524,288 GiB (512 TiB).
\n\n FSx for Windows File Server file systems - The amount\n of storage capacity that you can configure depends on the value that you set for\n StorageType as follows:
For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB).
\nFor HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB).
\nA list of IDs specifying the security groups to apply to all network interfaces\n created for file system access. This list isn't returned in later requests to\n describe the file system.
" + "smithy.api#documentation": "A list of IDs specifying the security groups to apply to all network interfaces\n created for file system access. This list isn't returned in later requests to\n describe the file system.
\nYou must specify a security group if you are creating a Multi-AZ \n FSx for ONTAP file system in a VPC subnet that has been shared with you.
\nSpecifies the security style for the volume. If a volume's security style is not specified, \n it is automatically set to the root volume's security style. The security style determines the type of permissions \n that FSx for ONTAP uses to control data access. For more information, see \n Volume security style \n in the Amazon FSx for NetApp ONTAP User Guide.\n Specify one of the following values:
\n\n UNIX if the file system is managed by a UNIX\n administrator, the majority of users are NFS clients, and an application\n accessing the data uses a UNIX user as the service account.\n
\n NTFS if the file system is managed by a Windows\n administrator, the majority of users are SMB clients, and an application\n accessing the data uses a Windows user as the service account.
\n MIXED if the file system is managed by both UNIX\n and Windows administrators and users consist of both NFS and SMB clients.
Specifies the security style for the volume. If a volume's security style is not specified, \n it is automatically set to the root volume's security style. The security style determines the type of permissions \n that FSx for ONTAP uses to control data access. For more information, see \n Volume security style \n in the Amazon FSx for NetApp ONTAP User Guide.\n Specify one of the following values:
\n\n UNIX if the file system is managed by a UNIX\n administrator, the majority of users are NFS clients, and an application\n accessing the data uses a UNIX user as the service account.\n
\n NTFS if the file system is managed by a Windows\n administrator, the majority of users are SMB clients, and an application\n accessing the data uses a Windows user as the service account.
\n MIXED This is an advanced setting. For more information, see the topic \n What the security styles and their effects are \n in the NetApp Documentation Center.
For more information, see Volume security style in the \n FSx for ONTAP User Guide.
" } }, "SizeInMegabytes": { @@ -3585,13 +3585,13 @@ "smithy.api#deprecated": { "message": "This property is deprecated, use SizeInBytes instead" }, - "smithy.api#documentation": "Specifies the size of the volume, in megabytes (MB), that you are creating.
" + "smithy.api#documentation": "Use SizeInBytes instead. Specifies the size of the volume, in megabytes (MB), that you are creating.
Set to true to enable deduplication, compression, and compaction storage\n efficiency features on the volume, or set to false to disable them.\n This parameter is required.
" + "smithy.api#documentation": "Set to true to enable deduplication, compression, and compaction storage\n efficiency features on the volume, or set to false to disable them.
\n\n StorageEfficiencyEnabled is required when creating a RW volume (OntapVolumeType set to RW).
Specifies the type of volume you are creating. Valid values are the following:
\n\n RW specifies a read/write volume. RW is the default.
\n DP specifies a data-protection volume. A DP volume\n is read-only and can be used as the destination of a NetApp SnapMirror relationship.
For more information, see Volume types \n in the Amazon FSx for NetApp ONTAP User Guide.
" + "smithy.api#documentation": "Specifies the type of volume you are creating. Valid values are the following:
\n\n RW specifies a read/write volume. RW is the default.
\n DP specifies a data-protection volume. A DP volume\n is read-only and can be used as the destination of a NetApp SnapMirror relationship.
For more information, see Volume types \n in the Amazon FSx for NetApp ONTAP User Guide.
" } }, "SnapshotPolicy": { "target": "com.amazonaws.fsx#SnapshotPolicy", "traits": { - "smithy.api#documentation": "Specifies the snapshot policy for the volume. There are three built-in snapshot policies:
\n\n default: This is the default policy. A maximum of six hourly snapshots taken five minutes past \n the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after\n midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.
\n default-1weekly: This policy is the same as the default policy except \n that it only retains one snapshot from the weekly schedule.
\n none: This policy does not take any snapshots. This policy can be assigned to volumes to \n prevent automatic snapshots from being taken.
You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.
\nFor more information, see Snapshot policies \n in the Amazon FSx for NetApp ONTAP User Guide.
" + "smithy.api#documentation": "Specifies the snapshot policy for the volume. There are three built-in snapshot policies:
\n\n default: This is the default policy. A maximum of six hourly snapshots taken five minutes past \n the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after\n midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.
\n default-1weekly: This policy is the same as the default policy except \n that it only retains one snapshot from the weekly schedule.
\n none: This policy does not take any snapshots. This policy can be assigned to volumes to \n prevent automatic snapshots from being taken.
You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.
\nFor more information, see Snapshot policies \n in the Amazon FSx for NetApp ONTAP User Guide.
" } }, "CopyTagsToBackups": { @@ -3632,7 +3632,7 @@ "VolumeStyle": { "target": "com.amazonaws.fsx#VolumeStyle", "traits": { - "smithy.api#documentation": "Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide.
" + "smithy.api#documentation": "Use to specify the style of an ONTAP volume. FSx for ONTAP offers two styles of volumes that you can use for different purposes, \n FlexVol and FlexGroup volumes. For more information, see \n Volume styles in the Amazon FSx for NetApp ONTAP User Guide.
" } }, "AggregateConfiguration": { @@ -3644,7 +3644,7 @@ "SizeInBytes": { "target": "com.amazonaws.fsx#VolumeCapacityBytes", "traits": { - "smithy.api#documentation": "The configured size of the volume, in bytes.
" + "smithy.api#documentation": "Specifies the configured size of the volume, in bytes.
" } } }, @@ -3737,7 +3737,7 @@ "UserAndGroupQuotas": { "target": "com.amazonaws.fsx#OpenZFSUserAndGroupQuotas", "traits": { - "smithy.api#documentation": "An object specifying how much storage users or groups can use on the volume.
" + "smithy.api#documentation": "Configures how much storage users and groups can use on the volume.
" } } }, @@ -3906,7 +3906,7 @@ "ActiveDirectoryConfiguration": { "target": "com.amazonaws.fsx#CreateSvmActiveDirectoryConfiguration", "traits": { - "smithy.api#documentation": "Describes the self-managed Microsoft Active Directory to which you want to join the SVM. \n Joining an Active Directory provides user authentication and access control for SMB clients, \n including Microsoft Windows and macOS client accessing the file system.
" + "smithy.api#documentation": "Describes the self-managed Microsoft Active Directory to which you want to join the SVM. \n Joining an Active Directory provides user authentication and access control for SMB clients, \n including Microsoft Windows and macOS clients accessing the file system.
" } }, "ClientRequestToken": { @@ -3942,7 +3942,7 @@ "RootVolumeSecurityStyle": { "target": "com.amazonaws.fsx#StorageVirtualMachineRootVolumeSecurityStyle", "traits": { - "smithy.api#documentation": "The security style of the root volume of the SVM. Specify one of the following values:
\n\n UNIX if the file system is managed by a UNIX\n administrator, the majority of users are NFS clients, and an application\n accessing the data uses a UNIX user as the service account.
\n NTFS if the file system is managed by a Windows\n administrator, the majority of users are SMB clients, and an application\n accessing the data uses a Windows user as the service account.
\n MIXED if the file system is managed by both UNIX\n and Windows administrators and users consist of both NFS and SMB clients.
The security style of the root volume of the SVM. Specify one of the following values:
\n\n UNIX if the file system is managed by a UNIX\n administrator, the majority of users are NFS clients, and an application\n accessing the data uses a UNIX user as the service account.
\n NTFS if the file system is managed by a Microsoft Windows\n administrator, the majority of users are SMB clients, and an application\n accessing the data uses a Microsoft Windows user as the service account.
\n MIXED This is an advanced setting. For more information, see \n Volume security style in the Amazon FSx for NetApp ONTAP User Guide.
The configuration that Amazon FSx uses to join the ONTAP storage virtual machine\n (SVM) to your self-managed (including on-premises) Microsoft Active Directory (AD) directory.
" + "smithy.api#documentation": "The configuration that Amazon FSx uses to join the ONTAP storage virtual machine\n (SVM) to your self-managed (including on-premises) Microsoft Active Directory directory.
" } }, "com.amazonaws.fsx#CreateVolume": { @@ -6105,7 +6105,7 @@ } ], "traits": { - "smithy.api#documentation": "Indicates whether participant accounts in your organization can create Amazon FSx for NetApp ONTAP Multi-AZ file systems in subnets that are shared by a virtual\n private cloud (VPC) owner. For more information, see the Amazon FSx for NetApp ONTAP User\n Guide.
" + "smithy.api#documentation": "Indicates whether participant accounts in your organization can create Amazon FSx for NetApp ONTAP Multi-AZ file systems in subnets that are shared by a virtual\n private cloud (VPC) owner. For more information, see Creating FSx for ONTAP file systems in shared subnets.
" } }, "com.amazonaws.fsx#DescribeSharedVpcConfigurationRequest": { @@ -6181,7 +6181,7 @@ "IncludeShared": { "target": "com.amazonaws.fsx#IncludeShared", "traits": { - "smithy.api#documentation": "Set to false (default) if you want to only see the snapshots in your\n Amazon Web Services account. Set to true if you want to see the\n snapshots in your account and the ones shared with you from another account.
Set to false (default) if you want to only see the snapshots owned by your\n Amazon Web Services account. Set to true if you want to see the\n snapshots in your account and the ones shared with you from another account.
Specifies whether the file system is \n using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, , or \n if it using a USER_PROVISIONED value.
Specifies whether the file system is \n using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or \n if it using a USER_PROVISIONED value.
The tags to associate with the file system. For more information, see Tagging your\n Amazon EC2 resources in the Amazon EC2 User\n Guide.
" + "smithy.api#documentation": "The tags to associate with the file system. For more information, see Tagging your\n Amazon FSx resources in the Amazon FSx for Lustre User\n Guide.
" } }, "WindowsConfiguration": { @@ -7511,7 +7511,7 @@ "traits": { "smithy.api#range": { "min": 1, - "max": 6 + "max": 12 } } }, @@ -8412,13 +8412,13 @@ "HAPairs": { "target": "com.amazonaws.fsx#HAPairs", "traits": { - "smithy.api#documentation": "Specifies how many high-availability (HA) file server pairs the file system will have. The default value is 1. The value of this property affects the values of StorageCapacity, Iops, and ThroughputCapacity. For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
\nThe value of HAPairs is less than 1 or greater than 6.
The value of HAPairs is greater than 1 and the value of DeploymentType is SINGLE_AZ_1 or MULTI_AZ_1.
Specifies how many high-availability (HA) file server pairs the file system will have. The default value is 1. The value of this property affects the values of StorageCapacity, Iops, and ThroughputCapacity. For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
\nThe value of HAPairs is less than 1 or greater than 12.
The value of HAPairs is greater than 1 and the value of DeploymentType is SINGLE_AZ_1 or MULTI_AZ_1.
Use to choose the throughput capacity per HA pair. When the value of HAPairs is equal to 1, the value of ThroughputCapacityPerHAPair is the total throughput for the file system.
This field and ThroughputCapacity cannot be defined in the same API call, but one is required.
This field and ThroughputCapacity are the same for file systems with one HA pair.
For SINGLE_AZ_1 and MULTI_AZ_1, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.
For SINGLE_AZ_2, valid values are 3072 or 6144 MBps.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
\nThe value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value.
The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is a valid HA pair (a value between 2 and 6).
The value of ThroughputCapacityPerHAPair is not a valid value.
Use to choose the throughput capacity per HA pair. When the value of HAPairs is equal to 1, the value of ThroughputCapacityPerHAPair is the total throughput for the file system.
This field and ThroughputCapacity cannot be defined in the same API call, but one is required.
This field and ThroughputCapacity are the same for file systems with one HA pair.
For SINGLE_AZ_1 and MULTI_AZ_1, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.
For SINGLE_AZ_2, valid values are 3072 or 6144 MBps.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
\nThe value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value.
The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is a valid HA pair (a value between 2 and 12).
The value of ThroughputCapacityPerHAPair is not a valid value.
A value that specifies whether the quota applies to a user or group.
", + "smithy.api#documentation": "Specifies whether the quota applies to a user or group.
", "smithy.api#required": {} } }, @@ -8897,7 +8897,7 @@ "target": "com.amazonaws.fsx#IntegerNoMax", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ID of the user or group.
", + "smithy.api#documentation": "The ID of the user or group that the quota applies to.
", "smithy.api#required": {} } }, @@ -8905,13 +8905,13 @@ "target": "com.amazonaws.fsx#IntegerNoMax", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The amount of storage that the user or group can use in gibibytes (GiB).
", + "smithy.api#documentation": "The user or group's storage quota, in gibibytes (GiB).
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The configuration for how much storage a user or group can use on the volume.
" + "smithy.api#documentation": "Used to configure quotas that define how much storage a user or group can use on an \n FSx for OpenZFS volume. For more information, see \n Volume properties\n in the FSx for OpenZFS User Guide.\n
" } }, "com.amazonaws.fsx#OpenZFSVolumeConfiguration": { @@ -11313,7 +11313,7 @@ "ThroughputCapacityPerHAPair": { "target": "com.amazonaws.fsx#ThroughputCapacityPerHAPair", "traits": { - "smithy.api#documentation": "Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system.
\nThis field and ThroughputCapacity cannot be defined in the same API call, but one is required.
This field and ThroughputCapacity are the same for file systems with one HA pair.
For SINGLE_AZ_1 and MULTI_AZ_1, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.
For SINGLE_AZ_2, valid values are 3072 or 6144 MBps.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
\nThe value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value for file systems with one HA pair.
The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is a valid HA pair (a value between 2 and 6).
The value of ThroughputCapacityPerHAPair is not a valid value.
Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system.
\nThis field and ThroughputCapacity cannot be defined in the same API call, but one is required.
This field and ThroughputCapacity are the same for file systems with one HA pair.
For SINGLE_AZ_1 and MULTI_AZ_1, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.
For SINGLE_AZ_2, valid values are 3072 or 6144 MBps.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
\nThe value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value for file systems with one HA pair.
The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is a valid HA pair (a value between 2 and 12).
The value of ThroughputCapacityPerHAPair is not a valid value.
The unique identifier (ID) associated with this OU.
\nThe regex pattern for an organizational unit ID string requires \n \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the \n OU). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters \n or digits.
" + "smithy.api#documentation": "The unique identifier (ID) associated with this OU. The ID is unique to the organization only.
\nThe regex pattern for an organizational unit ID string requires \n \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the \n OU). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters \n or digits.
" } }, "Arn": { @@ -7671,8 +7671,7 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 1, - "max": 1000000 + "min": 1 }, "smithy.api#pattern": "^[\\s\\S]*$" } @@ -8255,7 +8254,7 @@ "Id": { "target": "com.amazonaws.organizations#RootId", "traits": { - "smithy.api#documentation": "The unique identifier (ID) for the root.
\nThe regex pattern for a root ID string requires \"r-\" followed by \n from 4 to 32 lowercase letters or digits.
" + "smithy.api#documentation": "The unique identifier (ID) for the root. The ID is unique to the organization only.
\nThe regex pattern for a root ID string requires \"r-\" followed by \n from 4 to 32 lowercase letters or digits.
" } }, "Arn": {