@propulsionworks/cloudformation 0.1.13 → 0.1.14

package/out/exports/resources.generated/aws-securityhub-automationrulev2.d.ts

@@ -1,26 +1,26 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
 /**
- * Resource schema for AWS::SecurityHub::AutomationRuleV2
+ * Creates a V2 automation rule. This API is in private preview and subject to change.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-automationrulev2.html}
  */
 export type SecurityHubAutomationRuleV2 = ResourceDefinitionWithAttributes<"AWS::SecurityHub::AutomationRuleV2", SecurityHubAutomationRuleV2Props, SecurityHubAutomationRuleV2Attribs>;
 /**
- * Resource schema for AWS::SecurityHub::AutomationRuleV2
+ * Creates a V2 automation rule. This API is in private preview and subject to change.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-automationrulev2.html}
  */
 export type SecurityHubAutomationRuleV2Props = {
     /**
-     * A list of actions to be performed when the rule criteria is met
+     * A list of actions to be performed when the rule criteria is met.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-automationrulev2.html#cfn-securityhub-automationrulev2-actions}
      */
     Actions: AutomationRulesActionV2[];
     /**
-     * Defines the parameters and conditions used to evaluate and filter security findings
+     * The filtering type and configuration of the automation rule.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-automationrulev2.html#cfn-securityhub-automationrulev2-criteria}
      */
     Criteria: Criteria;
     /**
-     * A description of the automation rule
+     * A description of the V2 automation rule.
      * @minLength 1
      * @maxLength 256
      * @pattern .*\S.*
@@ -28,7 +28,7 @@ export type SecurityHubAutomationRuleV2Props = {
      */
     Description: string;
     /**
-     * The name of the automation rule
+     * The name of the V2 automation rule.
      * @minLength 1
      * @maxLength 256
      * @pattern .*\S.*
@@ -36,19 +36,19 @@ export type SecurityHubAutomationRuleV2Props = {
      */
     RuleName: string;
     /**
-     * The value for the rule priority
+     * The value for the rule priority.
      * @min 1
      * @max 1000
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-automationrulev2.html#cfn-securityhub-automationrulev2-ruleorder}
      */
     RuleOrder: number;
     /**
-     * The status of the automation rule
+     * The status of the V2 automation rule.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-automationrulev2.html#cfn-securityhub-automationrulev2-rulestatus}
      */
     RuleStatus?: "ENABLED" | "DISABLED" | undefined;
     /**
-     * A key-value pair to associate with a resource.
+     * A list of key-value pairs associated with the V2 automation rule.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-automationrulev2.html#cfn-securityhub-automationrulev2-tags}
      */
     Tags?: Record<string, string> | undefined;
@@ -58,24 +58,24 @@ export type SecurityHubAutomationRuleV2Props = {
  */
 export type SecurityHubAutomationRuleV2Attribs = {
     /**
-     * The timestamp formatted in ISO8601
+     * The timestamp when the V2 automation rule was created.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-automationrulev2.html#cfn-securityhub-automationrulev2-createdat}
      */
     CreatedAt: string;
     /**
-     * The ARN of the automation rule
+     * The ARN of the V2 automation rule.
      * @pattern ^arn:aws\S*:securityhub:[a-z0-9-]+:[0-9]{12}:automation-rulev2/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-automationrulev2.html#cfn-securityhub-automationrulev2-rulearn}
      */
     RuleArn: string;
     /**
-     * The ID of the automation rule
+     * The ID of the V2 automation rule.
      * @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-automationrulev2.html#cfn-securityhub-automationrulev2-ruleid}
      */
     RuleId: string;
     /**
-     * The timestamp formatted in ISO8601
+     * The timestamp when the V2 automation rule was updated.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-automationrulev2.html#cfn-securityhub-automationrulev2-updatedat}
      */
     UpdatedAt: string;
@@ -86,174 +86,198 @@ export type SecurityHubAutomationRuleV2Attribs = {
  */
 export type AllowedOperators = "AND" | "OR";
 /**
- * Allows you to configure automated responses
+ * Allows you to configure automated responses.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-automationrulesactionv2.html}
  */
 export type AutomationRulesActionV2 = {
     /**
-     * The settings for integrating automation rule actions with external systems or service
+     * The settings for integrating automation rule actions with external systems or service.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-automationrulesactionv2.html#cfn-securityhub-automationrulev2-automationrulesactionv2-externalintegrationconfiguration}
      */
     ExternalIntegrationConfiguration?: ExternalIntegrationConfiguration | undefined;
     /**
-     * The changes to be applied to fields in a security finding when an automation rule is triggered
+     * Specifies that the automation rule action is an update to a finding field.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-automationrulesactionv2.html#cfn-securityhub-automationrulev2-automationrulesactionv2-findingfieldsupdate}
      */
     FindingFieldsUpdate?: AutomationRulesFindingFieldsUpdateV2 | undefined;
     /**
-     * The category of action to be executed by the automation rule
+     * Specifies the type of action that Security Hub takes when a finding matches the defined criteria of a rule.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-automationrulesactionv2.html#cfn-securityhub-automationrulev2-automationrulesactionv2-type}
      */
     Type: "FINDING_FIELDS_UPDATE" | "EXTERNAL_INTEGRATION";
 };
 /**
- * The changes to be applied to fields in a security finding when an automation rule is triggered
+ * Allows you to define the structure for modifying specific fields in security findings.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-automationrulesfindingfieldsupdatev2.html}
  */
 export type AutomationRulesFindingFieldsUpdateV2 = {
     /**
-     * Notes or contextual information for findings that are modified by the automation rule
+     * Notes or contextual information for findings that are modified by the automation rule.
      * @pattern .*\S.*
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-automationrulesfindingfieldsupdatev2.html#cfn-securityhub-automationrulev2-automationrulesfindingfieldsupdatev2-comment}
      */
     Comment?: string | undefined;
     /**
-     * The severity level to be assigned to findings that match the automation rule criteria
+     * The severity level to be assigned to findings that match the automation rule criteria.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-automationrulesfindingfieldsupdatev2.html#cfn-securityhub-automationrulev2-automationrulesfindingfieldsupdatev2-severityid}
      */
     SeverityId?: number | undefined;
     /**
-     * The status to be applied to findings that match automation rule criteria
+     * The status to be applied to findings that match automation rule criteria.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-automationrulesfindingfieldsupdatev2.html#cfn-securityhub-automationrulev2-automationrulesfindingfieldsupdatev2-statusid}
      */
     StatusId?: number | undefined;
 };
 /**
- * Boolean filter for querying findings
+ * Boolean filter for querying findings.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-booleanfilter.html}
  */
 export type BooleanFilter = {
     /**
-     * The value of the boolean
+     * The value of the boolean.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-booleanfilter.html#cfn-securityhub-automationrulev2-booleanfilter-value}
      */
     Value: boolean;
 };
 /**
- * Enables the creation of filtering criteria for security findings
+ * Enables the creation of filtering criteria for security findings.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-compositefilter.html}
  */
 export type CompositeFilter = {
     /**
-     * Enables filtering based on boolean field values
+     * Enables filtering based on boolean field values.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-compositefilter.html#cfn-securityhub-automationrulev2-compositefilter-booleanfilters}
      */
     BooleanFilters?: OcsfBooleanFilter[] | undefined;
     /**
-     * Enables filtering based on date and timestamp fields
+     * Enables filtering based on date and timestamp fields.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-compositefilter.html#cfn-securityhub-automationrulev2-compositefilter-datefilters}
      */
     DateFilters?: OcsfDateFilter[] | undefined;
     /**
-     * Enables filtering based on map field value
+     * Enables the creation of filtering criteria for security findings.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-compositefilter.html#cfn-securityhub-automationrulev2-compositefilter-mapfilters}
      */
     MapFilters?: OcsfMapFilter[] | undefined;
     /**
-     * Enables filtering based on numerical field values
+     * Enables filtering based on numerical field values.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-compositefilter.html#cfn-securityhub-automationrulev2-compositefilter-numberfilters}
      */
     NumberFilters?: OcsfNumberFilter[] | undefined;
     /**
-     * The logical operator used to combine multiple conditions
+     * The logical operator used to combine multiple filter conditions.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-compositefilter.html#cfn-securityhub-automationrulev2-compositefilter-operator}
      */
     Operator?: AllowedOperators | undefined;
     /**
-     * Enables filtering based on string field values
+     * Enables filtering based on string field values.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-compositefilter.html#cfn-securityhub-automationrulev2-compositefilter-stringfilters}
      */
     StringFilters?: OcsfStringFilter[] | undefined;
 };
 /**
- * Defines the parameters and conditions used to evaluate and filter security findings
+ * The filtering type and configuration of the automation rule.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-criteria.html}
  */
 export type Criteria = {
     /**
-     * The filtering conditions that align with OCSF standards
+     * The filtering conditions that align with OCSF standards.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-criteria.html#cfn-securityhub-automationrulev2-criteria-ocsffindingcriteria}
      */
     OcsfFindingCriteria?: OcsfFindingFilters | undefined;
 };
 /**
- * A date filter for querying findings
+ * A date filter for querying findings.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-datefilter.html}
  */
 export type DateFilter = {
     /**
-     * A date range for the date filter
+     * A date range for the date filter.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-datefilter.html#cfn-securityhub-automationrulev2-datefilter-daterange}
      */
     DateRange?: DateRange | undefined;
     /**
-     * The timestamp formatted in ISO8601
+     * A timestamp that provides the end date for the date filter.
+     *
+     * For more information about the validation and formatting of timestamp fields in AWS Security Hub , see [Timestamps](https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps) .
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-datefilter.html#cfn-securityhub-automationrulev2-datefilter-end}
      */
     End?: string | undefined;
     /**
-     * The timestamp formatted in ISO8601
+     * A timestamp that provides the start date for the date filter.
+     *
+     * For more information about the validation and formatting of timestamp fields in AWS Security Hub , see [Timestamps](https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps) .
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-datefilter.html#cfn-securityhub-automationrulev2-datefilter-start}
      */
     Start?: string | undefined;
 };
 /**
- * A date range for the date filter
+ * A date range for the date filter.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-daterange.html}
  */
 export type DateRange = {
     /**
-     * A date range unit for the date filter
+     * A date range unit for the date filter.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-daterange.html#cfn-securityhub-automationrulev2-daterange-unit}
      */
     Unit: "DAYS";
     /**
-     * A date range value for the date filter
+     * A date range value for the date filter.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-daterange.html#cfn-securityhub-automationrulev2-daterange-value}
      */
     Value: number;
 };
 /**
- * The settings for integrating automation rule actions with external systems or service
+ * The settings for integrating automation rule actions with external systems or service.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-externalintegrationconfiguration.html}
  */
 export type ExternalIntegrationConfiguration = {
     /**
-     * The ARN of the connector that establishes the integration
+     * The ARN of the connector that establishes the integration.
      * @pattern .*\S.*
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-externalintegrationconfiguration.html#cfn-securityhub-automationrulev2-externalintegrationconfiguration-connectorarn}
      */
     ConnectorArn?: string | undefined;
 };
 /**
- * A map filter for filtering findings
+ * A map filter for filtering AWS Security Hub findings. Each map filter provides the field to check for, the value to check for, and the comparison operator.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-mapfilter.html}
  */
 export type MapFilter = {
     /**
-     * The condition to apply to the key value when filtering findings with a map filter
+     * The condition to apply to the key value when filtering Security Hub findings with a map filter.
+     *
+     * To search for values that have the filter value, use one of the following comparison operators:
+     *
+     * - To search for values that include the filter value, use `CONTAINS` . For example, for the `ResourceTags` field, the filter `Department CONTAINS Security` matches findings that include the value `Security` for the `Department` tag. In the same example, a finding with a value of `Security team` for the `Department` tag is a match.
+     * - To search for values that exactly match the filter value, use `EQUALS` . For example, for the `ResourceTags` field, the filter `Department EQUALS Security` matches findings that have the value `Security` for the `Department` tag.
+     *
+     * `CONTAINS` and `EQUALS` filters on the same field are joined by `OR` . A finding matches if it matches any one of those filters. For example, the filters `Department CONTAINS Security OR Department CONTAINS Finance` match a finding that includes either `Security` , `Finance` , or both values.
+     *
+     * To search for values that don't have the filter value, use one of the following comparison operators:
+     *
+     * - To search for values that exclude the filter value, use `NOT_CONTAINS` . For example, for the `ResourceTags` field, the filter `Department NOT_CONTAINS Finance` matches findings that exclude the value `Finance` for the `Department` tag.
+     * - To search for values other than the filter value, use `NOT_EQUALS` . For example, for the `ResourceTags` field, the filter `Department NOT_EQUALS Finance` matches findings that don’t have the value `Finance` for the `Department` tag.
+     *
+     * `NOT_CONTAINS` and `NOT_EQUALS` filters on the same field are joined by `AND` . A finding matches only if it matches all of those filters. For example, the filters `Department NOT_CONTAINS Security AND Department NOT_CONTAINS Finance` match a finding that excludes both the `Security` and `Finance` values.
+     *
+     * `CONTAINS` filters can only be used with other `CONTAINS` filters. `NOT_CONTAINS` filters can only be used with other `NOT_CONTAINS` filters.
+     *
+     * You can’t have both a `CONTAINS` filter and a `NOT_CONTAINS` filter on the same field. Similarly, you can’t have both an `EQUALS` filter and a `NOT_EQUALS` filter on the same field. Combining filters in this way returns an error.
+     *
+     * `CONTAINS` and `NOT_CONTAINS` operators can be used only with automation rules. For more information, see [Automation rules](https://docs.aws.amazon.com/securityhub/latest/userguide/automation-rules.html) in the *AWS Security Hub User Guide* .
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-mapfilter.html#cfn-securityhub-automationrulev2-mapfilter-comparison}
      */
     Comparison: "EQUALS" | "NOT_EQUALS";
     /**
-     * The key of the map filter
+     * The key of the map filter. For example, for `ResourceTags` , `Key` identifies the name of the tag. For `UserDefinedFields` , `Key` is the name of the field.
      * @minLength 1
      * @maxLength 4096
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-mapfilter.html#cfn-securityhub-automationrulev2-mapfilter-key}
      */
     Key: string;
     /**
-     * The value for the key in the map filter
+     * The value for the key in the map filter. Filter values are case sensitive. For example, one of the values for a tag called `Department` might be `Security` . If you provide `security` as the filter value, then there's no match.
      * @minLength 1
      * @maxLength 4096
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-mapfilter.html#cfn-securityhub-automationrulev2-mapfilter-value}
@@ -261,102 +285,102 @@ export type MapFilter = {
     Value: string;
 };
 /**
- * A number filter for querying findings
+ * A number filter for querying findings.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-numberfilter.html}
  */
 export type NumberFilter = {
     /**
-     * The equal-to condition to be applied to a single field when querying for findings
+     * The equal-to condition to be applied to a single field when querying for findings.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-numberfilter.html#cfn-securityhub-automationrulev2-numberfilter-eq}
      */
     Eq?: number | undefined;
     /**
-     * The greater-than-equal condition to be applied to a single field when querying for findings
+     * The greater-than-equal condition to be applied to a single field when querying for findings.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-numberfilter.html#cfn-securityhub-automationrulev2-numberfilter-gte}
      */
     Gte?: number | undefined;
     /**
-     * The less-than-equal condition to be applied to a single field when querying for findings
+     * The less-than-equal condition to be applied to a single field when querying for findings.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-numberfilter.html#cfn-securityhub-automationrulev2-numberfilter-lte}
      */
     Lte?: number | undefined;
 };
 /**
- * Enables filtering of security findings based on boolean field values in OCSF
+ * Enables filtering of security findings based on boolean field values in OCSF.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-ocsfbooleanfilter.html}
  */
 export type OcsfBooleanFilter = {
     /**
-     * The name of the field
+     * The name of the field.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-ocsfbooleanfilter.html#cfn-securityhub-automationrulev2-ocsfbooleanfilter-fieldname}
      */
     FieldName: "compliance.assessments.meets_criteria" | "vulnerabilities.is_exploit_available" | "vulnerabilities.is_fix_available";
     /**
-     * Boolean filter for querying findings
+     * Enables filtering of security findings based on boolean field values in OCSF.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-ocsfbooleanfilter.html#cfn-securityhub-automationrulev2-ocsfbooleanfilter-filter}
      */
     Filter: BooleanFilter;
 };
 /**
- * Enables filtering of security findings based on date and timestamp fields in OCSF
+ * Enables filtering of security findings based on date and timestamp fields in OCSF.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-ocsfdatefilter.html}
  */
 export type OcsfDateFilter = {
     /**
-     * The name of the field
+     * The name of the field.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-ocsfdatefilter.html#cfn-securityhub-automationrulev2-ocsfdatefilter-fieldname}
      */
     FieldName: "finding_info.created_time_dt" | "finding_info.first_seen_time_dt" | "finding_info.last_seen_time_dt" | "finding_info.modified_time_dt";
     /**
-     * A date filter for querying findings
+     * Enables filtering of security findings based on date and timestamp fields in OCSF.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-ocsfdatefilter.html#cfn-securityhub-automationrulev2-ocsfdatefilter-filter}
      */
     Filter: DateFilter;
 };
 /**
- * The filtering conditions that align with OCSF standards
+ * Specifies the filtering criteria for security findings using OCSF.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-ocsffindingfilters.html}
  */
 export type OcsfFindingFilters = {
     /**
-     * Enables the creation of complex filtering conditions by combining filter
+     * Enables the creation of complex filtering conditions by combining filter criteria.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-ocsffindingfilters.html#cfn-securityhub-automationrulev2-ocsffindingfilters-compositefilters}
      */
     CompositeFilters?: CompositeFilter[] | undefined;
     /**
-     * The logical operator used to combine multiple conditions
+     * The logical operators used to combine the filtering on multiple `CompositeFilters` .
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-ocsffindingfilters.html#cfn-securityhub-automationrulev2-ocsffindingfilters-compositeoperator}
      */
     CompositeOperator?: AllowedOperators | undefined;
 };
 /**
- * Enables filtering of security findings based on map field values in OCSF
+ * Enables filtering of security findings based on map field values in OCSF.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-ocsfmapfilter.html}
  */
 export type OcsfMapFilter = {
     /**
-     * The name of the field
+     * The name of the field.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-ocsfmapfilter.html#cfn-securityhub-automationrulev2-ocsfmapfilter-fieldname}
      */
     FieldName: "resources.tags";
     /**
-     * A map filter for filtering findings
+     * Enables filtering of security findings based on map field values in OCSF.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-ocsfmapfilter.html#cfn-securityhub-automationrulev2-ocsfmapfilter-filter}
      */
     Filter: MapFilter;
 };
 /**
- * Enables filtering of security findings based on numerical field values in OCSF
+ * Enables filtering of security findings based on numerical field values in OCSF.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-ocsfnumberfilter.html}
  */
 export type OcsfNumberFilter = {
     /**
-     * The name of the field
+     * The name of the field.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-ocsfnumberfilter.html#cfn-securityhub-automationrulev2-ocsfnumberfilter-fieldname}
      */
     FieldName: "activity_id" | "compliance.status_id" | "confidence_score" | "severity_id" | "status_id" | "finding_info.related_events_count";
     /**
-     * A number filter for querying findings
+     * Enables filtering of security findings based on numerical field values in OCSF.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-ocsfnumberfilter.html#cfn-securityhub-automationrulev2-ocsfnumberfilter-filter}
      */
     Filter: NumberFilter;
@@ -367,33 +391,62 @@ export type OcsfNumberFilter = {
  */
 export type OcsfStringField = "metadata.uid" | "activity_name" | "cloud.account.name" | "cloud.account.uid" | "cloud.provider" | "cloud.region" | "compliance.assessments.category" | "compliance.assessments.name" | "compliance.control" | "compliance.status" | "compliance.standards" | "finding_info.desc" | "finding_info.src_url" | "finding_info.title" | "finding_info.types" | "finding_info.uid" | "finding_info.related_events.uid" | "finding_info.related_events.product.uid" | "finding_info.related_events.title" | "metadata.product.feature.uid" | "metadata.product.name" | "metadata.product.uid" | "metadata.product.vendor_name" | "remediation.desc" | "remediation.references" | "resources.cloud_partition" | "resources.name" | "resources.region" | "resources.type" | "resources.uid" | "severity" | "status" | "comment" | "vulnerabilities.fix_coverage" | "class_name";
 /**
- * Enables filtering of security findings based on string field values in OCSF
+ * Enables filtering of security findings based on string field values in OCSF.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-ocsfstringfilter.html}
  */
 export type OcsfStringFilter = {
     /**
-     * The name of the field
+     * The name of the field.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-ocsfstringfilter.html#cfn-securityhub-automationrulev2-ocsfstringfilter-fieldname}
      */
     FieldName: OcsfStringField;
     /**
-     * A string filter for filtering findings
+     * Enables filtering of security findings based on string field values in OCSF.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-ocsfstringfilter.html#cfn-securityhub-automationrulev2-ocsfstringfilter-filter}
      */
     Filter: StringFilter;
 };
 /**
- * A string filter for filtering findings
+ * A string filter for filtering AWS Security Hub findings.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-stringfilter.html}
  */
 export type StringFilter = {
     /**
-     * The condition to apply to a string value when filtering findings
+     * The condition to apply to a string value when filtering Security Hub findings.
+     *
+     * To search for values that have the filter value, use one of the following comparison operators:
+     *
+     * - To search for values that include the filter value, use `CONTAINS` . For example, the filter `Title CONTAINS CloudFront` matches findings that have a `Title` that includes the string CloudFront.
+     * - To search for values that exactly match the filter value, use `EQUALS` . For example, the filter `AwsAccountId EQUALS 123456789012` only matches findings that have an account ID of `123456789012` .
+     * - To search for values that start with the filter value, use `PREFIX` . For example, the filter `ResourceRegion PREFIX us` matches findings that have a `ResourceRegion` that starts with `us` . A `ResourceRegion` that starts with a different value, such as `af` , `ap` , or `ca` , doesn't match.
+     *
+     * `CONTAINS` , `EQUALS` , and `PREFIX` filters on the same field are joined by `OR` . A finding matches if it matches any one of those filters. For example, the filters `Title CONTAINS CloudFront OR Title CONTAINS CloudWatch` match a finding that includes either `CloudFront` , `CloudWatch` , or both strings in the title.
+     *
+     * To search for values that don’t have the filter value, use one of the following comparison operators:
+     *
+     * - To search for values that exclude the filter value, use `NOT_CONTAINS` . For example, the filter `Title NOT_CONTAINS CloudFront` matches findings that have a `Title` that excludes the string CloudFront.
+     * - To search for values other than the filter value, use `NOT_EQUALS` . For example, the filter `AwsAccountId NOT_EQUALS 123456789012` only matches findings that have an account ID other than `123456789012` .
+     * - To search for values that don't start with the filter value, use `PREFIX_NOT_EQUALS` . For example, the filter `ResourceRegion PREFIX_NOT_EQUALS us` matches findings with a `ResourceRegion` that starts with a value other than `us` .
+     *
+     * `NOT_CONTAINS` , `NOT_EQUALS` , and `PREFIX_NOT_EQUALS` filters on the same field are joined by `AND` . A finding matches only if it matches all of those filters. For example, the filters `Title NOT_CONTAINS CloudFront AND Title NOT_CONTAINS CloudWatch` match a finding that excludes both `CloudFront` and `CloudWatch` in the title.
+     *
+     * You can’t have both a `CONTAINS` filter and a `NOT_CONTAINS` filter on the same field. Similarly, you can't provide both an `EQUALS` filter and a `NOT_EQUALS` or `PREFIX_NOT_EQUALS` filter on the same field. Combining filters in this way returns an error. `CONTAINS` filters can only be used with other `CONTAINS` filters. `NOT_CONTAINS` filters can only be used with other `NOT_CONTAINS` filters.
+     *
+     * You can combine `PREFIX` filters with `NOT_EQUALS` or `PREFIX_NOT_EQUALS` filters for the same field. Security Hub first processes the `PREFIX` filters, and then the `NOT_EQUALS` or `PREFIX_NOT_EQUALS` filters.
+     *
+     * For example, for the following filters, Security Hub first identifies findings that have resource types that start with either `AwsIam` or `AwsEc2` . It then excludes findings that have a resource type of `AwsIamPolicy` and findings that have a resource type of `AwsEc2NetworkInterface` .
+     *
+     * - `ResourceType PREFIX AwsIam`
+     * - `ResourceType PREFIX AwsEc2`
+     * - `ResourceType NOT_EQUALS AwsIamPolicy`
+     * - `ResourceType NOT_EQUALS AwsEc2NetworkInterface`
+     *
+     * `CONTAINS` and `NOT_CONTAINS` operators can be used only with automation rules V1. `CONTAINS_WORD` operator is only supported in `GetFindingsV2` , `GetFindingStatisticsV2` , `GetResourcesV2` , and `GetResourceStatisticsV2` APIs. For more information, see [Automation rules](https://docs.aws.amazon.com/securityhub/latest/userguide/automation-rules.html) in the *AWS Security Hub User Guide* .
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-stringfilter.html#cfn-securityhub-automationrulev2-stringfilter-comparison}
      */
     Comparison: "EQUALS" | "PREFIX" | "NOT_EQUALS" | "PREFIX_NOT_EQUALS" | "CONTAINS";
     /**
-     * The string filter value
+     * The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is `Security Hub` . If you provide `security hub` as the filter value, there's no match.
      * @minLength 1
      * @maxLength 4096
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-stringfilter.html#cfn-securityhub-automationrulev2-stringfilter-value}

package/out/exports/resources.generated/aws-securityhub-hubv2.d.ts

@@ -1,13 +1,16 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
 /**
+ * Returns details about the service resource in your account. This API is in private preview and subject to change.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-hubv2.html}
  */
 export type SecurityHubHubV2 = ResourceDefinitionWithAttributes<"AWS::SecurityHub::HubV2", SecurityHubHubV2Props, SecurityHubHubV2Attribs>;
 /**
+ * Returns details about the service resource in your account. This API is in private preview and subject to change.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-hubv2.html}
  */
 export type SecurityHubHubV2Props = {
     /**
+     * The tags to add to the hub V2 resource when you enable Security Hub.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-hubv2.html#cfn-securityhub-hubv2-tags}
      */
     Tags?: Record<string, string> | undefined;
@@ -17,12 +20,13 @@ export type SecurityHubHubV2Props = {
  */
 export type SecurityHubHubV2Attribs = {
     /**
-     * The Amazon Resource Name of the Security Hub V2 resource.
+     * The ARN of the service resource.
      * @pattern arn:aws(?:-[a-z]+)*:securityhub:[a-z0-9-]+:\d{12}:hubv2/[^/](.{0,1022}[^/:])?$
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-hubv2.html#cfn-securityhub-hubv2-hubv2arn}
      */
     HubV2Arn: string;
     /**
+     * The date and time when the service was enabled in the account.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-hubv2.html#cfn-securityhub-hubv2-subscribedat}
      */
     SubscribedAt: string;

package/out/exports/resources.generated/aws-synthetics-canary.d.ts

@@ -278,7 +278,7 @@ export type RunConfig = {
      */
     EnvironmentVariables?: Record<string, string> | undefined;
     /**
-     * Provide ephemeralStorage available for canary in MB
+     * Specifies the amount of ephemeral storage (in MB) to allocate for the canary run during execution. This temporary storage is used for storing canary run artifacts (which are uploaded to an Amazon S3 bucket at the end of the run), and any canary browser operations. This temporary storage is cleared after the run is completed. Default storage value is 1024 MB.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-runconfig.html#cfn-synthetics-canary-runconfig-ephemeralstorage}
      */
     EphemeralStorage?: number | undefined;