@alicloud/config20200907 4.2.2 → 4.2.3

package/src/models/GetAggregateConfigDeliveryChannelResponseBody.ts

@@ -3,21 +3,176 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class GetAggregateConfigDeliveryChannelResponseBodyDeliveryChannel extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the member in the account group.
+   * 
+   * @example
+   * 120886317861****
+   */
   accountId?: string;
+  /**
+   * @remarks
+   * The ID of the account group.
+   * 
+   * @example
+   * ca-a4e5626622af0079****
+   */
   aggregatorId?: string;
+  /**
+   * @remarks
+   * Indicates whether the specified destination receives 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: The specified destination receives scheduled compliant snapshots.
+   * *   false: The specified destination does not receive scheduled compliant snapshots.
+   * 
+   * @example
+   * false
+   */
   compliantSnapshot?: boolean;
+  /**
+   * @remarks
+   * Indicates whether the specified destination receives resource change logs. If the value of this parameter is true, Cloud Config delivers the resource change logs to OSS, Log Service, or MNS when the configurations of the resources change. Valid values:
+   * 
+   * *   true: The specified destination receives resource change logs.
+   * *   false: The specified destination does not receive resource change logs.
+   * 
+   * @example
+   * true
+   */
   configurationItemChangeNotification?: boolean;
+  /**
+   * @remarks
+   * Indicates whether the specified destination receives 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: The specified destination receives scheduled resource snapshots.
+   * *   false: The specified destination does not receive scheduled resource snapshots.
+   * 
+   * @example
+   * false
+   */
   configurationSnapshot?: boolean;
+  /**
+   * @remarks
+   * The ARN of the role that is assigned to the delivery channel.
+   * 
+   * @example
+   * acs:ram::120886317861****:role/aliyunserviceroleforconfig
+   */
   deliveryChannelAssumeRoleArn?: string;
+  /**
+   * @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 risk level of the events to which you want to subscribe. Valid values: 1, 2, and 3. The value 1 indicates the high risk level, the value 2 indicates the medium risk level, and the value 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 want to subscribe. 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.
+   * 
+   * @example
+   * cdc-d9106457e0d900b1****
+   */
   deliveryChannelId?: string;
+  /**
+   * @remarks
+   * The name of the delivery channel.
+   * 
+   * @example
+   * myDeliveryChannel
+   */
   deliveryChannelName?: string;
+  /**
+   * @remarks
+   * The ARN of the delivery destination.
+   * 
+   * *   If the value of the DeliveryChannelType parameter is OSS, the value of this parameter is the ARN of the destination OSS bucket.
+   * *   If the value of the DeliveryChannelType parameter is MNS, the value of this parameter is the ARN of the destination MNS topic.
+   * *   If the value of the DeliveryChannelType parameter is SLS, the value of this parameter is the ARN of the destination Log Service Logstore.
+   * 
+   * @example
+   * acs:oss:cn-shanghai:120886317861****:new-bucket
+   */
   deliveryChannelTargetArn?: string;
+  /**
+   * @remarks
+   * The type of the delivery channel. Valid values:
+   * 
+   * *   OSS: Object Storage Service (OSS)
+   * *   MNS: Message Service (MNS)
+   * *   SLS: Log Service
+   * 
+   * @example
+   * OSS
+   */
   deliveryChannelType?: string;
+  /**
+   * @remarks
+   * The time when Cloud Config delivers scheduled resources snapshots every day.
+   * 
+   * Format: `HH:mmZ`. This time is displayed in UTC.
+   * 
+   * @example
+   * 09:10Z
+   */
   deliverySnapshotTime?: string;
+  /**
+   * @remarks
+   * The description of the delivery channel.
+   * 
+   * @example
+   * My OSS delivery.
+   */
   description?: string;
+  /**
+   * @remarks
+   * Indicates whether the specified destination receives resource non-compliance events. If the value of this parameter is true, Cloud Config delivers resource non-compliance events to Log Service or MNS when resources are evaluated as non-compliant. Valid values:
+   * 
+   * *   true: The specified destination receives resource non-compliance events.
+   * *   false: The specified destination does not receive resource non-compliance events.
+   * 
+   * @example
+   * false
+   */
   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.
+   * 
+   * @example
+   * acs:oss:cn-shanghai:100931896542****:new-bucket
+   */
   oversizedDataOSSTargetArn?: string;
+  /**
+   * @remarks
+   * The status of the delivery channel. Valid values:
+   * 
+   * *   0: The delivery channel is disabled.
+   * *   1: The delivery channel is enabled.
+   * 
+   * @example
+   * 1
+   */
   status?: number;
   static names(): { [key: string]: string } {
     return {
@@ -71,7 +226,18 @@ export class GetAggregateConfigDeliveryChannelResponseBodyDeliveryChannel extend
 }
 
 export class GetAggregateConfigDeliveryChannelResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The information about a delivery channel.
+   */
   deliveryChannel?: GetAggregateConfigDeliveryChannelResponseBodyDeliveryChannel;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * DC300244-FCE3-5061-8214-C27ECB668487
+   */
   requestId?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/GetAggregateConfigRuleComplianceByPackRequest.ts

@@ -7,7 +7,7 @@ export class GetAggregateConfigRuleComplianceByPackRequest extends $dara.Model {
    * @remarks
    * The ID of the account group.
    * 
-   * For more information about how to obtain the ID of an account group, see [ListAggregators](https://help.aliyun.com/document_detail/255797.html).
+   * For 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.
    * 
@@ -17,9 +17,9 @@ export class GetAggregateConfigRuleComplianceByPackRequest extends $dara.Model {
   aggregatorId?: string;
   /**
    * @remarks
-   * The ID of the compliance pack.
+   * The ID of the compliance package.
    * 
-   * For more information about how to obtain the ID of a compliance pack, see [ListAggregateCompliancePacks](https://help.aliyun.com/document_detail/262059.html).
+   * For 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.
    * 

package/src/models/GetAggregateConfigRuleComplianceByPackResponseBody.ts

@@ -5,15 +5,12 @@ import * as $dara from '@darabonba/typescript';
 export class GetAggregateConfigRuleComplianceByPackResponseBodyConfigRuleComplianceResultConfigRuleCompliances extends $dara.Model {
   /**
    * @remarks
-   * The compliance result. Valid values:
+   * The compliance evaluation result returned by the rule. Valid values:
    * 
-   * - COMPLIANT: The rule is compliant.
-   * 
-   * - NON_COMPLIANT: The rule is non-compliant.
-   * 
-   * - NOT_APPLICABLE: The rule is not applicable.
-   * 
-   * - INSUFFICIENT_DATA: No data is available.
+   * *   COMPLIANT: The relevant resources are evaluated as compliant.
+   * *   NON_COMPLIANT: The relevant resources are evaluated as non-compliant.
+   * *   NOT_APPLICABLE: The rule does not apply to your resources.
+   * *   INSUFFICIENT_DATA: No resource data is available.
    * 
    * @example
    * COMPLIANT
@@ -21,7 +18,7 @@ export class GetAggregateConfigRuleComplianceByPackResponseBodyConfigRuleComplia
   complianceType?: string;
   /**
    * @remarks
-   * The ID of the rule in the compliance pack.
+   * The ID of the rule.
    * 
    * @example
    * cr-fdc8626622af00f9****
@@ -29,10 +26,10 @@ export class GetAggregateConfigRuleComplianceByPackResponseBodyConfigRuleComplia
   configRuleId?: string;
   /**
    * @remarks
-   * The name of the rule in the compliance pack.
+   * The name of the rule.
    * 
    * @example
-   * The bandwidth of the Elastic IP instance meets the minimum requirements.
+   * test-rule-name
    */
   configRuleName?: string;
   static names(): { [key: string]: string } {
@@ -63,63 +60,35 @@ export class GetAggregateConfigRuleComplianceByPackResponseBodyConfigRuleComplia
 export class GetAggregateConfigRuleComplianceByPackResponseBodyConfigRuleComplianceResult extends $dara.Model {
   /**
    * @remarks
-   * The ID of the compliance pack.
+   * The ID of the compliance package.
    * 
    * @example
    * cp-541e626622af0087****
    */
   compliancePackId?: string;
-  /**
-   * @remarks
-   * The total number of rules for which all evaluation results are **Compliant**.
-   * 
-   * @example
-   * 0
-   */
   compliantCount?: number;
   /**
    * @remarks
-   * A list of rule compliance results.
+   * The information about rules in the compliance package.
    */
   configRuleCompliances?: GetAggregateConfigRuleComplianceByPackResponseBodyConfigRuleComplianceResultConfigRuleCompliances[];
-  /**
-   * @remarks
-   * The total number of rules whose evaluation results include **Ignored**.
-   * 
-   * @example
-   * 1
-   */
   ignoredCount?: number;
-  /**
-   * @remarks
-   * The total number of rules whose evaluation results include **Insufficient Data**.
-   * 
-   * @example
-   * 1
-   */
   insufficientDataCount?: number;
   /**
    * @remarks
-   * The number of non-compliant rules.
+   * The number of rules against which specific resources are evaluated as non-compliant.
    * 
    * @example
-   * 1
+   * 0
    */
   nonCompliantCount?: number;
-  /**
-   * @remarks
-   * The total number of rules whose evaluation results include **Not Applicable**.
-   * 
-   * @example
-   * 1
-   */
   notApplicableCount?: number;
   /**
    * @remarks
-   * The total number of rules.
+   * The total number of rules in the compliance package.
    * 
    * @example
-   * 2
+   * 1
    */
   totalCount?: number;
   static names(): { [key: string]: string } {
@@ -163,12 +132,12 @@ export class GetAggregateConfigRuleComplianceByPackResponseBodyConfigRuleComplia
 export class GetAggregateConfigRuleComplianceByPackResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The compliance results of the rules in the compliance pack.
+   * The compliance evaluation results that are returned by rules in the compliance package.
    */
   configRuleComplianceResult?: GetAggregateConfigRuleComplianceByPackResponseBodyConfigRuleComplianceResult;
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * C6B0C0A8-3245-48F1-AEAB-BC1A446E99D0

package/src/models/GetAggregateConfigRuleRequest.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class GetAggregateConfigRuleRequestTag extends $dara.Model {
   /**
    * @remarks
-   * The tag key of the resource.
+   * The tag key of the resource. You can specify up to 20 tag keys.
    * 
-   * You can add a maximum of 20 tag keys.
+   * The tag key cannot be an empty string. The tag key must be 1 to 64 characters in length and cannot start with `aliyun` or `acs`:. The tag key cannot contain `http://` or `https://`.
    * 
    * @example
    * key-1
@@ -15,9 +15,11 @@ export class GetAggregateConfigRuleRequestTag extends $dara.Model {
   key?: string;
   /**
    * @remarks
-   * The tag value of the resource.
+   * The tag values.
    * 
-   * You can add a maximum of 20 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
@@ -51,7 +53,7 @@ export class GetAggregateConfigRuleRequest 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.
    * 
@@ -61,9 +63,9 @@ export class GetAggregateConfigRuleRequest extends $dara.Model {
   aggregatorId?: string;
   /**
    * @remarks
-   * The rule ID.
+   * The ID of the rule.
    * 
-   * For more information, see [ListAggregateConfigRules](https://help.aliyun.com/document_detail/264148.html).
+   * You can call the [ListAggregateConfigRules](https://help.aliyun.com/document_detail/264148.html) operation to obtain the rule ID.
    * 
    * This parameter is required.
    * 
@@ -73,8 +75,9 @@ export class GetAggregateConfigRuleRequest extends $dara.Model {
   configRuleId?: string;
   /**
    * @remarks
-   * The tags.
-   * This parameter is deprecated. If you specify this parameter, the value does not take effect.
+   * The tags of the resource.
+   * 
+   * You can add up to 20 tags to a resource.
    * 
    * @deprecated
    */