@alicloud/config20200907 4.2.1 → 4.2.3

package/src/models/UpdateAggregateCompliancePackResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateAggregateCompliancePackResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the compliance pack.
+   * The compliance package ID.
    * 
    * @example
    * ca-f632626622af0079****

package/src/models/UpdateAggregateCompliancePackShrinkRequest.ts

@@ -87,7 +87,7 @@ export class UpdateAggregateCompliancePackShrinkRequest extends $dara.Model {
    * @remarks
    * The ID of the account group.
    * 
-   * For more information, see [ListAggregators](https://help.aliyun.com/document_detail/255797.html).
+   * For more information about how to obtain the ID of an account group, see [ListAggregators](https://help.aliyun.com/document_detail/255797.html).
    * 
    * This parameter is required.
    * 
@@ -97,7 +97,7 @@ export class UpdateAggregateCompliancePackShrinkRequest extends $dara.Model {
   aggregatorId?: string;
   /**
    * @remarks
-   * A client token. It is used to ensure the idempotence of the request. Generate a value that is unique among different requests. The `ClientToken` parameter can contain only ASCII characters and cannot exceed 64 characters in length.
+   * 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****
@@ -105,9 +105,9 @@ export class UpdateAggregateCompliancePackShrinkRequest extends $dara.Model {
   clientToken?: string;
   /**
    * @remarks
-   * The ID of the compliance pack.
+   * The ID of the compliance package.
    * 
-   * For more information, see [ListAggregateCompliancePacks](https://help.aliyun.com/document_detail/262059.html).
+   * For more information about how to obtain the ID of a compliance package, see [ListAggregateCompliancePacks](https://help.aliyun.com/document_detail/262059.html).
    * 
    * This parameter is required.
    * 
@@ -117,32 +117,32 @@ export class UpdateAggregateCompliancePackShrinkRequest extends $dara.Model {
   compliancePackId?: string;
   /**
    * @remarks
-   * The name of the compliance pack.
+   * The name of the compliance package.
    * 
-   * For more information, see [ListAggregateCompliancePacks](https://help.aliyun.com/document_detail/262059.html).
+   * For more information about how to obtain the name of a compliance package, see [ListAggregateCompliancePacks](https://help.aliyun.com/document_detail/262059.html).
    * 
    * @example
-   * 等保三级预检合规包
+   * test-pack-name
    */
   compliancePackName?: string;
   /**
    * @remarks
-   * The rules in the compliance pack.
+   * The rules in the compliance package.
    * 
-   * If you leave this parameter empty when you modify the compliance pack, the existing rules are not changed. If you specify new rules, the new rules replace the existing ones.
+   * If you leave this parameter empty, the rules in the compliance package remain unchanged. If you set this parameter, Cloud Config replaces the existing rules in the compliance package with the specified rules.
    */
   configRulesShrink?: string;
   /**
    * @remarks
-   * The description of the compliance pack.
+   * The description of the compliance package.
    * 
    * @example
-   * 基于等保2.0三级标准，提供持续检测合规性的建议模板，帮助您提前自检并修复问题，以便快速通过正式检测。
+   * Test compliance pack description.
    */
   description?: string;
   /**
    * @remarks
-   * The rules are not effective for resources in the specified regions. Resources in these regions are not evaluated. Separate multiple region IDs with commas (,).
+   * The IDs of the regions to which the rule not applies. Separate multiple region IDs with commas (,).
    * 
    * @example
    * cn-shanghai
@@ -150,7 +150,7 @@ export class UpdateAggregateCompliancePackShrinkRequest extends $dara.Model {
   excludeRegionIdsScope?: string;
   /**
    * @remarks
-   * The rules are not effective for resources in the specified resource groups. Resources in these resource groups are not evaluated. Separate multiple resource group IDs with commas (,).
+   * ExcludeResourceGroupIdsScope. Separate multiple resource group IDs with commas (,).
    * 
    * @example
    * rg-bnczc6r7rml****
@@ -158,7 +158,7 @@ export class UpdateAggregateCompliancePackShrinkRequest extends $dara.Model {
   excludeResourceGroupIdsScope?: string;
   /**
    * @remarks
-   * The compliance pack is not effective for the specified resources. The specified resources are not evaluated. Separate multiple resource IDs with commas (,).
+   * 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****
@@ -166,12 +166,12 @@ export class UpdateAggregateCompliancePackShrinkRequest extends $dara.Model {
   excludeResourceIdsScope?: string;
   /**
    * @remarks
-   * The excluded tag scope.
+   * ExcludeTagsScope
    */
   excludeTagsScope?: UpdateAggregateCompliancePackShrinkRequestExcludeTagsScope[];
   /**
    * @remarks
-   * The compliance pack is effective only for resources in the specified regions. Separate multiple region IDs with commas (,).
+   * 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
@@ -179,7 +179,7 @@ export class UpdateAggregateCompliancePackShrinkRequest extends $dara.Model {
   regionIdsScope?: string;
   /**
    * @remarks
-   * The compliance pack is effective only for resources in the specified resource groups. Separate multiple resource group IDs with commas (,).
+   * 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-aekzc7r7rhx****
@@ -187,7 +187,7 @@ export class UpdateAggregateCompliancePackShrinkRequest extends $dara.Model {
   resourceGroupIdsScope?: string;
   /**
    * @remarks
-   * The rules are effective only for the specified resources. Separate multiple resource IDs with commas (,).
+   * The IDs of the resources included from the compliance evaluations performed by the rule. Separate multiple resource IDs with commas (,).
    * 
    * @example
    * lb-5cmbowstbkss9ta03****
@@ -195,13 +195,11 @@ export class UpdateAggregateCompliancePackShrinkRequest extends $dara.Model {
   resourceIdsScope?: string;
   /**
    * @remarks
-   * The risk level of the compliance pack. Valid values:
+   * The risk level of the resources that are not compliant with the rules in the compliance package. Valid values:
    * 
-   * - 1: high risk.
-   * 
-   * - 2: medium risk.
-   * 
-   * - 3: low risk.
+   * *   1: high risk level
+   * *   2: medium risk level
+   * *   3: low risk level
    * 
    * @example
    * 1
@@ -209,16 +207,16 @@ export class UpdateAggregateCompliancePackShrinkRequest extends $dara.Model {
   riskLevel?: number;
   /**
    * @remarks
-   * The tags of the resource. This parameter is deprecated and no longer takes effect.
+   * The tags of the resource.
    * 
-   * You can add up to 20 tags.
+   * You can add up to 20 tags to a resource.
    * 
    * @deprecated
    */
   tagShrink?: string;
   /**
    * @remarks
-   * The compliance pack is effective only for resources that have the specified tag key.
+   * The tag key of the resource that you want to evaluate by using the compliance package.
    * 
    * @example
    * ECS
@@ -226,9 +224,9 @@ export class UpdateAggregateCompliancePackShrinkRequest extends $dara.Model {
   tagKeyScope?: string;
   /**
    * @remarks
-   * The compliance pack is effective only for resources that have the specified tag key and tag value.
+   * The tag value of the resource that you want to evaluate by using the compliance package.
    * 
-   * > You must specify TagValueScope together with TagKeyScope.
+   * >  You must configure the TagValueScope parameter together with the TagKeyScope parameter.
    * 
    * @example
    * test
@@ -236,7 +234,7 @@ export class UpdateAggregateCompliancePackShrinkRequest extends $dara.Model {
   tagValueScope?: string;
   /**
    * @remarks
-   * The tag scope.
+   * TagsScope
    */
   tagsScope?: UpdateAggregateCompliancePackShrinkRequestTagsScope[];
   static names(): { [key: string]: string } {

package/src/models/UpdateAggregateConfigDeliveryChannelRequest.ts

@@ -5,41 +5,186 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateAggregateConfigDeliveryChannelRequest extends $dara.Model {
   /**
    * @remarks
+   * The ID of the account group.
+   * 
+   * For more information about how to obtain the ID of the account group, see [ListAggregators](https://help.aliyun.com/document_detail/255797.html).
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * ca-a4e5626622af0079****
    */
   aggregatorId?: string;
+  /**
+   * @remarks
+   * 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. For more information, see [Ensure idempotence](https://help.aliyun.com/document_detail/25693.html)
+   * 
+   * @example
+   * 1594295238-f9361358-5843-4294-8d30-b5183fac****
+   */
   clientToken?: string;
   /**
+   * @remarks
+   * Specifies whether to deliver scheduled compliant snapshots. Cloud Config delivers scheduled compliant snapshots at `04:00Z` and `16:00Z` to Log Service every day. The time is displayed in UTC. Valid values:
+   * 
+   * *   true: Cloud Config delivers scheduled compliant snapshots.
+   * *   false (default): Cloud Config does not deliver scheduled compliant snapshots.
+   * 
+   * @example
+   * false
+   * 
    * **if can be null:**
    * true
    */
   compliantSnapshot?: boolean;
   /**
+   * @remarks
+   * Specifies whether to deliver resource change logs. If you set this parameter to true, Cloud Config delivers resource change logs to OSS, Log Service, or MNS when the configurations of the resources change. Valid values:
+   * 
+   * *   true: Cloud Config delivers resource change logs.
+   * *   false (default): Cloud Config does not deliver resource change logs.
+   * 
+   * > This parameter is available for delivery channels of the OSS, SLS, and MNS types.
+   * 
+   * @example
+   * false
+   * 
    * **if can be null:**
    * true
    */
   configurationItemChangeNotification?: boolean;
   /**
+   * @remarks
+   * Specifies whether to deliver scheduled resource snapshots. Cloud Config delivers scheduled resource snapshots at `04:00Z` and `16:00Z` to OSS, MNS, or Log Service every day. The time is displayed in UTC. Valid values:
+   * 
+   * *   true: Cloud Config delivers scheduled resource snapshots.
+   * *   false (default): Cloud Config does not deliver scheduled resource snapshots.
+   * 
+   * @example
+   * false
+   * 
    * **if can be null:**
    * true
    */
   configurationSnapshot?: boolean;
+  /**
+   * @remarks
+   * The rule that is attached to the delivery channel. This parameter is available when you deliver data of all types to MNS or deliver snapshots to Log Service.
+   * 
+   * *   If the value of the DeliveryChannelType parameter is MNS, take note of the following settings of the lowest risk level and resource types of the events to which you subscribed:
+   * 
+   *     *   The lowest risk level of the events to which you want to subscribe is in the following format: `{"filterType":"RuleRiskLevel","value":"1","multiple":false}`.
+   * 
+   *         The `value` field indicates the lowest risk level of the events to which you subscribed. Valid values: 1, 2, and 3, where 1 indicates the high risk level, 2 indicates the medium risk level, and 3 indicates the low risk level.
+   * 
+   *     *   The setting of the resource types of the events to which you want to subscribe is in the following format: `{"filterType":"ResourceType","values":["ACS::ACK::Cluster","ACS::ActionTrail::Trail","ACS::CBWP::CommonBandwidthPackage"],"multiple":true}`.
+   * 
+   *         The `values` field indicates the resource types of the events to which you subscribed. The value of the field is a JSON array. Examples:
+   * 
+   * `[{"filterType":"ResourceType","values":["ACS::ActionTrail::Trail","ACS::CBWP::CommonBandwidthPackage","ACS::CDN::Domain","ACS::CEN::CenBandwidthPackage","ACS::CEN::CenInstance","ACS::CEN::Flowlog","ACS::DdosCoo::Instance"],"multiple":true}]`
+   * 
+   * *   If you set the DeliveryChannelType parameter to SLS, the setting of the resource types of the snapshots to which you want to deliver is in the following format: `{"filterType":"ResourceType","values":["ACS::ACK::Cluster","ACS::ActionTrail::Trail","ACS::CBWP::CommonBandwidthPackage"],"multiple":true}`.
+   * 
+   *     The `values` field specifies the resource types of the snapshots to which you want to deliver. The value of the field is a JSON array. Examples:
+   * 
+   * `[{"filterType":"ResourceType","values":["ACS::ActionTrail::Trail","ACS::CBWP::CommonBandwidthPackage","ACS::CDN::Domain","ACS::CEN::CenBandwidthPackage","ACS::CEN::CenInstance","ACS::CEN::Flowlog","ACS::DdosCoo::Instance"],"multiple":true}]`
+   * 
+   * @example
+   * [{"filterType":"ResourceType","values":["ACS::ActionTrail::Trail","ACS::CBWP::CommonBandwidthPackage","ACS::CDN::Domain","ACS::CEN::CenBandwidthPackage","ACS::CEN::CenInstance","ACS::CEN::Flowlog","ACS::DdosCoo::Instance"],"multiple":true}]
+   */
   deliveryChannelCondition?: string;
   /**
    * @remarks
+   * The ID of the delivery channel.
+   * 
+   * For more information about how to obtain the ID of a delivery channel, see [ListAggregateConfigDeliveryChannels](https://help.aliyun.com/document_detail/429842.html).
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * cdc-8e45ff4e06a3a8****
    */
   deliveryChannelId?: string;
+  /**
+   * @remarks
+   * The name of the delivery channel.
+   * 
+   * @example
+   * testoss
+   */
   deliveryChannelName?: string;
+  /**
+   * @remarks
+   * The ARN of the delivery destination. Valid values:
+   * 
+   * *   `acs:oss:{RegionId}:{accountId}:{bucketName}` if your delivery destination is an OSS bucket. Example: `acs:oss:cn-shanghai:100931896542****:new-bucket`.
+   * *   `acs:mns:{RegionId}:{accountId}:/topics/{topicName}` if your delivery destination is an MNS topic. Example: `acs:mns:cn-shanghai:100931896542****:/topics/topic1`.
+   * *   `acs:log:{RegionId}:{accountId}:project/{projectName}/logstore/{logstoreName}` if your delivery destination is a Log Service Logstore. Example: `acs:log:cn-shanghai:100931896542****:project/project1/logstore/logstore1`.
+   * 
+   * @example
+   * acs:oss:cn-shanghai:100931896542****:new-bucket
+   */
   deliveryChannelTargetArn?: string;
+  /**
+   * @remarks
+   * The time when Cloud Config delivers scheduled resources snapshots every day.
+   * 
+   * Format: `HH:mmZ`. This time is displayed in UTC.
+   * 
+   * > When you enable the scheduled resource delivery feature, you can specify a custom delivery time for this parameter. If you do not configure this parameter, Cloud Config automatically delivers scheduled resource snapshots at `04:00Z` and `16:00Z` every day.
+   * 
+   * @example
+   * 09:10Z
+   */
   deliverySnapshotTime?: string;
+  /**
+   * @remarks
+   * The description of the delivery channel.
+   * 
+   * @example
+   * My OSS delivery.
+   */
   description?: string;
   /**
+   * @remarks
+   * Specifies whether to deliver resource non-compliance events. If you set this parameter to true, Cloud Config delivers resource non-compliance events to Log Service or MNS when resources are considered non-compliant. Valid values:
+   * 
+   * *   true: Cloud Config delivers resource non-compliance events.
+   * *   false (default): Cloud Config does not deliver resource non-compliance events.
+   * 
+   * > This parameter is available only for delivery channels of the SLS or MNS type.
+   * 
+   * @example
+   * false
+   * 
    * **if can be null:**
    * true
    */
   nonCompliantNotification?: boolean;
+  /**
+   * @remarks
+   * The ARN of the OSS bucket to which the delivered data is transferred when the size of the data exceeds the specified upper limit of the delivery channel. Format: `acs:oss:{RegionId}:{accountId}:{bucketName}`.
+   * 
+   * If you do not configure this parameter, Cloud Config delivers only summary data.
+   * 
+   * > This parameter is available only for delivery channels of the SLS or MNS type. The upper limit on the storage size of delivery channels of the SLS type is 1 MB, and the upper limit on the storage size of delivery channels of the MNS type is 64 KB.
+   * 
+   * @example
+   * acs:oss:cn-shanghai:100931896542****:new-bucket
+   */
   oversizedDataOSSTargetArn?: string;
+  /**
+   * @remarks
+   * Specifies whether to enable the delivery channel. Valid values:
+   * 
+   * *   0: The delivery channel is disabled. Cloud Config retains the most recent delivery configuration and stops resource data delivery.
+   * *   1 (default): The delivery channel is enabled.
+   * 
+   * @example
+   * 0
+   */
   status?: number;
   static names(): { [key: string]: string } {
     return {

package/src/models/UpdateAggregateConfigDeliveryChannelResponseBody.ts

@@ -3,7 +3,21 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class UpdateAggregateConfigDeliveryChannelResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the delivery channel.
+   * 
+   * @example
+   * cdc-8e45ff4e06a3a8****
+   */
   deliveryChannelId?: string;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * A7A0FFF8-0B44-40C6-8BBF-3A185EFDERTHG
+   */
   requestId?: string;
   static names(): { [key: string]: string } {
     return {