@alicloud/config20200907 4.2.0 → 4.2.2

package/src/models/CreateCompliancePackShrinkRequest.ts

@@ -3,21 +3,7 @@ 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 {
@@ -43,21 +29,7 @@ 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 {
@@ -83,163 +55,32 @@ 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 {

package/src/models/CreateConfigDeliveryChannelRequest.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class CreateConfigDeliveryChannelRequest extends $dara.Model {
   /**
    * @remarks
-   * The client token that is used to ensure the idempotency of the request. You can use the client to generate the token, but you must ensure that the token is unique among different requests.
+   * A client token. It is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that the value is unique among different requests.
    * 
-   * The `token` can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](https://help.aliyun.com/document_detail/25693.html).
+   * `ClientToken` can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](https://help.aliyun.com/document_detail/25693.html).
    * 
    * @example
    * 1594295238-f9361358-5843-4294-8d30-b5183fac****
@@ -15,10 +15,11 @@ export class CreateConfigDeliveryChannelRequest extends $dara.Model {
   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:
+   * Specifies whether to deliver compliance snapshots. Cloud Config delivers the compliance and non-compliance information of resources to SLS. Valid values:
    * 
-   * *   true: Cloud Config delivers scheduled compliant snapshots.
-   * *   false (default): Cloud Config does not deliver scheduled compliant snapshots.
+   * - true: Deliver compliance snapshots.
+   * 
+   * - false: Do not deliver compliance snapshots.
    * 
    * @example
    * false
@@ -26,12 +27,17 @@ export class CreateConfigDeliveryChannelRequest extends $dara.Model {
   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:
+   * Specifies whether to deliver resource configuration histories. When the configuration of a resource changes, Cloud Config delivers the resource configuration history to OSS, SLS, or MNS. Valid values:
+   * 
+   * - true: Deliver resource configuration histories.
+   * 
+   * - false (default): Do not deliver resource configuration histories.
    * 
-   * *   true: Cloud Config delivers resource change logs.
-   * *   false (default): Cloud Config does not deliver resource change logs.
+   * > * If the delivery channel is OSS, you must set at least one of `ConfigurationSnapshot` (scheduled resource snapshots) and `ConfigurationItemChangeNotification` (resource configuration histories) to true.
    * 
-   * > This parameter is available for delivery channels of the OSS, SLS, and MNS types.
+   * > - If the delivery channel is SLS, you must set at least one of `ConfigurationSnapshot` (scheduled resource snapshots), `CompliantSnapshot` (compliance snapshots), `ConfigurationItemChangeNotification` (resource configuration histories), and `NonCompliantNotification` (non-compliant events) to true.
+   * 
+   * > - If the delivery channel is MNS, you must set at least one of `ConfigurationItemChangeNotification` (resource configuration histories) and `NonCompliantNotification` (non-compliant events) to true.
    * 
    * @example
    * false
@@ -39,45 +45,48 @@ export class CreateConfigDeliveryChannelRequest extends $dara.Model {
   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:
+   * Specifies whether to deliver scheduled resource snapshots. Cloud Config delivers scheduled resource snapshots to OSS or SLS at `04:00Z` and `16:00Z` (UTC) every day. Valid values:
+   * 
+   * - true: Deliver scheduled resource snapshots.
    * 
-   * *   true: Cloud Config delivers scheduled resource snapshots.
-   * *   false (default): Cloud Config does not deliver scheduled resource snapshots.
+   * - false (default): Do not deliver scheduled resource snapshots.
+   * 
+   * > * If the delivery channel is OSS, you must set at least one of `ConfigurationSnapshot` (scheduled resource snapshots) and `ConfigurationItemChangeNotification` (resource configuration histories) to true.
+   * 
+   * > - If the delivery channel is SLS, you must set at least one of `ConfigurationSnapshot` (scheduled resource snapshots), `ConfigurationItemChangeNotification` (resource configuration histories), `CompliantSnapshot` (compliance snapshots), and `NonCompliantNotification` (non-compliant events) to true.
    * 
    * @example
-   * false
+   * true
    */
   configurationSnapshot?: boolean;
   /**
    * @remarks
-   * The rule that you want to attach to the delivery channel, used to specify subscription content filtering conditions.
-   * 
-   * *   If you specify the minimum risk level and resource types for compliance events, it should be as follows:
+   * An additional rule for the delivery channel. Use this rule to specify filter conditions for subscriptions.
    * 
-   *     *   The setting of the lowest risk level for the events to which you want to subscribe is in the following format: `{"filterType":"RuleRiskLevel","value":"1","multiple":false}`.
+   * - If you subscribe to compliance events, you can specify the minimum risk level and resource types as follows:
    * 
-   *         The `value` field indicates the lowest 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.
+   *   - To specify the minimum risk level of events, use `{"filterType":"RuleRiskLevel","value":"1","multiple":false}`.
    * 
-   *         The `multiple` field indicates whether multiple values are supported for this group of filters. Risk levels only support single-value filtering, so the multiple field for compliance event type content can only be set to `false`.
+   *     `value` specifies the risk level to filter. Valid values: 1 for high, 2 for medium, and 3 for low.
    * 
-   *     *   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}`.
+   *     `multiple` specifies whether the filter supports multiple values. The risk level filter supports only a single value. Therefore, set `multiple` to `false` when you deliver compliance events.
    * 
-   *         The `values` field indicates the resource types of the events to which you want to subscribe. 
+   *   - To specify the resource types of events, use `{"filterType":"ResourceType","values":["ACS::ACK::Cluster","ACS::ActionTrail::Trail","ACS::CBWP::CommonBandwidthPackage"],"multiple":true}`.
    * 
-   *         The `multiple` field indicates whether multiple values are supported for this group of filters. Resource types support multi-value filtering; when selecting multiple resource types, the multiple field can be set to true.
-   * The value of the field is a JSON array. Examples:
+   *     `values` specifies the resource types to which you want to subscribe. The value is a JSON array of resource types.
+   *     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}]`
    * 
-   *         `[{"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}]`
+   *     `multiple` specifies whether the filter supports multiple values. The resource type filter supports multiple values. If you select multiple resource types, set `multiple` to `true`.
    * 
-   *     *   You can also simultaneously specify both risk levels and resource types, such as:
+   *   - You can also specify a risk level and resource types at the same time. Example:
+   *     `[{"filterType":"RuleRiskLevel","value":"2","multiple":false},{"filterType":"ResourceType","values":["ACS::CDN::Domain","ACS::ActionTrail::Trail"],"multiple":true}]`
    * 
-   *         `[{"filterType":"RuleRiskLevel","value":"2","multiple":false},{"filterType":"ResourceType","values":["ACS::CDN::Domain","ACS::ActionTrail::Trail"],"multiple":true}]`
+   * - If you subscribe to resource configuration deliveries, you can specify the resource types as `{"filterType":"ResourceType","values":["ACS::ACK::Cluster","ACS::ActionTrail::Trail","ACS::CBWP::CommonBandwidthPackage"],"multiple":true}`.
    * 
-   * *   If you specify the resource types for delivering configurations, the resource types are specified by: `{"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}]`
+   *   `values` specifies the resource types that you want to deliver. The value is a JSON array of resource types.
+   *   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}]`
    * 
    * @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}]
@@ -87,7 +96,7 @@ export class CreateConfigDeliveryChannelRequest extends $dara.Model {
    * @remarks
    * The name of the delivery channel.
    * 
-   * > If you do not configure this parameter, this parameter is left empty.
+   * > If you do not set this parameter, the value is left empty.
    * 
    * @example
    * testoss
@@ -95,11 +104,13 @@ export class CreateConfigDeliveryChannelRequest extends $dara.Model {
   deliveryChannelName?: string;
   /**
    * @remarks
-   * The Alibaba Cloud Resource Name (ARN) of the delivery destination. Valid values:
+   * The ARN of the delivery destination. Valid values:
+   * 
+   * - If the delivery channel is OSS, the value is in the format of `acs:oss:{RegionId}:{accountId}:{bucketName}`. Example: `acs:oss:cn-shanghai:100931896542****:new-bucket`.
+   * 
+   * - If the delivery channel is MNS, the value is in the format of `acs:mns:{RegionId}:{accountId}:/topics/{topicName}`. Example: `acs:mns:cn-shanghai:100931896542****:/topics/topic1`.
    * 
-   * *   `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`.
+   * - If the delivery channel is SLS, the value is in the format of `acs:log:{RegionId}:{accountId}:project/{projectName}/logstore/{logstoreName}`. Example: `acs:log:cn-shanghai:100931896542****:project/project1/logstore/logstore1`.
    * 
    * This parameter is required.
    * 
@@ -111,9 +122,11 @@ export class CreateConfigDeliveryChannelRequest extends $dara.Model {
    * @remarks
    * The type of the delivery channel. Valid values:
    * 
-   * *   OSS: Object Storage Service (OSS)
-   * *   MNS: Message Service (MNS)
-   * *   SLS: Log Service
+   * - OSS: Object Storage Service.
+   * 
+   * - MNS: Simple Message Queue (formerly MNS).
+   * 
+   * - SLS: Simple Log Service.
    * 
    * This parameter is required.
    * 
@@ -123,11 +136,11 @@ export class CreateConfigDeliveryChannelRequest extends $dara.Model {
   deliveryChannelType?: string;
   /**
    * @remarks
-   * The time when you want Cloud Config to deliver scheduled resource snapshots every day.
+   * The time when Cloud Config starts to deliver scheduled resource snapshots every day.
    * 
-   * Format: `HH:mmZ`. This time is displayed in UTC.
+   * The value must be in the `HH:mmZ` format (UTC).
    * 
-   * > When you enable the scheduled resource delivery feature, you can configure this parameter to specify a custom delivery time. If you do not configure this parameter, Cloud Config automatically delivers scheduled resource snapshots at `04:00Z` and `16:00Z` every day.
+   * > When you enable scheduled resource snapshot delivery, you can use this parameter to customize the delivery time. If you do not set this parameter, the snapshots are delivered at `04:00Z` and `16:00Z` (UTC) by default.
    * 
    * @example
    * 09:10Z
@@ -143,12 +156,15 @@ export class CreateConfigDeliveryChannelRequest extends $dara.Model {
   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:
+   * Specifies whether to deliver non-compliant events. When a resource is evaluated as non-compliant, Cloud Config delivers the non-compliant event to SLS or MNS. Valid values:
+   * 
+   * - true: Deliver non-compliant events.
+   * 
+   * - false (default): Do not deliver non-compliant events.
    * 
-   * *   true: Cloud Config delivers resource non-compliance events.
-   * *   false (default): Cloud Config does not deliver resource non-compliance events.
+   * > * If the delivery channel is SLS, you must set at least one of `ConfigurationSnapshot` (scheduled resource snapshots), `CompliantSnapshot` (compliance snapshots), `ConfigurationItemChangeNotification` (resource configuration histories), and `NonCompliantNotification` (non-compliant events) to true.
    * 
-   * > This parameter is available only for delivery channels of the SLS or MNS type.
+   * > - If the delivery channel is MNS, you must set at least one of `ConfigurationItemChangeNotification` (resource configuration histories) and `NonCompliantNotification` (non-compliant events) to true.
    * 
    * @example
    * false
@@ -156,11 +172,11 @@ export class CreateConfigDeliveryChannelRequest extends $dara.Model {
   nonCompliantNotification?: boolean;
   /**
    * @remarks
-   * The ARN of the OSS bucket to which you want to transfer the delivery data when the size of the data exceeds the specified upper limit of the delivery channel. Format: `acs:oss:{RegionId}:{accountId}:{bucketName}`.
+   * The ARN of the OSS bucket to which the oversized data is delivered when the size of the data exceeds the limit of the delivery channel. The format is `acs:oss:{RegionId}:{accountId}:{bucketName}`.
    * 
-   * If you do not configure this parameter, Cloud Config delivers only summary data.
+   * If you do not set this parameter, Cloud Config delivers only the summary of the data.
    * 
-   * > This parameter is available only for delivery channels of the SLS or MNS type. The maximum storage size of delivery channels of the SLS type is 1 MB, and the maximum storage size of delivery channels of the MNS type is 64 KB.
+   * > This parameter is supported only for SLS and MNS delivery channels. The delivery channel limit for SLS is 1 MB. The delivery channel limit for MNS is 64 KB.
    * 
    * @example
    * acs:oss:cn-shanghai:100931896542****:new-bucket