Skip to content

Commit

Permalink
docs(client-cloudformation): Documentation update, March 2024. Correc…
Browse files Browse the repository at this point in the history
…ts some formatting.
  • Loading branch information
awstools committed Mar 19, 2024
1 parent 487e1dd commit 1c3d2b4
Show file tree
Hide file tree
Showing 14 changed files with 396 additions and 586 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,9 @@ export interface ActivateTypeCommandOutput extends ActivateTypeOutput, __Metadat
* <p>Activates a public third-party extension, making it available for use in stack templates. For more information,
* see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html">Using public
* extensions</a> in the <i>CloudFormation User Guide</i>.</p>
* <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">
* <code>SetTypeConfiguration</code>
* </a> 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
* the account level</a> in the <i>CloudFormation User Guide</i>.</p>
* <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
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration">Configuring extensions at
* the account level</a> in the <i>CloudFormation User Guide</i>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ export interface CreateStackInstancesCommandOutput extends CreateStackInstancesO
/**
* <p>Creates 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. You must specify at least one value for either
* <code>Accounts</code> or <code>DeploymentTargets</code>, and you must specify at least one value for
* <code>Regions</code>.</p>
* <code>Accounts</code> or <code>DeploymentTargets</code>, and you must specify at least one value for
* <code>Regions</code>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,7 @@ export interface DeregisterTypeCommandOutput extends DeregisterTypeOutput, __Met
* <p>You can't deregister the default version of an extension if there are other active version of that extension. If
* you do deregister the default version of an extension, the extension type itself is deregistered as well and marked
* as deprecated.</p>
* <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">
* <code>DescribeType</code>
* </a>.</p>
* <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>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,7 @@ export interface DescribePublisherCommandOutput extends DescribePublisherOutput,
* <ul>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterPublisher.html">
* <code>RegisterPublisher</code>
* </a>
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterPublisher.html">RegisterPublisher</a>
* </p>
* </li>
* <li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export interface DescribeStackInstanceCommandOutput extends DescribeStackInstanc

/**
* <p>Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and
* Amazon Web Services Region.</p>
* Amazon Web Services Region.</p>
* <p>For a list of stack instances that are associated with a specific StackSet, use <a>ListStackInstances</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export interface DetectStackSetDriftCommandOutput extends DetectStackSetDriftOut
/**
* <p>Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs drift
* 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
* detection on a stack set</a>.</p>
* detection on a stack set</a>.</p>
* <p>
* <code>DetectStackSetDrift</code> returns the <code>OperationId</code> of the stack set drift detection
* operation. Use this operation id with <a>DescribeStackSetOperation</a> to monitor the progress of the
Expand All @@ -52,7 +52,7 @@ export interface DetectStackSetDriftCommandOutput extends DetectStackSetDriftOut
* </li>
* </ul>
* <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
* stack sets</a>.</p>
* stack sets</a>.</p>
* <p>You can only run a single drift detection operation on a given stack set at one time.</p>
* <p>To stop a drift detection stack set operation, use <a>StopStackSetOperation</a>.</p>
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,7 @@ export interface PublishTypeCommandOutput extends PublishTypeOutput, __MetadataB
* extensions are available for use by all CloudFormation users. For more information about publishing extensions, see
* <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html">Publishing extensions to
* make them available for public use</a> in the <i>CloudFormation CLI User Guide</i>.</p>
* <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">
* <code>RegisterPublisher</code>
* </a>.</p>
* <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>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,15 +43,11 @@ export interface RegisterTypeCommandOutput extends RegisterTypeOutput, __Metadat
* <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
* Providers</a> in the <i>CloudFormation CLI User Guide</i>.</p>
* <p>You can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and
* per Region. Use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeregisterType.html">
* <code>DeregisterType</code>
* </a> to deregister specific extension versions if necessary.</p>
* 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>
* <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>
* <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">
* <code>SetTypeConfiguration</code>
* </a>
* 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
* the account level</a> in the <i>CloudFormation User Guide</i>.</p>
* <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
* 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
* the account level</a> in the <i>CloudFormation User Guide</i>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,8 @@ export interface SetTypeConfigurationCommandOutput extends SetTypeConfigurationO
/**
* <p>Specifies the configuration data for a registered CloudFormation extension, in the given account and Region.</p>
* <p>To view the current configuration data for an extension, refer to the <code>ConfigurationSchema</code> element
* of <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html">
* <code>DescribeType</code>
* </a>. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration">Configuring extensions at
* the account level</a> in the <i>CloudFormation User Guide</i>.</p>
* 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
* the account level</a> in the <i>CloudFormation User Guide</i>.</p>
* <important>
* <p>It's strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such
* as third-party credentials. For more details on dynamic references, see <a href="https://docs.aws.amazon.com/">Using
Expand Down
10 changes: 3 additions & 7 deletions clients/client-cloudformation/src/commands/TestTypeCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,14 +41,10 @@ export interface TestTypeCommandOutput extends TestTypeOutput, __MetadataBearer
* <p>If you don't specify a version, CloudFormation uses the default version of the extension in your account and Region
* for testing.</p>
* <p>To perform testing, CloudFormation assumes the execution role specified when the type was registered. For more
* information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">
* <code>RegisterType</code>
* </a>.</p>
* information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">RegisterType</a>.</p>
* <p>Once you've initiated testing on an extension using <code>TestType</code>, you can pass the returned
* <code>TypeVersionArn</code> into <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html">
* <code>DescribeType</code>
* </a> to monitor the
* current test status and test status description for the extension.</p>
* <code>TypeVersionArn</code> into <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html">DescribeType</a> to monitor the current test
* status and test status description for the extension.</p>
* <p>An extension must have a test status of <code>PASSED</code> before it can be published. For more information,
* see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-publish.html">Publishing
* extensions to make them available for public use</a> in the <i>CloudFormation CLI User
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,21 +29,15 @@ export interface UpdateStackInstancesCommandOutput extends UpdateStackInstancesO
/**
* <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>
* <p>You can only update stack instances in Amazon Web Services Regions and accounts where they already exist; to
* create additional stack instances, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateStackInstances.html">
* <code>CreateStackInstances</code>
* </a>.</p>
* create additional stack instances, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateStackInstances.html">CreateStackInstances</a>.</p>
* <p>During stack set updates, any parameters overridden for a stack instance aren't updated, but retain their
* overridden value.</p>
* <p>You can only update the parameter <i>values</i> that are specified in the stack set; to add or
* delete a parameter itself, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html">
* <code>UpdateStackSet</code>
* </a> to update the
* stack set template. If you add a parameter to a template, before you can override the parameter value specified in
* the stack set you must first use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html">
* <code>UpdateStackSet</code>
* </a> to update all
* stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has
* been updated with the new parameter, you can then override the parameter value using
* 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
* template. If you add a parameter to a template, before you can override the parameter value specified in the stack
* set you must first use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html">UpdateStackSet</a> to update all stack
* instances with the updated template and parameter value specified in the stack set. Once a stack instance has been
* updated with the new parameter, you can then override the parameter value using
* <code>UpdateStackInstances</code>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Loading

0 comments on commit 1c3d2b4

Please sign in to comment.