@alicloud/config20200907 4.2.1 → 4.2.3

package/src/models/CreateAggregatorShrinkRequest.ts

@@ -5,11 +5,19 @@ import * as $dara from '@darabonba/typescript';
 export class CreateAggregatorShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The member accounts of the account group.
+   * The information about the member accounts in the account group. Example:
    * 
-   * > - If you set `AggregatorType` to \\`RD, you can leave this parameter empty. This indicates that all members in the resource directory are added to the global account group.
-   * >
-   * > - If you set `AggregatorType` to `FOLDER`, you can leave this parameter empty. This indicates that all members in a specific folder in the resource directory are added to the folder account group.
+   *     [{
+   *     	"accountId": 171322098523****,
+   *     	"accountType":"ResourceDirectory",
+   *                     "accountName":"Alice"
+   *     }, {
+   *     	"accountId": 100532098349****,
+   *     	"accountType":"ResourceDirectory",
+   *                     "accountName":"Tom"
+   *     }]
+   * 
+   * >  If `AggregatorType` is set to `RD` or `FOLDER`, this parameter can be left empty, which indicates that all accounts in the resource directory are added to the global account group.
    * 
    * **if can be null:**
    * false
@@ -22,18 +30,16 @@ export class CreateAggregatorShrinkRequest extends $dara.Model {
    * This parameter is required.
    * 
    * @example
-   * Example_Aggregator
+   * Test_Group
    */
   aggregatorName?: string;
   /**
    * @remarks
    * The type of the account group. Valid values:
    * 
-   * - RD: global account group.
-   * 
-   * - FOLDER: folder account group. You must also set the `FolderId` parameter. For more information about how to obtain a folder ID, see [ListAccounts](https://help.aliyun.com/document_detail/160016.html).
-   * 
-   * - CUSTOM (default): custom account group. You must also set the `AccountId` and `AccountType` parameters for `AggregatorAccounts`.
+   * *   RD: global account group.
+   * *   FOLDER: account group of the folder.
+   * *   CUSTOM (default): custom account group.
    * 
    * @example
    * CUSTOM
@@ -41,7 +47,7 @@ export class CreateAggregatorShrinkRequest extends $dara.Model {
   aggregatorType?: string;
   /**
    * @remarks
-   * A client token that is used to ensure the idempotence of the request. You must make sure that the token is unique for different requests. The `ClientToken` parameter can contain only ASCII characters and cannot exceed 64 characters in length.
+   * The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The `token` can contain only ASCII characters and cannot exceed 64 characters in length.
    * 
    * @example
    * 1594295238-f9361358-5843-4294-8d30-b5183fac****
@@ -52,14 +58,12 @@ export class CreateAggregatorShrinkRequest extends $dara.Model {
    * The description of the account group.
    * 
    * @example
-   * Example aggregator used to demonstrate how to create an aggregator.
+   * Aggregator description.
    */
   description?: string;
   /**
    * @remarks
-   * The ID of the attached folder. You can specify multiple folder IDs. Separate the IDs with commas (,).
-   * 
-   * This parameter is required if you set `AggregatorType` to `FOLDER`.
+   * The ID of the folder to which the account group is attached. You must specify this parameter if `AggregatorType` is set to `FOLDER`. Multiple resource folder IDs should be separated by commas (,).
    * 
    * @example
    * fd-brHdgv****,fd-brHdgk****
@@ -69,7 +73,7 @@ export class CreateAggregatorShrinkRequest extends $dara.Model {
    * @remarks
    * The tags of the resource.
    * 
-   * You can attach a maximum of 20 tags.
+   * You can add up to 20 tags to a resource.
    */
   tagShrink?: string;
   static names(): { [key: string]: string } {

package/src/models/CreateCompliancePackRequest.ts

@@ -3,7 +3,25 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class CreateCompliancePackRequestConfigRulesConfigRuleParameters extends $dara.Model {
+  /**
+   * @remarks
+   * The name of the input parameter.
+   * 
+   * You must specify both `ParameterName` and `ParameterValue` or neither of them. If the managed rule has an input parameter but no default value is specified, you must specify this parameter. You can call the [ListCompliancePackTemplates](https://help.aliyun.com/document_detail/261176.html) operation to obtain the names of input parameters of the managed rule.
+   * 
+   * @example
+   * bandwidth
+   */
   parameterName?: string;
+  /**
+   * @remarks
+   * The value of the input parameter.
+   * 
+   * You must specify both `ParameterName` and `ParameterValue` or neither of them. If the managed rule has an input parameter but no default value is specified, you must specify this parameter. You can call the [ListCompliancePackTemplates](https://help.aliyun.com/document_detail/261176.html) operation to obtain the values of input parameters of the managed rule.
+   * 
+   * @example
+   * 10
+   */
   parameterValue?: string;
   static names(): { [key: string]: string } {
     return {
@@ -29,11 +47,58 @@ export class CreateCompliancePackRequestConfigRulesConfigRuleParameters extends
 }
 
 export class CreateCompliancePackRequestConfigRules extends $dara.Model {
+  /**
+   * @remarks
+   * The rule ID. If you specify this parameter, Cloud Config adds the rule that has the specified ID to the compliance package.
+   * 
+   * You need to only specify `ManagedRuleIdentifier` or `ConfigRuleId`. If you specify both parameters, Cloud Config adds a rule based on the value of `ConfigRuleId`. You can call the [ListConfigRules](https://help.aliyun.com/document_detail/169607.html) operation to obtain the rule ID.
+   * 
+   * @example
+   * cr-e918626622af000f****
+   */
   configRuleId?: string;
+  /**
+   * @remarks
+   * The name of the rule.
+   * 
+   * @example
+   * eip-bandwidth-limit
+   */
   configRuleName?: string;
+  /**
+   * @remarks
+   * The input parameters of the rule.
+   */
   configRuleParameters?: CreateCompliancePackRequestConfigRulesConfigRuleParameters[];
+  /**
+   * @remarks
+   * The description of the rule.
+   * 
+   * @example
+   * The description of the test rule.
+   */
   description?: string;
+  /**
+   * @remarks
+   * The identifier of the managed rule. Cloud Config automatically creates a managed rule based on the specified identifier and adds the rule to the compliance package.
+   * 
+   * You need to only specify `ManagedRuleIdentifier` or `ConfigRuleId`. If you specify both parameters, Cloud Config adds a rule based on the value of `ConfigRuleId`. You can call the [ListCompliancePackTemplates](https://help.aliyun.com/document_detail/261176.html) operation to obtain the identifier of the managed rule.
+   * 
+   * @example
+   * eip-bandwidth-limit
+   */
   managedRuleIdentifier?: string;
+  /**
+   * @remarks
+   * The risk level of the resources that do not comply with the rule. Valid values:
+   * 
+   * *   1: high.
+   * *   2: medium.
+   * *   3: low.
+   * 
+   * @example
+   * 1
+   */
   riskLevel?: number;
   static names(): { [key: string]: string } {
     return {
@@ -70,7 +135,21 @@ export class CreateCompliancePackRequestConfigRules extends $dara.Model {
 }
 
 export class CreateCompliancePackRequestExcludeTagsScope extends $dara.Model {
+  /**
+   * @remarks
+   * TagKey
+   * 
+   * @example
+   * key-2
+   */
   tagKey?: string;
+  /**
+   * @remarks
+   * TagValue
+   * 
+   * @example
+   * value-2
+   */
   tagValue?: string;
   static names(): { [key: string]: string } {
     return {
@@ -96,7 +175,29 @@ export class CreateCompliancePackRequestExcludeTagsScope extends $dara.Model {
 }
 
 export class CreateCompliancePackRequestTag extends $dara.Model {
+  /**
+   * @remarks
+   * The tag keys.
+   * 
+   * The tag keys cannot be an empty string. The tag keys can be up to 64 characters in length. The tag keys cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`.
+   * 
+   * You can specify at most 20 tag keys in each call.
+   * 
+   * @example
+   * key-1
+   */
   key?: string;
+  /**
+   * @remarks
+   * The tag values.
+   * 
+   * The tag values can be an empty string or up to 128 characters in length. The tag values cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`.
+   * 
+   * Each key-value must be unique. You can specify at most 20 tag values in each call.
+   * 
+   * @example
+   * value-1
+   */
   value?: string;
   static names(): { [key: string]: string } {
     return {
@@ -122,7 +223,21 @@ export class CreateCompliancePackRequestTag extends $dara.Model {
 }
 
 export class CreateCompliancePackRequestTagsScope extends $dara.Model {
+  /**
+   * @remarks
+   * Tagkey
+   * 
+   * @example
+   * key-1
+   */
   tagKey?: string;
+  /**
+   * @remarks
+   * TagValue
+   * 
+   * @example
+   * value-1
+   */
   tagValue?: string;
   static names(): { [key: string]: string } {
     return {
@@ -148,32 +263,163 @@ export class CreateCompliancePackRequestTagsScope extends $dara.Model {
 }
 
 export class CreateCompliancePackRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The client token that you want to use to ensure the idempotency of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.``
+   * 
+   * @example
+   * 1594295238-f9361358-5843-4294-8d30-b5183fac****
+   */
   clientToken?: string;
   /**
    * @remarks
+   * The name of the compliance package.
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * test-pack-name
    */
   compliancePackName?: string;
+  /**
+   * @remarks
+   * The ID of the compliance package template.
+   * 
+   * You can call the [ListCompliancePackTemplates](https://help.aliyun.com/document_detail/261176.html) operation to obtain the ID of the compliance package.
+   * 
+   * @example
+   * ct-5f26ff4e06a300c4****
+   */
   compliancePackTemplateId?: string;
   /**
+   * @remarks
+   * The rules in the compliance package. You must specify either this parameter or TemplateContent.
+   * 
    * **if can be null:**
    * false
    */
   configRules?: CreateCompliancePackRequestConfigRules[];
+  /**
+   * @remarks
+   * Specifies whether to enable the rule together with the compliance package. Valid values:
+   * 
+   * *   true: The system enables the rule together with the compliance package.
+   * *   false: The system does not enable the rule together with the compliance package.
+   * 
+   * @example
+   * false
+   */
   defaultEnable?: boolean;
+  /**
+   * @remarks
+   * The description of the compliance package.
+   * 
+   * @example
+   * Test pack description.
+   */
   description?: string;
+  /**
+   * @remarks
+   * ExcludeRegionIdsScope
+   * 
+   * @example
+   * cn-hangzhou
+   */
   excludeRegionIdsScope?: string;
+  /**
+   * @remarks
+   * ExcludeResourceGroupIdsScope. Separate multiple resource group IDs with commas (,).
+   * 
+   * @example
+   * rg-bnczc6r7rml****
+   */
   excludeResourceGroupIdsScope?: string;
+  /**
+   * @remarks
+   * The ID of the resource that you do not want to evaluate by using the compliance package. Separate multiple resource IDs with commas (,).
+   * 
+   * @example
+   * eip-8vbf3x310fn56ijfd****
+   */
   excludeResourceIdsScope?: string;
+  /**
+   * @remarks
+   * ExcludeTagsScope
+   */
   excludeTagsScope?: CreateCompliancePackRequestExcludeTagsScope[];
+  /**
+   * @remarks
+   * The ID of the region whose resources you want to evaluate by using the compliance package. Separate multiple region IDs with commas (,).
+   * 
+   * @example
+   * cn-hangzhou
+   */
   regionIdsScope?: string;
+  /**
+   * @remarks
+   * The ID of the resource group whose resources you want to evaluate by using the compliance package. Separate multiple resource group IDs with commas (,).
+   * 
+   * @example
+   * rg-aekzdibsjjc****
+   */
   resourceGroupIdsScope?: string;
+  /**
+   * @remarks
+   * ResourceIdsScope
+   * 
+   * @example
+   * eip-8vbf3x310fn56ijfd****
+   */
   resourceIdsScope?: string;
+  /**
+   * @remarks
+   * The risk level of the resources that are not compliant with the rules in the compliance package. Default value: 2. Valid values:
+   * 
+   * *   1: high.
+   * *   2: medium.
+   * *   3: low.
+   * 
+   * @example
+   * 1
+   */
   riskLevel?: number;
+  /**
+   * @remarks
+   * The tags of the resource.
+   * 
+   * You can add up to 20 tags to a resource.
+   */
   tag?: CreateCompliancePackRequestTag[];
+  /**
+   * @remarks
+   * The tag key of the resource that you want to evaluate by using the compliance package.
+   * 
+   * @example
+   * ECS
+   */
   tagKeyScope?: string;
+  /**
+   * @remarks
+   * The tag value of the resource that you want to evaluate by using the compliance package.
+   * 
+   * >  You must configure the TagValueScope parameter together with the TagKeyScope parameter.
+   * 
+   * @example
+   * test
+   */
   tagValueScope?: string;
+  /**
+   * @remarks
+   * TagsScope
+   */
   tagsScope?: CreateCompliancePackRequestTagsScope[];
+  /**
+   * @remarks
+   * The information about the template that is used to generate the compliance package. You can call an API operation to view the details of an existing compliance package or write a compliance package template. For more information, see [Write a compliance package template in a configuration file](https://help.aliyun.com/document_detail/2659733.html). You must specify one of ConfigRules and TemplateContent.
+   * 
+   * @example
+   * { "configRuleTemplates": [ { "configRuleName": "condition-rule-example", "scope": { "complianceResourceTypes": [ "ACS::ECS::Instance" ] }, "description": "", "source": { "owner": "CUSTOM_CONFIGURATION", "identifier": "acs-config-configuration", "sourceDetails": [ { "messageType": "ScheduledNotification", "maximumExecutionFrequency": "Twelve_Hours" }, { "messageType": "ConfigurationItemChangeNotification" } ], "conditions": "{\\\\"ComplianceConditions\\\\":\\\\"{\\\\\\\\\\"operator\\\\\\\\\\":\\\\\\\\\\"and\\\\\\\\\\",\\\\\\\\\\"children\\\\\\\\\\":[{\\\\\\\\\\"operator\\\\\\\\\\":\\\\\\\\\\"GreaterOrEquals\\\\\\\\\\",\\\\\\\\\\"featurePath\\\\\\\\\\":\\\\\\\\\\"$.Cpu\\\\\\\\\\",\\\\\\\\\\"featureSource\\\\\\\\\\":\\\\\\\\\\"CONFIGURATION\\\\\\\\\\",\\\\\\\\\\"desired\\\\\\\\\\":\\\\\\\\\\"2\\\\\\\\\\"}]}\\\\"}" }, "inputParameters": {} }, { "configRuleName": "oss-bucket-referer-limit", "scope": { "complianceResourceTypes": [ "ACS::OSS::Bucket" ] }, "description": "If the hotlink protection feature is enabled for the Object Storage Service (OSS) bucket and the Referer is added to a specific whitelist, the evaluation result is compliant.", "source": { "owner": "ALIYUN", "identifier": "oss-bucket-referer-limit", "sourceDetails": [ { "messageType": "ConfigurationItemChangeNotification" } ] }, "inputParameters": { "allowEmptyReferer": "true", "allowReferers": "http://www.aliyun.com" } } ] }
+   */
   templateContent?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/CreateCompliancePackResponseBody.ts

@@ -3,7 +3,21 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class CreateCompliancePackResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The compliance package ID.
+   * 
+   * @example
+   * cp-a8a8626622af0082****
+   */
   compliancePackId?: string;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 6EC7AED1-172F-42AE-9C12-295BC2ADB751
+   */
   requestId?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/CreateCompliancePackShrinkRequest.ts

@@ -3,7 +3,21 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class CreateCompliancePackShrinkRequestExcludeTagsScope extends $dara.Model {
+  /**
+   * @remarks
+   * TagKey
+   * 
+   * @example
+   * key-2
+   */
   tagKey?: string;
+  /**
+   * @remarks
+   * TagValue
+   * 
+   * @example
+   * value-2
+   */
   tagValue?: string;
   static names(): { [key: string]: string } {
     return {
@@ -29,7 +43,21 @@ export class CreateCompliancePackShrinkRequestExcludeTagsScope extends $dara.Mod
 }
 
 export class CreateCompliancePackShrinkRequestTagsScope extends $dara.Model {
+  /**
+   * @remarks
+   * Tagkey
+   * 
+   * @example
+   * key-1
+   */
   tagKey?: string;
+  /**
+   * @remarks
+   * TagValue
+   * 
+   * @example
+   * value-1
+   */
   tagValue?: string;
   static names(): { [key: string]: string } {
     return {
@@ -55,32 +83,163 @@ export class CreateCompliancePackShrinkRequestTagsScope extends $dara.Model {
 }
 
 export class CreateCompliancePackShrinkRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The client token that you want to use to ensure the idempotency of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.``
+   * 
+   * @example
+   * 1594295238-f9361358-5843-4294-8d30-b5183fac****
+   */
   clientToken?: string;
   /**
    * @remarks
+   * The name of the compliance package.
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * test-pack-name
    */
   compliancePackName?: string;
+  /**
+   * @remarks
+   * The ID of the compliance package template.
+   * 
+   * You can call the [ListCompliancePackTemplates](https://help.aliyun.com/document_detail/261176.html) operation to obtain the ID of the compliance package.
+   * 
+   * @example
+   * ct-5f26ff4e06a300c4****
+   */
   compliancePackTemplateId?: string;
   /**
+   * @remarks
+   * The rules in the compliance package. You must specify either this parameter or TemplateContent.
+   * 
    * **if can be null:**
    * false
    */
   configRulesShrink?: string;
+  /**
+   * @remarks
+   * Specifies whether to enable the rule together with the compliance package. Valid values:
+   * 
+   * *   true: The system enables the rule together with the compliance package.
+   * *   false: The system does not enable the rule together with the compliance package.
+   * 
+   * @example
+   * false
+   */
   defaultEnable?: boolean;
+  /**
+   * @remarks
+   * The description of the compliance package.
+   * 
+   * @example
+   * Test pack description.
+   */
   description?: string;
+  /**
+   * @remarks
+   * ExcludeRegionIdsScope
+   * 
+   * @example
+   * cn-hangzhou
+   */
   excludeRegionIdsScope?: string;
+  /**
+   * @remarks
+   * ExcludeResourceGroupIdsScope. Separate multiple resource group IDs with commas (,).
+   * 
+   * @example
+   * rg-bnczc6r7rml****
+   */
   excludeResourceGroupIdsScope?: string;
+  /**
+   * @remarks
+   * The ID of the resource that you do not want to evaluate by using the compliance package. Separate multiple resource IDs with commas (,).
+   * 
+   * @example
+   * eip-8vbf3x310fn56ijfd****
+   */
   excludeResourceIdsScope?: string;
+  /**
+   * @remarks
+   * ExcludeTagsScope
+   */
   excludeTagsScope?: CreateCompliancePackShrinkRequestExcludeTagsScope[];
+  /**
+   * @remarks
+   * The ID of the region whose resources you want to evaluate by using the compliance package. Separate multiple region IDs with commas (,).
+   * 
+   * @example
+   * cn-hangzhou
+   */
   regionIdsScope?: string;
+  /**
+   * @remarks
+   * The ID of the resource group whose resources you want to evaluate by using the compliance package. Separate multiple resource group IDs with commas (,).
+   * 
+   * @example
+   * rg-aekzdibsjjc****
+   */
   resourceGroupIdsScope?: string;
+  /**
+   * @remarks
+   * ResourceIdsScope
+   * 
+   * @example
+   * eip-8vbf3x310fn56ijfd****
+   */
   resourceIdsScope?: string;
+  /**
+   * @remarks
+   * The risk level of the resources that are not compliant with the rules in the compliance package. Default value: 2. Valid values:
+   * 
+   * *   1: high.
+   * *   2: medium.
+   * *   3: low.
+   * 
+   * @example
+   * 1
+   */
   riskLevel?: number;
+  /**
+   * @remarks
+   * The tags of the resource.
+   * 
+   * You can add up to 20 tags to a resource.
+   */
   tagShrink?: string;
+  /**
+   * @remarks
+   * The tag key of the resource that you want to evaluate by using the compliance package.
+   * 
+   * @example
+   * ECS
+   */
   tagKeyScope?: string;
+  /**
+   * @remarks
+   * The tag value of the resource that you want to evaluate by using the compliance package.
+   * 
+   * >  You must configure the TagValueScope parameter together with the TagKeyScope parameter.
+   * 
+   * @example
+   * test
+   */
   tagValueScope?: string;
+  /**
+   * @remarks
+   * TagsScope
+   */
   tagsScope?: CreateCompliancePackShrinkRequestTagsScope[];
+  /**
+   * @remarks
+   * The information about the template that is used to generate the compliance package. You can call an API operation to view the details of an existing compliance package or write a compliance package template. For more information, see [Write a compliance package template in a configuration file](https://help.aliyun.com/document_detail/2659733.html). You must specify one of ConfigRules and TemplateContent.
+   * 
+   * @example
+   * { "configRuleTemplates": [ { "configRuleName": "condition-rule-example", "scope": { "complianceResourceTypes": [ "ACS::ECS::Instance" ] }, "description": "", "source": { "owner": "CUSTOM_CONFIGURATION", "identifier": "acs-config-configuration", "sourceDetails": [ { "messageType": "ScheduledNotification", "maximumExecutionFrequency": "Twelve_Hours" }, { "messageType": "ConfigurationItemChangeNotification" } ], "conditions": "{\\\\"ComplianceConditions\\\\":\\\\"{\\\\\\\\\\"operator\\\\\\\\\\":\\\\\\\\\\"and\\\\\\\\\\",\\\\\\\\\\"children\\\\\\\\\\":[{\\\\\\\\\\"operator\\\\\\\\\\":\\\\\\\\\\"GreaterOrEquals\\\\\\\\\\",\\\\\\\\\\"featurePath\\\\\\\\\\":\\\\\\\\\\"$.Cpu\\\\\\\\\\",\\\\\\\\\\"featureSource\\\\\\\\\\":\\\\\\\\\\"CONFIGURATION\\\\\\\\\\",\\\\\\\\\\"desired\\\\\\\\\\":\\\\\\\\\\"2\\\\\\\\\\"}]}\\\\"}" }, "inputParameters": {} }, { "configRuleName": "oss-bucket-referer-limit", "scope": { "complianceResourceTypes": [ "ACS::OSS::Bucket" ] }, "description": "If the hotlink protection feature is enabled for the Object Storage Service (OSS) bucket and the Referer is added to a specific whitelist, the evaluation result is compliant.", "source": { "owner": "ALIYUN", "identifier": "oss-bucket-referer-limit", "sourceDetails": [ { "messageType": "ConfigurationItemChangeNotification" } ] }, "inputParameters": { "allowEmptyReferer": "true", "allowReferers": "http://www.aliyun.com" } } ] }
+   */
   templateContent?: string;
   static names(): { [key: string]: string } {
     return {