@propulsionworks/cloudformation 0.1.0 → 0.1.2

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

@@ -1,165 +1,205 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * The `AWS::SecurityHub::AutomationRule` resource specifies an automation rule based on input parameters. 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-resource-securityhub-automationrule.html}
+ */
 export type SecurityHubAutomationRule = ResourceDefinitionWithAttributes<"AWS::SecurityHub::AutomationRule", SecurityHubAutomationRuleProps, SecurityHubAutomationRuleAttribs>;
 /**
  * The `AWS::SecurityHub::AutomationRule` resource specifies an automation rule based on input parameters. 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-resource-securityhub-automationrule.html}
  */
 export type SecurityHubAutomationRuleProps = {
     /**
      * One or more actions to update finding fields if a finding matches the conditions specified in `Criteria` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-automationrule.html#cfn-securityhub-automationrule-actions}
      */
     Actions: AutomationRulesAction[];
     /**
      * A set of [AWS Security Finding Format (ASFF)](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html) finding field attributes and corresponding expected values that Security Hub uses to filter findings. If a rule is enabled and a finding matches the criteria specified in this parameter, Security Hub applies the rule action to the finding.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-automationrule.html#cfn-securityhub-automationrule-criteria}
      */
     Criteria: AutomationRulesFindingFilters;
     /**
      * A description of the rule.
      * @minLength 1
      * @maxLength 1024
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-automationrule.html#cfn-securityhub-automationrule-description}
      */
     Description: string;
     /**
      * Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If a rule is terminal, Security Hub applies the rule action to a finding that matches the rule criteria and doesn't evaluate other rules for the finding. By default, a rule isn't terminal.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-automationrule.html#cfn-securityhub-automationrule-isterminal}
      */
     IsTerminal?: boolean | undefined;
     /**
      * The name of the rule.
      * @minLength 1
      * @maxLength 256
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-automationrule.html#cfn-securityhub-automationrule-rulename}
      */
     RuleName: string;
     /**
      * An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings. Security Hub applies rules with lower values for this parameter first.
      * @min 1
      * @max 1000
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-automationrule.html#cfn-securityhub-automationrule-ruleorder}
      */
     RuleOrder: number;
     /**
      * Whether the rule is active after it is created. If this parameter is equal to `ENABLED` , Security Hub applies the rule to findings and finding updates after the rule is created.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-automationrule.html#cfn-securityhub-automationrule-rulestatus}
      */
     RuleStatus?: "ENABLED" | "DISABLED" | undefined;
     /**
      * User-defined tags associated with an automation rule.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-automationrule.html#cfn-securityhub-automationrule-tags}
      */
     Tags?: Record<string, string> | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-automationrule.html#aws-resource-securityhub-automationrule-return-values}
+ */
 export type SecurityHubAutomationRuleAttribs = {
     /**
      * A timestamp that indicates when the rule was created.
      *
      * Uses the `date-time` format specified in [RFC 3339 section 5.6, Internet Date/Time Format](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc3339#section-5.6) . The value cannot contain spaces. For example, `2020-03-22T13:22:13.933Z` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-automationrule.html#cfn-securityhub-automationrule-createdat}
      */
     CreatedAt: string;
     /**
      * The principal that created the rule. For example, `arn:aws:sts::123456789012:assumed-role/Developer-Role/JaneDoe` .
      * @minLength 1
      * @maxLength 256
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-automationrule.html#cfn-securityhub-automationrule-createdby}
      */
     CreatedBy: string;
     /**
      * The Amazon Resource Name (ARN) of the automation rule that you create. For example, `arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111` .
      * @pattern arn:aws\S*:securityhub:\S*
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-automationrule.html#cfn-securityhub-automationrule-rulearn}
      */
     RuleArn: string;
     /**
      * A timestamp that indicates when the rule was most recently updated.
      *
      * Uses the `date-time` format specified in [RFC 3339 section 5.6, Internet Date/Time Format](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc3339#section-5.6) . The value cannot contain spaces. For example, `2020-03-22T13:22:13.933Z` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-automationrule.html#cfn-securityhub-automationrule-updatedat}
      */
     UpdatedAt: string;
 };
 /**
  * One or more actions that AWS 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-automationrule-automationrulesaction.html}
  */
 export type AutomationRulesAction = {
     /**
      * 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-automationrule-automationrulesaction.html#cfn-securityhub-automationrule-automationrulesaction-findingfieldsupdate}
      */
     FindingFieldsUpdate: AutomationRulesFindingFieldsUpdate;
     /**
      * 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-automationrule-automationrulesaction.html#cfn-securityhub-automationrule-automationrulesaction-type}
      */
     Type: "FINDING_FIELDS_UPDATE";
 };
 /**
  * Identifies the finding fields that the automation rule action updates when a finding matches the defined criteria.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfieldsupdate.html}
  */
 export type AutomationRulesFindingFieldsUpdate = {
     /**
      * The rule action updates the `Confidence` field of a finding.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfieldsupdate.html#cfn-securityhub-automationrule-automationrulesfindingfieldsupdate-confidence}
      */
     Confidence?: number | undefined;
     /**
      * The rule action updates the `Criticality` field of a finding.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfieldsupdate.html#cfn-securityhub-automationrule-automationrulesfindingfieldsupdate-criticality}
      */
     Criticality?: number | undefined;
     /**
      * The rule action will update the `Note` field of a finding.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfieldsupdate.html#cfn-securityhub-automationrule-automationrulesfindingfieldsupdate-note}
      */
     Note?: NoteUpdate | undefined;
     /**
      * The rule action will update the `RelatedFindings` field of a finding.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfieldsupdate.html#cfn-securityhub-automationrule-automationrulesfindingfieldsupdate-relatedfindings}
      */
     RelatedFindings?: RelatedFinding[] | undefined;
     /**
      * The rule action will update the `Severity` field of a finding.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfieldsupdate.html#cfn-securityhub-automationrule-automationrulesfindingfieldsupdate-severity}
      */
     Severity?: SeverityUpdate | undefined;
     /**
      * The rule action updates the `Types` field of a finding.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfieldsupdate.html#cfn-securityhub-automationrule-automationrulesfindingfieldsupdate-types}
      */
     Types?: string[] | undefined;
     /**
      * The rule action updates the `UserDefinedFields` field of a finding.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfieldsupdate.html#cfn-securityhub-automationrule-automationrulesfindingfieldsupdate-userdefinedfields}
      */
     UserDefinedFields?: Record<string, string> | undefined;
     /**
      * The rule action updates the `VerificationState` field of a finding.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfieldsupdate.html#cfn-securityhub-automationrule-automationrulesfindingfieldsupdate-verificationstate}
      */
     VerificationState?: "UNKNOWN" | "TRUE_POSITIVE" | "FALSE_POSITIVE" | "BENIGN_POSITIVE" | undefined;
     /**
      * The rule action will update the `Workflow` field of a finding.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfieldsupdate.html#cfn-securityhub-automationrule-automationrulesfindingfieldsupdate-workflow}
      */
     Workflow?: WorkflowUpdate | undefined;
 };
 /**
  * The criteria that determine which findings a rule applies to.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html}
  */
 export type AutomationRulesFindingFilters = {
     /**
      * The AWS account ID in which a finding was generated.
      *
      * Array Members: Minimum number of 1 item. Maximum number of 100 items.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-awsaccountid}
      */
     AwsAccountId?: StringFilter[] | undefined;
     /**
      * The name of the company for the product that generated the finding. For control-based findings, the company is AWS .
      *
      * Array Members: Minimum number of 1 item. Maximum number of 20 items.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-companyname}
      */
     CompanyName?: StringFilter[] | undefined;
     /**
      * The unique identifier of a standard in which a control is enabled. This field consists of the resource portion of the Amazon Resource Name (ARN) returned for a standard in the [DescribeStandards](https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html) API response.
      *
      * Array Members: Minimum number of 1 item. Maximum number of 20 items.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-complianceassociatedstandardsid}
      */
     ComplianceAssociatedStandardsId?: StringFilter[] | undefined;
     /**
      * The security control ID for which a finding was generated. Security control IDs are the same across standards.
      *
      * Array Members: Minimum number of 1 item. Maximum number of 20 items.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-compliancesecuritycontrolid}
      */
     ComplianceSecurityControlId?: StringFilter[] | undefined;
     /**
      * The result of a security check. This field is only used for findings generated from controls.
      *
      * Array Members: Minimum number of 1 item. Maximum number of 20 items.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-compliancestatus}
      */
     ComplianceStatus?: StringFilter[] | undefined;
     /**
      * The likelihood that a finding accurately identifies the behavior or issue that it was intended to identify. `Confidence` is scored on a 0–100 basis using a ratio scale. A value of `0` means 0 percent confidence, and a value of `100` means 100 percent confidence. For example, a data exfiltration detection based on a statistical deviation of network traffic has low confidence because an actual exfiltration hasn't been verified. For more information, see [Confidence](https://docs.aws.amazon.com/securityhub/latest/userguide/asff-top-level-attributes.html#asff-confidence) in the *AWS Security Hub User Guide* .
      *
      * Array Members: Minimum number of 1 item. Maximum number of 20 items.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-confidence}
      */
     Confidence?: NumberFilter[] | undefined;
     /**
@@ -168,18 +208,21 @@ export type AutomationRulesFindingFilters = {
      * 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) .
      *
      * Array Members: Minimum number of 1 item. Maximum number of 20 items.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-createdat}
      */
     CreatedAt?: DateFilter[] | undefined;
     /**
      * The level of importance that is assigned to the resources that are associated with a finding. `Criticality` is scored on a 0–100 basis, using a ratio scale that supports only full integers. A score of `0` means that the underlying resources have no criticality, and a score of `100` is reserved for the most critical resources. For more information, see [Criticality](https://docs.aws.amazon.com/securityhub/latest/userguide/asff-top-level-attributes.html#asff-criticality) in the *AWS Security Hub User Guide* .
      *
      * Array Members: Minimum number of 1 item. Maximum number of 20 items.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-criticality}
      */
     Criticality?: NumberFilter[] | undefined;
     /**
      * A finding's description.
      *
      * Array Members: Minimum number of 1 item. Maximum number of 20 items.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-description}
      */
     Description?: StringFilter[] | undefined;
     /**
@@ -188,18 +231,21 @@ export type AutomationRulesFindingFilters = {
      * 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) .
      *
      * Array Members: Minimum number of 1 item. Maximum number of 20 items.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-firstobservedat}
      */
     FirstObservedAt?: DateFilter[] | undefined;
     /**
      * The identifier for the solution-specific component that generated a finding.
      *
      * Array Members: Minimum number of 1 item. Maximum number of 100 items.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-generatorid}
      */
     GeneratorId?: StringFilter[] | undefined;
     /**
      * The product-specific identifier for a finding.
      *
      * Array Members: Minimum number of 1 item. Maximum number of 20 items.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-id}
      */
     Id?: StringFilter[] | undefined;
     /**
@@ -208,12 +254,14 @@ export type AutomationRulesFindingFilters = {
      * 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) .
      *
      * Array Members: Minimum number of 1 item. Maximum number of 20 items.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-lastobservedat}
      */
     LastObservedAt?: DateFilter[] | undefined;
     /**
      * The text of a user-defined note that's added to a finding.
      *
      * Array Members: Minimum number of 1 item. Maximum number of 20 items.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-notetext}
      */
     NoteText?: StringFilter[] | undefined;
     /**
@@ -222,102 +270,119 @@ export type AutomationRulesFindingFilters = {
      * 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) .
      *
      * Array Members: Minimum number of 1 item. Maximum number of 20 items.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-noteupdatedat}
      */
     NoteUpdatedAt?: DateFilter[] | undefined;
     /**
      * The principal that created a note.
      *
      * Array Members: Minimum number of 1 item. Maximum number of 20 items.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-noteupdatedby}
      */
     NoteUpdatedBy?: StringFilter[] | undefined;
     /**
      * The Amazon Resource Name (ARN) for a third-party product that generated a finding in Security Hub.
      *
      * Array Members: Minimum number of 1 item. Maximum number of 20 items.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-productarn}
      */
     ProductArn?: StringFilter[] | undefined;
     /**
      * Provides the name of the product that generated the finding. For control-based findings, the product name is Security Hub.
      *
      * Array Members: Minimum number of 1 item. Maximum number of 20 items.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-productname}
      */
     ProductName?: StringFilter[] | undefined;
     /**
      * Provides the current state of a finding.
      *
      * Array Members: Minimum number of 1 item. Maximum number of 20 items.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-recordstate}
      */
     RecordState?: StringFilter[] | undefined;
     /**
      * The product-generated identifier for a related finding.
      *
      * Array Members: Minimum number of 1 item. Maximum number of 20 items.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-relatedfindingsid}
      */
     RelatedFindingsId?: StringFilter[] | undefined;
     /**
      * The ARN for the product that generated a related finding.
      *
      * Array Members: Minimum number of 1 item. Maximum number of 20 items.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-relatedfindingsproductarn}
      */
     RelatedFindingsProductArn?: StringFilter[] | undefined;
     /**
      * Custom fields and values about the resource that a finding pertains to.
      *
      * Array Members: Minimum number of 1 item. Maximum number of 20 items.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-resourcedetailsother}
      */
     ResourceDetailsOther?: MapFilter[] | undefined;
     /**
      * The identifier for the given resource type. For AWS resources that are identified by Amazon Resource Names (ARNs), this is the ARN. For AWS resources that lack ARNs, this is the identifier as defined by the AWS service that created the resource. For non- AWS resources, this is a unique identifier that is associated with the resource.
      *
      * Array Members: Minimum number of 1 item. Maximum number of 100 items.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-resourceid}
      */
     ResourceId?: StringFilter[] | undefined;
     /**
      * The partition in which the resource that the finding pertains to is located. A partition is a group of AWS Regions . Each AWS account is scoped to one partition.
      *
      * Array Members: Minimum number of 1 item. Maximum number of 20 items.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-resourcepartition}
      */
     ResourcePartition?: StringFilter[] | undefined;
     /**
      * The AWS Region where the resource that a finding pertains to is located.
      *
      * Array Members: Minimum number of 1 item. Maximum number of 20 items.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-resourceregion}
      */
     ResourceRegion?: StringFilter[] | undefined;
     /**
      * A list of AWS tags associated with a resource at the time the finding was processed.
      *
      * Array Members: Minimum number of 1 item. Maximum number of 20 items.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-resourcetags}
      */
     ResourceTags?: MapFilter[] | undefined;
     /**
      * A finding's title.
      *
      * Array Members: Minimum number of 1 item. Maximum number of 100 items.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-resourcetype}
      */
     ResourceType?: StringFilter[] | undefined;
     /**
      * The severity value of the finding.
      *
      * Array Members: Minimum number of 1 item. Maximum number of 20 items.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-severitylabel}
      */
     SeverityLabel?: StringFilter[] | undefined;
     /**
      * Provides a URL that links to a page about the current finding in the finding product.
      *
      * Array Members: Minimum number of 1 item. Maximum number of 20 items.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-sourceurl}
      */
     SourceUrl?: StringFilter[] | undefined;
     /**
      * A finding's title.
      *
      * Array Members: Minimum number of 1 item. Maximum number of 100 items.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-title}
      */
     Title?: StringFilter[] | undefined;
     /**
      * One or more finding types in the format of namespace/category/classifier that classify a finding. For a list of namespaces, classifiers, and categories, see [Types taxonomy for ASFF](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format-type-taxonomy.html) in the *AWS Security Hub User Guide* .
      *
      * Array Members: Minimum number of 1 item. Maximum number of 20 items.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-type}
      */
     Type?: StringFilter[] | undefined;
     /**
@@ -326,80 +391,95 @@ export type AutomationRulesFindingFilters = {
      * 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) .
      *
      * Array Members: Minimum number of 1 item. Maximum number of 20 items.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-updatedat}
      */
     UpdatedAt?: DateFilter[] | undefined;
     /**
      * A list of user-defined name and value string pairs added to a finding.
      *
      * Array Members: Minimum number of 1 item. Maximum number of 20 items.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-userdefinedfields}
      */
     UserDefinedFields?: MapFilter[] | undefined;
     /**
      * Provides the veracity of a finding.
      *
      * Array Members: Minimum number of 1 item. Maximum number of 20 items.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-verificationstate}
      */
     VerificationState?: StringFilter[] | undefined;
     /**
      * Provides information about the status of the investigation into a finding.
      *
      * Array Members: Minimum number of 1 item. Maximum number of 20 items.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-workflowstatus}
      */
     WorkflowStatus?: StringFilter[] | undefined;
 };
 /**
  * A date filter for querying findings.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-datefilter.html}
  */
 export type DateFilter = {
     /**
      * A date range for the date filter.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-datefilter.html#cfn-securityhub-automationrule-datefilter-daterange}
      */
     DateRange: DateRange;
     /**
      * 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-automationrule-datefilter.html#cfn-securityhub-automationrule-datefilter-end}
      */
     End?: string | undefined;
     /**
      * 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-automationrule-datefilter.html#cfn-securityhub-automationrule-datefilter-start}
      */
     Start?: string | undefined;
 } | {
     /**
      * A date range for the date filter.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-datefilter.html#cfn-securityhub-automationrule-datefilter-daterange}
      */
     DateRange?: DateRange | undefined;
     /**
      * 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-automationrule-datefilter.html#cfn-securityhub-automationrule-datefilter-end}
      */
     End: string;
     /**
      * 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-automationrule-datefilter.html#cfn-securityhub-automationrule-datefilter-start}
      */
     Start: string;
 };
 /**
  * A date range for the date filter.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-daterange.html}
  */
 export type DateRange = {
     /**
      * A date range unit for the date filter.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-daterange.html#cfn-securityhub-automationrule-daterange-unit}
      */
     Unit: "DAYS";
     /**
      * A date range value for the date filter.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-daterange.html#cfn-securityhub-automationrule-daterange-value}
      */
     Value: number;
 };
 /**
  * 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-automationrule-mapfilter.html}
  */
 export type MapFilter = {
     /**
@@ -424,92 +504,112 @@ export type MapFilter = {
      * 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-automationrule-mapfilter.html#cfn-securityhub-automationrule-mapfilter-comparison}
      */
     Comparison: "EQUALS" | "NOT_EQUALS" | "CONTAINS" | "NOT_CONTAINS";
     /**
      * 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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-mapfilter.html#cfn-securityhub-automationrule-mapfilter-key}
      */
     Key: string;
     /**
      * 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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-mapfilter.html#cfn-securityhub-automationrule-mapfilter-value}
      */
     Value: string;
 };
 /**
  * The updated note.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-noteupdate.html}
  */
 export type NoteUpdate = {
     /**
      * The updated note text.
      * @minLength 1
      * @maxLength 512
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-noteupdate.html#cfn-securityhub-automationrule-noteupdate-text}
      */
     Text: string;
     /**
      * The principal that updated the note.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-noteupdate.html#cfn-securityhub-automationrule-noteupdate-updatedby}
      */
     UpdatedBy: arnOrId;
 };
 /**
  * A number filter for querying findings.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-numberfilter.html}
  */
 export type NumberFilter = {
     /**
      * 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-automationrule-numberfilter.html#cfn-securityhub-automationrule-numberfilter-eq}
      */
     Eq: number;
     /**
      * 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-automationrule-numberfilter.html#cfn-securityhub-automationrule-numberfilter-gte}
      */
     Gte?: number | undefined;
     /**
      * 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-automationrule-numberfilter.html#cfn-securityhub-automationrule-numberfilter-lte}
      */
     Lte?: number | undefined;
 } | {
     /**
      * 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-automationrule-numberfilter.html#cfn-securityhub-automationrule-numberfilter-eq}
      */
     Eq?: number | undefined;
     /**
      * 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-automationrule-numberfilter.html#cfn-securityhub-automationrule-numberfilter-gte}
      */
     Gte: number;
     /**
      * 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-automationrule-numberfilter.html#cfn-securityhub-automationrule-numberfilter-lte}
      */
     Lte?: number | undefined;
 } | {
     /**
      * 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-automationrule-numberfilter.html#cfn-securityhub-automationrule-numberfilter-eq}
      */
     Eq?: number | undefined;
     /**
      * 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-automationrule-numberfilter.html#cfn-securityhub-automationrule-numberfilter-gte}
      */
     Gte?: number | undefined;
     /**
      * 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-automationrule-numberfilter.html#cfn-securityhub-automationrule-numberfilter-lte}
      */
     Lte: number;
 };
 /**
  * Provides details about a list of findings that the current finding relates to.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-relatedfinding.html}
  */
 export type RelatedFinding = {
     /**
      * The product-generated identifier for a related finding.
      *
      * Array Members: Minimum number of 1 item. Maximum number of 20 items.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-relatedfinding.html#cfn-securityhub-automationrule-relatedfinding-id}
      */
     Id: arnOrId;
     /**
      * The Amazon Resource Name (ARN) for the product that generated a related finding.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-relatedfinding.html#cfn-securityhub-automationrule-relatedfinding-productarn}
      */
     ProductArn: string;
 };
 /**
  * Updates to the severity information for a finding.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-severityupdate.html}
  */
 export type SeverityUpdate = {
     /**
@@ -520,6 +620,7 @@ export type SeverityUpdate = {
      * - `MEDIUM` - The issue must be addressed but not urgently.
      * - `HIGH` - The issue must be addressed as a priority.
      * - `CRITICAL` - The issue must be remediated immediately to avoid it escalating.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-severityupdate.html#cfn-securityhub-automationrule-severityupdate-label}
      */
     Label?: "INFORMATIONAL" | "LOW" | "MEDIUM" | "HIGH" | "CRITICAL" | undefined;
     /**
@@ -532,15 +633,18 @@ export type SeverityUpdate = {
      * - 40–69 - `MEDIUM`
      * - 70–89 - `HIGH`
      * - 90–100 - `CRITICAL`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-severityupdate.html#cfn-securityhub-automationrule-severityupdate-normalized}
      */
     Normalized?: number | undefined;
     /**
      * The native severity as defined by the AWS service or integrated partner product that generated the finding.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-severityupdate.html#cfn-securityhub-automationrule-severityupdate-product}
      */
     Product?: number | undefined;
 };
 /**
  * A string filter for filtering AWS Security Hub findings.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-stringfilter.html}
  */
 export type StringFilter = {
     /**
@@ -574,19 +678,23 @@ export type StringFilter = {
      * - `ResourceType NOT_EQUALS AwsEc2NetworkInterface`
      *
      * `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-automationrule-stringfilter.html#cfn-securityhub-automationrule-stringfilter-comparison}
      */
     Comparison: StringFilterComparison;
     /**
      * 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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-stringfilter.html#cfn-securityhub-automationrule-stringfilter-value}
      */
     Value: string;
 };
 /**
  * The condition to apply to a string value when filtering Security Hub findings.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-stringfiltercomparison.html}
  */
 export type StringFilterComparison = "EQUALS" | "PREFIX" | "NOT_EQUALS" | "PREFIX_NOT_EQUALS" | "CONTAINS" | "NOT_CONTAINS";
 /**
  * Used to update information about the investigation into the finding.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-workflowupdate.html}
  */
 export type WorkflowUpdate = {
     /**
@@ -603,11 +711,13 @@ export type WorkflowUpdate = {
      * - `NOTIFIED` - Indicates that you notified the resource owner about the security issue. Used when the initial reviewer is not the resource owner, and needs intervention from the resource owner.
      * - `RESOLVED` - The finding was reviewed and remediated and is now considered resolved.
      * - `SUPPRESSED` - Indicates that you reviewed the finding and don't believe that any action is needed. The finding is no longer updated.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-workflowupdate.html#cfn-securityhub-automationrule-workflowupdate-status}
      */
     Status: "NEW" | "NOTIFIED" | "RESOLVED" | "SUPPRESSED";
 };
 /**
  * The Amazon Resource Name (ARN) or Id of the automation rule.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-arnorid.html}
  */
 export type arnOrId = string;
 //# sourceMappingURL=aws-securityhub-automationrule.d.ts.map