Skip to content

Commit 1c3d2b4

Browse files
author
awstools
committed
docs(client-cloudformation): Documentation update, March 2024. Corrects some formatting.
1 parent 487e1dd commit 1c3d2b4

14 files changed

+396
-586
lines changed

clients/client-cloudformation/src/commands/ActivateTypeCommand.ts

+3-5
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,9 @@ export interface ActivateTypeCommandOutput extends ActivateTypeOutput, __Metadat
3030
* <p>Activates a public third-party extension, making it available for use in stack templates. For more information,
3131
* see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html">Using public
3232
* 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>
3836
* @example
3937
* Use a bare-bones client and the command you need to make an API call.
4038
* ```javascript

clients/client-cloudformation/src/commands/CreateStackInstancesCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ export interface CreateStackInstancesCommandOutput extends CreateStackInstancesO
2929
/**
3030
* <p>Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack
3131
* instance refers to a stack in a specific account and Region. You must specify at least one value for either
32-
* <code>Accounts</code> or <code>DeploymentTargets</code>, and you must specify at least one value for
33-
* <code>Regions</code>.</p>
32+
* <code>Accounts</code> or <code>DeploymentTargets</code>, and you must specify at least one value for
33+
* <code>Regions</code>.</p>
3434
* @example
3535
* Use a bare-bones client and the command you need to make an API call.
3636
* ```javascript

clients/client-cloudformation/src/commands/DeregisterTypeCommand.ts

+1-3
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,7 @@ export interface DeregisterTypeCommandOutput extends DeregisterTypeOutput, __Met
3535
* <p>You can't deregister the default version of an extension if there are other active version of that extension. If
3636
* you do deregister the default version of an extension, the extension type itself is deregistered as well and marked
3737
* 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>
4139
* @example
4240
* Use a bare-bones client and the command you need to make an API call.
4341
* ```javascript

clients/client-cloudformation/src/commands/DescribePublisherCommand.ts

+1-3
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,7 @@ export interface DescribePublisherCommandOutput extends DescribePublisherOutput,
3434
* <ul>
3535
* <li>
3636
* <p>
37-
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterPublisher.html">
38-
* <code>RegisterPublisher</code>
39-
* </a>
37+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterPublisher.html">RegisterPublisher</a>
4038
* </p>
4139
* </li>
4240
* <li>

clients/client-cloudformation/src/commands/DescribeStackInstanceCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface DescribeStackInstanceCommandOutput extends DescribeStackInstanc
2828

2929
/**
3030
* <p>Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and
31-
* Amazon Web Services Region.</p>
31+
* Amazon Web Services Region.</p>
3232
* <p>For a list of stack instances that are associated with a specific StackSet, use <a>ListStackInstances</a>.</p>
3333
* @example
3434
* Use a bare-bones client and the command you need to make an API call.

clients/client-cloudformation/src/commands/DetectStackSetDriftCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export interface DetectStackSetDriftCommandOutput extends DetectStackSetDriftOut
2929
/**
3030
* <p>Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs drift
3131
* 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>
3333
* <p>
3434
* <code>DetectStackSetDrift</code> returns the <code>OperationId</code> of the stack set drift detection
3535
* operation. Use this operation id with <a>DescribeStackSetOperation</a> to monitor the progress of the
@@ -52,7 +52,7 @@ export interface DetectStackSetDriftCommandOutput extends DetectStackSetDriftOut
5252
* </li>
5353
* </ul>
5454
* <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>
5656
* <p>You can only run a single drift detection operation on a given stack set at one time.</p>
5757
* <p>To stop a drift detection stack set operation, use <a>StopStackSetOperation</a>.</p>
5858
* @example

clients/client-cloudformation/src/commands/PublishTypeCommand.ts

+1-3
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,7 @@ export interface PublishTypeCommandOutput extends PublishTypeOutput, __MetadataB
3131
* extensions are available for use by all CloudFormation users. For more information about publishing extensions, see
3232
* <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html">Publishing extensions to
3333
* 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>
3735
* @example
3836
* Use a bare-bones client and the command you need to make an API call.
3937
* ```javascript

clients/client-cloudformation/src/commands/RegisterTypeCommand.ts

+4-8
Original file line numberDiff line numberDiff line change
@@ -43,15 +43,11 @@ export interface RegisterTypeCommandOutput extends RegisterTypeOutput, __Metadat
4343
* <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
4444
* Providers</a> in the <i>CloudFormation CLI User Guide</i>.</p>
4545
* <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>
4947
* <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>
5551
* @example
5652
* Use a bare-bones client and the command you need to make an API call.
5753
* ```javascript

clients/client-cloudformation/src/commands/SetTypeConfigurationCommand.ts

+2-4
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,8 @@ export interface SetTypeConfigurationCommandOutput extends SetTypeConfigurationO
2929
/**
3030
* <p>Specifies the configuration data for a registered CloudFormation extension, in the given account and Region.</p>
3131
* <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>
3634
* <important>
3735
* <p>It's strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such
3836
* as third-party credentials. For more details on dynamic references, see <a href="https://docs.aws.amazon.com/">Using

clients/client-cloudformation/src/commands/TestTypeCommand.ts

+3-7
Original file line numberDiff line numberDiff line change
@@ -41,14 +41,10 @@ export interface TestTypeCommandOutput extends TestTypeOutput, __MetadataBearer
4141
* <p>If you don't specify a version, CloudFormation uses the default version of the extension in your account and Region
4242
* for testing.</p>
4343
* <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>
4745
* <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>
5248
* <p>An extension must have a test status of <code>PASSED</code> before it can be published. For more information,
5349
* see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-publish.html">Publishing
5450
* extensions to make them available for public use</a> in the <i>CloudFormation CLI User

clients/client-cloudformation/src/commands/UpdateStackInstancesCommand.ts

+6-12
Original file line numberDiff line numberDiff line change
@@ -29,21 +29,15 @@ export interface UpdateStackInstancesCommandOutput extends UpdateStackInstancesO
2929
/**
3030
* <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>
3131
* <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>
3533
* <p>During stack set updates, any parameters overridden for a stack instance aren't updated, but retain their
3634
* overridden value.</p>
3735
* <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
4741
* <code>UpdateStackInstances</code>.</p>
4842
* @example
4943
* Use a bare-bones client and the command you need to make an API call.

0 commit comments

Comments
 (0)