@aws-sdk/client-cloudformation 3.536.0 → 3.537.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (14) hide show
  1. package/dist-types/commands/ActivateTypeCommand.d.ts +3 -5
  2. package/dist-types/commands/CreateStackInstancesCommand.d.ts +2 -2
  3. package/dist-types/commands/DeregisterTypeCommand.d.ts +1 -3
  4. package/dist-types/commands/DescribePublisherCommand.d.ts +1 -3
  5. package/dist-types/commands/DescribeStackInstanceCommand.d.ts +1 -1
  6. package/dist-types/commands/DetectStackSetDriftCommand.d.ts +2 -2
  7. package/dist-types/commands/PublishTypeCommand.d.ts +1 -3
  8. package/dist-types/commands/RegisterTypeCommand.d.ts +4 -8
  9. package/dist-types/commands/SetTypeConfigurationCommand.d.ts +2 -4
  10. package/dist-types/commands/TestTypeCommand.d.ts +3 -7
  11. package/dist-types/commands/UpdateStackInstancesCommand.d.ts +6 -12
  12. package/dist-types/models/models_0.d.ts +190 -321
  13. package/dist-types/models/models_1.d.ts +59 -94
  14. package/package.json +1 -1
package/dist-types/commands/ActivateTypeCommand.d.ts CHANGED
@@ -29,11 +29,9 @@ declare const ActivateTypeCommand_base: {
29
29
  * <p>Activates a public third-party extension, making it available for use in stack templates. For more information,
30
30
  * see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html">Using public
31
31
  * extensions</a> in the <i>CloudFormation User Guide</i>.</p>
32
- * <p>Once you have activated a public third-party extension in your account and Region, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html">
33
- * <code>SetTypeConfiguration</code>
34
- * </a> to specify configuration properties for the extension. For more
35
- * information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration">Configuring extensions at
36
- * the account level</a> in the <i>CloudFormation User Guide</i>.</p>
32
+ * <p>Once you have activated a public third-party extension in your account and Region, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html">SetTypeConfiguration</a> to specify configuration properties for the extension. For more information, see
33
+ * <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration">Configuring extensions at
34
+ * the account level</a> in the <i>CloudFormation User Guide</i>.</p>
37
35
  * @example
38
36
  * Use a bare-bones client and the command you need to make an API call.
39
37
  * ```javascript
package/dist-types/commands/CreateStackInstancesCommand.d.ts CHANGED
@@ -28,8 +28,8 @@ declare const CreateStackInstancesCommand_base: {
28
28
  /**
29
29
  * <p>Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack
30
30
  * instance refers to a stack in a specific account and Region. You must specify at least one value for either
31
- * <code>Accounts</code> or <code>DeploymentTargets</code>, and you must specify at least one value for
32
- * <code>Regions</code>.</p>
31
+ * <code>Accounts</code> or <code>DeploymentTargets</code>, and you must specify at least one value for
32
+ * <code>Regions</code>.</p>
33
33
  * @example
34
34
  * Use a bare-bones client and the command you need to make an API call.
35
35
  * ```javascript
package/dist-types/commands/DeregisterTypeCommand.d.ts CHANGED
@@ -34,9 +34,7 @@ declare const DeregisterTypeCommand_base: {
34
34
  * <p>You can't deregister the default version of an extension if there are other active version of that extension. If
35
35
  * you do deregister the default version of an extension, the extension type itself is deregistered as well and marked
36
36
  * as deprecated.</p>
37
- * <p>To view the deprecation status of an extension or extension version, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html">
38
- * <code>DescribeType</code>
39
- * </a>.</p>
37
+ * <p>To view the deprecation status of an extension or extension version, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html">DescribeType</a>.</p>
40
38
  * @example
41
39
  * Use a bare-bones client and the command you need to make an API call.
42
40
  * ```javascript
package/dist-types/commands/DescribePublisherCommand.d.ts CHANGED
@@ -33,9 +33,7 @@ declare const DescribePublisherCommand_base: {
33
33
  * <ul>
34
34
  * <li>
35
35
  * <p>
36
- * <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterPublisher.html">
37
- * <code>RegisterPublisher</code>
38
- * </a>
36
+ * <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterPublisher.html">RegisterPublisher</a>
39
37
  * </p>
40
38
  * </li>
41
39
  * <li>
package/dist-types/commands/DescribeStackInstanceCommand.d.ts CHANGED
@@ -27,7 +27,7 @@ declare const DescribeStackInstanceCommand_base: {
27
27
  };
28
28
  /**
29
29
  * <p>Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and
30
- * Amazon Web Services Region.</p>
30
+ * Amazon Web Services Region.</p>
31
31
  * <p>For a list of stack instances that are associated with a specific StackSet, use <a>ListStackInstances</a>.</p>
32
32
  * @example
33
33
  * Use a bare-bones client and the command you need to make an API call.
package/dist-types/commands/DetectStackSetDriftCommand.d.ts CHANGED
@@ -28,7 +28,7 @@ declare const DetectStackSetDriftCommand_base: {
28
28
  /**
29
29
  * <p>Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs drift
30
30
  * detection on the stack associated with each stack instance in the stack set. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html">How CloudFormation performs drift
31
- * detection on a stack set</a>.</p>
31
+ * detection on a stack set</a>.</p>
32
32
  * <p>
33
33
  * <code>DetectStackSetDrift</code> returns the <code>OperationId</code> of the stack set drift detection
34
34
  * operation. Use this operation id with <a>DescribeStackSetOperation</a> to monitor the progress of the
@@ -51,7 +51,7 @@ declare const DetectStackSetDriftCommand_base: {
51
51
  * </li>
52
52
  * </ul>
53
53
  * <p>For more information about performing a drift detection operation on a stack set, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html">Detecting unmanaged changes in
54
- * stack sets</a>.</p>
54
+ * stack sets</a>.</p>
55
55
  * <p>You can only run a single drift detection operation on a given stack set at one time.</p>
56
56
  * <p>To stop a drift detection stack set operation, use <a>StopStackSetOperation</a>.</p>
57
57
  * @example
package/dist-types/commands/PublishTypeCommand.d.ts CHANGED
@@ -30,9 +30,7 @@ declare const PublishTypeCommand_base: {
30
30
  * extensions are available for use by all CloudFormation users. For more information about publishing extensions, see
31
31
  * <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html">Publishing extensions to
32
32
  * make them available for public use</a> in the <i>CloudFormation CLI User Guide</i>.</p>
33
- * <p>To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterPublisher.html">
34
- * <code>RegisterPublisher</code>
35
- * </a>.</p>
33
+ * <p>To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterPublisher.html">RegisterPublisher</a>.</p>
36
34
  * @example
37
35
  * Use a bare-bones client and the command you need to make an API call.
38
36
  * ```javascript
package/dist-types/commands/RegisterTypeCommand.d.ts CHANGED
@@ -42,15 +42,11 @@ declare const RegisterTypeCommand_base: {
42
42
  * <p>For more information about how to develop extensions and ready them for registration, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-types.html">Creating Resource
43
43
  * Providers</a> in the <i>CloudFormation CLI User Guide</i>.</p>
44
44
  * <p>You can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and
45
- * per Region. Use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeregisterType.html">
46
- * <code>DeregisterType</code>
47
- * </a> to deregister specific extension versions if necessary.</p>
45
+ * per Region. Use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeregisterType.html">DeregisterType</a> to deregister specific extension versions if necessary.</p>
48
46
  * <p>Once you have initiated a registration request using <a>RegisterType</a>, you can use <a>DescribeTypeRegistration</a> to monitor the progress of the registration request.</p>
49
- * <p>Once you have registered a private extension in your account and Region, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html">
50
- * <code>SetTypeConfiguration</code>
51
- * </a>
52
- * to specify configuration properties for the extension. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration">Configuring extensions at
53
- * the account level</a> in the <i>CloudFormation User Guide</i>.</p>
47
+ * <p>Once you have registered a private extension in your account and Region, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html">SetTypeConfiguration</a> to specify
48
+ * configuration properties for the extension. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration">Configuring extensions at
49
+ * the account level</a> in the <i>CloudFormation User Guide</i>.</p>
54
50
  * @example
55
51
  * Use a bare-bones client and the command you need to make an API call.
56
52
  * ```javascript
package/dist-types/commands/SetTypeConfigurationCommand.d.ts CHANGED
@@ -28,10 +28,8 @@ declare const SetTypeConfigurationCommand_base: {
28
28
  /**
29
29
  * <p>Specifies the configuration data for a registered CloudFormation extension, in the given account and Region.</p>
30
30
  * <p>To view the current configuration data for an extension, refer to the <code>ConfigurationSchema</code> element
31
- * of <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html">
32
- * <code>DescribeType</code>
33
- * </a>. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration">Configuring extensions at
34
- * the account level</a> in the <i>CloudFormation User Guide</i>.</p>
31
+ * of <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html">DescribeType</a>. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration">Configuring extensions at
32
+ * the account level</a> in the <i>CloudFormation User Guide</i>.</p>
35
33
  * <important>
36
34
  * <p>It's strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such
37
35
  * as third-party credentials. For more details on dynamic references, see <a href="https://docs.aws.amazon.com/">Using
package/dist-types/commands/TestTypeCommand.d.ts CHANGED
@@ -40,14 +40,10 @@ declare const TestTypeCommand_base: {
40
40
  * <p>If you don't specify a version, CloudFormation uses the default version of the extension in your account and Region
41
41
  * for testing.</p>
42
42
  * <p>To perform testing, CloudFormation assumes the execution role specified when the type was registered. For more
43
- * information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">
44
- * <code>RegisterType</code>
45
- * </a>.</p>
43
+ * information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">RegisterType</a>.</p>
46
44
  * <p>Once you've initiated testing on an extension using <code>TestType</code>, you can pass the returned
47
- * <code>TypeVersionArn</code> into <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html">
48
- * <code>DescribeType</code>
49
- * </a> to monitor the
50
- * current test status and test status description for the extension.</p>
45
+ * <code>TypeVersionArn</code> into <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html">DescribeType</a> to monitor the current test
46
+ * status and test status description for the extension.</p>
51
47
  * <p>An extension must have a test status of <code>PASSED</code> before it can be published. For more information,
52
48
  * see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-publish.html">Publishing
53
49
  * extensions to make them available for public use</a> in the <i>CloudFormation CLI User
package/dist-types/commands/UpdateStackInstancesCommand.d.ts CHANGED
@@ -28,21 +28,15 @@ declare const UpdateStackInstancesCommand_base: {
28
28
  /**
29
29
  * <p>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.</p>
30
30
  * <p>You can only update stack instances in Amazon Web Services Regions and accounts where they already exist; to
31
- * create additional stack instances, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateStackInstances.html">
32
- * <code>CreateStackInstances</code>
33
- * </a>.</p>
31
+ * create additional stack instances, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateStackInstances.html">CreateStackInstances</a>.</p>
34
32
  * <p>During stack set updates, any parameters overridden for a stack instance aren't updated, but retain their
35
33
  * overridden value.</p>
36
34
  * <p>You can only update the parameter <i>values</i> that are specified in the stack set; to add or
37
- * delete a parameter itself, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html">
38
- * <code>UpdateStackSet</code>
39
- * </a> to update the
40
- * stack set template. If you add a parameter to a template, before you can override the parameter value specified in
41
- * the stack set you must first use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html">
42
- * <code>UpdateStackSet</code>
43
- * </a> to update all
44
- * stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has
45
- * been updated with the new parameter, you can then override the parameter value using
35
+ * delete a parameter itself, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html">UpdateStackSet</a> to update the stack set
36
+ * template. If you add a parameter to a template, before you can override the parameter value specified in the stack
37
+ * set you must first use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html">UpdateStackSet</a> to update all stack
38
+ * instances with the updated template and parameter value specified in the stack set. Once a stack instance has been
39
+ * updated with the new parameter, you can then override the parameter value using
46
40
  * <code>UpdateStackInstances</code>.</p>
47
41
  * @example
48
42
  * Use a bare-bones client and the command you need to make an API call.