You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* <p>Activates a public third-party extension, making it available for use in stack templates. For more information,
31
31
* see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html">Using public
32
32
* extensions</a> in the <i>CloudFormation User Guide</i>.</p>
33
-
* <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">
34
-
* <code>SetTypeConfiguration</code>
35
-
* </a> to specify configuration properties for the extension. For more
36
-
* information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration">Configuring extensions at
37
-
* the account level</a> in the <i>CloudFormation User Guide</i>.</p>
33
+
* <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
34
+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration">Configuring extensions at
35
+
* the account level</a> in the <i>CloudFormation User Guide</i>.</p>
38
36
* @example
39
37
* Use a bare-bones client and the command you need to make an API call.
* <p>You can't deregister the default version of an extension if there are other active version of that extension. If
36
36
* you do deregister the default version of an extension, the extension type itself is deregistered as well and marked
37
37
* as deprecated.</p>
38
-
* <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">
39
-
* <code>DescribeType</code>
40
-
* </a>.</p>
38
+
* <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>
41
39
* @example
42
40
* Use a bare-bones client and the command you need to make an API call.
* <p>Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs drift
31
31
* 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
32
-
* detection on a stack set</a>.</p>
32
+
* detection on a stack set</a>.</p>
33
33
* <p>
34
34
* <code>DetectStackSetDrift</code> returns the <code>OperationId</code> of the stack set drift detection
35
35
* operation. Use this operation id with <a>DescribeStackSetOperation</a> to monitor the progress of the
* <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
55
-
* stack sets</a>.</p>
55
+
* stack sets</a>.</p>
56
56
* <p>You can only run a single drift detection operation on a given stack set at one time.</p>
57
57
* <p>To stop a drift detection stack set operation, use <a>StopStackSetOperation</a>.</p>
* extensions are available for use by all CloudFormation users. For more information about publishing extensions, see
32
32
* <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html">Publishing extensions to
33
33
* make them available for public use</a> in the <i>CloudFormation CLI User Guide</i>.</p>
34
-
* <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">
35
-
* <code>RegisterPublisher</code>
36
-
* </a>.</p>
34
+
* <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>
37
35
* @example
38
36
* Use a bare-bones client and the command you need to make an API call.
* <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
44
44
* Providers</a> in the <i>CloudFormation CLI User Guide</i>.</p>
45
45
* <p>You can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and
46
-
* per Region. Use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeregisterType.html">
47
-
* <code>DeregisterType</code>
48
-
* </a> to deregister specific extension versions if necessary.</p>
46
+
* 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>
49
47
* <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>
50
-
* <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">
51
-
* <code>SetTypeConfiguration</code>
52
-
* </a>
53
-
* 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
54
-
* the account level</a> in the <i>CloudFormation User Guide</i>.</p>
48
+
* <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
49
+
* 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
50
+
* the account level</a> in the <i>CloudFormation User Guide</i>.</p>
55
51
* @example
56
52
* Use a bare-bones client and the command you need to make an API call.
* <p>Specifies the configuration data for a registered CloudFormation extension, in the given account and Region.</p>
31
31
* <p>To view the current configuration data for an extension, refer to the <code>ConfigurationSchema</code> element
32
-
* of <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html">
33
-
* <code>DescribeType</code>
34
-
* </a>. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration">Configuring extensions at
35
-
* the account level</a> in the <i>CloudFormation User Guide</i>.</p>
32
+
* 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
33
+
* the account level</a> in the <i>CloudFormation User Guide</i>.</p>
36
34
* <important>
37
35
* <p>It's strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such
38
36
* as third-party credentials. For more details on dynamic references, see <a href="https://docs.aws.amazon.com/">Using
* <p>If you don't specify a version, CloudFormation uses the default version of the extension in your account and Region
42
42
* for testing.</p>
43
43
* <p>To perform testing, CloudFormation assumes the execution role specified when the type was registered. For more
44
-
* information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">
45
-
* <code>RegisterType</code>
46
-
* </a>.</p>
44
+
* information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">RegisterType</a>.</p>
47
45
* <p>Once you've initiated testing on an extension using <code>TestType</code>, you can pass the returned
48
-
* <code>TypeVersionArn</code> into <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html">
49
-
* <code>DescribeType</code>
50
-
* </a> to monitor the
51
-
* current test status and test status description for the extension.</p>
46
+
* <code>TypeVersionArn</code> into <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html">DescribeType</a> to monitor the current test
47
+
* status and test status description for the extension.</p>
52
48
* <p>An extension must have a test status of <code>PASSED</code> before it can be published. For more information,
53
49
* see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-publish.html">Publishing
54
50
* extensions to make them available for public use</a> in the <i>CloudFormation CLI User
* <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>
31
31
* <p>You can only update stack instances in Amazon Web Services Regions and accounts where they already exist; to
32
-
* create additional stack instances, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateStackInstances.html">
33
-
* <code>CreateStackInstances</code>
34
-
* </a>.</p>
32
+
* create additional stack instances, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateStackInstances.html">CreateStackInstances</a>.</p>
35
33
* <p>During stack set updates, any parameters overridden for a stack instance aren't updated, but retain their
36
34
* overridden value.</p>
37
35
* <p>You can only update the parameter <i>values</i> that are specified in the stack set; to add or
38
-
* delete a parameter itself, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html">
39
-
* <code>UpdateStackSet</code>
40
-
* </a> to update the
41
-
* stack set template. If you add a parameter to a template, before you can override the parameter value specified in
42
-
* the stack set you must first use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html">
43
-
* <code>UpdateStackSet</code>
44
-
* </a> to update all
45
-
* stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has
46
-
* been updated with the new parameter, you can then override the parameter value using
36
+
* 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
37
+
* template. If you add a parameter to a template, before you can override the parameter value specified in the stack
38
+
* set you must first use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html">UpdateStackSet</a> to update all stack
39
+
* instances with the updated template and parameter value specified in the stack set. Once a stack instance has been
40
+
* updated with the new parameter, you can then override the parameter value using
47
41
* <code>UpdateStackInstances</code>.</p>
48
42
* @example
49
43
* Use a bare-bones client and the command you need to make an API call.
0 commit comments