feat(client-cloudformation): Add new warning type 'EXCLUDED_RESOURCES'

Author: awstools

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

@@ -31,7 +31,7 @@ export interface DeactivateTypeCommandOutput extends DeactivateTypeOutput, __Met
  * <p>Deactivates a public third-party extension, such as a resource or module, or a CloudFormation
  *       Hook when you no longer use it.</p>
  *          <p>Deactivating an extension deletes the configuration details that are associated with it.
- *       To temporary disable a CloudFormation Hook instead, you can use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html">SetTypeConfiguration</a>.</p>
+ *       To temporarily disable a CloudFormation Hook instead, you can use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html">SetTypeConfiguration</a>.</p>
  *          <p>Once deactivated, an extension can't be used in any CloudFormation operation. This includes
  *       stack update operations where the stack template includes the extension, even if no updates
  *       are being made to the extension. In addition, deactivated extensions aren't automatically

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

@@ -59,7 +59,7 @@ export interface DescribeGeneratedTemplateCommandOutput extends DescribeGenerate
  * //       ResourceStatusReason: "STRING_VALUE",
  * //       Warnings: [ // WarningDetails
  * //         { // WarningDetail
- * //           Type: "MUTUALLY_EXCLUSIVE_PROPERTIES" || "UNSUPPORTED_PROPERTIES" || "MUTUALLY_EXCLUSIVE_TYPES" || "EXCLUDED_PROPERTIES",
+ * //           Type: "MUTUALLY_EXCLUSIVE_PROPERTIES" || "UNSUPPORTED_PROPERTIES" || "MUTUALLY_EXCLUSIVE_TYPES" || "EXCLUDED_PROPERTIES" || "EXCLUDED_RESOURCES",
  * //           Properties: [ // WarningProperties
  * //             { // WarningProperty
  * //               PropertyPath: "STRING_VALUE",

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

@@ -33,6 +33,9 @@ export interface DescribeTypeCommandOutput extends DescribeTypeOutput, __Metadat
  *          <p>If you specify a <code>VersionId</code>, <code>DescribeType</code> returns information
  *       about that specific extension version. Otherwise, it returns information about the default
  *       extension version.</p>
+ *          <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-set-configuration.html">Edit configuration
+ *         data for extensions in your account</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

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

@@ -28,8 +28,8 @@ export interface ListHookResultsCommandInput extends ListHookResultsInput {}
 export interface ListHookResultsCommandOutput extends ListHookResultsOutput, __MetadataBearer {}
 
 /**
- * <p>Returns summaries of invoked Hooks. For more information, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/hooks-view-invocations.html">View CloudFormation Hooks
- *         invocations</a> in the <i>CloudFormation Hooks User Guide</i>.</p>
+ * <p>Returns summaries of invoked Hooks. For more information, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/hooks-view-invocations.html">View invocation
+ *         summaries for CloudFormation Hooks</a> in the <i>CloudFormation Hooks User Guide</i>.</p>
  *          <p>This operation supports the following parameter combinations:</p>
  *          <ul>
  *             <li>

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

@@ -28,20 +28,22 @@ export interface SetTypeConfigurationCommandInput extends SetTypeConfigurationIn
 export interface SetTypeConfigurationCommandOutput extends SetTypeConfigurationOutput, __MetadataBearer {}
 
 /**
- * <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">DescribeType</a>. For
- *       more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-set-configuration.html">Edit configuration
+ * <p>Specifies the configuration data for a CloudFormation extension, such as a resource or Hook,
+ *       in the given account and Region.</p>
+ *          <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-set-configuration.html">Edit configuration
  *         data for extensions in your account</a> in the
  *       <i>CloudFormation User Guide</i>.</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">DescribeType</a>.</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/AWSCloudFormation/latest/UserGuide/dynamic-references.html">Specify values stored in
- *           other services using dynamic references</a> in the
+ *         configuration definitions, such as third-party credentials. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html">Specify values stored in other services using dynamic references</a> in the
  *           <i>CloudFormation User Guide</i>.</p>
  *          </important>
+ *          <p>For more information about setting the configuration data for resource types, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-model.html#resource-type-howto-configuration">Defining the account-level configuration of an extension</a> in the
+ *         <i>CloudFormation Command Line Interface (CLI) User Guide</i>. For more information about setting the configuration
+ *       data for Hooks, see the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/what-is-cloudformation-hooks.html">CloudFormation
+ *         Hooks User Guide</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-cloudformation/src/models/models_0.ts

@@ -273,7 +273,7 @@ export interface ActivateTypeInput {
   TypeName?: string | undefined;
 
   /**
-   * <p>An alias to assign to the public extension, in this account and Region. If you specify an
+   * <p>An alias to assign to the public extension in this account and Region. If you specify an
    *       alias for the extension, CloudFormation treats the alias as the extension type name within this
    *       account and Region. You must use the alias to refer to the extension in your templates, API
    *       calls, and CloudFormation console.</p>
@@ -341,7 +341,7 @@ export interface ActivateTypeInput {
  */
 export interface ActivateTypeOutput {
   /**
-   * <p>The Amazon Resource Name (ARN) of the activated extension, in this account and
+   * <p>The Amazon Resource Name (ARN) of the activated extension in this account and
    *       Region.</p>
    * @public
    */
@@ -1830,17 +1830,15 @@ export interface RollbackConfiguration {
  */
 export interface Tag {
   /**
-   * <p>
-   *             <i>Required</i>. A string used to identify this tag. You can specify a maximum of
+   * <p>A string used to identify this tag. You can specify a maximum of
    *    128 characters for a tag key. Tags owned by Amazon Web Services have the reserved prefix:
    *    <code>aws:</code>.</p>
    * @public
    */
   Key: string | undefined;
 
   /**
-   * <p>
-   *             <i>Required</i>. A string that contains the value for this tag. You can specify a
+   * <p>A string that contains the value for this tag. You can specify a
    *    maximum of 256 characters for a tag value.</p>
    * @public
    */
@@ -2361,7 +2359,7 @@ export interface TemplateConfiguration {
 export interface CreateGeneratedTemplateInput {
   /**
    * <p>An optional list of resources to be included in the generated template.</p>
-   *          <p> If no resources are specified,the template will be created without any resources.
+   *          <p>If no resources are specified,the template will be created without any resources.
    *       Resources can be added to the template using the <code>UpdateGeneratedTemplate</code> API
    *       action.</p>
    * @public
@@ -3613,7 +3611,7 @@ export interface DeactivateOrganizationsAccessOutput {}
  */
 export interface DeactivateTypeInput {
   /**
-   * <p>The type name of the extension, in this account and Region. If you specified a type name
+   * <p>The type name of the extension in this account and Region. If you specified a type name
    *       alias when enabling the extension, use the type name alias.</p>
    *          <p>Conditional: You must specify either <code>Arn</code>, or <code>TypeName</code> and
    *         <code>Type</code>.</p>
@@ -3630,7 +3628,7 @@ export interface DeactivateTypeInput {
   Type?: ThirdPartyType | undefined;
 
   /**
-   * <p>The Amazon Resource Name (ARN) for the extension, in this account and Region.</p>
+   * <p>The Amazon Resource Name (ARN) for the extension in this account and Region.</p>
    *          <p>Conditional: You must specify either <code>Arn</code>, or <code>TypeName</code> and
    *         <code>Type</code>.</p>
    * @public
@@ -4429,6 +4427,7 @@ export interface WarningProperty {
  */
 export const WarningType = {
   EXCLUDED_PROPERTIES: "EXCLUDED_PROPERTIES",
+  EXCLUDED_RESOURCES: "EXCLUDED_RESOURCES",
   MUTUALLY_EXCLUSIVE_PROPERTIES: "MUTUALLY_EXCLUSIVE_PROPERTIES",
   MUTUALLY_EXCLUSIVE_TYPES: "MUTUALLY_EXCLUSIVE_TYPES",
   UNSUPPORTED_PROPERTIES: "UNSUPPORTED_PROPERTIES",
@@ -7699,8 +7698,9 @@ export interface DescribeTypeOutput {
 
   /**
    * <p>The schema that defines the extension.</p>
-   *          <p>For more information about extension schemas, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html">Resource type
-   *         schema</a> in the <i>CloudFormation Command Line Interface (CLI) User Guide</i>.</p>
+   *          <p>For more information, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html">Resource type
+   *         schema</a> in the <i>CloudFormation Command Line Interface (CLI) User Guide</i> and the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/what-is-cloudformation-hooks.html">CloudFormation
+   *         Hooks User Guide</a>.</p>
    * @public
    */
   Schema?: string | undefined;
@@ -7850,9 +7850,7 @@ export interface DescribeTypeOutput {
   /**
    * <p>A JSON string that represent the current configuration data for the extension in this
    *       account and Region.</p>
-   *          <p>To set the configuration data for an extension, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html">SetTypeConfiguration</a>. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-set-configuration.html">Edit configuration
-   *         data for extensions in your account</a> in the
-   *       <i>CloudFormation User Guide</i>.</p>
+   *          <p>To set the configuration data for an extension, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html">SetTypeConfiguration</a>.</p>
    * @public
    */
   ConfigurationSchema?: string | undefined;
@@ -8903,7 +8901,7 @@ export interface ListGeneratedTemplatesInput {
   NextToken?: string | undefined;
 
   /**
-   * <p> If the number of available results exceeds this maximum, the response includes a
+   * <p>If the number of available results exceeds this maximum, the response includes a
    *         <code>NextToken</code> value that you can use for the <code>NextToken</code> parameter to
    *       get the next set of results. By default the <code>ListGeneratedTemplates</code> API action
    *       will return at most 50 results in each response. The maximum value is 100.</p>
@@ -9350,7 +9348,7 @@ export interface ListResourceScanRelatedResourcesInput {
   NextToken?: string | undefined;
 
   /**
-   * <p> If the number of available results exceeds this maximum, the response includes a
+   * <p>If the number of available results exceeds this maximum, the response includes a
    *         <code>NextToken</code> value that you can use for the <code>NextToken</code> parameter to
    *       get the next set of results. By default the <code>ListResourceScanRelatedResources</code> API
    *       action will return up to 100 results in each response. The maximum value is 100.</p>
@@ -9480,7 +9478,7 @@ export interface ListResourceScanResourcesInput {
   NextToken?: string | undefined;
 
   /**
-   * <p> If the number of available results exceeds this maximum, the response includes a
+   * <p>If the number of available results exceeds this maximum, the response includes a
    *         <code>NextToken</code> value that you can use for the <code>NextToken</code> parameter to
    *       get the next set of results. By default the <code>ListResourceScanResources</code> API action
    *       will return at most 100 results in each response. The maximum value is 100.</p>
@@ -9535,7 +9533,7 @@ export interface ListResourceScansInput {
   NextToken?: string | undefined;
 
   /**
-   * <p> If the number of available results exceeds this maximum, the response includes a
+   * <p>If the number of available results exceeds this maximum, the response includes a
    *         <code>NextToken</code> value that you can use for the <code>NextToken</code> parameter to
    *       get the next set of results. The default value is 10. The maximum value is 100.</p>
    * @public

clients/client-cloudformation/src/models/models_1.ts

@@ -358,8 +358,8 @@ export interface ListTypesInput {
    *             <li>
    *                <p>
    *                   <code>PUBLIC</code>: 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.</p>
+   *           activated within any Amazon Web Services account. This includes extensions from Amazon Web Services and third-party
+   *           publishers.</p>
    *             </li>
    *          </ul>
    *          <p>The default is <code>PRIVATE</code>.</p>
@@ -1211,7 +1211,7 @@ export interface SetStackPolicyInput {
  */
 export interface SetTypeConfigurationInput {
   /**
-   * <p>The Amazon Resource Name (ARN) for the extension, in this account and Region.</p>
+   * <p>The Amazon Resource Name (ARN) for the extension in this account and Region.</p>
    *          <p>For public extensions, this will be the ARN assigned when you call the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html">ActivateType</a> API operation in this account and Region. For private extensions, this
    *       will be the ARN assigned when you call the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">RegisterType</a> API
    *       operation in this account and Region.</p>
@@ -1222,11 +1222,9 @@ export interface SetTypeConfigurationInput {
   TypeArn?: string | undefined;
 
   /**
-   * <p>The configuration data for the extension, in this account and Region.</p>
-   *          <p>The configuration data must be formatted as JSON, and validate against the schema returned
-   *       in the <code>ConfigurationSchema</code> response element 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/cloudformation-cli/latest/userguide/resource-type-model.html#resource-type-howto-configuration">Defining the account-level configuration of an extension</a> in the
-   *         <i>CloudFormation Command Line Interface (CLI) User Guide</i>.</p>
+   * <p>The configuration data for the extension in this account and Region.</p>
+   *          <p>The configuration data must be formatted as JSON and validate against the extension's
+   *       schema returned in the <code>Schema</code> response element of <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html">DescribeType</a>.</p>
    * @public
    */
   Configuration: string | undefined;
@@ -1261,7 +1259,7 @@ export interface SetTypeConfigurationInput {
  */
 export interface SetTypeConfigurationOutput {
   /**
-   * <p>The Amazon Resource Name (ARN) for the configuration data, in this account and
+   * <p>The Amazon Resource Name (ARN) for the configuration data in this account and
    *       Region.</p>
    *          <p>Conditional: You must specify <code>ConfigurationArn</code>, or <code>Type</code> and
    *         <code>TypeName</code>.</p>