Skip to content
AWS for Query.Farm

aws.securityhub.get_findings

Example SQL Queries

SELECT * FROM
aws.securityhub.get_findings;

Description

Returns a list of findings that match the specified criteria.

If finding aggregation is enabled, then when you call GetFindings from the aggregation Region, the results include all of the matching findings from both the aggregation Region and the linked Regions.

Table Definition

Column NameColumn Data Type
filters Input Column

The finding attributes used to define a condition to filter the returned findings.

You can filter by up to 10 finding attributes. For each attribute, you can provide up to 20 filter values.

Note that in the available filter fields, WorkflowState is deprecated. To search for a finding based on its workflow status, use WorkflowStatus.

STRUCT(
    "product_arn" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "aws_account_id" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "id" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "generator_id" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "region" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "type" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "first_observed_at" STRUCT(
        "start" VARCHAR,
        "end" VARCHAR,
        "date_range" STRUCT(
            "value" BIGINT,
            "unit" VARCHAR
        )
    )[],
    "last_observed_at" STRUCT(
        "start" VARCHAR,
        "end" VARCHAR,
        "date_range" STRUCT(
            "value" BIGINT,
            "unit" VARCHAR
        )
    )[],
    "created_at" STRUCT(
        "start" VARCHAR,
        "end" VARCHAR,
        "date_range" STRUCT(
            "value" BIGINT,
            "unit" VARCHAR
        )
    )[],
    "updated_at" STRUCT(
        "start" VARCHAR,
        "end" VARCHAR,
        "date_range" STRUCT(
            "value" BIGINT,
            "unit" VARCHAR
        )
    )[],
    "severity_product" STRUCT(
        "gte" DOUBLE,
        "lte" DOUBLE,
        "eq" DOUBLE,
        "gt" DOUBLE,
        "lt" DOUBLE
    )[],
    "severity_normalized" STRUCT(
        "gte" DOUBLE,
        "lte" DOUBLE,
        "eq" DOUBLE,
        "gt" DOUBLE,
        "lt" DOUBLE
    )[],
    "severity_label" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "confidence" STRUCT(
        "gte" DOUBLE,
        "lte" DOUBLE,
        "eq" DOUBLE,
        "gt" DOUBLE,
        "lt" DOUBLE
    )[],
    "criticality" STRUCT(
        "gte" DOUBLE,
        "lte" DOUBLE,
        "eq" DOUBLE,
        "gt" DOUBLE,
        "lt" DOUBLE
    )[],
    "title" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "description" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "recommendation_text" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "source_url" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "product_fields" STRUCT(
        "key" VARCHAR,
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "product_name" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "company_name" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "user_defined_fields" STRUCT(
        "key" VARCHAR,
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "malware_name" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "malware_type" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "malware_path" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "malware_state" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "network_direction" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "network_protocol" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "network_source_ip_v4" STRUCT(
        "cidr" VARCHAR
    )[],
    "network_source_ip_v6" STRUCT(
        "cidr" VARCHAR
    )[],
    "network_source_port" STRUCT(
        "gte" DOUBLE,
        "lte" DOUBLE,
        "eq" DOUBLE,
        "gt" DOUBLE,
        "lt" DOUBLE
    )[],
    "network_source_domain" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "network_source_mac" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "network_destination_ip_v4" STRUCT(
        "cidr" VARCHAR
    )[],
    "network_destination_ip_v6" STRUCT(
        "cidr" VARCHAR
    )[],
    "network_destination_port" STRUCT(
        "gte" DOUBLE,
        "lte" DOUBLE,
        "eq" DOUBLE,
        "gt" DOUBLE,
        "lt" DOUBLE
    )[],
    "network_destination_domain" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "process_name" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "process_path" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "process_pid" STRUCT(
        "gte" DOUBLE,
        "lte" DOUBLE,
        "eq" DOUBLE,
        "gt" DOUBLE,
        "lt" DOUBLE
    )[],
    "process_parent_pid" STRUCT(
        "gte" DOUBLE,
        "lte" DOUBLE,
        "eq" DOUBLE,
        "gt" DOUBLE,
        "lt" DOUBLE
    )[],
    "process_launched_at" STRUCT(
        "start" VARCHAR,
        "end" VARCHAR,
        "date_range" STRUCT(
            "value" BIGINT,
            "unit" VARCHAR
        )
    )[],
    "process_terminated_at" STRUCT(
        "start" VARCHAR,
        "end" VARCHAR,
        "date_range" STRUCT(
            "value" BIGINT,
            "unit" VARCHAR
        )
    )[],
    "threat_intel_indicator_type" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "threat_intel_indicator_value" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "threat_intel_indicator_category" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "threat_intel_indicator_last_observed_at" STRUCT(
        "start" VARCHAR,
        "end" VARCHAR,
        "date_range" STRUCT(
            "value" BIGINT,
            "unit" VARCHAR
        )
    )[],
    "threat_intel_indicator_source" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "threat_intel_indicator_source_url" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "resource_type" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "resource_id" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "resource_partition" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "resource_region" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "resource_tags" STRUCT(
        "key" VARCHAR,
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "resource_aws_ec2_instance_type" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "resource_aws_ec2_instance_image_id" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "resource_aws_ec2_instance_ip_v4_addresses" STRUCT(
        "cidr" VARCHAR
    )[],
    "resource_aws_ec2_instance_ip_v6_addresses" STRUCT(
        "cidr" VARCHAR
    )[],
    "resource_aws_ec2_instance_key_name" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "resource_aws_ec2_instance_iam_instance_profile_arn" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "resource_aws_ec2_instance_vpc_id" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "resource_aws_ec2_instance_subnet_id" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "resource_aws_ec2_instance_launched_at" STRUCT(
        "start" VARCHAR,
        "end" VARCHAR,
        "date_range" STRUCT(
            "value" BIGINT,
            "unit" VARCHAR
        )
    )[],
    "resource_aws_s3_bucket_owner_id" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "resource_aws_s3_bucket_owner_name" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "resource_aws_iam_access_key_user_name" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "resource_aws_iam_access_key_principal_name" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "resource_aws_iam_access_key_status" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "resource_aws_iam_access_key_created_at" STRUCT(
        "start" VARCHAR,
        "end" VARCHAR,
        "date_range" STRUCT(
            "value" BIGINT,
            "unit" VARCHAR
        )
    )[],
    "resource_aws_iam_user_user_name" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "resource_container_name" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "resource_container_image_id" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "resource_container_image_name" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "resource_container_launched_at" STRUCT(
        "start" VARCHAR,
        "end" VARCHAR,
        "date_range" STRUCT(
            "value" BIGINT,
            "unit" VARCHAR
        )
    )[],
    "resource_details_other" STRUCT(
        "key" VARCHAR,
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "compliance_status" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "verification_state" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "workflow_state" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "workflow_status" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "record_state" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "related_findings_product_arn" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "related_findings_id" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "note_text" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "note_updated_at" STRUCT(
        "start" VARCHAR,
        "end" VARCHAR,
        "date_range" STRUCT(
            "value" BIGINT,
            "unit" VARCHAR
        )
    )[],
    "note_updated_by" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "keyword" STRUCT(
        "value" VARCHAR
    )[],
    "finding_provider_fields_confidence" STRUCT(
        "gte" DOUBLE,
        "lte" DOUBLE,
        "eq" DOUBLE,
        "gt" DOUBLE,
        "lt" DOUBLE
    )[],
    "finding_provider_fields_criticality" STRUCT(
        "gte" DOUBLE,
        "lte" DOUBLE,
        "eq" DOUBLE,
        "gt" DOUBLE,
        "lt" DOUBLE
    )[],
    "finding_provider_fields_related_findings_id" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "finding_provider_fields_related_findings_product_arn" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "finding_provider_fields_severity_label" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "finding_provider_fields_severity_original" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "finding_provider_fields_types" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "sample" STRUCT(
        "value" BOOLEAN
    )[],
    "compliance_security_control_id" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "compliance_associated_standards_id" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "vulnerabilities_exploit_available" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "vulnerabilities_fix_available" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "compliance_security_control_parameters_name" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "compliance_security_control_parameters_value" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "aws_account_name" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "resource_application_name" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[],
    "resource_application_arn" STRUCT(
        "value" VARCHAR,
        "comparison" VARCHAR
    )[]
)
Show child fields
filters.aws_account_id[]
Show child fields
filters.aws_account_id[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.aws_account_id[].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.

filters.aws_account_name[]
Show child fields
filters.aws_account_name[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.aws_account_name[].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.

filters.company_name[]
Show child fields
filters.company_name[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.company_name[].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.

filters.compliance_associated_standards_id[]
Show child fields
filters.compliance_associated_standards_id[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.compliance_associated_standards_id[].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.

filters.compliance_security_control_id[]
Show child fields
filters.compliance_security_control_id[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.compliance_security_control_id[].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.

filters.compliance_security_control_parameters_name[]
Show child fields
filters.compliance_security_control_parameters_name[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.compliance_security_control_parameters_name[].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.

filters.compliance_security_control_parameters_value[]
Show child fields
filters.compliance_security_control_parameters_value[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.compliance_security_control_parameters_value[].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.

filters.compliance_status[]
Show child fields
filters.compliance_status[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.compliance_status[].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.

filters.confidence[]
Show child fields
filters.confidence[].eq

The equal-to condition to be applied to a single field when querying for findings.

filters.confidence[].gt

The greater-than condition to be applied to a single field when querying for findings.

filters.confidence[].gte

The greater-than-equal condition to be applied to a single field when querying for findings.

filters.confidence[].lt

The less-than condition to be applied to a single field when querying for findings.

filters.confidence[].lte

The less-than-equal condition to be applied to a single field when querying for findings.

filters.created_at[]
Show child fields
filters.created_at[].date_range

A date range for the date filter.

Show child fields
filters.created_at[].date_range.unit

A date range unit for the date filter.

filters.created_at[].date_range.value

A date range value for the date filter.

filters.created_at[].end

A timestamp that provides the end date for the date filter.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

filters.created_at[].start

A timestamp that provides the start date for the date filter.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

filters.criticality[]
Show child fields
filters.criticality[].eq

The equal-to condition to be applied to a single field when querying for findings.

filters.criticality[].gt

The greater-than condition to be applied to a single field when querying for findings.

filters.criticality[].gte

The greater-than-equal condition to be applied to a single field when querying for findings.

filters.criticality[].lt

The less-than condition to be applied to a single field when querying for findings.

filters.criticality[].lte

The less-than-equal condition to be applied to a single field when querying for findings.

filters.description[]
Show child fields
filters.description[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.description[].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.

filters.finding_provider_fields_confidence[]
Show child fields
filters.finding_provider_fields_confidence[].eq

The equal-to condition to be applied to a single field when querying for findings.

filters.finding_provider_fields_confidence[].gt

The greater-than condition to be applied to a single field when querying for findings.

filters.finding_provider_fields_confidence[].gte

The greater-than-equal condition to be applied to a single field when querying for findings.

filters.finding_provider_fields_confidence[].lt

The less-than condition to be applied to a single field when querying for findings.

filters.finding_provider_fields_confidence[].lte

The less-than-equal condition to be applied to a single field when querying for findings.

filters.finding_provider_fields_criticality[]
Show child fields
filters.finding_provider_fields_criticality[].eq

The equal-to condition to be applied to a single field when querying for findings.

filters.finding_provider_fields_criticality[].gt

The greater-than condition to be applied to a single field when querying for findings.

filters.finding_provider_fields_criticality[].gte

The greater-than-equal condition to be applied to a single field when querying for findings.

filters.finding_provider_fields_criticality[].lt

The less-than condition to be applied to a single field when querying for findings.

filters.finding_provider_fields_criticality[].lte

The less-than-equal condition to be applied to a single field when querying for findings.

filters.finding_provider_fields_related_findings_id[]
Show child fields
filters.finding_provider_fields_related_findings_id[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.finding_provider_fields_related_findings_id[].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.

filters.finding_provider_fields_related_findings_product_arn[]
Show child fields
filters.finding_provider_fields_related_findings_product_arn[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.finding_provider_fields_related_findings_product_arn[].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.

filters.finding_provider_fields_severity_label[]
Show child fields
filters.finding_provider_fields_severity_label[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.finding_provider_fields_severity_label[].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.

filters.finding_provider_fields_severity_original[]
Show child fields
filters.finding_provider_fields_severity_original[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.finding_provider_fields_severity_original[].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.

filters.finding_provider_fields_types[]
Show child fields
filters.finding_provider_fields_types[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.finding_provider_fields_types[].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.

filters.first_observed_at[]
Show child fields
filters.first_observed_at[].date_range

A date range for the date filter.

Show child fields
filters.first_observed_at[].date_range.unit

A date range unit for the date filter.

filters.first_observed_at[].date_range.value

A date range value for the date filter.

filters.first_observed_at[].end

A timestamp that provides the end date for the date filter.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

filters.first_observed_at[].start

A timestamp that provides the start date for the date filter.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

filters.generator_id[]
Show child fields
filters.generator_id[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.generator_id[].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.

filters.id[]
Show child fields
filters.id[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.id[].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.

filters.keyword[]
Show child fields
filters.keyword[].value

A value for the keyword.

filters.last_observed_at[]
Show child fields
filters.last_observed_at[].date_range

A date range for the date filter.

Show child fields
filters.last_observed_at[].date_range.unit

A date range unit for the date filter.

filters.last_observed_at[].date_range.value

A date range value for the date filter.

filters.last_observed_at[].end

A timestamp that provides the end date for the date filter.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

filters.last_observed_at[].start

A timestamp that provides the start date for the date filter.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

filters.malware_name[]
Show child fields
filters.malware_name[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.malware_name[].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.

filters.malware_path[]
Show child fields
filters.malware_path[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.malware_path[].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.

filters.malware_state[]
Show child fields
filters.malware_state[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.malware_state[].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.

filters.malware_type[]
Show child fields
filters.malware_type[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.malware_type[].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.

filters.network_destination_domain[]
Show child fields
filters.network_destination_domain[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.network_destination_domain[].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.

filters.network_destination_ip_v4[]
Show child fields
filters.network_destination_ip_v4[].cidr

A finding's CIDR value.

filters.network_destination_ip_v6[]
Show child fields
filters.network_destination_ip_v6[].cidr

A finding's CIDR value.

filters.network_destination_port[]
Show child fields
filters.network_destination_port[].eq

The equal-to condition to be applied to a single field when querying for findings.

filters.network_destination_port[].gt

The greater-than condition to be applied to a single field when querying for findings.

filters.network_destination_port[].gte

The greater-than-equal condition to be applied to a single field when querying for findings.

filters.network_destination_port[].lt

The less-than condition to be applied to a single field when querying for findings.

filters.network_destination_port[].lte

The less-than-equal condition to be applied to a single field when querying for findings.

filters.network_direction[]
Show child fields
filters.network_direction[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.network_direction[].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.

filters.network_protocol[]
Show child fields
filters.network_protocol[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.network_protocol[].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.

filters.network_source_domain[]
Show child fields
filters.network_source_domain[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.network_source_domain[].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.

filters.network_source_ip_v4[]
Show child fields
filters.network_source_ip_v4[].cidr

A finding's CIDR value.

filters.network_source_ip_v6[]
Show child fields
filters.network_source_ip_v6[].cidr

A finding's CIDR value.

filters.network_source_mac[]
Show child fields
filters.network_source_mac[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.network_source_mac[].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.

filters.network_source_port[]
Show child fields
filters.network_source_port[].eq

The equal-to condition to be applied to a single field when querying for findings.

filters.network_source_port[].gt

The greater-than condition to be applied to a single field when querying for findings.

filters.network_source_port[].gte

The greater-than-equal condition to be applied to a single field when querying for findings.

filters.network_source_port[].lt

The less-than condition to be applied to a single field when querying for findings.

filters.network_source_port[].lte

The less-than-equal condition to be applied to a single field when querying for findings.

filters.note_text[]
Show child fields
filters.note_text[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.note_text[].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.

filters.note_updated_at[]
Show child fields
filters.note_updated_at[].date_range

A date range for the date filter.

Show child fields
filters.note_updated_at[].date_range.unit

A date range unit for the date filter.

filters.note_updated_at[].date_range.value

A date range value for the date filter.

filters.note_updated_at[].end

A timestamp that provides the end date for the date filter.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

filters.note_updated_at[].start

A timestamp that provides the start date for the date filter.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

filters.note_updated_by[]
Show child fields
filters.note_updated_by[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.note_updated_by[].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.

filters.process_launched_at[]
Show child fields
filters.process_launched_at[].date_range

A date range for the date filter.

Show child fields
filters.process_launched_at[].date_range.unit

A date range unit for the date filter.

filters.process_launched_at[].date_range.value

A date range value for the date filter.

filters.process_launched_at[].end

A timestamp that provides the end date for the date filter.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

filters.process_launched_at[].start

A timestamp that provides the start date for the date filter.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

filters.process_name[]
Show child fields
filters.process_name[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.process_name[].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.

filters.process_parent_pid[]
Show child fields
filters.process_parent_pid[].eq

The equal-to condition to be applied to a single field when querying for findings.

filters.process_parent_pid[].gt

The greater-than condition to be applied to a single field when querying for findings.

filters.process_parent_pid[].gte

The greater-than-equal condition to be applied to a single field when querying for findings.

filters.process_parent_pid[].lt

The less-than condition to be applied to a single field when querying for findings.

filters.process_parent_pid[].lte

The less-than-equal condition to be applied to a single field when querying for findings.

filters.process_path[]
Show child fields
filters.process_path[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.process_path[].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.

filters.process_pid[]
Show child fields
filters.process_pid[].eq

The equal-to condition to be applied to a single field when querying for findings.

filters.process_pid[].gt

The greater-than condition to be applied to a single field when querying for findings.

filters.process_pid[].gte

The greater-than-equal condition to be applied to a single field when querying for findings.

filters.process_pid[].lt

The less-than condition to be applied to a single field when querying for findings.

filters.process_pid[].lte

The less-than-equal condition to be applied to a single field when querying for findings.

filters.process_terminated_at[]
Show child fields
filters.process_terminated_at[].date_range

A date range for the date filter.

Show child fields
filters.process_terminated_at[].date_range.unit

A date range unit for the date filter.

filters.process_terminated_at[].date_range.value

A date range value for the date filter.

filters.process_terminated_at[].end

A timestamp that provides the end date for the date filter.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

filters.process_terminated_at[].start

A timestamp that provides the start date for the date filter.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

filters.product_arn[]
Show child fields
filters.product_arn[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.product_arn[].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.

filters.product_fields[]
Show child fields
filters.product_fields[].comparison

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 in the Security Hub User Guide.

filters.product_fields[].key

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.

filters.product_fields[].value

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.

filters.product_name[]
Show child fields
filters.product_name[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.product_name[].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.

filters.recommendation_text[]
Show child fields
filters.recommendation_text[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.recommendation_text[].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.

filters.record_state[]
Show child fields
filters.record_state[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.record_state[].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.

filters.region[]
Show child fields
filters.region[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.region[].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.

filters.related_findings_id[]
Show child fields
filters.related_findings_id[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.related_findings_id[].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.

filters.related_findings_product_arn[]
Show child fields
filters.related_findings_product_arn[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.related_findings_product_arn[].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.

filters.resource_application_arn[]
Show child fields
filters.resource_application_arn[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.resource_application_arn[].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.

filters.resource_application_name[]
Show child fields
filters.resource_application_name[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.resource_application_name[].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.

filters.resource_aws_ec2_instance_iam_instance_profile_arn[]
Show child fields
filters.resource_aws_ec2_instance_iam_instance_profile_arn[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.resource_aws_ec2_instance_iam_instance_profile_arn[].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.

filters.resource_aws_ec2_instance_image_id[]
Show child fields
filters.resource_aws_ec2_instance_image_id[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.resource_aws_ec2_instance_image_id[].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.

filters.resource_aws_ec2_instance_ip_v4_addresses[]
Show child fields
filters.resource_aws_ec2_instance_ip_v4_addresses[].cidr

A finding's CIDR value.

filters.resource_aws_ec2_instance_ip_v6_addresses[]
Show child fields
filters.resource_aws_ec2_instance_ip_v6_addresses[].cidr

A finding's CIDR value.

filters.resource_aws_ec2_instance_key_name[]
Show child fields
filters.resource_aws_ec2_instance_key_name[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.resource_aws_ec2_instance_key_name[].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.

filters.resource_aws_ec2_instance_launched_at[]
Show child fields
filters.resource_aws_ec2_instance_launched_at[].date_range

A date range for the date filter.

Show child fields
filters.resource_aws_ec2_instance_launched_at[].date_range.unit

A date range unit for the date filter.

filters.resource_aws_ec2_instance_launched_at[].date_range.value

A date range value for the date filter.

filters.resource_aws_ec2_instance_launched_at[].end

A timestamp that provides the end date for the date filter.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

filters.resource_aws_ec2_instance_launched_at[].start

A timestamp that provides the start date for the date filter.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

filters.resource_aws_ec2_instance_subnet_id[]
Show child fields
filters.resource_aws_ec2_instance_subnet_id[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.resource_aws_ec2_instance_subnet_id[].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.

filters.resource_aws_ec2_instance_type[]
Show child fields
filters.resource_aws_ec2_instance_type[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.resource_aws_ec2_instance_type[].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.

filters.resource_aws_ec2_instance_vpc_id[]
Show child fields
filters.resource_aws_ec2_instance_vpc_id[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.resource_aws_ec2_instance_vpc_id[].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.

filters.resource_aws_iam_access_key_created_at[]
Show child fields
filters.resource_aws_iam_access_key_created_at[].date_range

A date range for the date filter.

Show child fields
filters.resource_aws_iam_access_key_created_at[].date_range.unit

A date range unit for the date filter.

filters.resource_aws_iam_access_key_created_at[].date_range.value

A date range value for the date filter.

filters.resource_aws_iam_access_key_created_at[].end

A timestamp that provides the end date for the date filter.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

filters.resource_aws_iam_access_key_created_at[].start

A timestamp that provides the start date for the date filter.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

filters.resource_aws_iam_access_key_principal_name[]
Show child fields
filters.resource_aws_iam_access_key_principal_name[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.resource_aws_iam_access_key_principal_name[].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.

filters.resource_aws_iam_access_key_status[]
Show child fields
filters.resource_aws_iam_access_key_status[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.resource_aws_iam_access_key_status[].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.

filters.resource_aws_iam_access_key_user_name[]
Show child fields
filters.resource_aws_iam_access_key_user_name[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.resource_aws_iam_access_key_user_name[].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.

filters.resource_aws_iam_user_user_name[]
Show child fields
filters.resource_aws_iam_user_user_name[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.resource_aws_iam_user_user_name[].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.

filters.resource_aws_s3_bucket_owner_id[]
Show child fields
filters.resource_aws_s3_bucket_owner_id[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.resource_aws_s3_bucket_owner_id[].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.

filters.resource_aws_s3_bucket_owner_name[]
Show child fields
filters.resource_aws_s3_bucket_owner_name[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.resource_aws_s3_bucket_owner_name[].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.

filters.resource_container_image_id[]
Show child fields
filters.resource_container_image_id[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.resource_container_image_id[].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.

filters.resource_container_image_name[]
Show child fields
filters.resource_container_image_name[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.resource_container_image_name[].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.

filters.resource_container_launched_at[]
Show child fields
filters.resource_container_launched_at[].date_range

A date range for the date filter.

Show child fields
filters.resource_container_launched_at[].date_range.unit

A date range unit for the date filter.

filters.resource_container_launched_at[].date_range.value

A date range value for the date filter.

filters.resource_container_launched_at[].end

A timestamp that provides the end date for the date filter.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

filters.resource_container_launched_at[].start

A timestamp that provides the start date for the date filter.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

filters.resource_container_name[]
Show child fields
filters.resource_container_name[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.resource_container_name[].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.

filters.resource_details_other[]
Show child fields
filters.resource_details_other[].comparison

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 in the Security Hub User Guide.

filters.resource_details_other[].key

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.

filters.resource_details_other[].value

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.

filters.resource_id[]
Show child fields
filters.resource_id[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.resource_id[].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.

filters.resource_partition[]
Show child fields
filters.resource_partition[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.resource_partition[].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.

filters.resource_region[]
Show child fields
filters.resource_region[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.resource_region[].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.

filters.resource_tags[]
Show child fields
filters.resource_tags[].comparison

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 in the Security Hub User Guide.

filters.resource_tags[].key

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.

filters.resource_tags[].value

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.

filters.resource_type[]
Show child fields
filters.resource_type[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.resource_type[].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.

filters.sample[]
Show child fields
filters.sample[].value

The value of the boolean.

filters.severity_label[]
Show child fields
filters.severity_label[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.severity_label[].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.

filters.severity_normalized[]
Show child fields
filters.severity_normalized[].eq

The equal-to condition to be applied to a single field when querying for findings.

filters.severity_normalized[].gt

The greater-than condition to be applied to a single field when querying for findings.

filters.severity_normalized[].gte

The greater-than-equal condition to be applied to a single field when querying for findings.

filters.severity_normalized[].lt

The less-than condition to be applied to a single field when querying for findings.

filters.severity_normalized[].lte

The less-than-equal condition to be applied to a single field when querying for findings.

filters.severity_product[]
Show child fields
filters.severity_product[].eq

The equal-to condition to be applied to a single field when querying for findings.

filters.severity_product[].gt

The greater-than condition to be applied to a single field when querying for findings.

filters.severity_product[].gte

The greater-than-equal condition to be applied to a single field when querying for findings.

filters.severity_product[].lt

The less-than condition to be applied to a single field when querying for findings.

filters.severity_product[].lte

The less-than-equal condition to be applied to a single field when querying for findings.

filters.source_url[]
Show child fields
filters.source_url[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.source_url[].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.

filters.threat_intel_indicator_category[]
Show child fields
filters.threat_intel_indicator_category[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.threat_intel_indicator_category[].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.

filters.threat_intel_indicator_last_observed_at[]
Show child fields
filters.threat_intel_indicator_last_observed_at[].date_range

A date range for the date filter.

Show child fields
filters.threat_intel_indicator_last_observed_at[].date_range.unit

A date range unit for the date filter.

filters.threat_intel_indicator_last_observed_at[].date_range.value

A date range value for the date filter.

filters.threat_intel_indicator_last_observed_at[].end

A timestamp that provides the end date for the date filter.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

filters.threat_intel_indicator_last_observed_at[].start

A timestamp that provides the start date for the date filter.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

filters.threat_intel_indicator_source[]
Show child fields
filters.threat_intel_indicator_source[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.threat_intel_indicator_source[].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.

filters.threat_intel_indicator_source_url[]
Show child fields
filters.threat_intel_indicator_source_url[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.threat_intel_indicator_source_url[].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.

filters.threat_intel_indicator_type[]
Show child fields
filters.threat_intel_indicator_type[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.threat_intel_indicator_type[].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.

filters.threat_intel_indicator_value[]
Show child fields
filters.threat_intel_indicator_value[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.threat_intel_indicator_value[].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.

filters.title[]
Show child fields
filters.title[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.title[].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.

filters.type[]
Show child fields
filters.type[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.type[].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.

filters.updated_at[]
Show child fields
filters.updated_at[].date_range

A date range for the date filter.

Show child fields
filters.updated_at[].date_range.unit

A date range unit for the date filter.

filters.updated_at[].date_range.value

A date range value for the date filter.

filters.updated_at[].end

A timestamp that provides the end date for the date filter.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

filters.updated_at[].start

A timestamp that provides the start date for the date filter.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

filters.user_defined_fields[]
Show child fields
filters.user_defined_fields[].comparison

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 in the Security Hub User Guide.

filters.user_defined_fields[].key

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.

filters.user_defined_fields[].value

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.

filters.verification_state[]
Show child fields
filters.verification_state[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.verification_state[].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.

filters.vulnerabilities_exploit_available[]
Show child fields
filters.vulnerabilities_exploit_available[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.vulnerabilities_exploit_available[].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.

filters.vulnerabilities_fix_available[]
Show child fields
filters.vulnerabilities_fix_available[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.vulnerabilities_fix_available[].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.

filters.workflow_state[]
Show child fields
filters.workflow_state[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.workflow_state[].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.

filters.workflow_status[]
Show child fields
filters.workflow_status[].comparison

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. For more information, see Automation rules in the Security Hub User Guide.

filters.workflow_status[].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.

sort_criteria Input Column

The finding attributes used to sort the list of returned findings.

STRUCT(
    "field" VARCHAR,
    "sort_order" VARCHAR
)[]
Show child fields
sort_criteria[]
Show child fields
sort_criteria[].field

The finding attribute used to sort findings.

sort_criteria[].sort_order

The order used to sort findings.

_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
action

Provides details about an action that affects or that was taken on a resource.

STRUCT(
    "action_type" VARCHAR,
    "network_connection_action" STRUCT(
        "connection_direction" VARCHAR,
        "remote_ip_details" STRUCT(
            "ip_address_v4" VARCHAR,
            "organization" STRUCT(
                "asn" BIGINT,
                "asn_org" VARCHAR,
                "isp" VARCHAR,
                "org" VARCHAR
            ),
            "country" STRUCT(
                "country_code" VARCHAR,
                "country_name" VARCHAR
            ),
            "city" STRUCT(
                "city_name" VARCHAR
            ),
            "geo_location" STRUCT(
                "lon" DOUBLE,
                "lat" DOUBLE
            )
        ),
        "remote_port_details" STRUCT(
            "port" BIGINT,
            "port_name" VARCHAR
        ),
        "local_port_details" STRUCT(
            "port" BIGINT,
            "port_name" VARCHAR
        ),
        "protocol" VARCHAR,
        "blocked" BOOLEAN
    ),
    "aws_api_call_action" STRUCT(
        "api" VARCHAR,
        "service_name" VARCHAR,
        "caller_type" VARCHAR,
        "remote_ip_details" STRUCT(
            "ip_address_v4" VARCHAR,
            "organization" STRUCT(
                "asn" BIGINT,
                "asn_org" VARCHAR,
                "isp" VARCHAR,
                "org" VARCHAR
            ),
            "country" STRUCT(
                "country_code" VARCHAR,
                "country_name" VARCHAR
            ),
            "city" STRUCT(
                "city_name" VARCHAR
            ),
            "geo_location" STRUCT(
                "lon" DOUBLE,
                "lat" DOUBLE
            )
        ),
        "domain_details" STRUCT(
            "domain" VARCHAR
        ),
        "affected_resources" MAP(VARCHAR, VARCHAR),
        "first_seen" VARCHAR,
        "last_seen" VARCHAR
    ),
    "dns_request_action" STRUCT(
        "domain" VARCHAR,
        "protocol" VARCHAR,
        "blocked" BOOLEAN
    ),
    "port_probe_action" STRUCT(
        "port_probe_details" STRUCT(
            "local_port_details" STRUCT(
                "port" BIGINT,
                "port_name" VARCHAR
            ),
            "local_ip_details" STRUCT(
                "ip_address_v4" VARCHAR
            ),
            "remote_ip_details" STRUCT(
                "ip_address_v4" VARCHAR,
                "organization" STRUCT(
                    "asn" BIGINT,
                    "asn_org" VARCHAR,
                    "isp" VARCHAR,
                    "org" VARCHAR
                ),
                "country" STRUCT(
                    "country_code" VARCHAR,
                    "country_name" VARCHAR
                ),
                "city" STRUCT(
                    "city_name" VARCHAR
                ),
                "geo_location" STRUCT(
                    "lon" DOUBLE,
                    "lat" DOUBLE
                )
            )
        )[],
        "blocked" BOOLEAN
    )
)
Show child fields
action.action_type

The type of action that was detected. The possible action types are:

  • NETWORK_CONNECTION

  • AWS_API_CALL

  • DNS_REQUEST

  • PORT_PROBE

action.aws_api_call_action

Included if ActionType is AWS_API_CALL. Provides details about the API call that was detected.

Show child fields
action.aws_api_call_action.affected_resources

Identifies the resources that were affected by the API call.

action.aws_api_call_action.api

The name of the API method that was issued.

Length Constraints: 128.

action.aws_api_call_action.caller_type

Indicates whether the API call originated from a remote IP address (remoteip) or from a DNS domain (domain).

action.aws_api_call_action.domain_details

Provided if CallerType is domain. Provides information about the DNS domain that the API call originated from.

Show child fields
action.aws_api_call_action.domain_details.domain

The name of the DNS domain that issued the API call.

Length Constraints: 128.

action.aws_api_call_action.first_seen

A timestamp that indicates when the API call was first observed.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

action.aws_api_call_action.last_seen

A timestamp that indicates when the API call was most recently observed.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

action.aws_api_call_action.remote_ip_details

Provided if CallerType is remoteIp. Provides information about the remote IP address that the API call originated from.

Show child fields
action.aws_api_call_action.remote_ip_details.city

The city where the remote IP address is located.

Show child fields
action.aws_api_call_action.remote_ip_details.city.city_name

The name of the city.

action.aws_api_call_action.remote_ip_details.country

The country where the remote IP address is located.

Show child fields
action.aws_api_call_action.remote_ip_details.country.country_code

The 2-letter ISO 3166 country code for the country.

action.aws_api_call_action.remote_ip_details.country.country_name

The name of the country.

action.aws_api_call_action.remote_ip_details.geo_location

The coordinates of the location of the remote IP address.

Show child fields
action.aws_api_call_action.remote_ip_details.geo_location.lat

The latitude of the location.

action.aws_api_call_action.remote_ip_details.geo_location.lon

The longitude of the location.

action.aws_api_call_action.remote_ip_details.ip_address_v4

The IP address.

action.aws_api_call_action.remote_ip_details.organization

The internet service provider (ISP) organization associated with the remote IP address.

Show child fields
action.aws_api_call_action.remote_ip_details.organization.asn

The Autonomous System Number (ASN) of the internet provider

action.aws_api_call_action.remote_ip_details.organization.asn_org

The name of the organization that registered the ASN.

action.aws_api_call_action.remote_ip_details.organization.isp

The ISP information for the internet provider.

action.aws_api_call_action.remote_ip_details.organization.org

The name of the internet provider.

action.aws_api_call_action.service_name

The name of the Amazon Web Services service that the API method belongs to.

Length Constraints: 128.

action.dns_request_action

Included if ActionType is DNS_REQUEST. Provides details about the DNS request that was detected.

Show child fields
action.dns_request_action.blocked

Indicates whether the DNS request was blocked.

action.dns_request_action.domain

The DNS domain that is associated with the DNS request.

Length Constraints: 128.

action.dns_request_action.protocol

The protocol that was used for the DNS request.

Length Constraints: Minimum length of 1. Maximum length of 64.

action.network_connection_action

Included if ActionType is NETWORK_CONNECTION. Provides details about the network connection that was detected.

Show child fields
action.network_connection_action.blocked

Indicates whether the network connection attempt was blocked.

action.network_connection_action.connection_direction

The direction of the network connection request (IN or OUT).

action.network_connection_action.local_port_details

Information about the port on the EC2 instance.

Show child fields
action.network_connection_action.local_port_details.port

The number of the port.

action.network_connection_action.local_port_details.port_name

The port name of the local connection.

Length Constraints: 128.

action.network_connection_action.protocol

The protocol used to make the network connection request.

Length Constraints: Minimum length of 1. Maximum length of 64.

action.network_connection_action.remote_ip_details

Information about the remote IP address that issued the network connection request.

Show child fields
action.network_connection_action.remote_ip_details.city

The city where the remote IP address is located.

Show child fields
action.network_connection_action.remote_ip_details.city.city_name

The name of the city.

action.network_connection_action.remote_ip_details.country

The country where the remote IP address is located.

Show child fields
action.network_connection_action.remote_ip_details.country.country_code

The 2-letter ISO 3166 country code for the country.

action.network_connection_action.remote_ip_details.country.country_name

The name of the country.

action.network_connection_action.remote_ip_details.geo_location

The coordinates of the location of the remote IP address.

Show child fields
action.network_connection_action.remote_ip_details.geo_location.lat

The latitude of the location.

action.network_connection_action.remote_ip_details.geo_location.lon

The longitude of the location.

action.network_connection_action.remote_ip_details.ip_address_v4

The IP address.

action.network_connection_action.remote_ip_details.organization

The internet service provider (ISP) organization associated with the remote IP address.

Show child fields
action.network_connection_action.remote_ip_details.organization.asn

The Autonomous System Number (ASN) of the internet provider

action.network_connection_action.remote_ip_details.organization.asn_org

The name of the organization that registered the ASN.

action.network_connection_action.remote_ip_details.organization.isp

The ISP information for the internet provider.

action.network_connection_action.remote_ip_details.organization.org

The name of the internet provider.

action.network_connection_action.remote_port_details

Information about the port on the remote IP address.

Show child fields
action.network_connection_action.remote_port_details.port

The number of the port.

action.network_connection_action.remote_port_details.port_name

The port name of the remote connection.

Length Constraints: 128.

action.port_probe_action

Included if ActionType is PORT_PROBE. Provides details about the port probe that was detected.

Show child fields
action.port_probe_action.blocked

Indicates whether the port probe was blocked.

action.port_probe_action.port_probe_details[]
Show child fields
action.port_probe_action.port_probe_details[].local_ip_details

Provides information about the IP address where the scanned port is located.

Show child fields
action.port_probe_action.port_probe_details[].local_ip_details.ip_address_v4

The IP address.

action.port_probe_action.port_probe_details[].local_port_details

Provides information about the port that was scanned.

Show child fields
action.port_probe_action.port_probe_details[].local_port_details.port

The number of the port.

action.port_probe_action.port_probe_details[].local_port_details.port_name

The port name of the local connection.

Length Constraints: 128.

action.port_probe_action.port_probe_details[].remote_ip_details

Provides information about the remote IP address that performed the scan.

Show child fields
action.port_probe_action.port_probe_details[].remote_ip_details.city

The city where the remote IP address is located.

Show child fields
action.port_probe_action.port_probe_details[].remote_ip_details.city.city_name

The name of the city.

action.port_probe_action.port_probe_details[].remote_ip_details.country

The country where the remote IP address is located.

Show child fields
action.port_probe_action.port_probe_details[].remote_ip_details.country.country_code

The 2-letter ISO 3166 country code for the country.

action.port_probe_action.port_probe_details[].remote_ip_details.country.country_name

The name of the country.

action.port_probe_action.port_probe_details[].remote_ip_details.geo_location

The coordinates of the location of the remote IP address.

Show child fields
action.port_probe_action.port_probe_details[].remote_ip_details.geo_location.lat

The latitude of the location.

action.port_probe_action.port_probe_details[].remote_ip_details.geo_location.lon

The longitude of the location.

action.port_probe_action.port_probe_details[].remote_ip_details.ip_address_v4

The IP address.

action.port_probe_action.port_probe_details[].remote_ip_details.organization

The internet service provider (ISP) organization associated with the remote IP address.

Show child fields
action.port_probe_action.port_probe_details[].remote_ip_details.organization.asn

The Autonomous System Number (ASN) of the internet provider

action.port_probe_action.port_probe_details[].remote_ip_details.organization.asn_org

The name of the organization that registered the ASN.

action.port_probe_action.port_probe_details[].remote_ip_details.organization.isp

The ISP information for the internet provider.

action.port_probe_action.port_probe_details[].remote_ip_details.organization.org

The name of the internet provider.

aws_account_id

The Amazon Web Services account ID that a finding is generated in.

Length Constraints: 12.

VARCHAR
aws_account_name

The name of the Amazon Web Services account from which a finding was generated.

Length Constraints: Minimum length of 1. Maximum length of 50. 

VARCHAR
company_name

The name of the company for the product that generated the finding.

Security Hub populates this attribute automatically for each finding. You cannot update this attribute with BatchImportFindings or BatchUpdateFindings. The exception to this is a custom integration.

When you use the Security Hub console or API to filter findings by company name, you use this attribute.

Length Constraints: Minimum length of 1. Maximum length of 128. 

VARCHAR
compliance

This data type is exclusive to findings that are generated as the result of a check run against a specific rule in a supported security standard, such as CIS Amazon Web Services Foundations. Contains security standard-related finding details.

STRUCT(
    "status" VARCHAR,
    "related_requirements" VARCHAR[],
    "status_reasons" STRUCT(
        "reason_code" VARCHAR,
        "description" VARCHAR
    )[],
    "security_control_id" VARCHAR,
    "associated_standards" STRUCT(
        "standards_id" VARCHAR
    )[],
    "security_control_parameters" STRUCT(
        "name" VARCHAR,
        "value" VARCHAR[]
    )[]
)
Show child fields
compliance.associated_standards[]
Show child fields
compliance.associated_standards[].standards_id

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 API response.

compliance.related_requirements[]
compliance.security_control_id

The unique identifier of a control across standards. Values for this field typically consist of an Amazon Web Servicesservice and a number, such as APIGateway.5.

compliance.security_control_parameters[]
Show child fields
compliance.security_control_parameters[].name

The name of a

compliance.security_control_parameters[].value[]
compliance.status

The result of a standards check.

The valid values for Status are as follows.

    • PASSED - Standards check passed for all evaluated resources.

    • WARNING - Some information is missing or this check is not supported for your configuration.

    • FAILED - Standards check failed for at least one evaluated resource.

    • NOT_AVAILABLE - Check could not be performed due to a service outage, API error, or because the result of the Config evaluation was NOT_APPLICABLE. If the Config evaluation result was NOT_APPLICABLE for a Security Hub control, Security Hub automatically archives the finding after 3 days.

compliance.status_reasons[]
Show child fields
compliance.status_reasons[].description

The corresponding description for the status reason code.

compliance.status_reasons[].reason_code

A code that represents a reason for the control status. For the list of status reason codes and their meanings, see Standards-related information in the ASFF in the Security Hub User Guide.

confidence

A finding's confidence. Confidence is defined as 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, where 0 means zero percent confidence and 100 means 100 percent confidence.

BIGINT
created_at

Indicates when the security findings provider created the potential security issue that a finding captured.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

VARCHAR
criticality

The level of importance assigned to the resources associated with the finding.

A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.

BIGINT
description

A finding's description. Description is a required property.

Length Constraints: Minimum length of 1. Maximum length of 1024.

VARCHAR
finding_provider_fields

In a BatchImportFindings request, finding providers use FindingProviderFields to provide and update their own values for confidence, criticality, related findings, severity, and types.

STRUCT(
    "confidence" BIGINT,
    "criticality" BIGINT,
    "related_findings" STRUCT(
        "product_arn" VARCHAR,
        "id" VARCHAR
    )[],
    "severity" STRUCT(
        "label" VARCHAR,
        "original" VARCHAR
    ),
    "types" VARCHAR[]
)
Show child fields
finding_provider_fields.confidence

A finding's confidence. Confidence is defined as 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, where 0 means zero percent confidence and 100 means 100 percent confidence.

finding_provider_fields.criticality

The level of importance assigned to the resources associated with the finding.

A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.

finding_provider_fields.related_findings[]
Show child fields
finding_provider_fields.related_findings[].id

The product-generated identifier for a related finding.

finding_provider_fields.related_findings[].product_arn

The ARN of the product that generated a related finding.

finding_provider_fields.severity

The severity of a finding.

Show child fields
finding_provider_fields.severity.label

The severity label assigned to the finding by the finding provider.

finding_provider_fields.severity.original

The finding provider's original value for the severity.

Length Constraints: Minimum length of 1. Maximum length of 64.

finding_provider_fields.types[]
first_observed_at

Indicates when the security findings provider first observed the potential security issue that a finding captured.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

VARCHAR
generator_details

Provides metadata for the Amazon CodeGuru detector associated with a finding. This field pertains to findings that relate to Lambda functions. Amazon Inspector identifies policy violations and vulnerabilities in Lambda function code based on internal detectors developed in collaboration with Amazon CodeGuru. Security Hub receives those findings. 

STRUCT(
    "name" VARCHAR,
    "description" VARCHAR,
    "labels" VARCHAR[]
)
Show child fields
generator_details.description

The description of the detector used to identify the code vulnerability.

generator_details.labels[]
generator_details.name

The name of the detector used to identify the code vulnerability.

generator_id

The identifier for the solution-specific component (a discrete unit of logic) that generated a finding. In various security findings providers' solutions, this generator can be called a rule, a check, a detector, a plugin, or something else.

Length Constraints: Minimum length of 1. Maximum length of 512.

VARCHAR
id

The security findings provider-specific identifier for a finding.

Length Constraints: Minimum length of 1. Maximum length of 512.

VARCHAR
last_observed_at

Indicates when the security findings provider most recently observed the potential security issue that a finding captured.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

VARCHAR
malware

A list of malware related to a finding.

Array Members: Maximum number of 5 items.

STRUCT(
    "name" VARCHAR,
    "type" VARCHAR,
    "path" VARCHAR,
    "state" VARCHAR
)[]
Show child fields
malware[]
Show child fields
malware[].name

The name of the malware that was observed.

Length Constraints: Minimum of 1. Maximum of 64.

malware[].path

The file system path of the malware that was observed.

Length Constraints: Minimum of 1. Maximum of 512.

malware[].state

The state of the malware that was observed.

malware[].type

The type of the malware that was observed.

network

The details of network-related information about a finding.

STRUCT(
    "direction" VARCHAR,
    "protocol" VARCHAR,
    "open_port_range" STRUCT(
        "begin" BIGINT,
        "end" BIGINT
    ),
    "source_ip_v4" VARCHAR,
    "source_ip_v6" VARCHAR,
    "source_port" BIGINT,
    "source_domain" VARCHAR,
    "source_mac" VARCHAR,
    "destination_ip_v4" VARCHAR,
    "destination_ip_v6" VARCHAR,
    "destination_port" BIGINT,
    "destination_domain" VARCHAR
)
Show child fields
network.destination_domain

The destination domain of network-related information about a finding.

Length Constraints: Minimum of 1. Maximum of 128.

network.destination_ip_v4

The destination IPv4 address of network-related information about a finding.

network.destination_ip_v6

The destination IPv6 address of network-related information about a finding.

network.destination_port

The destination port of network-related information about a finding.

network.direction

The direction of network traffic associated with a finding.

network.open_port_range

The range of open ports that is present on the network.

Show child fields
network.open_port_range.begin

The first port in the port range.

network.open_port_range.end

The last port in the port range.

network.protocol

The protocol of network-related information about a finding.

Length Constraints: Minimum of 1. Maximum of 16.

network.source_domain

The source domain of network-related information about a finding.

Length Constraints: Minimum of 1. Maximum of 128.

network.source_ip_v4

The source IPv4 address of network-related information about a finding.

network.source_ip_v6

The source IPv6 address of network-related information about a finding.

network.source_mac

The source media access control (MAC) address of network-related information about a finding.

network.source_port

The source port of network-related information about a finding.

network_path

Provides information about a network path that is relevant to a finding. Each entry under NetworkPath represents a component of that path.

STRUCT(
    "component_id" VARCHAR,
    "component_type" VARCHAR,
    "egress" STRUCT(
        "protocol" VARCHAR,
        "destination" STRUCT(
            "address" VARCHAR[],
            "port_ranges" STRUCT(
                "begin" BIGINT,
                "end" BIGINT
            )[]
        ),
        "source" STRUCT(
            "address" VARCHAR[],
            "port_ranges" STRUCT(
                "begin" BIGINT,
                "end" BIGINT
            )[]
        )
    ),
    "ingress" STRUCT(
        "protocol" VARCHAR,
        "destination" STRUCT(
            "address" VARCHAR[],
            "port_ranges" STRUCT(
                "begin" BIGINT,
                "end" BIGINT
            )[]
        ),
        "source" STRUCT(
            "address" VARCHAR[],
            "port_ranges" STRUCT(
                "begin" BIGINT,
                "end" BIGINT
            )[]
        )
    )
)[]
Show child fields
network_path[]
Show child fields
network_path[].component_id

The identifier of a component in the network path.

Length Constraints: Minimum of 1. Maximum of 32.

network_path[].component_type

The type of component.

Length Constraints: Minimum of 1. Maximum of 32.

network_path[].egress

Information about the component that comes after the current component in the network path.

Show child fields
network_path[].egress.destination

Information about the destination of the component.

Show child fields
network_path[].egress.destination.address[]
network_path[].egress.destination.port_ranges[]
Show child fields
network_path[].egress.destination.port_ranges[].begin

The first port in the port range.

network_path[].egress.destination.port_ranges[].end

The last port in the port range.

network_path[].egress.protocol

The protocol used for the component.

Length Constraints: Minimum of 1. Maximum of 16.

network_path[].egress.source

Information about the origin of the component.

Show child fields
network_path[].egress.source.address[]
network_path[].egress.source.port_ranges[]
Show child fields
network_path[].egress.source.port_ranges[].begin

The first port in the port range.

network_path[].egress.source.port_ranges[].end

The last port in the port range.

network_path[].ingress

Information about the component that comes before the current node in the network path.

Show child fields
network_path[].ingress.destination

Information about the destination of the component.

Show child fields
network_path[].ingress.destination.address[]
network_path[].ingress.destination.port_ranges[]
Show child fields
network_path[].ingress.destination.port_ranges[].begin

The first port in the port range.

network_path[].ingress.destination.port_ranges[].end

The last port in the port range.

network_path[].ingress.protocol

The protocol used for the component.

Length Constraints: Minimum of 1. Maximum of 16.

network_path[].ingress.source

Information about the origin of the component.

Show child fields
network_path[].ingress.source.address[]
network_path[].ingress.source.port_ranges[]
Show child fields
network_path[].ingress.source.port_ranges[].begin

The first port in the port range.

network_path[].ingress.source.port_ranges[].end

The last port in the port range.

note

A user-defined note added to a finding.

STRUCT(
    "text" VARCHAR,
    "updated_by" VARCHAR,
    "updated_at" VARCHAR
)
Show child fields
note.text

The text of a note.

Length Constraints: Minimum of 1. Maximum of 512.

note.updated_at

A timestamp that indicates when the note was updated.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

note.updated_by

The principal that created a note.

patch_summary

Provides an overview of the patch compliance status for an instance against a selected compliance standard.

STRUCT(
    "id" VARCHAR,
    "installed_count" BIGINT,
    "missing_count" BIGINT,
    "failed_count" BIGINT,
    "installed_other_count" BIGINT,
    "installed_rejected_count" BIGINT,
    "installed_pending_reboot" BIGINT,
    "operation_start_time" VARCHAR,
    "operation_end_time" VARCHAR,
    "reboot_option" VARCHAR,
    "operation" VARCHAR
)
Show child fields
patch_summary.failed_count

The number of patches from the compliance standard that failed to install.

The value can be an integer from 0 to 100000.

patch_summary.id

The identifier of the compliance standard that was used to determine the patch compliance status.

Length Constraints: Minimum length of 1. Maximum length of 256.

patch_summary.installed_count

The number of patches from the compliance standard that were installed successfully.

The value can be an integer from 0 to 100000.

patch_summary.installed_other_count

The number of installed patches that are not part of the compliance standard.

The value can be an integer from 0 to 100000.

patch_summary.installed_pending_reboot

The number of patches that were applied, but that require the instance to be rebooted in order to be marked as installed.

The value can be an integer from 0 to 100000.

patch_summary.installed_rejected_count

The number of patches that are installed but are also on a list of patches that the customer rejected.

The value can be an integer from 0 to 100000.

patch_summary.missing_count

The number of patches that are part of the compliance standard but are not installed. The count includes patches that failed to install.

The value can be an integer from 0 to 100000.

patch_summary.operation

The type of patch operation performed. For Patch Manager, the values are SCAN and INSTALL.

Length Constraints: Minimum length of 1. Maximum length of 256.

patch_summary.operation_end_time

Indicates when the operation completed.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

patch_summary.operation_start_time

Indicates when the operation started.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

patch_summary.reboot_option

The reboot option specified for the instance.

Length Constraints: Minimum length of 1. Maximum length of 256.

process

The details of process-related information about a finding.

STRUCT(
    "name" VARCHAR,
    "path" VARCHAR,
    "pid" BIGINT,
    "parent_pid" BIGINT,
    "launched_at" VARCHAR,
    "terminated_at" VARCHAR
)
Show child fields
process.launched_at

Indicates when the process was launched.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

process.name

The name of the process.

Length Constraints: Minimum of 1. Maximum of 64.

process.parent_pid

The parent process ID. This field accepts positive integers between O and 2147483647.

process.path

The path to the process executable.

Length Constraints: Minimum of 1. Maximum of 512.

process.pid

The process ID.

process.terminated_at

Indicates when the process was terminated.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

processed_at

A timestamp that indicates when Security Hub received a finding and begins to process it.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

VARCHAR
product_arn

The ARN generated by Security Hub that uniquely identifies a product that generates findings. This can be the ARN for a third-party product that is integrated with Security Hub, or the ARN for a custom integration.

Length Constraints: Minimum length of 12. Maximum length of 2048.

VARCHAR
product_fields

A data type where security findings providers can include additional solution-specific details that aren't part of the defined AwsSecurityFinding format.

Can contain up to 50 key-value pairs. For each key-value pair, the key can contain up to 128 characters, and the value can contain up to 2048 characters.

MAP(VARCHAR, VARCHAR)
product_name

The name of the product that generated the finding.

Security Hub populates this attribute automatically for each finding. You cannot update this attribute with BatchImportFindings or BatchUpdateFindings. The exception to this is a custom integration.

When you use the Security Hub console or API to filter findings by product name, you use this attribute.

Length Constraints: Minimum length of 1. Maximum length of 128.

VARCHAR
record_state

The record state of a finding.

VARCHAR
region

The Region from which the finding was generated.

Security Hub populates this attribute automatically for each finding. You cannot update it using BatchImportFindings or BatchUpdateFindings.

Length Constraints: Minimum length of 1. Maximum length of 16. 

VARCHAR
related_findings

A list of related findings.

Array Members: Minimum number of 1 item. Maximum number of 10 items.

STRUCT(
    "product_arn" VARCHAR,
    "id" VARCHAR
)[]
Show child fields
related_findings[]
Show child fields
related_findings[].id

The product-generated identifier for a related finding.

related_findings[].product_arn

The ARN of the product that generated a related finding.

remediation

A data type that describes the remediation options for a finding.

STRUCT(
    "recommendation" STRUCT(
        "text" VARCHAR,
        "url" VARCHAR
    )
)
Show child fields
remediation.recommendation

A recommendation on the steps to take to remediate the issue identified by a finding.

Show child fields
remediation.recommendation.text

Describes the recommended steps to take to remediate an issue identified in a finding.

Length Constraints: Minimum of 1 length. Maximum of 512 length.

remediation.recommendation.url

A URL to a page or site that contains information about how to remediate a finding.

resources

A set of resource data types that describe the resources that the finding refers to.

Array Members: Minimum number of 1 item. Maximum number of 32 items.

STRUCT(
    "type" VARCHAR,
    "id" VARCHAR,
    "partition" VARCHAR,
    "region" VARCHAR,
    "resource_role" VARCHAR,
    "tags" MAP(VARCHAR, VARCHAR),
    "data_classification" STRUCT(
        "detailed_results_location" VARCHAR,
        "result" STRUCT(
            "mime_type" VARCHAR,
            "size_classified" BIGINT,
            "additional_occurrences" BOOLEAN,
            "status" STRUCT(
                "code" VARCHAR,
                "reason" VARCHAR
            ),
            "sensitive_data" STRUCT(
                "category" VARCHAR,
                "detections" STRUCT(
                    "count" BIGINT,
                    "type" VARCHAR,
                    "occurrences" STRUCT(
                        "line_ranges" STRUCT(
                            "start" BIGINT,
                            "end" BIGINT,
                            "start_column" BIGINT
                        )[],
                        "offset_ranges" STRUCT(
                            "start" BIGINT,
                            "end" BIGINT,
                            "start_column" BIGINT
                        )[],
                        "pages" STRUCT(
                            "page_number" BIGINT,
                            "line_range" STRUCT(
                                "start" BIGINT,
                                "end" BIGINT,
                                "start_column" BIGINT
                            ),
                            "offset_range" STRUCT(
                                "start" BIGINT,
                                "end" BIGINT,
                                "start_column" BIGINT
                            )
                        )[],
                        "records" STRUCT(
                            "json_path" VARCHAR,
                            "record_index" BIGINT
                        )[],
                        "cells" STRUCT(
                            "column" BIGINT,
                            "row" BIGINT,
                            "column_name" VARCHAR,
                            "cell_reference" VARCHAR
                        )[]
                    )
                )[],
                "total_count" BIGINT
            )[],
            "custom_data_identifiers" STRUCT(
                "detections" STRUCT(
                    "count" BIGINT,
                    "arn" VARCHAR,
                    "name" VARCHAR,
                    "occurrences" STRUCT(
                        "line_ranges" STRUCT(
                            "start" BIGINT,
                            "end" BIGINT,
                            "start_column" BIGINT
                        )[],
                        "offset_ranges" STRUCT(
                            "start" BIGINT,
                            "end" BIGINT,
                            "start_column" BIGINT
                        )[],
                        "pages" STRUCT(
                            "page_number" BIGINT,
                            "line_range" STRUCT(
                                "start" BIGINT,
                                "end" BIGINT,
                                "start_column" BIGINT
                            ),
                            "offset_range" STRUCT(
                                "start" BIGINT,
                                "end" BIGINT,
                                "start_column" BIGINT
                            )
                        )[],
                        "records" STRUCT(
                            "json_path" VARCHAR,
                            "record_index" BIGINT
                        )[],
                        "cells" STRUCT(
                            "column" BIGINT,
                            "row" BIGINT,
                            "column_name" VARCHAR,
                            "cell_reference" VARCHAR
                        )[]
                    )
                )[],
                "total_count" BIGINT
            )
        )
    ),
    "details" STRUCT(
        "aws_auto_scaling_auto_scaling_group" STRUCT(
            "launch_configuration_name" VARCHAR,
            "load_balancer_names" VARCHAR[],
            "health_check_type" VARCHAR,
            "health_check_grace_period" BIGINT,
            "created_time" VARCHAR,
            "mixed_instances_policy" STRUCT(
                "instances_distribution" STRUCT(
                    "on_demand_allocation_strategy" VARCHAR,
                    "on_demand_base_capacity" BIGINT,
                    "on_demand_percentage_above_base_capacity" BIGINT,
                    "spot_allocation_strategy" VARCHAR,
                    "spot_instance_pools" BIGINT,
                    "spot_max_price" VARCHAR
                ),
                "launch_template" STRUCT(
                    "launch_template_specification" STRUCT(
                        "launch_template_id" VARCHAR,
                        "launch_template_name" VARCHAR,
                        "version" VARCHAR
                    ),
                    "overrides" STRUCT(
                        "instance_type" VARCHAR,
                        "weighted_capacity" VARCHAR
                    )[]
                )
            ),
            "availability_zones" STRUCT(
                "value" VARCHAR
            )[],
            "launch_template" STRUCT(
                "launch_template_id" VARCHAR,
                "launch_template_name" VARCHAR,
                "version" VARCHAR
            ),
            "capacity_rebalance" BOOLEAN
        ),
        "aws_code_build_project" STRUCT(
            "encryption_key" VARCHAR,
            "artifacts" STRUCT(
                "artifact_identifier" VARCHAR,
                "encryption_disabled" BOOLEAN,
                "location" VARCHAR,
                "name" VARCHAR,
                "namespace_type" VARCHAR,
                "override_artifact_name" BOOLEAN,
                "packaging" VARCHAR,
                "path" VARCHAR,
                "type" VARCHAR
            )[],
            "environment" STRUCT(
                "certificate" VARCHAR,
                "environment_variables" STRUCT(
                    "name" VARCHAR,
                    "type" VARCHAR,
                    "value" VARCHAR
                )[],
                "privileged_mode" BOOLEAN,
                "image_pull_credentials_type" VARCHAR,
                "registry_credential" STRUCT(
                    "credential" VARCHAR,
                    "credential_provider" VARCHAR
                ),
                "type" VARCHAR
            ),
            "name" VARCHAR,
            "source" STRUCT(
                "type" VARCHAR,
                "location" VARCHAR,
                "git_clone_depth" BIGINT,
                "insecure_ssl" BOOLEAN
            ),
            "service_role" VARCHAR,
            "logs_config" STRUCT(
                "cloud_watch_logs" STRUCT(
                    "group_name" VARCHAR,
                    "status" VARCHAR,
                    "stream_name" VARCHAR
                ),
                "s3_logs" STRUCT(
                    "encryption_disabled" BOOLEAN,
                    "location" VARCHAR,
                    "status" VARCHAR
                )
            ),
            "vpc_config" STRUCT(
                "vpc_id" VARCHAR,
                "subnets" VARCHAR[],
                "security_group_ids" VARCHAR[]
            ),
            "secondary_artifacts" STRUCT(
                "artifact_identifier" VARCHAR,
                "encryption_disabled" BOOLEAN,
                "location" VARCHAR,
                "name" VARCHAR,
                "namespace_type" VARCHAR,
                "override_artifact_name" BOOLEAN,
                "packaging" VARCHAR,
                "path" VARCHAR,
                "type" VARCHAR
            )[]
        ),
        "aws_cloud_front_distribution" STRUCT(
            "cache_behaviors" STRUCT(
                "items" STRUCT(
                    "viewer_protocol_policy" VARCHAR
                )[]
            ),
            "default_cache_behavior" STRUCT(
                "viewer_protocol_policy" VARCHAR
            ),
            "default_root_object" VARCHAR,
            "domain_name" VARCHAR,
            "e_tag" VARCHAR,
            "last_modified_time" VARCHAR,
            "logging" STRUCT(
                "bucket" VARCHAR,
                "enabled" BOOLEAN,
                "include_cookies" BOOLEAN,
                "prefix" VARCHAR
            ),
            "origins" STRUCT(
                "items" STRUCT(
                    "domain_name" VARCHAR,
                    "id" VARCHAR,
                    "origin_path" VARCHAR,
                    "s3_origin_config" STRUCT(
                        "origin_access_identity" VARCHAR
                    ),
                    "custom_origin_config" STRUCT(
                        "http_port" BIGINT,
                        "https_port" BIGINT,
                        "origin_keepalive_timeout" BIGINT,
                        "origin_protocol_policy" VARCHAR,
                        "origin_read_timeout" BIGINT,
                        "origin_ssl_protocols" STRUCT(
                            "items" VARCHAR[],
                            "quantity" BIGINT
                        )
                    )
                )[]
            ),
            "origin_groups" STRUCT(
                "items" STRUCT(
                    "failover_criteria" STRUCT(
                        "status_codes" STRUCT(
                            "items" BIGINT[],
                            "quantity" BIGINT
                        )
                    )
                )[]
            ),
            "viewer_certificate" STRUCT(
                "acm_certificate_arn" VARCHAR,
                "certificate" VARCHAR,
                "certificate_source" VARCHAR,
                "cloud_front_default_certificate" BOOLEAN,
                "iam_certificate_id" VARCHAR,
                "minimum_protocol_version" VARCHAR,
                "ssl_support_method" VARCHAR
            ),
            "status" VARCHAR,
            "web_acl_id" VARCHAR
        ),
        "aws_ec2_instance" STRUCT(
            "type" VARCHAR,
            "image_id" VARCHAR,
            "ip_v4_addresses" VARCHAR[],
            "ip_v6_addresses" VARCHAR[],
            "key_name" VARCHAR,
            "iam_instance_profile_arn" VARCHAR,
            "vpc_id" VARCHAR,
            "subnet_id" VARCHAR,
            "launched_at" VARCHAR,
            "network_interfaces" STRUCT(
                "network_interface_id" VARCHAR
            )[],
            "virtualization_type" VARCHAR,
            "metadata_options" STRUCT(
                "http_endpoint" VARCHAR,
                "http_protocol_ipv6" VARCHAR,
                "http_put_response_hop_limit" BIGINT,
                "http_tokens" VARCHAR,
                "instance_metadata_tags" VARCHAR
            ),
            "monitoring" STRUCT(
                "state" VARCHAR
            )
        ),
        "aws_ec2_network_interface" STRUCT(
            "attachment" STRUCT(
                "attach_time" VARCHAR,
                "attachment_id" VARCHAR,
                "delete_on_termination" BOOLEAN,
                "device_index" BIGINT,
                "instance_id" VARCHAR,
                "instance_owner_id" VARCHAR,
                "status" VARCHAR
            ),
            "network_interface_id" VARCHAR,
            "security_groups" STRUCT(
                "group_name" VARCHAR,
                "group_id" VARCHAR
            )[],
            "source_dest_check" BOOLEAN,
            "ip_v6_addresses" STRUCT(
                "ip_v6_address" VARCHAR
            )[],
            "private_ip_addresses" STRUCT(
                "private_ip_address" VARCHAR,
                "private_dns_name" VARCHAR
            )[],
            "public_dns_name" VARCHAR,
            "public_ip" VARCHAR
        ),
        "aws_ec2_security_group" STRUCT(
            "group_name" VARCHAR,
            "group_id" VARCHAR,
            "owner_id" VARCHAR,
            "vpc_id" VARCHAR,
            "ip_permissions" STRUCT(
                "ip_protocol" VARCHAR,
                "from_port" BIGINT,
                "to_port" BIGINT,
                "user_id_group_pairs" STRUCT(
                    "group_id" VARCHAR,
                    "group_name" VARCHAR,
                    "peering_status" VARCHAR,
                    "user_id" VARCHAR,
                    "vpc_id" VARCHAR,
                    "vpc_peering_connection_id" VARCHAR
                )[],
                "ip_ranges" STRUCT(
                    "cidr_ip" VARCHAR
                )[],
                "ipv6_ranges" STRUCT(
                    "cidr_ipv6" VARCHAR
                )[],
                "prefix_list_ids" STRUCT(
                    "prefix_list_id" VARCHAR
                )[]
            )[],
            "ip_permissions_egress" STRUCT(
                "ip_protocol" VARCHAR,
                "from_port" BIGINT,
                "to_port" BIGINT,
                "user_id_group_pairs" STRUCT(
                    "group_id" VARCHAR,
                    "group_name" VARCHAR,
                    "peering_status" VARCHAR,
                    "user_id" VARCHAR,
                    "vpc_id" VARCHAR,
                    "vpc_peering_connection_id" VARCHAR
                )[],
                "ip_ranges" STRUCT(
                    "cidr_ip" VARCHAR
                )[],
                "ipv6_ranges" STRUCT(
                    "cidr_ipv6" VARCHAR
                )[],
                "prefix_list_ids" STRUCT(
                    "prefix_list_id" VARCHAR
                )[]
            )[]
        ),
        "aws_ec2_volume" STRUCT(
            "create_time" VARCHAR,
            "device_name" VARCHAR,
            "encrypted" BOOLEAN,
            "size" BIGINT,
            "snapshot_id" VARCHAR,
            "status" VARCHAR,
            "kms_key_id" VARCHAR,
            "attachments" STRUCT(
                "attach_time" VARCHAR,
                "delete_on_termination" BOOLEAN,
                "instance_id" VARCHAR,
                "status" VARCHAR
            )[],
            "volume_id" VARCHAR,
            "volume_type" VARCHAR,
            "volume_scan_status" VARCHAR
        ),
        "aws_ec2_vpc" STRUCT(
            "cidr_block_association_set" STRUCT(
                "association_id" VARCHAR,
                "cidr_block" VARCHAR,
                "cidr_block_state" VARCHAR
            )[],
            "ipv6_cidr_block_association_set" STRUCT(
                "association_id" VARCHAR,
                "ipv6_cidr_block" VARCHAR,
                "cidr_block_state" VARCHAR
            )[],
            "dhcp_options_id" VARCHAR,
            "state" VARCHAR
        ),
        "aws_ec2_eip" STRUCT(
            "instance_id" VARCHAR,
            "public_ip" VARCHAR,
            "allocation_id" VARCHAR,
            "association_id" VARCHAR,
            "domain" VARCHAR,
            "public_ipv4_pool" VARCHAR,
            "network_border_group" VARCHAR,
            "network_interface_id" VARCHAR,
            "network_interface_owner_id" VARCHAR,
            "private_ip_address" VARCHAR
        ),
        "aws_ec2_subnet" STRUCT(
            "assign_ipv6_address_on_creation" BOOLEAN,
            "availability_zone" VARCHAR,
            "availability_zone_id" VARCHAR,
            "available_ip_address_count" BIGINT,
            "cidr_block" VARCHAR,
            "default_for_az" BOOLEAN,
            "map_public_ip_on_launch" BOOLEAN,
            "owner_id" VARCHAR,
            "state" VARCHAR,
            "subnet_arn" VARCHAR,
            "subnet_id" VARCHAR,
            "vpc_id" VARCHAR,
            "ipv6_cidr_block_association_set" STRUCT(
                "association_id" VARCHAR,
                "ipv6_cidr_block" VARCHAR,
                "cidr_block_state" VARCHAR
            )[]
        ),
        "aws_ec2_network_acl" STRUCT(
            "is_default" BOOLEAN,
            "network_acl_id" VARCHAR,
            "owner_id" VARCHAR,
            "vpc_id" VARCHAR,
            "associations" STRUCT(
                "network_acl_association_id" VARCHAR,
                "network_acl_id" VARCHAR,
                "subnet_id" VARCHAR
            )[],
            "entries" STRUCT(
                "cidr_block" VARCHAR,
                "egress" BOOLEAN,
                "icmp_type_code" STRUCT(
                    "code" BIGINT,
                    "type" BIGINT
                ),
                "ipv6_cidr_block" VARCHAR,
                "port_range" STRUCT(
                    "from" BIGINT,
                    "to" BIGINT
                ),
                "protocol" VARCHAR,
                "rule_action" VARCHAR,
                "rule_number" BIGINT
            )[]
        ),
        "aws_elbv2_load_balancer" STRUCT(
            "availability_zones" STRUCT(
                "zone_name" VARCHAR,
                "subnet_id" VARCHAR
            )[],
            "canonical_hosted_zone_id" VARCHAR,
            "created_time" VARCHAR,
            "dns_name" VARCHAR,
            "ip_address_type" VARCHAR,
            "scheme" VARCHAR,
            "security_groups" VARCHAR[],
            "state" STRUCT(
                "code" VARCHAR,
                "reason" VARCHAR
            ),
            "type" VARCHAR,
            "vpc_id" VARCHAR,
            "load_balancer_attributes" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        ),
        "aws_elastic_beanstalk_environment" STRUCT(
            "application_name" VARCHAR,
            "cname" VARCHAR,
            "date_created" VARCHAR,
            "date_updated" VARCHAR,
            "description" VARCHAR,
            "endpoint_url" VARCHAR,
            "environment_arn" VARCHAR,
            "environment_id" VARCHAR,
            "environment_links" STRUCT(
                "environment_name" VARCHAR,
                "link_name" VARCHAR
            )[],
            "environment_name" VARCHAR,
            "option_settings" STRUCT(
                "namespace" VARCHAR,
                "option_name" VARCHAR,
                "resource_name" VARCHAR,
                "value" VARCHAR
            )[],
            "platform_arn" VARCHAR,
            "solution_stack_name" VARCHAR,
            "status" VARCHAR,
            "tier" STRUCT(
                "name" VARCHAR,
                "type" VARCHAR,
                "version" VARCHAR
            ),
            "version_label" VARCHAR
        ),
        "aws_elasticsearch_domain" STRUCT(
            "access_policies" VARCHAR,
            "domain_endpoint_options" STRUCT(
                "enforce_https" BOOLEAN,
                "tls_security_policy" VARCHAR
            ),
            "domain_id" VARCHAR,
            "domain_name" VARCHAR,
            "endpoint" VARCHAR,
            "endpoints" MAP(VARCHAR, VARCHAR),
            "elasticsearch_version" VARCHAR,
            "elasticsearch_cluster_config" STRUCT(
                "dedicated_master_count" BIGINT,
                "dedicated_master_enabled" BOOLEAN,
                "dedicated_master_type" VARCHAR,
                "instance_count" BIGINT,
                "instance_type" VARCHAR,
                "zone_awareness_config" STRUCT(
                    "availability_zone_count" BIGINT
                ),
                "zone_awareness_enabled" BOOLEAN
            ),
            "encryption_at_rest_options" STRUCT(
                "enabled" BOOLEAN,
                "kms_key_id" VARCHAR
            ),
            "log_publishing_options" STRUCT(
                "index_slow_logs" STRUCT(
                    "cloud_watch_logs_log_group_arn" VARCHAR,
                    "enabled" BOOLEAN
                ),
                "search_slow_logs" STRUCT(
                    "cloud_watch_logs_log_group_arn" VARCHAR,
                    "enabled" BOOLEAN
                ),
                "audit_logs" STRUCT(
                    "cloud_watch_logs_log_group_arn" VARCHAR,
                    "enabled" BOOLEAN
                )
            ),
            "node_to_node_encryption_options" STRUCT(
                "enabled" BOOLEAN
            ),
            "service_software_options" STRUCT(
                "automated_update_date" VARCHAR,
                "cancellable" BOOLEAN,
                "current_version" VARCHAR,
                "description" VARCHAR,
                "new_version" VARCHAR,
                "update_available" BOOLEAN,
                "update_status" VARCHAR
            ),
            "vpc_options" STRUCT(
                "availability_zones" VARCHAR[],
                "security_group_ids" VARCHAR[],
                "subnet_ids" VARCHAR[],
                "vpc_id" VARCHAR
            )
        ),
        "aws_s3_bucket" STRUCT(
            "owner_id" VARCHAR,
            "owner_name" VARCHAR,
            "owner_account_id" VARCHAR,
            "created_at" VARCHAR,
            "server_side_encryption_configuration" STRUCT(
                "rules" STRUCT(
                    "apply_server_side_encryption_by_default" STRUCT(
                        "sse_algorithm" VARCHAR,
                        "kms_master_key_id" VARCHAR
                    )
                )[]
            ),
            "bucket_lifecycle_configuration" STRUCT(
                "rules" STRUCT(
                    "abort_incomplete_multipart_upload" STRUCT(
                        "days_after_initiation" BIGINT
                    ),
                    "expiration_date" VARCHAR,
                    "expiration_in_days" BIGINT,
                    "expired_object_delete_marker" BOOLEAN,
                    "filter" STRUCT(
                        "predicate" STRUCT(
                            "operands" STRUCT(
                                "prefix" VARCHAR,
                                "tag" STRUCT(
                                    "key" VARCHAR,
                                    "value" VARCHAR
                                ),
                                "type" VARCHAR
                            )[],
                            "prefix" VARCHAR,
                            "tag" STRUCT(
                                "key" VARCHAR,
                                "value" VARCHAR
                            ),
                            "type" VARCHAR
                        )
                    ),
                    "id" VARCHAR,
                    "noncurrent_version_expiration_in_days" BIGINT,
                    "noncurrent_version_transitions" STRUCT(
                        "days" BIGINT,
                        "storage_class" VARCHAR
                    )[],
                    "prefix" VARCHAR,
                    "status" VARCHAR,
                    "transitions" STRUCT(
                        "date" VARCHAR,
                        "days" BIGINT,
                        "storage_class" VARCHAR
                    )[]
                )[]
            ),
            "public_access_block_configuration" STRUCT(
                "block_public_acls" BOOLEAN,
                "block_public_policy" BOOLEAN,
                "ignore_public_acls" BOOLEAN,
                "restrict_public_buckets" BOOLEAN
            ),
            "access_control_list" VARCHAR,
            "bucket_logging_configuration" STRUCT(
                "destination_bucket_name" VARCHAR,
                "log_file_prefix" VARCHAR
            ),
            "bucket_website_configuration" STRUCT(
                "error_document" VARCHAR,
                "index_document_suffix" VARCHAR,
                "redirect_all_requests_to" STRUCT(
                    "hostname" VARCHAR,
                    "protocol" VARCHAR
                ),
                "routing_rules" STRUCT(
                    "condition" STRUCT(
                        "http_error_code_returned_equals" VARCHAR,
                        "key_prefix_equals" VARCHAR
                    ),
                    "redirect" STRUCT(
                        "hostname" VARCHAR,
                        "http_redirect_code" VARCHAR,
                        "protocol" VARCHAR,
                        "replace_key_prefix_with" VARCHAR,
                        "replace_key_with" VARCHAR
                    )
                )[]
            ),
            "bucket_notification_configuration" STRUCT(
                "configurations" STRUCT(
                    "events" VARCHAR[],
                    "filter" STRUCT(
                        "s3_key_filter" STRUCT(
                            "filter_rules" STRUCT(
                                "name" VARCHAR,
                                "value" VARCHAR
                            )[]
                        )
                    ),
                    "destination" VARCHAR,
                    "type" VARCHAR
                )[]
            ),
            "bucket_versioning_configuration" STRUCT(
                "is_mfa_delete_enabled" BOOLEAN,
                "status" VARCHAR
            ),
            "object_lock_configuration" STRUCT(
                "object_lock_enabled" VARCHAR,
                "rule" STRUCT(
                    "default_retention" STRUCT(
                        "days" BIGINT,
                        "mode" VARCHAR,
                        "years" BIGINT
                    )
                )
            ),
            "name" VARCHAR
        ),
        "aws_s3_account_public_access_block" STRUCT(
            "block_public_acls" BOOLEAN,
            "block_public_policy" BOOLEAN,
            "ignore_public_acls" BOOLEAN,
            "restrict_public_buckets" BOOLEAN
        ),
        "aws_s3_object" STRUCT(
            "last_modified" VARCHAR,
            "e_tag" VARCHAR,
            "version_id" VARCHAR,
            "content_type" VARCHAR,
            "server_side_encryption" VARCHAR,
            "ssekms_key_id" VARCHAR
        ),
        "aws_secrets_manager_secret" STRUCT(
            "rotation_rules" STRUCT(
                "automatically_after_days" BIGINT
            ),
            "rotation_occurred_within_frequency" BOOLEAN,
            "kms_key_id" VARCHAR,
            "rotation_enabled" BOOLEAN,
            "rotation_lambda_arn" VARCHAR,
            "deleted" BOOLEAN,
            "name" VARCHAR,
            "description" VARCHAR
        ),
        "aws_iam_access_key" STRUCT(
            "user_name" VARCHAR,
            "status" VARCHAR,
            "created_at" VARCHAR,
            "principal_id" VARCHAR,
            "principal_type" VARCHAR,
            "principal_name" VARCHAR,
            "account_id" VARCHAR,
            "access_key_id" VARCHAR,
            "session_context" STRUCT(
                "attributes" STRUCT(
                    "mfa_authenticated" BOOLEAN,
                    "creation_date" VARCHAR
                ),
                "session_issuer" STRUCT(
                    "type" VARCHAR,
                    "principal_id" VARCHAR,
                    "arn" VARCHAR,
                    "account_id" VARCHAR,
                    "user_name" VARCHAR
                )
            )
        ),
        "aws_iam_user" STRUCT(
            "attached_managed_policies" STRUCT(
                "policy_name" VARCHAR,
                "policy_arn" VARCHAR
            )[],
            "create_date" VARCHAR,
            "group_list" VARCHAR[],
            "path" VARCHAR,
            "permissions_boundary" STRUCT(
                "permissions_boundary_arn" VARCHAR,
                "permissions_boundary_type" VARCHAR
            ),
            "user_id" VARCHAR,
            "user_name" VARCHAR,
            "user_policy_list" STRUCT(
                "policy_name" VARCHAR
            )[]
        ),
        "aws_iam_policy" STRUCT(
            "attachment_count" BIGINT,
            "create_date" VARCHAR,
            "default_version_id" VARCHAR,
            "description" VARCHAR,
            "is_attachable" BOOLEAN,
            "path" VARCHAR,
            "permissions_boundary_usage_count" BIGINT,
            "policy_id" VARCHAR,
            "policy_name" VARCHAR,
            "policy_version_list" STRUCT(
                "version_id" VARCHAR,
                "is_default_version" BOOLEAN,
                "create_date" VARCHAR
            )[],
            "update_date" VARCHAR
        ),
        "aws_api_gateway_v2_stage" STRUCT(
            "client_certificate_id" VARCHAR,
            "created_date" VARCHAR,
            "description" VARCHAR,
            "default_route_settings" STRUCT(
                "detailed_metrics_enabled" BOOLEAN,
                "logging_level" VARCHAR,
                "data_trace_enabled" BOOLEAN,
                "throttling_burst_limit" BIGINT,
                "throttling_rate_limit" DOUBLE
            ),
            "deployment_id" VARCHAR,
            "last_updated_date" VARCHAR,
            "route_settings" STRUCT(
                "detailed_metrics_enabled" BOOLEAN,
                "logging_level" VARCHAR,
                "data_trace_enabled" BOOLEAN,
                "throttling_burst_limit" BIGINT,
                "throttling_rate_limit" DOUBLE
            ),
            "stage_name" VARCHAR,
            "stage_variables" MAP(VARCHAR, VARCHAR),
            "access_log_settings" STRUCT(
                "format" VARCHAR,
                "destination_arn" VARCHAR
            ),
            "auto_deploy" BOOLEAN,
            "last_deployment_status_message" VARCHAR,
            "api_gateway_managed" BOOLEAN
        ),
        "aws_api_gateway_v2_api" STRUCT(
            "api_endpoint" VARCHAR,
            "api_id" VARCHAR,
            "api_key_selection_expression" VARCHAR,
            "created_date" VARCHAR,
            "description" VARCHAR,
            "version" VARCHAR,
            "name" VARCHAR,
            "protocol_type" VARCHAR,
            "route_selection_expression" VARCHAR,
            "cors_configuration" STRUCT(
                "allow_origins" VARCHAR[],
                "allow_credentials" BOOLEAN,
                "expose_headers" VARCHAR[],
                "max_age" BIGINT,
                "allow_methods" VARCHAR[],
                "allow_headers" VARCHAR[]
            )
        ),
        "aws_dynamo_db_table" STRUCT(
            "attribute_definitions" STRUCT(
                "attribute_name" VARCHAR,
                "attribute_type" VARCHAR
            )[],
            "billing_mode_summary" STRUCT(
                "billing_mode" VARCHAR,
                "last_update_to_pay_per_request_date_time" VARCHAR
            ),
            "creation_date_time" VARCHAR,
            "global_secondary_indexes" STRUCT(
                "backfilling" BOOLEAN,
                "index_arn" VARCHAR,
                "index_name" VARCHAR,
                "index_size_bytes" BIGINT,
                "index_status" VARCHAR,
                "item_count" BIGINT,
                "key_schema" STRUCT(
                    "attribute_name" VARCHAR,
                    "key_type" VARCHAR
                )[],
                "projection" STRUCT(
                    "non_key_attributes" VARCHAR[],
                    "projection_type" VARCHAR
                ),
                "provisioned_throughput" STRUCT(
                    "last_decrease_date_time" VARCHAR,
                    "last_increase_date_time" VARCHAR,
                    "number_of_decreases_today" BIGINT,
                    "read_capacity_units" BIGINT,
                    "write_capacity_units" BIGINT
                )
            )[],
            "global_table_version" VARCHAR,
            "item_count" BIGINT,
            "key_schema" STRUCT(
                "attribute_name" VARCHAR,
                "key_type" VARCHAR
            )[],
            "latest_stream_arn" VARCHAR,
            "latest_stream_label" VARCHAR,
            "local_secondary_indexes" STRUCT(
                "index_arn" VARCHAR,
                "index_name" VARCHAR,
                "key_schema" STRUCT(
                    "attribute_name" VARCHAR,
                    "key_type" VARCHAR
                )[],
                "projection" STRUCT(
                    "non_key_attributes" VARCHAR[],
                    "projection_type" VARCHAR
                )
            )[],
            "provisioned_throughput" STRUCT(
                "last_decrease_date_time" VARCHAR,
                "last_increase_date_time" VARCHAR,
                "number_of_decreases_today" BIGINT,
                "read_capacity_units" BIGINT,
                "write_capacity_units" BIGINT
            ),
            "replicas" STRUCT(
                "global_secondary_indexes" STRUCT(
                    "index_name" VARCHAR,
                    "provisioned_throughput_override" STRUCT(
                        "read_capacity_units" BIGINT
                    )
                )[],
                "kms_master_key_id" VARCHAR,
                "provisioned_throughput_override" STRUCT(
                    "read_capacity_units" BIGINT
                ),
                "region_name" VARCHAR,
                "replica_status" VARCHAR,
                "replica_status_description" VARCHAR
            )[],
            "restore_summary" STRUCT(
                "source_backup_arn" VARCHAR,
                "source_table_arn" VARCHAR,
                "restore_date_time" VARCHAR,
                "restore_in_progress" BOOLEAN
            ),
            "sse_description" STRUCT(
                "inaccessible_encryption_date_time" VARCHAR,
                "status" VARCHAR,
                "sse_type" VARCHAR,
                "kms_master_key_arn" VARCHAR
            ),
            "stream_specification" STRUCT(
                "stream_enabled" BOOLEAN,
                "stream_view_type" VARCHAR
            ),
            "table_id" VARCHAR,
            "table_name" VARCHAR,
            "table_size_bytes" BIGINT,
            "table_status" VARCHAR,
            "deletion_protection_enabled" BOOLEAN
        ),
        "aws_api_gateway_stage" STRUCT(
            "deployment_id" VARCHAR,
            "client_certificate_id" VARCHAR,
            "stage_name" VARCHAR,
            "description" VARCHAR,
            "cache_cluster_enabled" BOOLEAN,
            "cache_cluster_size" VARCHAR,
            "cache_cluster_status" VARCHAR,
            "method_settings" STRUCT(
                "metrics_enabled" BOOLEAN,
                "logging_level" VARCHAR,
                "data_trace_enabled" BOOLEAN,
                "throttling_burst_limit" BIGINT,
                "throttling_rate_limit" DOUBLE,
                "caching_enabled" BOOLEAN,
                "cache_ttl_in_seconds" BIGINT,
                "cache_data_encrypted" BOOLEAN,
                "require_authorization_for_cache_control" BOOLEAN,
                "unauthorized_cache_control_header_strategy" VARCHAR,
                "http_method" VARCHAR,
                "resource_path" VARCHAR
            )[],
            "variables" MAP(VARCHAR, VARCHAR),
            "documentation_version" VARCHAR,
            "access_log_settings" STRUCT(
                "format" VARCHAR,
                "destination_arn" VARCHAR
            ),
            "canary_settings" STRUCT(
                "percent_traffic" DOUBLE,
                "deployment_id" VARCHAR,
                "stage_variable_overrides" MAP(VARCHAR, VARCHAR),
                "use_stage_cache" BOOLEAN
            ),
            "tracing_enabled" BOOLEAN,
            "created_date" VARCHAR,
            "last_updated_date" VARCHAR,
            "web_acl_arn" VARCHAR
        ),
        "aws_api_gateway_rest_api" STRUCT(
            "id" VARCHAR,
            "name" VARCHAR,
            "description" VARCHAR,
            "created_date" VARCHAR,
            "version" VARCHAR,
            "binary_media_types" VARCHAR[],
            "minimum_compression_size" BIGINT,
            "api_key_source" VARCHAR,
            "endpoint_configuration" STRUCT(
                "types" VARCHAR[]
            )
        ),
        "aws_cloud_trail_trail" STRUCT(
            "cloud_watch_logs_log_group_arn" VARCHAR,
            "cloud_watch_logs_role_arn" VARCHAR,
            "has_custom_event_selectors" BOOLEAN,
            "home_region" VARCHAR,
            "include_global_service_events" BOOLEAN,
            "is_multi_region_trail" BOOLEAN,
            "is_organization_trail" BOOLEAN,
            "kms_key_id" VARCHAR,
            "log_file_validation_enabled" BOOLEAN,
            "name" VARCHAR,
            "s3_bucket_name" VARCHAR,
            "s3_key_prefix" VARCHAR,
            "sns_topic_arn" VARCHAR,
            "sns_topic_name" VARCHAR,
            "trail_arn" VARCHAR
        ),
        "aws_ssm_patch_compliance" STRUCT(
            "patch" STRUCT(
                "compliance_summary" STRUCT(
                    "status" VARCHAR,
                    "compliant_critical_count" BIGINT,
                    "compliant_high_count" BIGINT,
                    "compliant_medium_count" BIGINT,
                    "execution_type" VARCHAR,
                    "non_compliant_critical_count" BIGINT,
                    "compliant_informational_count" BIGINT,
                    "non_compliant_informational_count" BIGINT,
                    "compliant_unspecified_count" BIGINT,
                    "non_compliant_low_count" BIGINT,
                    "non_compliant_high_count" BIGINT,
                    "compliant_low_count" BIGINT,
                    "compliance_type" VARCHAR,
                    "patch_baseline_id" VARCHAR,
                    "overall_severity" VARCHAR,
                    "non_compliant_medium_count" BIGINT,
                    "non_compliant_unspecified_count" BIGINT,
                    "patch_group" VARCHAR
                )
            )
        ),
        "aws_certificate_manager_certificate" STRUCT(
            "certificate_authority_arn" VARCHAR,
            "created_at" VARCHAR,
            "domain_name" VARCHAR,
            "domain_validation_options" STRUCT(
                "domain_name" VARCHAR,
                "resource_record" STRUCT(
                    "name" VARCHAR,
                    "type" VARCHAR,
                    "value" VARCHAR
                ),
                "validation_domain" VARCHAR,
                "validation_emails" VARCHAR[],
                "validation_method" VARCHAR,
                "validation_status" VARCHAR
            )[],
            "extended_key_usages" STRUCT(
                "name" VARCHAR,
                "o_id" VARCHAR
            )[],
            "failure_reason" VARCHAR,
            "imported_at" VARCHAR,
            "in_use_by" VARCHAR[],
            "issued_at" VARCHAR,
            "issuer" VARCHAR,
            "key_algorithm" VARCHAR,
            "key_usages" STRUCT(
                "name" VARCHAR
            )[],
            "not_after" VARCHAR,
            "not_before" VARCHAR,
            "options" STRUCT(
                "certificate_transparency_logging_preference" VARCHAR
            ),
            "renewal_eligibility" VARCHAR,
            "renewal_summary" STRUCT(
                "domain_validation_options" STRUCT(
                    "domain_name" VARCHAR,
                    "resource_record" STRUCT(
                        "name" VARCHAR,
                        "type" VARCHAR,
                        "value" VARCHAR
                    ),
                    "validation_domain" VARCHAR,
                    "validation_emails" VARCHAR[],
                    "validation_method" VARCHAR,
                    "validation_status" VARCHAR
                )[],
                "renewal_status" VARCHAR,
                "renewal_status_reason" VARCHAR,
                "updated_at" VARCHAR
            ),
            "serial" VARCHAR,
            "signature_algorithm" VARCHAR,
            "status" VARCHAR,
            "subject" VARCHAR,
            "subject_alternative_names" VARCHAR[],
            "type" VARCHAR
        ),
        "aws_redshift_cluster" STRUCT(
            "allow_version_upgrade" BOOLEAN,
            "automated_snapshot_retention_period" BIGINT,
            "availability_zone" VARCHAR,
            "cluster_availability_status" VARCHAR,
            "cluster_create_time" VARCHAR,
            "cluster_identifier" VARCHAR,
            "cluster_nodes" STRUCT(
                "node_role" VARCHAR,
                "private_ip_address" VARCHAR,
                "public_ip_address" VARCHAR
            )[],
            "cluster_parameter_groups" STRUCT(
                "cluster_parameter_status_list" STRUCT(
                    "parameter_name" VARCHAR,
                    "parameter_apply_status" VARCHAR,
                    "parameter_apply_error_description" VARCHAR
                )[],
                "parameter_apply_status" VARCHAR,
                "parameter_group_name" VARCHAR
            )[],
            "cluster_public_key" VARCHAR,
            "cluster_revision_number" VARCHAR,
            "cluster_security_groups" STRUCT(
                "cluster_security_group_name" VARCHAR,
                "status" VARCHAR
            )[],
            "cluster_snapshot_copy_status" STRUCT(
                "destination_region" VARCHAR,
                "manual_snapshot_retention_period" BIGINT,
                "retention_period" BIGINT,
                "snapshot_copy_grant_name" VARCHAR
            ),
            "cluster_status" VARCHAR,
            "cluster_subnet_group_name" VARCHAR,
            "cluster_version" VARCHAR,
            "db_name" VARCHAR,
            "deferred_maintenance_windows" STRUCT(
                "defer_maintenance_end_time" VARCHAR,
                "defer_maintenance_identifier" VARCHAR,
                "defer_maintenance_start_time" VARCHAR
            )[],
            "elastic_ip_status" STRUCT(
                "elastic_ip" VARCHAR,
                "status" VARCHAR
            ),
            "elastic_resize_number_of_node_options" VARCHAR,
            "encrypted" BOOLEAN,
            "endpoint" STRUCT(
                "address" VARCHAR,
                "port" BIGINT
            ),
            "enhanced_vpc_routing" BOOLEAN,
            "expected_next_snapshot_schedule_time" VARCHAR,
            "expected_next_snapshot_schedule_time_status" VARCHAR,
            "hsm_status" STRUCT(
                "hsm_client_certificate_identifier" VARCHAR,
                "hsm_configuration_identifier" VARCHAR,
                "status" VARCHAR
            ),
            "iam_roles" STRUCT(
                "apply_status" VARCHAR,
                "iam_role_arn" VARCHAR
            )[],
            "kms_key_id" VARCHAR,
            "maintenance_track_name" VARCHAR,
            "manual_snapshot_retention_period" BIGINT,
            "master_username" VARCHAR,
            "next_maintenance_window_start_time" VARCHAR,
            "node_type" VARCHAR,
            "number_of_nodes" BIGINT,
            "pending_actions" VARCHAR[],
            "pending_modified_values" STRUCT(
                "automated_snapshot_retention_period" BIGINT,
                "cluster_identifier" VARCHAR,
                "cluster_type" VARCHAR,
                "cluster_version" VARCHAR,
                "encryption_type" VARCHAR,
                "enhanced_vpc_routing" BOOLEAN,
                "maintenance_track_name" VARCHAR,
                "master_user_password" VARCHAR,
                "node_type" VARCHAR,
                "number_of_nodes" BIGINT,
                "publicly_accessible" BOOLEAN
            ),
            "preferred_maintenance_window" VARCHAR,
            "publicly_accessible" BOOLEAN,
            "resize_info" STRUCT(
                "allow_cancel_resize" BOOLEAN,
                "resize_type" VARCHAR
            ),
            "restore_status" STRUCT(
                "current_restore_rate_in_mega_bytes_per_second" DOUBLE,
                "elapsed_time_in_seconds" BIGINT,
                "estimated_time_to_completion_in_seconds" BIGINT,
                "progress_in_mega_bytes" BIGINT,
                "snapshot_size_in_mega_bytes" BIGINT,
                "status" VARCHAR
            ),
            "snapshot_schedule_identifier" VARCHAR,
            "snapshot_schedule_state" VARCHAR,
            "vpc_id" VARCHAR,
            "vpc_security_groups" STRUCT(
                "status" VARCHAR,
                "vpc_security_group_id" VARCHAR
            )[],
            "logging_status" STRUCT(
                "bucket_name" VARCHAR,
                "last_failure_message" VARCHAR,
                "last_failure_time" VARCHAR,
                "last_successful_delivery_time" VARCHAR,
                "logging_enabled" BOOLEAN,
                "s3_key_prefix" VARCHAR
            )
        ),
        "aws_elb_load_balancer" STRUCT(
            "availability_zones" VARCHAR[],
            "backend_server_descriptions" STRUCT(
                "instance_port" BIGINT,
                "policy_names" VARCHAR[]
            )[],
            "canonical_hosted_zone_name" VARCHAR,
            "canonical_hosted_zone_name_id" VARCHAR,
            "created_time" VARCHAR,
            "dns_name" VARCHAR,
            "health_check" STRUCT(
                "healthy_threshold" BIGINT,
                "interval" BIGINT,
                "target" VARCHAR,
                "timeout" BIGINT,
                "unhealthy_threshold" BIGINT
            ),
            "instances" STRUCT(
                "instance_id" VARCHAR
            )[],
            "listener_descriptions" STRUCT(
                "listener" STRUCT(
                    "instance_port" BIGINT,
                    "instance_protocol" VARCHAR,
                    "load_balancer_port" BIGINT,
                    "protocol" VARCHAR,
                    "ssl_certificate_id" VARCHAR
                ),
                "policy_names" VARCHAR[]
            )[],
            "load_balancer_attributes" STRUCT(
                "access_log" STRUCT(
                    "emit_interval" BIGINT,
                    "enabled" BOOLEAN,
                    "s3_bucket_name" VARCHAR,
                    "s3_bucket_prefix" VARCHAR
                ),
                "connection_draining" STRUCT(
                    "enabled" BOOLEAN,
                    "timeout" BIGINT
                ),
                "connection_settings" STRUCT(
                    "idle_timeout" BIGINT
                ),
                "cross_zone_load_balancing" STRUCT(
                    "enabled" BOOLEAN
                ),
                "additional_attributes" STRUCT(
                    "key" VARCHAR,
                    "value" VARCHAR
                )[]
            ),
            "load_balancer_name" VARCHAR,
            "policies" STRUCT(
                "app_cookie_stickiness_policies" STRUCT(
                    "cookie_name" VARCHAR,
                    "policy_name" VARCHAR
                )[],
                "lb_cookie_stickiness_policies" STRUCT(
                    "cookie_expiration_period" BIGINT,
                    "policy_name" VARCHAR
                )[],
                "other_policies" VARCHAR[]
            ),
            "scheme" VARCHAR,
            "security_groups" VARCHAR[],
            "source_security_group" STRUCT(
                "group_name" VARCHAR,
                "owner_alias" VARCHAR
            ),
            "subnets" VARCHAR[],
            "vpc_id" VARCHAR
        ),
        "aws_iam_group" STRUCT(
            "attached_managed_policies" STRUCT(
                "policy_name" VARCHAR,
                "policy_arn" VARCHAR
            )[],
            "create_date" VARCHAR,
            "group_id" VARCHAR,
            "group_name" VARCHAR,
            "group_policy_list" STRUCT(
                "policy_name" VARCHAR
            )[],
            "path" VARCHAR
        ),
        "aws_iam_role" STRUCT(
            "assume_role_policy_document" VARCHAR,
            "attached_managed_policies" STRUCT(
                "policy_name" VARCHAR,
                "policy_arn" VARCHAR
            )[],
            "create_date" VARCHAR,
            "instance_profile_list" STRUCT(
                "arn" VARCHAR,
                "create_date" VARCHAR,
                "instance_profile_id" VARCHAR,
                "instance_profile_name" VARCHAR,
                "path" VARCHAR,
                "roles" STRUCT(
                    "arn" VARCHAR,
                    "assume_role_policy_document" VARCHAR,
                    "create_date" VARCHAR,
                    "path" VARCHAR,
                    "role_id" VARCHAR,
                    "role_name" VARCHAR
                )[]
            )[],
            "permissions_boundary" STRUCT(
                "permissions_boundary_arn" VARCHAR,
                "permissions_boundary_type" VARCHAR
            ),
            "role_id" VARCHAR,
            "role_name" VARCHAR,
            "role_policy_list" STRUCT(
                "policy_name" VARCHAR
            )[],
            "max_session_duration" BIGINT,
            "path" VARCHAR
        ),
        "aws_kms_key" STRUCT(
            "aws_account_id" VARCHAR,
            "creation_date" DOUBLE,
            "key_id" VARCHAR,
            "key_manager" VARCHAR,
            "key_state" VARCHAR,
            "origin" VARCHAR,
            "description" VARCHAR,
            "key_rotation_status" BOOLEAN
        ),
        "aws_lambda_function" STRUCT(
            "code" STRUCT(
                "s3_bucket" VARCHAR,
                "s3_key" VARCHAR,
                "s3_object_version" VARCHAR,
                "zip_file" VARCHAR
            ),
            "code_sha256" VARCHAR,
            "dead_letter_config" STRUCT(
                "target_arn" VARCHAR
            ),
            "environment" STRUCT(
                "variables" MAP(VARCHAR, VARCHAR),
                "error" STRUCT(
                    "error_code" VARCHAR,
                    "message" VARCHAR
                )
            ),
            "function_name" VARCHAR,
            "handler" VARCHAR,
            "kms_key_arn" VARCHAR,
            "last_modified" VARCHAR,
            "layers" STRUCT(
                "arn" VARCHAR,
                "code_size" BIGINT
            )[],
            "master_arn" VARCHAR,
            "memory_size" BIGINT,
            "revision_id" VARCHAR,
            "role" VARCHAR,
            "runtime" VARCHAR,
            "timeout" BIGINT,
            "tracing_config" STRUCT(
                "mode" VARCHAR
            ),
            "vpc_config" STRUCT(
                "security_group_ids" VARCHAR[],
                "subnet_ids" VARCHAR[],
                "vpc_id" VARCHAR
            ),
            "version" VARCHAR,
            "architectures" VARCHAR[],
            "package_type" VARCHAR
        ),
        "aws_lambda_layer_version" STRUCT(
            "version" BIGINT,
            "compatible_runtimes" VARCHAR[],
            "created_date" VARCHAR
        ),
        "aws_rds_db_instance" STRUCT(
            "associated_roles" STRUCT(
                "role_arn" VARCHAR,
                "feature_name" VARCHAR,
                "status" VARCHAR
            )[],
            "ca_certificate_identifier" VARCHAR,
            "db_cluster_identifier" VARCHAR,
            "db_instance_identifier" VARCHAR,
            "db_instance_class" VARCHAR,
            "db_instance_port" BIGINT,
            "dbi_resource_id" VARCHAR,
            "db_name" VARCHAR,
            "deletion_protection" BOOLEAN,
            "endpoint" STRUCT(
                "address" VARCHAR,
                "port" BIGINT,
                "hosted_zone_id" VARCHAR
            ),
            "engine" VARCHAR,
            "engine_version" VARCHAR,
            "iam_database_authentication_enabled" BOOLEAN,
            "instance_create_time" VARCHAR,
            "kms_key_id" VARCHAR,
            "publicly_accessible" BOOLEAN,
            "storage_encrypted" BOOLEAN,
            "tde_credential_arn" VARCHAR,
            "vpc_security_groups" STRUCT(
                "vpc_security_group_id" VARCHAR,
                "status" VARCHAR
            )[],
            "multi_az" BOOLEAN,
            "enhanced_monitoring_resource_arn" VARCHAR,
            "db_instance_status" VARCHAR,
            "master_username" VARCHAR,
            "allocated_storage" BIGINT,
            "preferred_backup_window" VARCHAR,
            "backup_retention_period" BIGINT,
            "db_security_groups" VARCHAR[],
            "db_parameter_groups" STRUCT(
                "db_parameter_group_name" VARCHAR,
                "parameter_apply_status" VARCHAR
            )[],
            "availability_zone" VARCHAR,
            "db_subnet_group" STRUCT(
                "db_subnet_group_name" VARCHAR,
                "db_subnet_group_description" VARCHAR,
                "vpc_id" VARCHAR,
                "subnet_group_status" VARCHAR,
                "subnets" STRUCT(
                    "subnet_identifier" VARCHAR,
                    "subnet_availability_zone" STRUCT(
                        "name" VARCHAR
                    ),
                    "subnet_status" VARCHAR
                )[],
                "db_subnet_group_arn" VARCHAR
            ),
            "preferred_maintenance_window" VARCHAR,
            "pending_modified_values" STRUCT(
                "db_instance_class" VARCHAR,
                "allocated_storage" BIGINT,
                "master_user_password" VARCHAR,
                "port" BIGINT,
                "backup_retention_period" BIGINT,
                "multi_az" BOOLEAN,
                "engine_version" VARCHAR,
                "license_model" VARCHAR,
                "iops" BIGINT,
                "db_instance_identifier" VARCHAR,
                "storage_type" VARCHAR,
                "ca_certificate_identifier" VARCHAR,
                "db_subnet_group_name" VARCHAR,
                "pending_cloud_watch_logs_exports" STRUCT(
                    "log_types_to_enable" VARCHAR[],
                    "log_types_to_disable" VARCHAR[]
                ),
                "processor_features" STRUCT(
                    "name" VARCHAR,
                    "value" VARCHAR
                )[]
            ),
            "latest_restorable_time" VARCHAR,
            "auto_minor_version_upgrade" BOOLEAN,
            "read_replica_source_db_instance_identifier" VARCHAR,
            "read_replica_db_instance_identifiers" VARCHAR[],
            "read_replica_db_cluster_identifiers" VARCHAR[],
            "license_model" VARCHAR,
            "iops" BIGINT,
            "option_group_memberships" STRUCT(
                "option_group_name" VARCHAR,
                "status" VARCHAR
            )[],
            "character_set_name" VARCHAR,
            "secondary_availability_zone" VARCHAR,
            "status_infos" STRUCT(
                "status_type" VARCHAR,
                "normal" BOOLEAN,
                "status" VARCHAR,
                "message" VARCHAR
            )[],
            "storage_type" VARCHAR,
            "domain_memberships" STRUCT(
                "domain" VARCHAR,
                "status" VARCHAR,
                "fqdn" VARCHAR,
                "iam_role_name" VARCHAR
            )[],
            "copy_tags_to_snapshot" BOOLEAN,
            "monitoring_interval" BIGINT,
            "monitoring_role_arn" VARCHAR,
            "promotion_tier" BIGINT,
            "timezone" VARCHAR,
            "performance_insights_enabled" BOOLEAN,
            "performance_insights_kms_key_id" VARCHAR,
            "performance_insights_retention_period" BIGINT,
            "enabled_cloud_watch_logs_exports" VARCHAR[],
            "processor_features" STRUCT(
                "name" VARCHAR,
                "value" VARCHAR
            )[],
            "listener_endpoint" STRUCT(
                "address" VARCHAR,
                "port" BIGINT,
                "hosted_zone_id" VARCHAR
            ),
            "max_allocated_storage" BIGINT
        ),
        "aws_sns_topic" STRUCT(
            "kms_master_key_id" VARCHAR,
            "subscription" STRUCT(
                "endpoint" VARCHAR,
                "protocol" VARCHAR
            )[],
            "topic_name" VARCHAR,
            "owner" VARCHAR,
            "sqs_success_feedback_role_arn" VARCHAR,
            "sqs_failure_feedback_role_arn" VARCHAR,
            "application_success_feedback_role_arn" VARCHAR,
            "firehose_success_feedback_role_arn" VARCHAR,
            "firehose_failure_feedback_role_arn" VARCHAR,
            "http_success_feedback_role_arn" VARCHAR,
            "http_failure_feedback_role_arn" VARCHAR
        ),
        "aws_sqs_queue" STRUCT(
            "kms_data_key_reuse_period_seconds" BIGINT,
            "kms_master_key_id" VARCHAR,
            "queue_name" VARCHAR,
            "dead_letter_target_arn" VARCHAR
        ),
        "aws_waf_web_acl" STRUCT(
            "name" VARCHAR,
            "default_action" VARCHAR,
            "rules" STRUCT(
                "action" STRUCT(
                    "type" VARCHAR
                ),
                "excluded_rules" STRUCT(
                    "rule_id" VARCHAR
                )[],
                "override_action" STRUCT(
                    "type" VARCHAR
                ),
                "priority" BIGINT,
                "rule_id" VARCHAR,
                "type" VARCHAR
            )[],
            "web_acl_id" VARCHAR
        ),
        "aws_rds_db_snapshot" STRUCT(
            "db_snapshot_identifier" VARCHAR,
            "db_instance_identifier" VARCHAR,
            "snapshot_create_time" VARCHAR,
            "engine" VARCHAR,
            "allocated_storage" BIGINT,
            "status" VARCHAR,
            "port" BIGINT,
            "availability_zone" VARCHAR,
            "vpc_id" VARCHAR,
            "instance_create_time" VARCHAR,
            "master_username" VARCHAR,
            "engine_version" VARCHAR,
            "license_model" VARCHAR,
            "snapshot_type" VARCHAR,
            "iops" BIGINT,
            "option_group_name" VARCHAR,
            "percent_progress" BIGINT,
            "source_region" VARCHAR,
            "source_db_snapshot_identifier" VARCHAR,
            "storage_type" VARCHAR,
            "tde_credential_arn" VARCHAR,
            "encrypted" BOOLEAN,
            "kms_key_id" VARCHAR,
            "timezone" VARCHAR,
            "iam_database_authentication_enabled" BOOLEAN,
            "processor_features" STRUCT(
                "name" VARCHAR,
                "value" VARCHAR
            )[],
            "dbi_resource_id" VARCHAR
        ),
        "aws_rds_db_cluster_snapshot" STRUCT(
            "availability_zones" VARCHAR[],
            "snapshot_create_time" VARCHAR,
            "engine" VARCHAR,
            "allocated_storage" BIGINT,
            "status" VARCHAR,
            "port" BIGINT,
            "vpc_id" VARCHAR,
            "cluster_create_time" VARCHAR,
            "master_username" VARCHAR,
            "engine_version" VARCHAR,
            "license_model" VARCHAR,
            "snapshot_type" VARCHAR,
            "percent_progress" BIGINT,
            "storage_encrypted" BOOLEAN,
            "kms_key_id" VARCHAR,
            "db_cluster_identifier" VARCHAR,
            "db_cluster_snapshot_identifier" VARCHAR,
            "iam_database_authentication_enabled" BOOLEAN,
            "db_cluster_snapshot_attributes" STRUCT(
                "attribute_name" VARCHAR,
                "attribute_values" VARCHAR[]
            )[]
        ),
        "aws_rds_db_cluster" STRUCT(
            "allocated_storage" BIGINT,
            "availability_zones" VARCHAR[],
            "backup_retention_period" BIGINT,
            "database_name" VARCHAR,
            "status" VARCHAR,
            "endpoint" VARCHAR,
            "reader_endpoint" VARCHAR,
            "custom_endpoints" VARCHAR[],
            "multi_az" BOOLEAN,
            "engine" VARCHAR,
            "engine_version" VARCHAR,
            "port" BIGINT,
            "master_username" VARCHAR,
            "preferred_backup_window" VARCHAR,
            "preferred_maintenance_window" VARCHAR,
            "read_replica_identifiers" VARCHAR[],
            "vpc_security_groups" STRUCT(
                "vpc_security_group_id" VARCHAR,
                "status" VARCHAR
            )[],
            "hosted_zone_id" VARCHAR,
            "storage_encrypted" BOOLEAN,
            "kms_key_id" VARCHAR,
            "db_cluster_resource_id" VARCHAR,
            "associated_roles" STRUCT(
                "role_arn" VARCHAR,
                "status" VARCHAR
            )[],
            "cluster_create_time" VARCHAR,
            "enabled_cloud_watch_logs_exports" VARCHAR[],
            "engine_mode" VARCHAR,
            "deletion_protection" BOOLEAN,
            "http_endpoint_enabled" BOOLEAN,
            "activity_stream_status" VARCHAR,
            "copy_tags_to_snapshot" BOOLEAN,
            "cross_account_clone" BOOLEAN,
            "domain_memberships" STRUCT(
                "domain" VARCHAR,
                "status" VARCHAR,
                "fqdn" VARCHAR,
                "iam_role_name" VARCHAR
            )[],
            "db_cluster_parameter_group" VARCHAR,
            "db_subnet_group" VARCHAR,
            "db_cluster_option_group_memberships" STRUCT(
                "db_cluster_option_group_name" VARCHAR,
                "status" VARCHAR
            )[],
            "db_cluster_identifier" VARCHAR,
            "db_cluster_members" STRUCT(
                "is_cluster_writer" BOOLEAN,
                "promotion_tier" BIGINT,
                "db_instance_identifier" VARCHAR,
                "db_cluster_parameter_group_status" VARCHAR
            )[],
            "iam_database_authentication_enabled" BOOLEAN,
            "auto_minor_version_upgrade" BOOLEAN
        ),
        "aws_ecs_cluster" STRUCT(
            "cluster_arn" VARCHAR,
            "active_services_count" BIGINT,
            "capacity_providers" VARCHAR[],
            "cluster_settings" STRUCT(
                "name" VARCHAR,
                "value" VARCHAR
            )[],
            "configuration" STRUCT(
                "execute_command_configuration" STRUCT(
                    "kms_key_id" VARCHAR,
                    "log_configuration" STRUCT(
                        "cloud_watch_encryption_enabled" BOOLEAN,
                        "cloud_watch_log_group_name" VARCHAR,
                        "s3_bucket_name" VARCHAR,
                        "s3_encryption_enabled" BOOLEAN,
                        "s3_key_prefix" VARCHAR
                    ),
                    "logging" VARCHAR
                )
            ),
            "default_capacity_provider_strategy" STRUCT(
                "base" BIGINT,
                "capacity_provider" VARCHAR,
                "weight" BIGINT
            )[],
            "cluster_name" VARCHAR,
            "registered_container_instances_count" BIGINT,
            "running_tasks_count" BIGINT,
            "status" VARCHAR
        ),
        "aws_ecs_container" STRUCT(
            "name" VARCHAR,
            "image" VARCHAR,
            "mount_points" STRUCT(
                "source_volume" VARCHAR,
                "container_path" VARCHAR
            )[],
            "privileged" BOOLEAN
        ),
        "aws_ecs_task_definition" STRUCT(
            "container_definitions" STRUCT(
                "command" VARCHAR[],
                "cpu" BIGINT,
                "depends_on" STRUCT(
                    "condition" VARCHAR,
                    "container_name" VARCHAR
                )[],
                "disable_networking" BOOLEAN,
                "dns_search_domains" VARCHAR[],
                "dns_servers" VARCHAR[],
                "docker_labels" MAP(VARCHAR, VARCHAR),
                "docker_security_options" VARCHAR[],
                "entry_point" VARCHAR[],
                "environment" STRUCT(
                    "name" VARCHAR,
                    "value" VARCHAR
                )[],
                "environment_files" STRUCT(
                    "type" VARCHAR,
                    "value" VARCHAR
                )[],
                "essential" BOOLEAN,
                "extra_hosts" STRUCT(
                    "hostname" VARCHAR,
                    "ip_address" VARCHAR
                )[],
                "firelens_configuration" STRUCT(
                    "options" MAP(VARCHAR, VARCHAR),
                    "type" VARCHAR
                ),
                "health_check" STRUCT(
                    "command" VARCHAR[],
                    "interval" BIGINT,
                    "retries" BIGINT,
                    "start_period" BIGINT,
                    "timeout" BIGINT
                ),
                "hostname" VARCHAR,
                "image" VARCHAR,
                "interactive" BOOLEAN,
                "links" VARCHAR[],
                "linux_parameters" STRUCT(
                    "capabilities" STRUCT(
                        "add" VARCHAR[],
                        "drop" VARCHAR[]
                    ),
                    "devices" STRUCT(
                        "container_path" VARCHAR,
                        "host_path" VARCHAR,
                        "permissions" VARCHAR[]
                    )[],
                    "init_process_enabled" BOOLEAN,
                    "max_swap" BIGINT,
                    "shared_memory_size" BIGINT,
                    "swappiness" BIGINT,
                    "tmpfs" STRUCT(
                        "container_path" VARCHAR,
                        "mount_options" VARCHAR[],
                        "size" BIGINT
                    )[]
                ),
                "log_configuration" STRUCT(
                    "log_driver" VARCHAR,
                    "options" MAP(VARCHAR, VARCHAR),
                    "secret_options" STRUCT(
                        "name" VARCHAR,
                        "value_from" VARCHAR
                    )[]
                ),
                "memory" BIGINT,
                "memory_reservation" BIGINT,
                "mount_points" STRUCT(
                    "container_path" VARCHAR,
                    "read_only" BOOLEAN,
                    "source_volume" VARCHAR
                )[],
                "name" VARCHAR,
                "port_mappings" STRUCT(
                    "container_port" BIGINT,
                    "host_port" BIGINT,
                    "protocol" VARCHAR
                )[],
                "privileged" BOOLEAN,
                "pseudo_terminal" BOOLEAN,
                "readonly_root_filesystem" BOOLEAN,
                "repository_credentials" STRUCT(
                    "credentials_parameter" VARCHAR
                ),
                "resource_requirements" STRUCT(
                    "type" VARCHAR,
                    "value" VARCHAR
                )[],
                "secrets" STRUCT(
                    "name" VARCHAR,
                    "value_from" VARCHAR
                )[],
                "start_timeout" BIGINT,
                "stop_timeout" BIGINT,
                "system_controls" STRUCT(
                    "namespace" VARCHAR,
                    "value" VARCHAR
                )[],
                "ulimits" STRUCT(
                    "hard_limit" BIGINT,
                    "name" VARCHAR,
                    "soft_limit" BIGINT
                )[],
                "user" VARCHAR,
                "volumes_from" STRUCT(
                    "read_only" BOOLEAN,
                    "source_container" VARCHAR
                )[],
                "working_directory" VARCHAR
            )[],
            "cpu" VARCHAR,
            "execution_role_arn" VARCHAR,
            "family" VARCHAR,
            "inference_accelerators" STRUCT(
                "device_name" VARCHAR,
                "device_type" VARCHAR
            )[],
            "ipc_mode" VARCHAR,
            "memory" VARCHAR,
            "network_mode" VARCHAR,
            "pid_mode" VARCHAR,
            "placement_constraints" STRUCT(
                "expression" VARCHAR,
                "type" VARCHAR
            )[],
            "proxy_configuration" STRUCT(
                "container_name" VARCHAR,
                "proxy_configuration_properties" STRUCT(
                    "name" VARCHAR,
                    "value" VARCHAR
                )[],
                "type" VARCHAR
            ),
            "requires_compatibilities" VARCHAR[],
            "task_role_arn" VARCHAR,
            "volumes" STRUCT(
                "docker_volume_configuration" STRUCT(
                    "autoprovision" BOOLEAN,
                    "driver" VARCHAR,
                    "driver_opts" MAP(VARCHAR, VARCHAR),
                    "labels" MAP(VARCHAR, VARCHAR),
                    "scope" VARCHAR
                ),
                "efs_volume_configuration" STRUCT(
                    "authorization_config" STRUCT(
                        "access_point_id" VARCHAR,
                        "iam" VARCHAR
                    ),
                    "filesystem_id" VARCHAR,
                    "root_directory" VARCHAR,
                    "transit_encryption" VARCHAR,
                    "transit_encryption_port" BIGINT
                ),
                "host" STRUCT(
                    "source_path" VARCHAR
                ),
                "name" VARCHAR
            )[],
            "status" VARCHAR
        ),
        "container" STRUCT(
            "container_runtime" VARCHAR,
            "name" VARCHAR,
            "image_id" VARCHAR,
            "image_name" VARCHAR,
            "launched_at" VARCHAR,
            "volume_mounts" STRUCT(
                "name" VARCHAR,
                "mount_path" VARCHAR
            )[],
            "privileged" BOOLEAN
        ),
        "other" MAP(VARCHAR, VARCHAR),
        "aws_rds_event_subscription" STRUCT(
            "cust_subscription_id" VARCHAR,
            "customer_aws_id" VARCHAR,
            "enabled" BOOLEAN,
            "event_categories_list" VARCHAR[],
            "event_subscription_arn" VARCHAR,
            "sns_topic_arn" VARCHAR,
            "source_ids_list" VARCHAR[],
            "source_type" VARCHAR,
            "status" VARCHAR,
            "subscription_creation_time" VARCHAR
        ),
        "aws_ecs_service" STRUCT(
            "capacity_provider_strategy" STRUCT(
                "base" BIGINT,
                "capacity_provider" VARCHAR,
                "weight" BIGINT
            )[],
            "cluster" VARCHAR,
            "deployment_configuration" STRUCT(
                "deployment_circuit_breaker" STRUCT(
                    "enable" BOOLEAN,
                    "rollback" BOOLEAN
                ),
                "maximum_percent" BIGINT,
                "minimum_healthy_percent" BIGINT
            ),
            "deployment_controller" STRUCT(
                "type" VARCHAR
            ),
            "desired_count" BIGINT,
            "enable_ecs_managed_tags" BOOLEAN,
            "enable_execute_command" BOOLEAN,
            "health_check_grace_period_seconds" BIGINT,
            "launch_type" VARCHAR,
            "load_balancers" STRUCT(
                "container_name" VARCHAR,
                "container_port" BIGINT,
                "load_balancer_name" VARCHAR,
                "target_group_arn" VARCHAR
            )[],
            "name" VARCHAR,
            "network_configuration" STRUCT(
                "aws_vpc_configuration" STRUCT(
                    "assign_public_ip" VARCHAR,
                    "security_groups" VARCHAR[],
                    "subnets" VARCHAR[]
                )
            ),
            "placement_constraints" STRUCT(
                "expression" VARCHAR,
                "type" VARCHAR
            )[],
            "placement_strategies" STRUCT(
                "field" VARCHAR,
                "type" VARCHAR
            )[],
            "platform_version" VARCHAR,
            "propagate_tags" VARCHAR,
            "role" VARCHAR,
            "scheduling_strategy" VARCHAR,
            "service_arn" VARCHAR,
            "service_name" VARCHAR,
            "service_registries" STRUCT(
                "container_name" VARCHAR,
                "container_port" BIGINT,
                "port" BIGINT,
                "registry_arn" VARCHAR
            )[],
            "task_definition" VARCHAR
        ),
        "aws_auto_scaling_launch_configuration" STRUCT(
            "associate_public_ip_address" BOOLEAN,
            "block_device_mappings" STRUCT(
                "device_name" VARCHAR,
                "ebs" STRUCT(
                    "delete_on_termination" BOOLEAN,
                    "encrypted" BOOLEAN,
                    "iops" BIGINT,
                    "snapshot_id" VARCHAR,
                    "volume_size" BIGINT,
                    "volume_type" VARCHAR
                ),
                "no_device" BOOLEAN,
                "virtual_name" VARCHAR
            )[],
            "classic_link_vpc_id" VARCHAR,
            "classic_link_vpc_security_groups" VARCHAR[],
            "created_time" VARCHAR,
            "ebs_optimized" BOOLEAN,
            "iam_instance_profile" VARCHAR,
            "image_id" VARCHAR,
            "instance_monitoring" STRUCT(
                "enabled" BOOLEAN
            ),
            "instance_type" VARCHAR,
            "kernel_id" VARCHAR,
            "key_name" VARCHAR,
            "launch_configuration_name" VARCHAR,
            "placement_tenancy" VARCHAR,
            "ramdisk_id" VARCHAR,
            "security_groups" VARCHAR[],
            "spot_price" VARCHAR,
            "user_data" VARCHAR,
            "metadata_options" STRUCT(
                "http_endpoint" VARCHAR,
                "http_put_response_hop_limit" BIGINT,
                "http_tokens" VARCHAR
            )
        ),
        "aws_ec2_vpn_connection" STRUCT(
            "vpn_connection_id" VARCHAR,
            "state" VARCHAR,
            "customer_gateway_id" VARCHAR,
            "customer_gateway_configuration" VARCHAR,
            "type" VARCHAR,
            "vpn_gateway_id" VARCHAR,
            "category" VARCHAR,
            "vgw_telemetry" STRUCT(
                "accepted_route_count" BIGINT,
                "certificate_arn" VARCHAR,
                "last_status_change" VARCHAR,
                "outside_ip_address" VARCHAR,
                "status" VARCHAR,
                "status_message" VARCHAR
            )[],
            "options" STRUCT(
                "static_routes_only" BOOLEAN,
                "tunnel_options" STRUCT(
                    "dpd_timeout_seconds" BIGINT,
                    "ike_versions" VARCHAR[],
                    "outside_ip_address" VARCHAR,
                    "phase1_dh_group_numbers" BIGINT[],
                    "phase1_encryption_algorithms" VARCHAR[],
                    "phase1_integrity_algorithms" VARCHAR[],
                    "phase1_lifetime_seconds" BIGINT,
                    "phase2_dh_group_numbers" BIGINT[],
                    "phase2_encryption_algorithms" VARCHAR[],
                    "phase2_integrity_algorithms" VARCHAR[],
                    "phase2_lifetime_seconds" BIGINT,
                    "pre_shared_key" VARCHAR,
                    "rekey_fuzz_percentage" BIGINT,
                    "rekey_margin_time_seconds" BIGINT,
                    "replay_window_size" BIGINT,
                    "tunnel_inside_cidr" VARCHAR
                )[]
            ),
            "routes" STRUCT(
                "destination_cidr_block" VARCHAR,
                "state" VARCHAR
            )[],
            "transit_gateway_id" VARCHAR
        ),
        "aws_ecr_container_image" STRUCT(
            "registry_id" VARCHAR,
            "repository_name" VARCHAR,
            "architecture" VARCHAR,
            "image_digest" VARCHAR,
            "image_tags" VARCHAR[],
            "image_published_at" VARCHAR
        ),
        "aws_open_search_service_domain" STRUCT(
            "arn" VARCHAR,
            "access_policies" VARCHAR,
            "domain_name" VARCHAR,
            "id" VARCHAR,
            "domain_endpoint" VARCHAR,
            "engine_version" VARCHAR,
            "encryption_at_rest_options" STRUCT(
                "enabled" BOOLEAN,
                "kms_key_id" VARCHAR
            ),
            "node_to_node_encryption_options" STRUCT(
                "enabled" BOOLEAN
            ),
            "service_software_options" STRUCT(
                "automated_update_date" VARCHAR,
                "cancellable" BOOLEAN,
                "current_version" VARCHAR,
                "description" VARCHAR,
                "new_version" VARCHAR,
                "update_available" BOOLEAN,
                "update_status" VARCHAR,
                "optional_deployment" BOOLEAN
            ),
            "cluster_config" STRUCT(
                "instance_count" BIGINT,
                "warm_enabled" BOOLEAN,
                "warm_count" BIGINT,
                "dedicated_master_enabled" BOOLEAN,
                "zone_awareness_config" STRUCT(
                    "availability_zone_count" BIGINT
                ),
                "dedicated_master_count" BIGINT,
                "instance_type" VARCHAR,
                "warm_type" VARCHAR,
                "zone_awareness_enabled" BOOLEAN,
                "dedicated_master_type" VARCHAR
            ),
            "domain_endpoint_options" STRUCT(
                "custom_endpoint_certificate_arn" VARCHAR,
                "custom_endpoint_enabled" BOOLEAN,
                "enforce_https" BOOLEAN,
                "custom_endpoint" VARCHAR,
                "tls_security_policy" VARCHAR
            ),
            "vpc_options" STRUCT(
                "security_group_ids" VARCHAR[],
                "subnet_ids" VARCHAR[]
            ),
            "log_publishing_options" STRUCT(
                "index_slow_logs" STRUCT(
                    "cloud_watch_logs_log_group_arn" VARCHAR,
                    "enabled" BOOLEAN
                ),
                "search_slow_logs" STRUCT(
                    "cloud_watch_logs_log_group_arn" VARCHAR,
                    "enabled" BOOLEAN
                ),
                "audit_logs" STRUCT(
                    "cloud_watch_logs_log_group_arn" VARCHAR,
                    "enabled" BOOLEAN
                )
            ),
            "domain_endpoints" MAP(VARCHAR, VARCHAR),
            "advanced_security_options" STRUCT(
                "enabled" BOOLEAN,
                "internal_user_database_enabled" BOOLEAN,
                "master_user_options" STRUCT(
                    "master_user_arn" VARCHAR,
                    "master_user_name" VARCHAR,
                    "master_user_password" VARCHAR
                )
            )
        ),
        "aws_ec2_vpc_endpoint_service" STRUCT(
            "acceptance_required" BOOLEAN,
            "availability_zones" VARCHAR[],
            "base_endpoint_dns_names" VARCHAR[],
            "manages_vpc_endpoints" BOOLEAN,
            "gateway_load_balancer_arns" VARCHAR[],
            "network_load_balancer_arns" VARCHAR[],
            "private_dns_name" VARCHAR,
            "service_id" VARCHAR,
            "service_name" VARCHAR,
            "service_state" VARCHAR,
            "service_type" STRUCT(
                "service_type" VARCHAR
            )[]
        ),
        "aws_xray_encryption_config" STRUCT(
            "key_id" VARCHAR,
            "status" VARCHAR,
            "type" VARCHAR
        ),
        "aws_waf_rate_based_rule" STRUCT(
            "metric_name" VARCHAR,
            "name" VARCHAR,
            "rate_key" VARCHAR,
            "rate_limit" BIGINT,
            "rule_id" VARCHAR,
            "match_predicates" STRUCT(
                "data_id" VARCHAR,
                "negated" BOOLEAN,
                "type" VARCHAR
            )[]
        ),
        "aws_waf_regional_rate_based_rule" STRUCT(
            "metric_name" VARCHAR,
            "name" VARCHAR,
            "rate_key" VARCHAR,
            "rate_limit" BIGINT,
            "rule_id" VARCHAR,
            "match_predicates" STRUCT(
                "data_id" VARCHAR,
                "negated" BOOLEAN,
                "type" VARCHAR
            )[]
        ),
        "aws_ecr_repository" STRUCT(
            "arn" VARCHAR,
            "image_scanning_configuration" STRUCT(
                "scan_on_push" BOOLEAN
            ),
            "image_tag_mutability" VARCHAR,
            "lifecycle_policy" STRUCT(
                "lifecycle_policy_text" VARCHAR,
                "registry_id" VARCHAR
            ),
            "repository_name" VARCHAR,
            "repository_policy_text" VARCHAR
        ),
        "aws_eks_cluster" STRUCT(
            "arn" VARCHAR,
            "certificate_authority_data" VARCHAR,
            "cluster_status" VARCHAR,
            "endpoint" VARCHAR,
            "name" VARCHAR,
            "resources_vpc_config" STRUCT(
                "security_group_ids" VARCHAR[],
                "subnet_ids" VARCHAR[],
                "endpoint_public_access" BOOLEAN
            ),
            "role_arn" VARCHAR,
            "version" VARCHAR,
            "logging" STRUCT(
                "cluster_logging" STRUCT(
                    "enabled" BOOLEAN,
                    "types" VARCHAR[]
                )[]
            )
        ),
        "aws_network_firewall_firewall_policy" STRUCT(
            "firewall_policy" STRUCT(
                "stateful_rule_group_references" STRUCT(
                    "resource_arn" VARCHAR
                )[],
                "stateless_custom_actions" STRUCT(
                    "action_definition" STRUCT(
                        "publish_metric_action" STRUCT(
                            "dimensions" STRUCT(
                                "value" VARCHAR
                            )[]
                        )
                    ),
                    "action_name" VARCHAR
                )[],
                "stateless_default_actions" VARCHAR[],
                "stateless_fragment_default_actions" VARCHAR[],
                "stateless_rule_group_references" STRUCT(
                    "priority" BIGINT,
                    "resource_arn" VARCHAR
                )[]
            ),
            "firewall_policy_arn" VARCHAR,
            "firewall_policy_id" VARCHAR,
            "firewall_policy_name" VARCHAR,
            "description" VARCHAR
        ),
        "aws_network_firewall_firewall" STRUCT(
            "delete_protection" BOOLEAN,
            "description" VARCHAR,
            "firewall_arn" VARCHAR,
            "firewall_id" VARCHAR,
            "firewall_name" VARCHAR,
            "firewall_policy_arn" VARCHAR,
            "firewall_policy_change_protection" BOOLEAN,
            "subnet_change_protection" BOOLEAN,
            "subnet_mappings" STRUCT(
                "subnet_id" VARCHAR
            )[],
            "vpc_id" VARCHAR
        ),
        "aws_network_firewall_rule_group" STRUCT(
            "capacity" BIGINT,
            "description" VARCHAR,
            "rule_group" STRUCT(
                "rule_variables" STRUCT(
                    "ip_sets" STRUCT(
                        "definition" VARCHAR[]
                    ),
                    "port_sets" STRUCT(
                        "definition" VARCHAR[]
                    )
                ),
                "rules_source" STRUCT(
                    "rules_source_list" STRUCT(
                        "generated_rules_type" VARCHAR,
                        "target_types" VARCHAR[],
                        "targets" VARCHAR[]
                    ),
                    "rules_string" VARCHAR,
                    "stateful_rules" STRUCT(
                        "action" VARCHAR,
                        "header" STRUCT(
                            "destination" VARCHAR,
                            "destination_port" VARCHAR,
                            "direction" VARCHAR,
                            "protocol" VARCHAR,
                            "source" VARCHAR,
                            "source_port" VARCHAR
                        ),
                        "rule_options" STRUCT(
                            "keyword" VARCHAR,
                            "settings" VARCHAR[]
                        )[]
                    )[],
                    "stateless_rules_and_custom_actions" STRUCT(
                        "custom_actions" STRUCT(
                            "action_definition" STRUCT(
                                "publish_metric_action" STRUCT(
                                    "dimensions" STRUCT(
                                        "value" VARCHAR
                                    )[]
                                )
                            ),
                            "action_name" VARCHAR
                        )[],
                        "stateless_rules" STRUCT(
                            "priority" BIGINT,
                            "rule_definition" STRUCT(
                                "actions" VARCHAR[],
                                "match_attributes" STRUCT(
                                    "destination_ports" STRUCT(
                                        "from_port" BIGINT,
                                        "to_port" BIGINT
                                    )[],
                                    "destinations" STRUCT(
                                        "address_definition" VARCHAR
                                    )[],
                                    "protocols" BIGINT[],
                                    "source_ports" STRUCT(
                                        "from_port" BIGINT,
                                        "to_port" BIGINT
                                    )[],
                                    "sources" STRUCT(
                                        "address_definition" VARCHAR
                                    )[],
                                    "tcp_flags" STRUCT(
                                        "flags" VARCHAR[],
                                        "masks" VARCHAR[]
                                    )[]
                                )
                            )
                        )[]
                    )
                )
            ),
            "rule_group_arn" VARCHAR,
            "rule_group_id" VARCHAR,
            "rule_group_name" VARCHAR,
            "type" VARCHAR
        ),
        "aws_rds_db_security_group" STRUCT(
            "db_security_group_arn" VARCHAR,
            "db_security_group_description" VARCHAR,
            "db_security_group_name" VARCHAR,
            "ec2_security_groups" STRUCT(
                "ec2_security_group_id" VARCHAR,
                "ec2_security_group_name" VARCHAR,
                "ec2_security_group_owner_id" VARCHAR,
                "status" VARCHAR
            )[],
            "ip_ranges" STRUCT(
                "cidr_ip" VARCHAR,
                "status" VARCHAR
            )[],
            "owner_id" VARCHAR,
            "vpc_id" VARCHAR
        ),
        "aws_kinesis_stream" STRUCT(
            "name" VARCHAR,
            "arn" VARCHAR,
            "stream_encryption" STRUCT(
                "encryption_type" VARCHAR,
                "key_id" VARCHAR
            ),
            "shard_count" BIGINT,
            "retention_period_hours" BIGINT
        ),
        "aws_ec2_transit_gateway" STRUCT(
            "id" VARCHAR,
            "description" VARCHAR,
            "default_route_table_propagation" VARCHAR,
            "auto_accept_shared_attachments" VARCHAR,
            "default_route_table_association" VARCHAR,
            "transit_gateway_cidr_blocks" VARCHAR[],
            "association_default_route_table_id" VARCHAR,
            "propagation_default_route_table_id" VARCHAR,
            "vpn_ecmp_support" VARCHAR,
            "dns_support" VARCHAR,
            "multicast_support" VARCHAR,
            "amazon_side_asn" BIGINT
        ),
        "aws_efs_access_point" STRUCT(
            "access_point_id" VARCHAR,
            "arn" VARCHAR,
            "client_token" VARCHAR,
            "file_system_id" VARCHAR,
            "posix_user" STRUCT(
                "gid" VARCHAR,
                "secondary_gids" VARCHAR[],
                "uid" VARCHAR
            ),
            "root_directory" STRUCT(
                "creation_info" STRUCT(
                    "owner_gid" VARCHAR,
                    "owner_uid" VARCHAR,
                    "permissions" VARCHAR
                ),
                "path" VARCHAR
            )
        ),
        "aws_cloud_formation_stack" STRUCT(
            "capabilities" VARCHAR[],
            "creation_time" VARCHAR,
            "description" VARCHAR,
            "disable_rollback" BOOLEAN,
            "drift_information" STRUCT(
                "stack_drift_status" VARCHAR
            ),
            "enable_termination_protection" BOOLEAN,
            "last_updated_time" VARCHAR,
            "notification_arns" VARCHAR[],
            "outputs" STRUCT(
                "description" VARCHAR,
                "output_key" VARCHAR,
                "output_value" VARCHAR
            )[],
            "role_arn" VARCHAR,
            "stack_id" VARCHAR,
            "stack_name" VARCHAR,
            "stack_status" VARCHAR,
            "stack_status_reason" VARCHAR,
            "timeout_in_minutes" BIGINT
        ),
        "aws_cloud_watch_alarm" STRUCT(
            "actions_enabled" BOOLEAN,
            "alarm_actions" VARCHAR[],
            "alarm_arn" VARCHAR,
            "alarm_configuration_updated_timestamp" VARCHAR,
            "alarm_description" VARCHAR,
            "alarm_name" VARCHAR,
            "comparison_operator" VARCHAR,
            "datapoints_to_alarm" BIGINT,
            "dimensions" STRUCT(
                "name" VARCHAR,
                "value" VARCHAR
            )[],
            "evaluate_low_sample_count_percentile" VARCHAR,
            "evaluation_periods" BIGINT,
            "extended_statistic" VARCHAR,
            "insufficient_data_actions" VARCHAR[],
            "metric_name" VARCHAR,
            "namespace" VARCHAR,
            "ok_actions" VARCHAR[],
            "period" BIGINT,
            "statistic" VARCHAR,
            "threshold" DOUBLE,
            "threshold_metric_id" VARCHAR,
            "treat_missing_data" VARCHAR,
            "unit" VARCHAR
        ),
        "aws_ec2_vpc_peering_connection" STRUCT(
            "accepter_vpc_info" STRUCT(
                "cidr_block" VARCHAR,
                "cidr_block_set" STRUCT(
                    "cidr_block" VARCHAR
                )[],
                "ipv6_cidr_block_set" STRUCT(
                    "ipv6_cidr_block" VARCHAR
                )[],
                "owner_id" VARCHAR,
                "peering_options" STRUCT(
                    "allow_dns_resolution_from_remote_vpc" BOOLEAN,
                    "allow_egress_from_local_classic_link_to_remote_vpc" BOOLEAN,
                    "allow_egress_from_local_vpc_to_remote_classic_link" BOOLEAN
                ),
                "region" VARCHAR,
                "vpc_id" VARCHAR
            ),
            "expiration_time" VARCHAR,
            "requester_vpc_info" STRUCT(
                "cidr_block" VARCHAR,
                "cidr_block_set" STRUCT(
                    "cidr_block" VARCHAR
                )[],
                "ipv6_cidr_block_set" STRUCT(
                    "ipv6_cidr_block" VARCHAR
                )[],
                "owner_id" VARCHAR,
                "peering_options" STRUCT(
                    "allow_dns_resolution_from_remote_vpc" BOOLEAN,
                    "allow_egress_from_local_classic_link_to_remote_vpc" BOOLEAN,
                    "allow_egress_from_local_vpc_to_remote_classic_link" BOOLEAN
                ),
                "region" VARCHAR,
                "vpc_id" VARCHAR
            ),
            "status" STRUCT(
                "code" VARCHAR,
                "message" VARCHAR
            ),
            "vpc_peering_connection_id" VARCHAR
        ),
        "aws_waf_regional_rule_group" STRUCT(
            "metric_name" VARCHAR,
            "name" VARCHAR,
            "rule_group_id" VARCHAR,
            "rules" STRUCT(
                "action" STRUCT(
                    "type" VARCHAR
                ),
                "priority" BIGINT,
                "rule_id" VARCHAR,
                "type" VARCHAR
            )[]
        ),
        "aws_waf_regional_rule" STRUCT(
            "metric_name" VARCHAR,
            "name" VARCHAR,
            "predicate_list" STRUCT(
                "data_id" VARCHAR,
                "negated" BOOLEAN,
                "type" VARCHAR
            )[],
            "rule_id" VARCHAR
        ),
        "aws_waf_regional_web_acl" STRUCT(
            "default_action" VARCHAR,
            "metric_name" VARCHAR,
            "name" VARCHAR,
            "rules_list" STRUCT(
                "action" STRUCT(
                    "type" VARCHAR
                ),
                "override_action" STRUCT(
                    "type" VARCHAR
                ),
                "priority" BIGINT,
                "rule_id" VARCHAR,
                "type" VARCHAR
            )[],
            "web_acl_id" VARCHAR
        ),
        "aws_waf_rule" STRUCT(
            "metric_name" VARCHAR,
            "name" VARCHAR,
            "predicate_list" STRUCT(
                "data_id" VARCHAR,
                "negated" BOOLEAN,
                "type" VARCHAR
            )[],
            "rule_id" VARCHAR
        ),
        "aws_waf_rule_group" STRUCT(
            "metric_name" VARCHAR,
            "name" VARCHAR,
            "rule_group_id" VARCHAR,
            "rules" STRUCT(
                "action" STRUCT(
                    "type" VARCHAR
                ),
                "priority" BIGINT,
                "rule_id" VARCHAR,
                "type" VARCHAR
            )[]
        ),
        "aws_ecs_task" STRUCT(
            "cluster_arn" VARCHAR,
            "task_definition_arn" VARCHAR,
            "version" VARCHAR,
            "created_at" VARCHAR,
            "started_at" VARCHAR,
            "started_by" VARCHAR,
            "group" VARCHAR,
            "volumes" STRUCT(
                "name" VARCHAR,
                "host" STRUCT(
                    "source_path" VARCHAR
                )
            )[],
            "containers" STRUCT(
                "name" VARCHAR,
                "image" VARCHAR,
                "mount_points" STRUCT(
                    "source_volume" VARCHAR,
                    "container_path" VARCHAR
                )[],
                "privileged" BOOLEAN
            )[]
        ),
        "aws_backup_backup_vault" STRUCT(
            "backup_vault_arn" VARCHAR,
            "backup_vault_name" VARCHAR,
            "encryption_key_arn" VARCHAR,
            "notifications" STRUCT(
                "backup_vault_events" VARCHAR[],
                "sns_topic_arn" VARCHAR
            ),
            "access_policy" VARCHAR
        ),
        "aws_backup_backup_plan" STRUCT(
            "backup_plan" STRUCT(
                "backup_plan_name" VARCHAR,
                "advanced_backup_settings" STRUCT(
                    "backup_options" MAP(VARCHAR, VARCHAR),
                    "resource_type" VARCHAR
                )[],
                "backup_plan_rule" STRUCT(
                    "target_backup_vault" VARCHAR,
                    "start_window_minutes" BIGINT,
                    "schedule_expression" VARCHAR,
                    "rule_name" VARCHAR,
                    "rule_id" VARCHAR,
                    "enable_continuous_backup" BOOLEAN,
                    "completion_window_minutes" BIGINT,
                    "copy_actions" STRUCT(
                        "destination_backup_vault_arn" VARCHAR,
                        "lifecycle" STRUCT(
                            "delete_after_days" BIGINT,
                            "move_to_cold_storage_after_days" BIGINT
                        )
                    )[],
                    "lifecycle" STRUCT(
                        "delete_after_days" BIGINT,
                        "move_to_cold_storage_after_days" BIGINT
                    )
                )[]
            ),
            "backup_plan_arn" VARCHAR,
            "backup_plan_id" VARCHAR,
            "version_id" VARCHAR
        ),
        "aws_backup_recovery_point" STRUCT(
            "backup_size_in_bytes" BIGINT,
            "backup_vault_arn" VARCHAR,
            "backup_vault_name" VARCHAR,
            "calculated_lifecycle" STRUCT(
                "delete_at" VARCHAR,
                "move_to_cold_storage_at" VARCHAR
            ),
            "completion_date" VARCHAR,
            "created_by" STRUCT(
                "backup_plan_arn" VARCHAR,
                "backup_plan_id" VARCHAR,
                "backup_plan_version" VARCHAR,
                "backup_rule_id" VARCHAR
            ),
            "creation_date" VARCHAR,
            "encryption_key_arn" VARCHAR,
            "iam_role_arn" VARCHAR,
            "is_encrypted" BOOLEAN,
            "last_restore_time" VARCHAR,
            "lifecycle" STRUCT(
                "delete_after_days" BIGINT,
                "move_to_cold_storage_after_days" BIGINT
            ),
            "recovery_point_arn" VARCHAR,
            "resource_arn" VARCHAR,
            "resource_type" VARCHAR,
            "source_backup_vault_arn" VARCHAR,
            "status" VARCHAR,
            "status_message" VARCHAR,
            "storage_class" VARCHAR
        ),
        "aws_ec2_launch_template" STRUCT(
            "launch_template_name" VARCHAR,
            "id" VARCHAR,
            "launch_template_data" STRUCT(
                "block_device_mapping_set" STRUCT(
                    "device_name" VARCHAR,
                    "ebs" STRUCT(
                        "delete_on_termination" BOOLEAN,
                        "encrypted" BOOLEAN,
                        "iops" BIGINT,
                        "kms_key_id" VARCHAR,
                        "snapshot_id" VARCHAR,
                        "throughput" BIGINT,
                        "volume_size" BIGINT,
                        "volume_type" VARCHAR
                    ),
                    "no_device" VARCHAR,
                    "virtual_name" VARCHAR
                )[],
                "capacity_reservation_specification" STRUCT(
                    "capacity_reservation_preference" VARCHAR,
                    "capacity_reservation_target" STRUCT(
                        "capacity_reservation_id" VARCHAR,
                        "capacity_reservation_resource_group_arn" VARCHAR
                    )
                ),
                "cpu_options" STRUCT(
                    "core_count" BIGINT,
                    "threads_per_core" BIGINT
                ),
                "credit_specification" STRUCT(
                    "cpu_credits" VARCHAR
                ),
                "disable_api_stop" BOOLEAN,
                "disable_api_termination" BOOLEAN,
                "ebs_optimized" BOOLEAN,
                "elastic_gpu_specification_set" STRUCT(
                    "type" VARCHAR
                )[],
                "elastic_inference_accelerator_set" STRUCT(
                    "count" BIGINT,
                    "type" VARCHAR
                )[],
                "enclave_options" STRUCT(
                    "enabled" BOOLEAN
                ),
                "hibernation_options" STRUCT(
                    "configured" BOOLEAN
                ),
                "iam_instance_profile" STRUCT(
                    "arn" VARCHAR,
                    "name" VARCHAR
                ),
                "image_id" VARCHAR,
                "instance_initiated_shutdown_behavior" VARCHAR,
                "instance_market_options" STRUCT(
                    "market_type" VARCHAR,
                    "spot_options" STRUCT(
                        "block_duration_minutes" BIGINT,
                        "instance_interruption_behavior" VARCHAR,
                        "max_price" VARCHAR,
                        "spot_instance_type" VARCHAR,
                        "valid_until" VARCHAR
                    )
                ),
                "instance_requirements" STRUCT(
                    "accelerator_count" STRUCT(
                        "max" BIGINT,
                        "min" BIGINT
                    ),
                    "accelerator_manufacturers" VARCHAR[],
                    "accelerator_names" VARCHAR[],
                    "accelerator_total_memory_mi_b" STRUCT(
                        "max" BIGINT,
                        "min" BIGINT
                    ),
                    "accelerator_types" VARCHAR[],
                    "bare_metal" VARCHAR,
                    "baseline_ebs_bandwidth_mbps" STRUCT(
                        "max" BIGINT,
                        "min" BIGINT
                    ),
                    "burstable_performance" VARCHAR,
                    "cpu_manufacturers" VARCHAR[],
                    "excluded_instance_types" VARCHAR[],
                    "instance_generations" VARCHAR[],
                    "local_storage" VARCHAR,
                    "local_storage_types" VARCHAR[],
                    "memory_gi_b_per_v_cpu" STRUCT(
                        "max" DOUBLE,
                        "min" DOUBLE
                    ),
                    "memory_mi_b" STRUCT(
                        "max" BIGINT,
                        "min" BIGINT
                    ),
                    "network_interface_count" STRUCT(
                        "max" BIGINT,
                        "min" BIGINT
                    ),
                    "on_demand_max_price_percentage_over_lowest_price" BIGINT,
                    "require_hibernate_support" BOOLEAN,
                    "spot_max_price_percentage_over_lowest_price" BIGINT,
                    "total_local_storage_gb" STRUCT(
                        "max" DOUBLE,
                        "min" DOUBLE
                    ),
                    "v_cpu_count" STRUCT(
                        "max" BIGINT,
                        "min" BIGINT
                    )
                ),
                "instance_type" VARCHAR,
                "kernel_id" VARCHAR,
                "key_name" VARCHAR,
                "license_set" STRUCT(
                    "license_configuration_arn" VARCHAR
                )[],
                "maintenance_options" STRUCT(
                    "auto_recovery" VARCHAR
                ),
                "metadata_options" STRUCT(
                    "http_endpoint" VARCHAR,
                    "http_protocol_ipv6" VARCHAR,
                    "http_tokens" VARCHAR,
                    "http_put_response_hop_limit" BIGINT,
                    "instance_metadata_tags" VARCHAR
                ),
                "monitoring" STRUCT(
                    "enabled" BOOLEAN
                ),
                "network_interface_set" STRUCT(
                    "associate_carrier_ip_address" BOOLEAN,
                    "associate_public_ip_address" BOOLEAN,
                    "delete_on_termination" BOOLEAN,
                    "description" VARCHAR,
                    "device_index" BIGINT,
                    "groups" VARCHAR[],
                    "interface_type" VARCHAR,
                    "ipv4_prefix_count" BIGINT,
                    "ipv4_prefixes" STRUCT(
                        "ipv4_prefix" VARCHAR
                    )[],
                    "ipv6_address_count" BIGINT,
                    "ipv6_addresses" STRUCT(
                        "ipv6_address" VARCHAR
                    )[],
                    "ipv6_prefix_count" BIGINT,
                    "ipv6_prefixes" STRUCT(
                        "ipv6_prefix" VARCHAR
                    )[],
                    "network_card_index" BIGINT,
                    "network_interface_id" VARCHAR,
                    "private_ip_address" VARCHAR,
                    "private_ip_addresses" STRUCT(
                        "primary" BOOLEAN,
                        "private_ip_address" VARCHAR
                    )[],
                    "secondary_private_ip_address_count" BIGINT,
                    "subnet_id" VARCHAR
                )[],
                "placement" STRUCT(
                    "affinity" VARCHAR,
                    "availability_zone" VARCHAR,
                    "group_name" VARCHAR,
                    "host_id" VARCHAR,
                    "host_resource_group_arn" VARCHAR,
                    "partition_number" BIGINT,
                    "spread_domain" VARCHAR,
                    "tenancy" VARCHAR
                ),
                "private_dns_name_options" STRUCT(
                    "enable_resource_name_dns_aaaa_record" BOOLEAN,
                    "enable_resource_name_dns_a_record" BOOLEAN,
                    "hostname_type" VARCHAR
                ),
                "ram_disk_id" VARCHAR,
                "security_group_id_set" VARCHAR[],
                "security_group_set" VARCHAR[],
                "user_data" VARCHAR
            ),
            "default_version_number" BIGINT,
            "latest_version_number" BIGINT
        ),
        "aws_sage_maker_notebook_instance" STRUCT(
            "accelerator_types" VARCHAR[],
            "additional_code_repositories" VARCHAR[],
            "default_code_repository" VARCHAR,
            "direct_internet_access" VARCHAR,
            "failure_reason" VARCHAR,
            "instance_metadata_service_configuration" STRUCT(
                "minimum_instance_metadata_service_version" VARCHAR
            ),
            "instance_type" VARCHAR,
            "kms_key_id" VARCHAR,
            "network_interface_id" VARCHAR,
            "notebook_instance_arn" VARCHAR,
            "notebook_instance_lifecycle_config_name" VARCHAR,
            "notebook_instance_name" VARCHAR,
            "notebook_instance_status" VARCHAR,
            "platform_identifier" VARCHAR,
            "role_arn" VARCHAR,
            "root_access" VARCHAR,
            "security_groups" VARCHAR[],
            "subnet_id" VARCHAR,
            "url" VARCHAR,
            "volume_size_in_gb" BIGINT
        ),
        "aws_wafv2_web_acl" STRUCT(
            "name" VARCHAR,
            "arn" VARCHAR,
            "managedby_firewall_manager" BOOLEAN,
            "id" VARCHAR,
            "capacity" BIGINT,
            "captcha_config" STRUCT(
                "immunity_time_property" STRUCT(
                    "immunity_time" BIGINT
                )
            ),
            "default_action" STRUCT(
                "allow" STRUCT(
                    "custom_request_handling" STRUCT(
                        "insert_headers" STRUCT(
                            "name" VARCHAR,
                            "value" VARCHAR
                        )[]
                    )
                ),
                "block" STRUCT(
                    "custom_response" STRUCT(
                        "custom_response_body_key" VARCHAR,
                        "response_code" BIGINT,
                        "response_headers" STRUCT(
                            "name" VARCHAR,
                            "value" VARCHAR
                        )[]
                    )
                )
            ),
            "description" VARCHAR,
            "rules" STRUCT(
                "action" STRUCT(
                    "allow" STRUCT(
                        "custom_request_handling" STRUCT(
                            "insert_headers" STRUCT(
                                "name" VARCHAR,
                                "value" VARCHAR
                            )[]
                        )
                    ),
                    "block" STRUCT(
                        "custom_response" STRUCT(
                            "custom_response_body_key" VARCHAR,
                            "response_code" BIGINT,
                            "response_headers" STRUCT(
                                "name" VARCHAR,
                                "value" VARCHAR
                            )[]
                        )
                    ),
                    "captcha" STRUCT(
                        "custom_request_handling" STRUCT(
                            "insert_headers" STRUCT(
                                "name" VARCHAR,
                                "value" VARCHAR
                            )[]
                        )
                    ),
                    "count" STRUCT(
                        "custom_request_handling" STRUCT(
                            "insert_headers" STRUCT(
                                "name" VARCHAR,
                                "value" VARCHAR
                            )[]
                        )
                    )
                ),
                "name" VARCHAR,
                "override_action" VARCHAR,
                "priority" BIGINT,
                "visibility_config" STRUCT(
                    "cloud_watch_metrics_enabled" BOOLEAN,
                    "metric_name" VARCHAR,
                    "sampled_requests_enabled" BOOLEAN
                )
            )[],
            "visibility_config" STRUCT(
                "cloud_watch_metrics_enabled" BOOLEAN,
                "metric_name" VARCHAR,
                "sampled_requests_enabled" BOOLEAN
            )
        ),
        "aws_wafv2_rule_group" STRUCT(
            "capacity" BIGINT,
            "description" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "arn" VARCHAR,
            "rules" STRUCT(
                "action" STRUCT(
                    "allow" STRUCT(
                        "custom_request_handling" STRUCT(
                            "insert_headers" STRUCT(
                                "name" VARCHAR,
                                "value" VARCHAR
                            )[]
                        )
                    ),
                    "block" STRUCT(
                        "custom_response" STRUCT(
                            "custom_response_body_key" VARCHAR,
                            "response_code" BIGINT,
                            "response_headers" STRUCT(
                                "name" VARCHAR,
                                "value" VARCHAR
                            )[]
                        )
                    ),
                    "captcha" STRUCT(
                        "custom_request_handling" STRUCT(
                            "insert_headers" STRUCT(
                                "name" VARCHAR,
                                "value" VARCHAR
                            )[]
                        )
                    ),
                    "count" STRUCT(
                        "custom_request_handling" STRUCT(
                            "insert_headers" STRUCT(
                                "name" VARCHAR,
                                "value" VARCHAR
                            )[]
                        )
                    )
                ),
                "name" VARCHAR,
                "override_action" VARCHAR,
                "priority" BIGINT,
                "visibility_config" STRUCT(
                    "cloud_watch_metrics_enabled" BOOLEAN,
                    "metric_name" VARCHAR,
                    "sampled_requests_enabled" BOOLEAN
                )
            )[],
            "scope" VARCHAR,
            "visibility_config" STRUCT(
                "cloud_watch_metrics_enabled" BOOLEAN,
                "metric_name" VARCHAR,
                "sampled_requests_enabled" BOOLEAN
            )
        ),
        "aws_ec2_route_table" STRUCT(
            "association_set" STRUCT(
                "association_state" STRUCT(
                    "state" VARCHAR,
                    "status_message" VARCHAR
                ),
                "gateway_id" VARCHAR,
                "main" BOOLEAN,
                "route_table_association_id" VARCHAR,
                "route_table_id" VARCHAR,
                "subnet_id" VARCHAR
            )[],
            "owner_id" VARCHAR,
            "propagating_vgw_set" STRUCT(
                "gateway_id" VARCHAR
            )[],
            "route_table_id" VARCHAR,
            "route_set" STRUCT(
                "carrier_gateway_id" VARCHAR,
                "core_network_arn" VARCHAR,
                "destination_cidr_block" VARCHAR,
                "destination_ipv6_cidr_block" VARCHAR,
                "destination_prefix_list_id" VARCHAR,
                "egress_only_internet_gateway_id" VARCHAR,
                "gateway_id" VARCHAR,
                "instance_id" VARCHAR,
                "instance_owner_id" VARCHAR,
                "local_gateway_id" VARCHAR,
                "nat_gateway_id" VARCHAR,
                "network_interface_id" VARCHAR,
                "origin" VARCHAR,
                "state" VARCHAR,
                "transit_gateway_id" VARCHAR,
                "vpc_peering_connection_id" VARCHAR
            )[],
            "vpc_id" VARCHAR
        ),
        "aws_amazon_mq_broker" STRUCT(
            "authentication_strategy" VARCHAR,
            "auto_minor_version_upgrade" BOOLEAN,
            "broker_arn" VARCHAR,
            "broker_name" VARCHAR,
            "deployment_mode" VARCHAR,
            "encryption_options" STRUCT(
                "kms_key_id" VARCHAR,
                "use_aws_owned_key" BOOLEAN
            ),
            "engine_type" VARCHAR,
            "engine_version" VARCHAR,
            "host_instance_type" VARCHAR,
            "broker_id" VARCHAR,
            "ldap_server_metadata" STRUCT(
                "hosts" VARCHAR[],
                "role_base" VARCHAR,
                "role_name" VARCHAR,
                "role_search_matching" VARCHAR,
                "role_search_subtree" BOOLEAN,
                "service_account_username" VARCHAR,
                "user_base" VARCHAR,
                "user_role_name" VARCHAR,
                "user_search_matching" VARCHAR,
                "user_search_subtree" BOOLEAN
            ),
            "logs" STRUCT(
                "audit" BOOLEAN,
                "general" BOOLEAN,
                "audit_log_group" VARCHAR,
                "general_log_group" VARCHAR,
                "pending" STRUCT(
                    "audit" BOOLEAN,
                    "general" BOOLEAN
                )
            ),
            "maintenance_window_start_time" STRUCT(
                "day_of_week" VARCHAR,
                "time_of_day" VARCHAR,
                "time_zone" VARCHAR
            ),
            "publicly_accessible" BOOLEAN,
            "security_groups" VARCHAR[],
            "storage_type" VARCHAR,
            "subnet_ids" VARCHAR[],
            "users" STRUCT(
                "pending_change" VARCHAR,
                "username" VARCHAR
            )[]
        ),
        "aws_app_sync_graph_ql_api" STRUCT(
            "api_id" VARCHAR,
            "id" VARCHAR,
            "open_id_connect_config" STRUCT(
                "auth_tt_l" BIGINT,
                "client_id" VARCHAR,
                "iat_tt_l" BIGINT,
                "issuer" VARCHAR
            ),
            "name" VARCHAR,
            "lambda_authorizer_config" STRUCT(
                "authorizer_result_ttl_in_seconds" BIGINT,
                "authorizer_uri" VARCHAR,
                "identity_validation_expression" VARCHAR
            ),
            "xray_enabled" BOOLEAN,
            "arn" VARCHAR,
            "user_pool_config" STRUCT(
                "app_id_client_regex" VARCHAR,
                "aws_region" VARCHAR,
                "default_action" VARCHAR,
                "user_pool_id" VARCHAR
            ),
            "authentication_type" VARCHAR,
            "log_config" STRUCT(
                "cloud_watch_logs_role_arn" VARCHAR,
                "exclude_verbose_content" BOOLEAN,
                "field_log_level" VARCHAR
            ),
            "additional_authentication_providers" STRUCT(
                "authentication_type" VARCHAR,
                "lambda_authorizer_config" STRUCT(
                    "authorizer_result_ttl_in_seconds" BIGINT,
                    "authorizer_uri" VARCHAR,
                    "identity_validation_expression" VARCHAR
                ),
                "open_id_connect_config" STRUCT(
                    "auth_tt_l" BIGINT,
                    "client_id" VARCHAR,
                    "iat_tt_l" BIGINT,
                    "issuer" VARCHAR
                ),
                "user_pool_config" STRUCT(
                    "app_id_client_regex" VARCHAR,
                    "aws_region" VARCHAR,
                    "default_action" VARCHAR,
                    "user_pool_id" VARCHAR
                )
            )[],
            "waf_web_acl_arn" VARCHAR
        ),
        "aws_event_schemas_registry" STRUCT(
            "description" VARCHAR,
            "registry_arn" VARCHAR,
            "registry_name" VARCHAR
        ),
        "aws_guard_duty_detector" STRUCT(
            "data_sources" STRUCT(
                "cloud_trail" STRUCT(
                    "status" VARCHAR
                ),
                "dns_logs" STRUCT(
                    "status" VARCHAR
                ),
                "flow_logs" STRUCT(
                    "status" VARCHAR
                ),
                "kubernetes" STRUCT(
                    "audit_logs" STRUCT(
                        "status" VARCHAR
                    )
                ),
                "malware_protection" STRUCT(
                    "scan_ec2_instance_with_findings" STRUCT(
                        "ebs_volumes" STRUCT(
                            "reason" VARCHAR,
                            "status" VARCHAR
                        )
                    ),
                    "service_role" VARCHAR
                ),
                "s3_logs" STRUCT(
                    "status" VARCHAR
                )
            ),
            "features" STRUCT(
                "name" VARCHAR,
                "status" VARCHAR
            )[],
            "finding_publishing_frequency" VARCHAR,
            "service_role" VARCHAR,
            "status" VARCHAR
        ),
        "aws_step_function_state_machine" STRUCT(
            "label" VARCHAR,
            "logging_configuration" STRUCT(
                "destinations" STRUCT(
                    "cloud_watch_logs_log_group" STRUCT(
                        "log_group_arn" VARCHAR
                    )
                )[],
                "include_execution_data" BOOLEAN,
                "level" VARCHAR
            ),
            "name" VARCHAR,
            "role_arn" VARCHAR,
            "state_machine_arn" VARCHAR,
            "status" VARCHAR,
            "tracing_configuration" STRUCT(
                "enabled" BOOLEAN
            ),
            "type" VARCHAR
        ),
        "aws_athena_work_group" STRUCT(
            "name" VARCHAR,
            "description" VARCHAR,
            "state" VARCHAR,
            "configuration" STRUCT(
                "result_configuration" STRUCT(
                    "encryption_configuration" STRUCT(
                        "encryption_option" VARCHAR,
                        "kms_key" VARCHAR
                    )
                )
            )
        ),
        "aws_events_eventbus" STRUCT(
            "arn" VARCHAR,
            "name" VARCHAR,
            "policy" VARCHAR
        ),
        "aws_dms_endpoint" STRUCT(
            "certificate_arn" VARCHAR,
            "database_name" VARCHAR,
            "endpoint_arn" VARCHAR,
            "endpoint_identifier" VARCHAR,
            "endpoint_type" VARCHAR,
            "engine_name" VARCHAR,
            "external_id" VARCHAR,
            "extra_connection_attributes" VARCHAR,
            "kms_key_id" VARCHAR,
            "port" BIGINT,
            "server_name" VARCHAR,
            "ssl_mode" VARCHAR,
            "username" VARCHAR
        ),
        "aws_events_endpoint" STRUCT(
            "arn" VARCHAR,
            "description" VARCHAR,
            "endpoint_id" VARCHAR,
            "endpoint_url" VARCHAR,
            "event_buses" STRUCT(
                "event_bus_arn" VARCHAR
            )[],
            "name" VARCHAR,
            "replication_config" STRUCT(
                "state" VARCHAR
            ),
            "role_arn" VARCHAR,
            "routing_config" STRUCT(
                "failover_config" STRUCT(
                    "primary" STRUCT(
                        "health_check" VARCHAR
                    ),
                    "secondary" STRUCT(
                        "route" VARCHAR
                    )
                )
            ),
            "state" VARCHAR,
            "state_reason" VARCHAR
        ),
        "aws_dms_replication_task" STRUCT(
            "cdc_start_position" VARCHAR,
            "cdc_start_time" VARCHAR,
            "cdc_stop_position" VARCHAR,
            "migration_type" VARCHAR,
            "id" VARCHAR,
            "resource_identifier" VARCHAR,
            "replication_instance_arn" VARCHAR,
            "replication_task_identifier" VARCHAR,
            "replication_task_settings" VARCHAR,
            "source_endpoint_arn" VARCHAR,
            "table_mappings" VARCHAR,
            "target_endpoint_arn" VARCHAR,
            "task_data" VARCHAR
        ),
        "aws_dms_replication_instance" STRUCT(
            "allocated_storage" BIGINT,
            "auto_minor_version_upgrade" BOOLEAN,
            "availability_zone" VARCHAR,
            "engine_version" VARCHAR,
            "kms_key_id" VARCHAR,
            "multi_az" BOOLEAN,
            "preferred_maintenance_window" VARCHAR,
            "publicly_accessible" BOOLEAN,
            "replication_instance_class" VARCHAR,
            "replication_instance_identifier" VARCHAR,
            "replication_subnet_group" STRUCT(
                "replication_subnet_group_identifier" VARCHAR
            ),
            "vpc_security_groups" STRUCT(
                "vpc_security_group_id" VARCHAR
            )[]
        ),
        "aws_route53_hosted_zone" STRUCT(
            "hosted_zone" STRUCT(
                "id" VARCHAR,
                "name" VARCHAR,
                "config" STRUCT(
                    "comment" VARCHAR
                )
            ),
            "vpcs" STRUCT(
                "id" VARCHAR,
                "region" VARCHAR
            )[],
            "name_servers" VARCHAR[],
            "query_logging_config" STRUCT(
                "cloud_watch_logs_log_group_arn" STRUCT(
                    "cloud_watch_logs_log_group_arn" VARCHAR,
                    "hosted_zone_id" VARCHAR,
                    "id" VARCHAR
                )
            )
        ),
        "aws_msk_cluster" STRUCT(
            "cluster_info" STRUCT(
                "encryption_info" STRUCT(
                    "encryption_in_transit" STRUCT(
                        "in_cluster" BOOLEAN,
                        "client_broker" VARCHAR
                    ),
                    "encryption_at_rest" STRUCT(
                        "data_volume_kms_key_id" VARCHAR
                    )
                ),
                "current_version" VARCHAR,
                "number_of_broker_nodes" BIGINT,
                "cluster_name" VARCHAR,
                "client_authentication" STRUCT(
                    "sasl" STRUCT(
                        "iam" STRUCT(
                            "enabled" BOOLEAN
                        ),
                        "scram" STRUCT(
                            "enabled" BOOLEAN
                        )
                    ),
                    "unauthenticated" STRUCT(
                        "enabled" BOOLEAN
                    ),
                    "tls" STRUCT(
                        "certificate_authority_arn_list" VARCHAR[],
                        "enabled" BOOLEAN
                    )
                ),
                "enhanced_monitoring" VARCHAR
            )
        ),
        "aws_s3_access_point" STRUCT(
            "access_point_arn" VARCHAR,
            "alias" VARCHAR,
            "bucket" VARCHAR,
            "bucket_account_id" VARCHAR,
            "name" VARCHAR,
            "network_origin" VARCHAR,
            "public_access_block_configuration" STRUCT(
                "block_public_acls" BOOLEAN,
                "block_public_policy" BOOLEAN,
                "ignore_public_acls" BOOLEAN,
                "restrict_public_buckets" BOOLEAN
            ),
            "vpc_configuration" STRUCT(
                "vpc_id" VARCHAR
            )
        ),
        "aws_ec2_client_vpn_endpoint" STRUCT(
            "client_vpn_endpoint_id" VARCHAR,
            "description" VARCHAR,
            "client_cidr_block" VARCHAR,
            "dns_server" VARCHAR[],
            "split_tunnel" BOOLEAN,
            "transport_protocol" VARCHAR,
            "vpn_port" BIGINT,
            "server_certificate_arn" VARCHAR,
            "authentication_options" STRUCT(
                "type" VARCHAR,
                "active_directory" STRUCT(
                    "directory_id" VARCHAR
                ),
                "mutual_authentication" STRUCT(
                    "client_root_certificate_chain" VARCHAR
                ),
                "federated_authentication" STRUCT(
                    "saml_provider_arn" VARCHAR,
                    "self_service_saml_provider_arn" VARCHAR
                )
            )[],
            "connection_log_options" STRUCT(
                "enabled" BOOLEAN,
                "cloudwatch_log_group" VARCHAR,
                "cloudwatch_log_stream" VARCHAR
            ),
            "security_group_id_set" VARCHAR[],
            "vpc_id" VARCHAR,
            "self_service_portal_url" VARCHAR,
            "client_connect_options" STRUCT(
                "enabled" BOOLEAN,
                "lambda_function_arn" VARCHAR,
                "status" STRUCT(
                    "code" VARCHAR,
                    "message" VARCHAR
                )
            ),
            "session_timeout_hours" BIGINT,
            "client_login_banner_options" STRUCT(
                "enabled" BOOLEAN,
                "banner_text" VARCHAR
            )
        )
    ),
    "application_name" VARCHAR,
    "application_arn" VARCHAR
)[]
Show child fields
resources[]
Show child fields
resources[].application_arn

The Amazon Resource Name (ARN) of the application that is related to a finding.

resources[].application_name

The name of the application that is related to a finding.

resources[].data_classification

Contains information about sensitive data that was detected on the resource.

Show child fields
resources[].data_classification.detailed_results_location

The path to the folder or file that contains the sensitive data.

resources[].data_classification.result

The details about the sensitive data that was detected on the resource.

Show child fields
resources[].data_classification.result.additional_occurrences

Indicates whether there are additional occurrences of sensitive data that are not included in the finding. This occurs when the number of occurrences exceeds the maximum that can be included.

resources[].data_classification.result.custom_data_identifiers

Provides details about sensitive data that was identified based on customer-defined configuration.

Show child fields
resources[].data_classification.result.custom_data_identifiers.detections[]
Show child fields
resources[].data_classification.result.custom_data_identifiers.detections[].arn

The ARN of the custom identifier that was used to detect the sensitive data.

resources[].data_classification.result.custom_data_identifiers.detections[].count

The total number of occurrences of sensitive data that were detected.

resources[].data_classification.result.custom_data_identifiers.detections[].name

he name of the custom identifier that detected the sensitive data.

resources[].data_classification.result.custom_data_identifiers.detections[].occurrences

Details about the sensitive data that was detected.

Show child fields
resources[].data_classification.result.custom_data_identifiers.detections[].occurrences.cells[]
Show child fields
resources[].data_classification.result.custom_data_identifiers.detections[].occurrences.cells[].cell_reference

For a Microsoft Excel workbook, provides the location of the cell, as an absolute cell reference, that contains the data. For example, Sheet2!C5 for cell C5 on Sheet2.

resources[].data_classification.result.custom_data_identifiers.detections[].occurrences.cells[].column

The column number of the column that contains the data. For a Microsoft Excel workbook, the column number corresponds to the alphabetical column identifiers. For example, a value of 1 for Column corresponds to the A column in the workbook.

resources[].data_classification.result.custom_data_identifiers.detections[].occurrences.cells[].column_name

The name of the column that contains the data.

resources[].data_classification.result.custom_data_identifiers.detections[].occurrences.cells[].row

The row number of the row that contains the data.

resources[].data_classification.result.custom_data_identifiers.detections[].occurrences.line_ranges[]
Show child fields
resources[].data_classification.result.custom_data_identifiers.detections[].occurrences.line_ranges[].end

The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.

resources[].data_classification.result.custom_data_identifiers.detections[].occurrences.line_ranges[].start

The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.

resources[].data_classification.result.custom_data_identifiers.detections[].occurrences.line_ranges[].start_column

In the line where the sensitive data starts, the column within the line where the sensitive data starts.

resources[].data_classification.result.custom_data_identifiers.detections[].occurrences.offset_ranges[]
Show child fields
resources[].data_classification.result.custom_data_identifiers.detections[].occurrences.offset_ranges[].end

The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.

resources[].data_classification.result.custom_data_identifiers.detections[].occurrences.offset_ranges[].start

The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.

resources[].data_classification.result.custom_data_identifiers.detections[].occurrences.offset_ranges[].start_column

In the line where the sensitive data starts, the column within the line where the sensitive data starts.

resources[].data_classification.result.custom_data_identifiers.detections[].occurrences.pages[]
Show child fields
resources[].data_classification.result.custom_data_identifiers.detections[].occurrences.pages[].line_range

An occurrence of sensitive data detected in a non-binary text file or a Microsoft Word file. Non-binary text files include files such as HTML, XML, JSON, and TXT files.

Show child fields
resources[].data_classification.result.custom_data_identifiers.detections[].occurrences.pages[].line_range.end

The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.

resources[].data_classification.result.custom_data_identifiers.detections[].occurrences.pages[].line_range.start

The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.

resources[].data_classification.result.custom_data_identifiers.detections[].occurrences.pages[].line_range.start_column

In the line where the sensitive data starts, the column within the line where the sensitive data starts.

resources[].data_classification.result.custom_data_identifiers.detections[].occurrences.pages[].offset_range

An occurrence of sensitive data detected in a binary text file.

Show child fields
resources[].data_classification.result.custom_data_identifiers.detections[].occurrences.pages[].offset_range.end

The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.

resources[].data_classification.result.custom_data_identifiers.detections[].occurrences.pages[].offset_range.start

The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.

resources[].data_classification.result.custom_data_identifiers.detections[].occurrences.pages[].offset_range.start_column

In the line where the sensitive data starts, the column within the line where the sensitive data starts.

resources[].data_classification.result.custom_data_identifiers.detections[].occurrences.pages[].page_number

The page number of the page that contains the sensitive data.

resources[].data_classification.result.custom_data_identifiers.detections[].occurrences.records[]
Show child fields
resources[].data_classification.result.custom_data_identifiers.detections[].occurrences.records[].json_path

The path, as a JSONPath expression, to the field in the record that contains the data. If the field name is longer than 20 characters, it is truncated. If the path is longer than 250 characters, it is truncated.

resources[].data_classification.result.custom_data_identifiers.detections[].occurrences.records[].record_index

The record index, starting from 0, for the record that contains the data.

resources[].data_classification.result.custom_data_identifiers.total_count

The total number of occurrences of sensitive data.

resources[].data_classification.result.mime_type

The type of content that the finding applies to.

resources[].data_classification.result.sensitive_data[]
Show child fields
resources[].data_classification.result.sensitive_data[].category

The category of sensitive data that was detected. For example, the category can indicate that the sensitive data involved credentials, financial information, or personal information.

resources[].data_classification.result.sensitive_data[].detections[]
Show child fields
resources[].data_classification.result.sensitive_data[].detections[].count

The total number of occurrences of sensitive data that were detected.

resources[].data_classification.result.sensitive_data[].detections[].occurrences

Details about the sensitive data that was detected.

Show child fields
resources[].data_classification.result.sensitive_data[].detections[].occurrences.cells[]
Show child fields
resources[].data_classification.result.sensitive_data[].detections[].occurrences.cells[].cell_reference

For a Microsoft Excel workbook, provides the location of the cell, as an absolute cell reference, that contains the data. For example, Sheet2!C5 for cell C5 on Sheet2.

resources[].data_classification.result.sensitive_data[].detections[].occurrences.cells[].column

The column number of the column that contains the data. For a Microsoft Excel workbook, the column number corresponds to the alphabetical column identifiers. For example, a value of 1 for Column corresponds to the A column in the workbook.

resources[].data_classification.result.sensitive_data[].detections[].occurrences.cells[].column_name

The name of the column that contains the data.

resources[].data_classification.result.sensitive_data[].detections[].occurrences.cells[].row

The row number of the row that contains the data.

resources[].data_classification.result.sensitive_data[].detections[].occurrences.line_ranges[]
Show child fields
resources[].data_classification.result.sensitive_data[].detections[].occurrences.line_ranges[].end

The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.

resources[].data_classification.result.sensitive_data[].detections[].occurrences.line_ranges[].start

The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.

resources[].data_classification.result.sensitive_data[].detections[].occurrences.line_ranges[].start_column

In the line where the sensitive data starts, the column within the line where the sensitive data starts.

resources[].data_classification.result.sensitive_data[].detections[].occurrences.offset_ranges[]
Show child fields
resources[].data_classification.result.sensitive_data[].detections[].occurrences.offset_ranges[].end

The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.

resources[].data_classification.result.sensitive_data[].detections[].occurrences.offset_ranges[].start

The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.

resources[].data_classification.result.sensitive_data[].detections[].occurrences.offset_ranges[].start_column

In the line where the sensitive data starts, the column within the line where the sensitive data starts.

resources[].data_classification.result.sensitive_data[].detections[].occurrences.pages[]
Show child fields
resources[].data_classification.result.sensitive_data[].detections[].occurrences.pages[].line_range

An occurrence of sensitive data detected in a non-binary text file or a Microsoft Word file. Non-binary text files include files such as HTML, XML, JSON, and TXT files.

Show child fields
resources[].data_classification.result.sensitive_data[].detections[].occurrences.pages[].line_range.end

The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.

resources[].data_classification.result.sensitive_data[].detections[].occurrences.pages[].line_range.start

The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.

resources[].data_classification.result.sensitive_data[].detections[].occurrences.pages[].line_range.start_column

In the line where the sensitive data starts, the column within the line where the sensitive data starts.

resources[].data_classification.result.sensitive_data[].detections[].occurrences.pages[].offset_range

An occurrence of sensitive data detected in a binary text file.

Show child fields
resources[].data_classification.result.sensitive_data[].detections[].occurrences.pages[].offset_range.end

The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.

resources[].data_classification.result.sensitive_data[].detections[].occurrences.pages[].offset_range.start

The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.

resources[].data_classification.result.sensitive_data[].detections[].occurrences.pages[].offset_range.start_column

In the line where the sensitive data starts, the column within the line where the sensitive data starts.

resources[].data_classification.result.sensitive_data[].detections[].occurrences.pages[].page_number

The page number of the page that contains the sensitive data.

resources[].data_classification.result.sensitive_data[].detections[].occurrences.records[]
Show child fields
resources[].data_classification.result.sensitive_data[].detections[].occurrences.records[].json_path

The path, as a JSONPath expression, to the field in the record that contains the data. If the field name is longer than 20 characters, it is truncated. If the path is longer than 250 characters, it is truncated.

resources[].data_classification.result.sensitive_data[].detections[].occurrences.records[].record_index

The record index, starting from 0, for the record that contains the data.

resources[].data_classification.result.sensitive_data[].detections[].type

The type of sensitive data that was detected. For example, the type might indicate that the data is an email address.

resources[].data_classification.result.sensitive_data[].total_count

The total number of occurrences of sensitive data.

resources[].data_classification.result.size_classified

The total size in bytes of the affected data.

resources[].data_classification.result.status

The current status of the sensitive data detection.

Show child fields
resources[].data_classification.result.status.code

The code that represents the status of the sensitive data detection.

resources[].data_classification.result.status.reason

A longer description of the current status of the sensitive data detection.

resources[].details

Additional details about the resource related to a finding.

Show child fields
resources[].details.aws_amazon_mq_broker

Provides details about AppSync message broker. A message broker allows software applications and components to communicate using various programming languages, operating systems, and formal messaging protocols.

Show child fields
resources[].details.aws_amazon_mq_broker.authentication_strategy

The authentication strategy used to secure the broker. The default is SIMPLE.

resources[].details.aws_amazon_mq_broker.auto_minor_version_upgrade

Whether automatically upgrade new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.

resources[].details.aws_amazon_mq_broker.broker_arn

The Amazon Resource Name (ARN) of the broker.

resources[].details.aws_amazon_mq_broker.broker_id

The unique ID that Amazon MQ generates for the broker.

resources[].details.aws_amazon_mq_broker.broker_name

The broker's name.

resources[].details.aws_amazon_mq_broker.deployment_mode

The broker's deployment mode.

resources[].details.aws_amazon_mq_broker.encryption_options

Encryption options for the broker. Doesn’t apply to RabbitMQ brokers.

Show child fields
resources[].details.aws_amazon_mq_broker.encryption_options.kms_key_id

The KMS key that’s used to encrypt your data at rest. If not provided, Amazon MQ will use a default KMS key to encrypt your data.

resources[].details.aws_amazon_mq_broker.encryption_options.use_aws_owned_key

Specifies that an KMS key should be used for at-rest encryption. Set to true by default if no value is provided (for example, for RabbitMQ brokers).

resources[].details.aws_amazon_mq_broker.engine_type

The type of broker engine.

resources[].details.aws_amazon_mq_broker.engine_version

The version of the broker engine.

resources[].details.aws_amazon_mq_broker.host_instance_type

The broker's instance type.

resources[].details.aws_amazon_mq_broker.ldap_server_metadata

The metadata of the Lightweight Directory Access Protocol (LDAP) server used to authenticate and authorize connections to the broker. This is an optional failover server.

Show child fields
resources[].details.aws_amazon_mq_broker.ldap_server_metadata.hosts[]
resources[].details.aws_amazon_mq_broker.ldap_server_metadata.role_base

The distinguished name of the node in the directory information tree (DIT) to search for roles or groups.

resources[].details.aws_amazon_mq_broker.ldap_server_metadata.role_name

The group name attribute in a role entry whose value is the name of that role.

resources[].details.aws_amazon_mq_broker.ldap_server_metadata.role_search_matching

The LDAP search filter used to find roles within the roleBase.

resources[].details.aws_amazon_mq_broker.ldap_server_metadata.role_search_subtree

The directory search scope for the role. If set to true, the scope is to search the entire subtree.

resources[].details.aws_amazon_mq_broker.ldap_server_metadata.service_account_username

A username for the service account, which is an account in your LDAP server that has access to initiate a connection.

resources[].details.aws_amazon_mq_broker.ldap_server_metadata.user_base

Selects a particular subtree of the directory information tree (DIT) to search for user entries.

resources[].details.aws_amazon_mq_broker.ldap_server_metadata.user_role_name

The name of the LDAP attribute in the user's directory entry for the user's group membership.

resources[].details.aws_amazon_mq_broker.ldap_server_metadata.user_search_matching

The LDAP search filter used to find users within the userBase.

resources[].details.aws_amazon_mq_broker.ldap_server_metadata.user_search_subtree

The directory search scope for the user. If set to true, the scope is to search the entire subtree.

resources[].details.aws_amazon_mq_broker.logs

Turns on Amazon CloudWatch logging for brokers.

Show child fields
resources[].details.aws_amazon_mq_broker.logs.audit

Activates audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Doesn't apply to RabbitMQ brokers.

resources[].details.aws_amazon_mq_broker.logs.audit_log_group

The location of the CloudWatch Logs log group where audit logs are sent.

resources[].details.aws_amazon_mq_broker.logs.general

Activates general logging.

resources[].details.aws_amazon_mq_broker.logs.general_log_group

The location of the CloudWatch Logs log group where general logs are sent.

resources[].details.aws_amazon_mq_broker.logs.pending

The list of information about logs that are to be turned on for the specified broker.

Show child fields
resources[].details.aws_amazon_mq_broker.logs.pending.audit

Activates audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Doesn't apply to RabbitMQ brokers.

resources[].details.aws_amazon_mq_broker.logs.pending.general

Activates general logging.

resources[].details.aws_amazon_mq_broker.maintenance_window_start_time

The scheduled time period (UTC) during which Amazon MQ begins to apply pending updates or patches to the broker.

Show child fields
resources[].details.aws_amazon_mq_broker.maintenance_window_start_time.day_of_week

The day of the week on which the maintenance window falls.

resources[].details.aws_amazon_mq_broker.maintenance_window_start_time.time_of_day

The time, in 24-hour format, on which the maintenance window falls.

resources[].details.aws_amazon_mq_broker.maintenance_window_start_time.time_zone

The time zone in either the Country/City format or the UTC offset format. UTC is the default format.

resources[].details.aws_amazon_mq_broker.publicly_accessible

Permits connections from applications outside of the VPC that hosts the broker's subnets.

resources[].details.aws_amazon_mq_broker.security_groups[]
resources[].details.aws_amazon_mq_broker.storage_type

The broker's storage type.

resources[].details.aws_amazon_mq_broker.subnet_ids[]
resources[].details.aws_amazon_mq_broker.users[]
Show child fields
resources[].details.aws_amazon_mq_broker.users[].pending_change

The type of change pending for the broker user.

resources[].details.aws_amazon_mq_broker.users[].username

The username of the broker user.

resources[].details.aws_api_gateway_rest_api

Provides information about a REST API in version 1 of Amazon API Gateway.

Show child fields
resources[].details.aws_api_gateway_rest_api.api_key_source

The source of the API key for metering requests according to a usage plan.

HEADER indicates whether to read the API key from the X-API-Key header of a request.

AUTHORIZER indicates whether to read the API key from the UsageIdentifierKey from a custom authorizer.

resources[].details.aws_api_gateway_rest_api.binary_media_types[]
resources[].details.aws_api_gateway_rest_api.created_date

Indicates when the API was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_api_gateway_rest_api.description

A description of the REST API.

resources[].details.aws_api_gateway_rest_api.endpoint_configuration

The endpoint configuration of the REST API.

Show child fields
resources[].details.aws_api_gateway_rest_api.endpoint_configuration.types[]
resources[].details.aws_api_gateway_rest_api.id

The identifier of the REST API.

resources[].details.aws_api_gateway_rest_api.minimum_compression_size

The minimum size in bytes of a payload before compression is enabled.

If null, then compression is disabled.

If 0, then all payloads are compressed.

resources[].details.aws_api_gateway_rest_api.name

The name of the REST API.

resources[].details.aws_api_gateway_rest_api.version

The version identifier for the REST API.

resources[].details.aws_api_gateway_stage

Provides information about a version 1 Amazon API Gateway stage.

Show child fields
resources[].details.aws_api_gateway_stage.access_log_settings

Settings for logging access for the stage.

Show child fields
resources[].details.aws_api_gateway_stage.access_log_settings.destination_arn

The ARN of the CloudWatch Logs log group that receives the access logs.

resources[].details.aws_api_gateway_stage.access_log_settings.format

A single-line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.

resources[].details.aws_api_gateway_stage.cache_cluster_enabled

Indicates whether a cache cluster is enabled for the stage.

resources[].details.aws_api_gateway_stage.cache_cluster_size

If a cache cluster is enabled, the size of the cache cluster.

resources[].details.aws_api_gateway_stage.cache_cluster_status

If a cache cluster is enabled, the status of the cache cluster.

resources[].details.aws_api_gateway_stage.canary_settings

Information about settings for canary deployment in the stage.

Show child fields
resources[].details.aws_api_gateway_stage.canary_settings.deployment_id

The deployment identifier for the canary deployment.

resources[].details.aws_api_gateway_stage.canary_settings.percent_traffic

The percentage of traffic that is diverted to a canary deployment.

resources[].details.aws_api_gateway_stage.canary_settings.stage_variable_overrides

Stage variables that are overridden in the canary release deployment. The variables include new stage variables that are introduced in the canary.

Each variable is represented as a string-to-string map between the stage variable name and the variable value.

resources[].details.aws_api_gateway_stage.canary_settings.use_stage_cache

Indicates whether the canary deployment uses the stage cache.

resources[].details.aws_api_gateway_stage.client_certificate_id

The identifier of the client certificate for the stage.

resources[].details.aws_api_gateway_stage.created_date

Indicates when the stage was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_api_gateway_stage.deployment_id

The identifier of the deployment that the stage points to.

resources[].details.aws_api_gateway_stage.description

A description of the stage.

resources[].details.aws_api_gateway_stage.documentation_version

The version of the API documentation that is associated with the stage.

resources[].details.aws_api_gateway_stage.last_updated_date

Indicates when the stage was most recently updated.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_api_gateway_stage.method_settings[]
Show child fields
resources[].details.aws_api_gateway_stage.method_settings[].cache_data_encrypted

Indicates whether the cached responses are encrypted.

resources[].details.aws_api_gateway_stage.method_settings[].cache_ttl_in_seconds

Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response is cached.

resources[].details.aws_api_gateway_stage.method_settings[].caching_enabled

Indicates whether responses are cached and returned for requests. For responses to be cached, a cache cluster must be enabled on the stage.

resources[].details.aws_api_gateway_stage.method_settings[].data_trace_enabled

Indicates whether data trace logging is enabled for the method. Data trace logging affects the log entries that are pushed to CloudWatch Logs.

resources[].details.aws_api_gateway_stage.method_settings[].http_method

The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.

resources[].details.aws_api_gateway_stage.method_settings[].logging_level

The logging level for this method. The logging level affects the log entries that are pushed to CloudWatch Logs.

If the logging level is ERROR, then the logs only include error-level entries.

If the logging level is INFO, then the logs include both ERROR events and extra informational events.

Valid values: OFF | ERROR | INFO

resources[].details.aws_api_gateway_stage.method_settings[].metrics_enabled

Indicates whether CloudWatch metrics are enabled for the method.

resources[].details.aws_api_gateway_stage.method_settings[].require_authorization_for_cache_control

Indicates whether authorization is required for a cache invalidation request.

resources[].details.aws_api_gateway_stage.method_settings[].resource_path

The resource path for this method. Forward slashes (/) are encoded as ~1 . The initial slash must include a forward slash.

For example, the path value /resource/subresource must be encoded as /~1resource~1subresource.

To specify the root path, use only a slash (/). You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.

resources[].details.aws_api_gateway_stage.method_settings[].throttling_burst_limit

The throttling burst limit for the method.

resources[].details.aws_api_gateway_stage.method_settings[].throttling_rate_limit

The throttling rate limit for the method.

resources[].details.aws_api_gateway_stage.method_settings[].unauthorized_cache_control_header_strategy

Indicates how to handle unauthorized requests for cache invalidation.

Valid values: FAIL_WITH_403 | SUCCEED_WITH_RESPONSE_HEADER | SUCCEED_WITHOUT_RESPONSE_HEADER

resources[].details.aws_api_gateway_stage.stage_name

The name of the stage.

resources[].details.aws_api_gateway_stage.tracing_enabled

Indicates whether active tracing with X-Ray is enabled for the stage.

resources[].details.aws_api_gateway_stage.variables

A map that defines the stage variables for the stage.

Variable names can have alphanumeric and underscore characters.

Variable values can contain the following characters:

  • Uppercase and lowercase letters

  • Numbers

  • Special characters -._~:/?#&=,

resources[].details.aws_api_gateway_stage.web_acl_arn

The ARN of the web ACL associated with the stage.

resources[].details.aws_api_gateway_v2_api

Provides information about a version 2 API in Amazon API Gateway.

Show child fields
resources[].details.aws_api_gateway_v2_api.api_endpoint

The URI of the API.

Uses the format <api-id>.execute-api.<region>.amazonaws.com

The stage name is typically appended to the URI to form a complete path to a deployed API stage.

resources[].details.aws_api_gateway_v2_api.api_id

The identifier of the API.

resources[].details.aws_api_gateway_v2_api.api_key_selection_expression

An API key selection expression. Supported only for WebSocket APIs.

resources[].details.aws_api_gateway_v2_api.cors_configuration

A cross-origin resource sharing (CORS) configuration. Supported only for HTTP APIs.

Show child fields
resources[].details.aws_api_gateway_v2_api.cors_configuration.allow_credentials

Indicates whether the CORS request includes credentials.

resources[].details.aws_api_gateway_v2_api.cors_configuration.allow_headers[]
resources[].details.aws_api_gateway_v2_api.cors_configuration.allow_methods[]
resources[].details.aws_api_gateway_v2_api.cors_configuration.allow_origins[]
resources[].details.aws_api_gateway_v2_api.cors_configuration.expose_headers[]
resources[].details.aws_api_gateway_v2_api.cors_configuration.max_age

The number of seconds for which the browser caches preflight request results.

resources[].details.aws_api_gateway_v2_api.created_date

Indicates when the API was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_api_gateway_v2_api.description

A description of the API.

resources[].details.aws_api_gateway_v2_api.name

The name of the API.

resources[].details.aws_api_gateway_v2_api.protocol_type

The API protocol for the API.

Valid values: WEBSOCKET | HTTP

resources[].details.aws_api_gateway_v2_api.route_selection_expression

The route selection expression for the API.

For HTTP APIs, must be ${request.method} ${request.path}. This is the default value for HTTP APIs.

For WebSocket APIs, there is no default value.

resources[].details.aws_api_gateway_v2_api.version

The version identifier for the API.

resources[].details.aws_api_gateway_v2_stage

Provides information about a version 2 stage for Amazon API Gateway.

Show child fields
resources[].details.aws_api_gateway_v2_stage.access_log_settings

Information about settings for logging access for the stage.

Show child fields
resources[].details.aws_api_gateway_v2_stage.access_log_settings.destination_arn

The ARN of the CloudWatch Logs log group that receives the access logs.

resources[].details.aws_api_gateway_v2_stage.access_log_settings.format

A single-line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.

resources[].details.aws_api_gateway_v2_stage.api_gateway_managed

Indicates whether the stage is managed by API Gateway.

resources[].details.aws_api_gateway_v2_stage.auto_deploy

Indicates whether updates to an API automatically trigger a new deployment.

resources[].details.aws_api_gateway_v2_stage.client_certificate_id

The identifier of a client certificate for a stage. Supported only for WebSocket API calls.

resources[].details.aws_api_gateway_v2_stage.created_date

Indicates when the stage was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_api_gateway_v2_stage.default_route_settings

Default route settings for the stage.

Show child fields
resources[].details.aws_api_gateway_v2_stage.default_route_settings.data_trace_enabled

Indicates whether data trace logging is enabled. Data trace logging affects the log entries that are pushed to CloudWatch Logs. Supported only for WebSocket APIs.

resources[].details.aws_api_gateway_v2_stage.default_route_settings.detailed_metrics_enabled

Indicates whether detailed metrics are enabled.

resources[].details.aws_api_gateway_v2_stage.default_route_settings.logging_level

The logging level. The logging level affects the log entries that are pushed to CloudWatch Logs. Supported only for WebSocket APIs.

If the logging level is ERROR, then the logs only include error-level entries.

If the logging level is INFO, then the logs include both ERROR events and extra informational events.

Valid values: OFF | ERROR | INFO

resources[].details.aws_api_gateway_v2_stage.default_route_settings.throttling_burst_limit

The throttling burst limit.

resources[].details.aws_api_gateway_v2_stage.default_route_settings.throttling_rate_limit

The throttling rate limit.

resources[].details.aws_api_gateway_v2_stage.deployment_id

The identifier of the deployment that the stage is associated with.

resources[].details.aws_api_gateway_v2_stage.description

The description of the stage.

resources[].details.aws_api_gateway_v2_stage.last_deployment_status_message

The status of the last deployment of a stage. Supported only if the stage has automatic deployment enabled.

resources[].details.aws_api_gateway_v2_stage.last_updated_date

Indicates when the stage was most recently updated.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_api_gateway_v2_stage.route_settings

The route settings for the stage.

Show child fields
resources[].details.aws_api_gateway_v2_stage.route_settings.data_trace_enabled

Indicates whether data trace logging is enabled. Data trace logging affects the log entries that are pushed to CloudWatch Logs. Supported only for WebSocket APIs.

resources[].details.aws_api_gateway_v2_stage.route_settings.detailed_metrics_enabled

Indicates whether detailed metrics are enabled.

resources[].details.aws_api_gateway_v2_stage.route_settings.logging_level

The logging level. The logging level affects the log entries that are pushed to CloudWatch Logs. Supported only for WebSocket APIs.

If the logging level is ERROR, then the logs only include error-level entries.

If the logging level is INFO, then the logs include both ERROR events and extra informational events.

Valid values: OFF | ERROR | INFO

resources[].details.aws_api_gateway_v2_stage.route_settings.throttling_burst_limit

The throttling burst limit.

resources[].details.aws_api_gateway_v2_stage.route_settings.throttling_rate_limit

The throttling rate limit.

resources[].details.aws_api_gateway_v2_stage.stage_name

The name of the stage.

resources[].details.aws_api_gateway_v2_stage.stage_variables

A map that defines the stage variables for the stage.

Variable names can have alphanumeric and underscore characters.

Variable values can contain the following characters:

  • Uppercase and lowercase letters

  • Numbers

  • Special characters -._~:/?#&=,

resources[].details.aws_app_sync_graph_ql_api

Provides details about an AppSync Graph QL API, which lets you query multiple databases, microservices, and APIs from a single GraphQL endpoint.

Show child fields
resources[].details.aws_app_sync_graph_ql_api.additional_authentication_providers[]
Show child fields
resources[].details.aws_app_sync_graph_ql_api.additional_authentication_providers[].authentication_type

The type of security configuration for your GraphQL API: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.

resources[].details.aws_app_sync_graph_ql_api.additional_authentication_providers[].lambda_authorizer_config

The configuration for Lambda function authorization.

Show child fields
resources[].details.aws_app_sync_graph_ql_api.additional_authentication_providers[].lambda_authorizer_config.authorizer_result_ttl_in_seconds

The number of seconds a response should be cached for. The default is 5 minutes (300 seconds).

resources[].details.aws_app_sync_graph_ql_api.additional_authentication_providers[].lambda_authorizer_config.authorizer_uri

The Amazon Resource Name (ARN) of the Lambda function to be called for authorization. This can be a standard Lambda ARN, a version ARN (.../v3), or an alias ARN.

resources[].details.aws_app_sync_graph_ql_api.additional_authentication_providers[].lambda_authorizer_config.identity_validation_expression

A regular expression for validation of tokens before the Lambda function is called.

resources[].details.aws_app_sync_graph_ql_api.additional_authentication_providers[].open_id_connect_config

The OpenID Connect configuration.

Show child fields
resources[].details.aws_app_sync_graph_ql_api.additional_authentication_providers[].open_id_connect_config.auth_tt_l

The number of milliseconds that a token is valid after being authenticated.

resources[].details.aws_app_sync_graph_ql_api.additional_authentication_providers[].open_id_connect_config.client_id

The client identifier of the relying party at the OpenID identity provider. This identifier is typically obtained when the relying party is registered with the OpenID identity provider. You can specify a regular expression so that AppSync can validate against multiple client identifiers at a time.

resources[].details.aws_app_sync_graph_ql_api.additional_authentication_providers[].open_id_connect_config.iat_tt_l

The number of milliseconds that a token is valid after it's issued to a user.

resources[].details.aws_app_sync_graph_ql_api.additional_authentication_providers[].open_id_connect_config.issuer

The issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.

resources[].details.aws_app_sync_graph_ql_api.additional_authentication_providers[].user_pool_config

The Amazon Cognito user pools configuration.

Show child fields
resources[].details.aws_app_sync_graph_ql_api.additional_authentication_providers[].user_pool_config.app_id_client_regex

A regular expression for validating the incoming Amazon Cognito user pools app client ID. If this value isn't set, no filtering is applied.

resources[].details.aws_app_sync_graph_ql_api.additional_authentication_providers[].user_pool_config.aws_region

The Amazon Web Services Region in which the user pool was created.

resources[].details.aws_app_sync_graph_ql_api.additional_authentication_providers[].user_pool_config.default_action

The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pools authentication doesn't match the Amazon Cognito user pools configuration.

resources[].details.aws_app_sync_graph_ql_api.additional_authentication_providers[].user_pool_config.user_pool_id

The user pool ID.

resources[].details.aws_app_sync_graph_ql_api.api_id

The unique identifier for the API.

resources[].details.aws_app_sync_graph_ql_api.arn

The Amazon Resource Name (ARN) of the API.

resources[].details.aws_app_sync_graph_ql_api.authentication_type

The type of security configuration for your GraphQL API: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.

resources[].details.aws_app_sync_graph_ql_api.id

The unique identifier for the API.

resources[].details.aws_app_sync_graph_ql_api.lambda_authorizer_config

Specifies the configuration for Lambda function authorization.

Show child fields
resources[].details.aws_app_sync_graph_ql_api.lambda_authorizer_config.authorizer_result_ttl_in_seconds

The number of seconds a response should be cached for. The default is 5 minutes (300 seconds).

resources[].details.aws_app_sync_graph_ql_api.lambda_authorizer_config.authorizer_uri

The Amazon Resource Name (ARN) of the Lambda function to be called for authorization. This can be a standard Lambda ARN, a version ARN (.../v3), or an alias ARN.

resources[].details.aws_app_sync_graph_ql_api.lambda_authorizer_config.identity_validation_expression

A regular expression for validation of tokens before the Lambda function is called.

resources[].details.aws_app_sync_graph_ql_api.log_config

The Amazon CloudWatch Logs configuration.

Show child fields
resources[].details.aws_app_sync_graph_ql_api.log_config.cloud_watch_logs_role_arn

The Amazon Resource Name (ARN) of the service role that AppSync assumes to publish to CloudWatch Logs in your account.

resources[].details.aws_app_sync_graph_ql_api.log_config.exclude_verbose_content

Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.

resources[].details.aws_app_sync_graph_ql_api.log_config.field_log_level

The field logging level.

resources[].details.aws_app_sync_graph_ql_api.name

The API name.

resources[].details.aws_app_sync_graph_ql_api.open_id_connect_config

Specifies the authorization configuration for using an OpenID Connect compliant service with an AppSync GraphQL API endpoint.

Show child fields
resources[].details.aws_app_sync_graph_ql_api.open_id_connect_config.auth_tt_l

The number of milliseconds that a token is valid after being authenticated.

resources[].details.aws_app_sync_graph_ql_api.open_id_connect_config.client_id

The client identifier of the relying party at the OpenID identity provider. This identifier is typically obtained when the relying party is registered with the OpenID identity provider. You can specify a regular expression so that AppSync can validate against multiple client identifiers at a time.

resources[].details.aws_app_sync_graph_ql_api.open_id_connect_config.iat_tt_l

The number of milliseconds that a token is valid after it's issued to a user.

resources[].details.aws_app_sync_graph_ql_api.open_id_connect_config.issuer

The issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.

resources[].details.aws_app_sync_graph_ql_api.user_pool_config

The Amazon Cognito user pools configuration.

Show child fields
resources[].details.aws_app_sync_graph_ql_api.user_pool_config.app_id_client_regex

A regular expression for validating the incoming Amazon Cognito user pools app client ID. If this value isn't set, no filtering is applied.

resources[].details.aws_app_sync_graph_ql_api.user_pool_config.aws_region

The Amazon Web Services Region in which the user pool was created.

resources[].details.aws_app_sync_graph_ql_api.user_pool_config.default_action

The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pools authentication doesn't match the Amazon Cognito user pools configuration.

resources[].details.aws_app_sync_graph_ql_api.user_pool_config.user_pool_id

The user pool ID.

resources[].details.aws_app_sync_graph_ql_api.waf_web_acl_arn

The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) associated with this GraphQL API, if one exists.

resources[].details.aws_app_sync_graph_ql_api.xray_enabled

Indicates whether to use X-Ray tracing for the GraphQL API.

resources[].details.aws_athena_work_group

Provides information about an Amazon Athena workgroup. A workgroup helps you separate users, teams, applications, or workloads. It also helps you set limits on data processing and track costs.

Show child fields
resources[].details.aws_athena_work_group.configuration

The configuration of the workgroup, which includes the location in Amazon Simple Storage Service (Amazon S3) where query results are stored, the encryption option, if any, used for query results, whether Amazon CloudWatch metrics are enabled for the workgroup, and the limit for the amount of bytes scanned (cutoff) per query, if it is specified.

Show child fields
resources[].details.aws_athena_work_group.configuration.result_configuration

The location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query and calculation results. These are known as client-side settings. If workgroup settings override client-side settings, then the query uses the workgroup settings.

Show child fields
resources[].details.aws_athena_work_group.configuration.result_configuration.encryption_configuration

Specifies the method used to encrypt the user’s data stores in the Athena workgroup.

Show child fields
resources[].details.aws_athena_work_group.configuration.result_configuration.encryption_configuration.encryption_option

Indicates whether Amazon Simple Storage Service (Amazon S3) server-side encryption with Amazon S3 managed keys (SSE_S3), server-side encryption with KMS keys (SSE_KMS), or client-side encryption with KMS customer managed keys (CSE_KMS) is used.

resources[].details.aws_athena_work_group.configuration.result_configuration.encryption_configuration.kms_key

For SSE_KMS and CSE_KMS, this is the KMS key Amazon Resource Name (ARN) or ID.

resources[].details.aws_athena_work_group.description

The workgroup description.

resources[].details.aws_athena_work_group.name

The workgroup name.

resources[].details.aws_athena_work_group.state

Whether the workgroup is enabled or disabled.

resources[].details.aws_auto_scaling_auto_scaling_group

Details for an autoscaling group.

Show child fields
resources[].details.aws_auto_scaling_auto_scaling_group.availability_zones[]
Show child fields
resources[].details.aws_auto_scaling_auto_scaling_group.availability_zones[].value

The name of the Availability Zone.

resources[].details.aws_auto_scaling_auto_scaling_group.capacity_rebalance

Indicates whether capacity rebalancing is enabled.

resources[].details.aws_auto_scaling_auto_scaling_group.created_time

Indicates when the auto scaling group was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_auto_scaling_auto_scaling_group.health_check_grace_period

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before it checks the health status of an EC2 instance that has come into service.

resources[].details.aws_auto_scaling_auto_scaling_group.health_check_type

The service to use for the health checks. Valid values are EC2 or ELB.

resources[].details.aws_auto_scaling_auto_scaling_group.launch_configuration_name

The name of the launch configuration.

resources[].details.aws_auto_scaling_auto_scaling_group.launch_template

The launch template to use.

Show child fields
resources[].details.aws_auto_scaling_auto_scaling_group.launch_template.launch_template_id

The identifier of the launch template. You must specify either LaunchTemplateId or LaunchTemplateName.

resources[].details.aws_auto_scaling_auto_scaling_group.launch_template.launch_template_name

The name of the launch template. You must specify either LaunchTemplateId or LaunchTemplateName.

resources[].details.aws_auto_scaling_auto_scaling_group.launch_template.version

Identifies the version of the launch template. You can specify a version identifier, or use the values $Latest or $Default.

resources[].details.aws_auto_scaling_auto_scaling_group.load_balancer_names[]
resources[].details.aws_auto_scaling_auto_scaling_group.mixed_instances_policy

The mixed instances policy for the automatic scaling group.

Show child fields
resources[].details.aws_auto_scaling_auto_scaling_group.mixed_instances_policy.instances_distribution

The instances distribution. The instances distribution specifies the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances, and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacity.

Show child fields
resources[].details.aws_auto_scaling_auto_scaling_group.mixed_instances_policy.instances_distribution.on_demand_allocation_strategy

How to allocate instance types to fulfill On-Demand capacity. The valid value is prioritized.

resources[].details.aws_auto_scaling_auto_scaling_group.mixed_instances_policy.instances_distribution.on_demand_base_capacity

The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances.

resources[].details.aws_auto_scaling_auto_scaling_group.mixed_instances_policy.instances_distribution.on_demand_percentage_above_base_capacity

The percentage of On-Demand Instances and Spot Instances for additional capacity beyond OnDemandBaseCapacity.

resources[].details.aws_auto_scaling_auto_scaling_group.mixed_instances_policy.instances_distribution.spot_allocation_strategy

How to allocate instances across Spot Instance pools. Valid values are as follows:

  • lowest-price

  • capacity-optimized

  • capacity-optimized-prioritized

resources[].details.aws_auto_scaling_auto_scaling_group.mixed_instances_policy.instances_distribution.spot_instance_pools

The number of Spot Instance pools across which to allocate your Spot Instances.

resources[].details.aws_auto_scaling_auto_scaling_group.mixed_instances_policy.instances_distribution.spot_max_price

The maximum price per unit hour that you are willing to pay for a Spot Instance.

resources[].details.aws_auto_scaling_auto_scaling_group.mixed_instances_policy.launch_template

The launch template to use and the instance types (overrides) to use to provision EC2 instances to fulfill On-Demand and Spot capacities.

Show child fields
resources[].details.aws_auto_scaling_auto_scaling_group.mixed_instances_policy.launch_template.launch_template_specification

The launch template to use for a mixed instances policy.

Show child fields
resources[].details.aws_auto_scaling_auto_scaling_group.mixed_instances_policy.launch_template.launch_template_specification.launch_template_id

The identifier of the launch template. You must specify either LaunchTemplateId or LaunchTemplateName.

resources[].details.aws_auto_scaling_auto_scaling_group.mixed_instances_policy.launch_template.launch_template_specification.launch_template_name

The name of the launch template. You must specify either LaunchTemplateId or LaunchTemplateName.

resources[].details.aws_auto_scaling_auto_scaling_group.mixed_instances_policy.launch_template.launch_template_specification.version

Identifies the version of the launch template. You can specify a version identifier, or use the values $Latest or $Default.

resources[].details.aws_auto_scaling_auto_scaling_group.mixed_instances_policy.launch_template.overrides[]
Show child fields
resources[].details.aws_auto_scaling_auto_scaling_group.mixed_instances_policy.launch_template.overrides[].instance_type

The instance type. For example, m3.xlarge.

resources[].details.aws_auto_scaling_auto_scaling_group.mixed_instances_policy.launch_template.overrides[].weighted_capacity

The number of capacity units provided by the specified instance type in terms of virtual CPUs, memory, storage, throughput, or other relative performance characteristic.

resources[].details.aws_auto_scaling_launch_configuration

Provides details about a launch configuration.

Show child fields
resources[].details.aws_auto_scaling_launch_configuration.associate_public_ip_address

For Auto Scaling groups that run in a VPC, specifies whether to assign a public IP address to the group's instances.

resources[].details.aws_auto_scaling_launch_configuration.block_device_mappings[]
Show child fields
resources[].details.aws_auto_scaling_launch_configuration.block_device_mappings[].device_name

The device name that is exposed to the EC2 instance. For example, /dev/sdh or xvdh.

resources[].details.aws_auto_scaling_launch_configuration.block_device_mappings[].ebs

Parameters that are used to automatically set up Amazon EBS volumes when an instance is launched.

Show child fields
resources[].details.aws_auto_scaling_launch_configuration.block_device_mappings[].ebs.delete_on_termination

Whether to delete the volume when the instance is terminated.

resources[].details.aws_auto_scaling_launch_configuration.block_device_mappings[].ebs.encrypted

Whether to encrypt the volume.

resources[].details.aws_auto_scaling_launch_configuration.block_device_mappings[].ebs.iops

The number of input/output (I/O) operations per second (IOPS) to provision for the volume.

Only supported for gp3 or io1 volumes. Required for io1 volumes. Not used with standard, gp2, st1, or sc1 volumes.

resources[].details.aws_auto_scaling_launch_configuration.block_device_mappings[].ebs.snapshot_id

The snapshot ID of the volume to use.

You must specify either VolumeSize or SnapshotId.

resources[].details.aws_auto_scaling_launch_configuration.block_device_mappings[].ebs.volume_size

The volume size, in GiBs. The following are the supported volumes sizes for each volume type:

  • gp2 and gp3: 1-16,384

  • io1: 4-16,384

  • st1 and sc1: 125-16,384

  • standard: 1-1,024

You must specify either SnapshotId or VolumeSize. If you specify both SnapshotId and VolumeSize, the volume size must be equal or greater than the size of the snapshot.

resources[].details.aws_auto_scaling_launch_configuration.block_device_mappings[].ebs.volume_type

The volume type. Valid values are as follows:

  • gp2

  • gp3

  • io1

  • sc1

  • st1

  • standard

resources[].details.aws_auto_scaling_launch_configuration.block_device_mappings[].no_device

Whether to suppress the device that is included in the block device mapping of the Amazon Machine Image (AMI).

If NoDevice is true, then you cannot specify Ebs.>

resources[].details.aws_auto_scaling_launch_configuration.block_device_mappings[].virtual_name

The name of the virtual device (for example, ephemeral0).

You can provide either VirtualName or Ebs, but not both.

resources[].details.aws_auto_scaling_launch_configuration.classic_link_vpc_id

The identifier of a ClassicLink-enabled VPC that EC2-Classic instances are linked to.

resources[].details.aws_auto_scaling_launch_configuration.classic_link_vpc_security_groups[]
resources[].details.aws_auto_scaling_launch_configuration.created_time

The creation date and time for the launch configuration.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_auto_scaling_launch_configuration.ebs_optimized

Whether the launch configuration is optimized for Amazon EBS I/O.

resources[].details.aws_auto_scaling_launch_configuration.iam_instance_profile

The name or the ARN of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role.

resources[].details.aws_auto_scaling_launch_configuration.image_id

The identifier of the Amazon Machine Image (AMI) that is used to launch EC2 instances.

resources[].details.aws_auto_scaling_launch_configuration.instance_monitoring

Indicates the type of monitoring for instances in the group.

Show child fields
resources[].details.aws_auto_scaling_launch_configuration.instance_monitoring.enabled

If set to true, then instances in the group launch with detailed monitoring.

If set to false, then instances in the group launch with basic monitoring.

resources[].details.aws_auto_scaling_launch_configuration.instance_type

The instance type for the instances.

resources[].details.aws_auto_scaling_launch_configuration.kernel_id

The identifier of the kernel associated with the AMI.

resources[].details.aws_auto_scaling_launch_configuration.key_name

The name of the key pair.

resources[].details.aws_auto_scaling_launch_configuration.launch_configuration_name

The name of the launch configuration.

resources[].details.aws_auto_scaling_launch_configuration.metadata_options

The metadata options for the instances.

Show child fields
resources[].details.aws_auto_scaling_launch_configuration.metadata_options.http_endpoint

Enables or disables the HTTP metadata endpoint on your instances. By default, the metadata endpoint is enabled.

resources[].details.aws_auto_scaling_launch_configuration.metadata_options.http_put_response_hop_limit

The HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.

resources[].details.aws_auto_scaling_launch_configuration.metadata_options.http_tokens

Indicates whether token usage is required or optional for metadata requests. By default, token usage is optional.

resources[].details.aws_auto_scaling_launch_configuration.placement_tenancy

The tenancy of the instance. An instance with dedicated tenancy runs on isolated, single-tenant hardware and can only be launched into a VPC.

resources[].details.aws_auto_scaling_launch_configuration.ramdisk_id

The identifier of the RAM disk associated with the AMI.

resources[].details.aws_auto_scaling_launch_configuration.security_groups[]
resources[].details.aws_auto_scaling_launch_configuration.spot_price

The maximum hourly price to be paid for any Spot Instance that is launched to fulfill the request.

resources[].details.aws_auto_scaling_launch_configuration.user_data

The user data to make available to the launched EC2 instances. Must be base64-encoded text.

resources[].details.aws_backup_backup_plan

Provides details about an Backup backup plan.

Show child fields
resources[].details.aws_backup_backup_plan.backup_plan

Uniquely identifies the backup plan to be associated with the selection of resources.

Show child fields
resources[].details.aws_backup_backup_plan.backup_plan.advanced_backup_settings[]
Show child fields
resources[].details.aws_backup_backup_plan.backup_plan.advanced_backup_settings[].backup_options

Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs. Valid values are as follows:

  • Set to WindowsVSS: enabled to enable the WindowsVSS backup option and create a Windows VSS backup.

  • Set to WindowsVSS: disabled to create a regular backup. The WindowsVSS option is not enabled by default.

resources[].details.aws_backup_backup_plan.backup_plan.advanced_backup_settings[].resource_type

The name of a resource type. The only supported resource type is Amazon EC2 instances with Windows VSS.

The only valid value is EC2.

resources[].details.aws_backup_backup_plan.backup_plan.backup_plan_name

The display name of a backup plan.

resources[].details.aws_backup_backup_plan.backup_plan.backup_plan_rule[]
Show child fields
resources[].details.aws_backup_backup_plan.backup_plan.backup_plan_rule[].completion_window_minutes

A value in minutes after a backup job is successfully started before it must be completed, or it is canceled by Backup.

resources[].details.aws_backup_backup_plan.backup_plan.backup_plan_rule[].copy_actions[]
Show child fields
resources[].details.aws_backup_backup_plan.backup_plan.backup_plan_rule[].copy_actions[].destination_backup_vault_arn

An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for the copied backup.

resources[].details.aws_backup_backup_plan.backup_plan.backup_plan_rule[].copy_actions[].lifecycle

Defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. If you do not specify a lifecycle, Backup applies the lifecycle policy of the source backup to the destination backup.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.

Show child fields
resources[].details.aws_backup_backup_plan.backup_plan.backup_plan_rule[].copy_actions[].lifecycle.delete_after_days

Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.

resources[].details.aws_backup_backup_plan.backup_plan.backup_plan_rule[].copy_actions[].lifecycle.move_to_cold_storage_after_days

Specifies the number of days after creation that a recovery point is moved to cold storage.

resources[].details.aws_backup_backup_plan.backup_plan.backup_plan_rule[].enable_continuous_backup

Specifies whether Backup creates continuous backups capable of point-in-time restore (PITR).

resources[].details.aws_backup_backup_plan.backup_plan.backup_plan_rule[].lifecycle

Defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. If you do not specify a lifecycle, Backup applies the lifecycle policy of the source backup to the destination backup.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.

Show child fields
resources[].details.aws_backup_backup_plan.backup_plan.backup_plan_rule[].lifecycle.delete_after_days

Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.

resources[].details.aws_backup_backup_plan.backup_plan.backup_plan_rule[].lifecycle.move_to_cold_storage_after_days

Specifies the number of days after creation that a recovery point is moved to cold storage.

resources[].details.aws_backup_backup_plan.backup_plan.backup_plan_rule[].rule_id

Uniquely identifies a rule that is used to schedule the backup of a selection of resources.

resources[].details.aws_backup_backup_plan.backup_plan.backup_plan_rule[].rule_name

A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.

resources[].details.aws_backup_backup_plan.backup_plan.backup_plan_rule[].schedule_expression

A cron expression in UTC specifying when Backup initiates a backup job.

resources[].details.aws_backup_backup_plan.backup_plan.backup_plan_rule[].start_window_minutes

A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully.

resources[].details.aws_backup_backup_plan.backup_plan.backup_plan_rule[].target_backup_vault

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the Amazon Web Services account used to create them and the Amazon Web Services Region where they are created. They consist of letters, numbers, and hyphens.

resources[].details.aws_backup_backup_plan.backup_plan_arn

An Amazon Resource Name (ARN) that uniquely identifies the backup plan.

resources[].details.aws_backup_backup_plan.backup_plan_id

A unique ID for the backup plan.

resources[].details.aws_backup_backup_plan.version_id

Unique, randomly generated, Unicode, UTF-8 encoded strings. Version IDs cannot be edited.

resources[].details.aws_backup_backup_vault

Provides details about an Backup backup vault.

Show child fields
resources[].details.aws_backup_backup_vault.access_policy

A resource-based policy that is used to manage access permissions on the target backup vault.

resources[].details.aws_backup_backup_vault.backup_vault_arn

An Amazon Resource Name (ARN) that uniquely identifies a backup vault.

resources[].details.aws_backup_backup_vault.backup_vault_name

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the Amazon Web Services account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

resources[].details.aws_backup_backup_vault.encryption_key_arn

The unique ARN associated with the server-side encryption key. You can specify a key to encrypt your backups from services that support full Backup management. If you do not specify a key, Backup creates an KMS key for you by default.

resources[].details.aws_backup_backup_vault.notifications

The Amazon SNS event notifications for the specified backup vault.

Show child fields
resources[].details.aws_backup_backup_vault.notifications.backup_vault_events[]
resources[].details.aws_backup_backup_vault.notifications.sns_topic_arn

The Amazon Resource Name (ARN) that uniquely identifies the Amazon SNS topic for a backup vault's events.

resources[].details.aws_backup_recovery_point

Provides details about an Backup backup, or recovery point.

Show child fields
resources[].details.aws_backup_recovery_point.backup_size_in_bytes

The size, in bytes, of a backup.

resources[].details.aws_backup_recovery_point.backup_vault_arn

An Amazon Resource Name (ARN) that uniquely identifies a backup vault.

resources[].details.aws_backup_recovery_point.backup_vault_name

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the Amazon Web Services account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

resources[].details.aws_backup_recovery_point.calculated_lifecycle

A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.

Show child fields
resources[].details.aws_backup_recovery_point.calculated_lifecycle.delete_at

Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.

resources[].details.aws_backup_recovery_point.calculated_lifecycle.move_to_cold_storage_at

Specifies the number of days after creation that a recovery point is moved to cold storage.

resources[].details.aws_backup_recovery_point.completion_date

The date and time that a job to create a recovery point is completed, in Unix format and UTC. The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

resources[].details.aws_backup_recovery_point.created_by

Contains identifying information about the creation of a recovery point, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to create it.

Show child fields
resources[].details.aws_backup_recovery_point.created_by.backup_plan_arn

An Amazon Resource Name (ARN) that uniquely identifies a backup plan.

resources[].details.aws_backup_recovery_point.created_by.backup_plan_id

Uniquely identifies a backup plan.

resources[].details.aws_backup_recovery_point.created_by.backup_plan_version

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

resources[].details.aws_backup_recovery_point.created_by.backup_rule_id

Uniquely identifies a rule used to schedule the backup of a selection of resources.

resources[].details.aws_backup_recovery_point.creation_date

The date and time a recovery point is created, in Unix format and UTC. The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

resources[].details.aws_backup_recovery_point.encryption_key_arn

The ARN for the server-side encryption key that is used to protect your backups.

resources[].details.aws_backup_recovery_point.iam_role_arn

Specifies the IAM role ARN used to create the target recovery point

resources[].details.aws_backup_recovery_point.is_encrypted

A Boolean value that is returned as TRUE if the specified recovery point is encrypted, or FALSE if the recovery point is not encrypted.

resources[].details.aws_backup_recovery_point.last_restore_time

The date and time that a recovery point was last restored, in Unix format and UTC. The value of LastRestoreTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

resources[].details.aws_backup_recovery_point.lifecycle

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define

Show child fields
resources[].details.aws_backup_recovery_point.lifecycle.delete_after_days

Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.

resources[].details.aws_backup_recovery_point.lifecycle.move_to_cold_storage_after_days

Specifies the number of days after creation that a recovery point is moved to cold storage.

resources[].details.aws_backup_recovery_point.recovery_point_arn

An ARN that uniquely identifies a recovery point.

resources[].details.aws_backup_recovery_point.resource_arn

An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

resources[].details.aws_backup_recovery_point.resource_type

The type of Amazon Web Services resource saved as a recovery point, such as an Amazon EBS volume or an Amazon RDS database.

resources[].details.aws_backup_recovery_point.source_backup_vault_arn

The ARN for the backup vault where the recovery point was originally copied from. If the recovery point is restored to the same account, this value will be null.

resources[].details.aws_backup_recovery_point.status

A status code specifying the state of the recovery point. Valid values are as follows:

  • COMPLETED

  • DELETING

  • EXPIRED

  • PARTIAL

resources[].details.aws_backup_recovery_point.status_message

A message explaining the reason of the recovery point deletion failure.

resources[].details.aws_backup_recovery_point.storage_class

Specifies the storage class of the recovery point. Valid values are as follows:

  • COLD

  • DELETED

  • WARM

resources[].details.aws_certificate_manager_certificate

Provides details about an Certificate Manager certificate.

Show child fields
resources[].details.aws_certificate_manager_certificate.certificate_authority_arn

The ARN of the private certificate authority (CA) that will be used to issue the certificate.

resources[].details.aws_certificate_manager_certificate.created_at

Indicates when the certificate was requested.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_certificate_manager_certificate.domain_name

The fully qualified domain name (FQDN), such as www.example.com, that is secured by the certificate.

resources[].details.aws_certificate_manager_certificate.domain_validation_options[]
Show child fields
resources[].details.aws_certificate_manager_certificate.domain_validation_options[].domain_name

A fully qualified domain name (FQDN) in the certificate.

resources[].details.aws_certificate_manager_certificate.domain_validation_options[].resource_record

The CNAME record that is added to the DNS database for domain validation.

Show child fields
resources[].details.aws_certificate_manager_certificate.domain_validation_options[].resource_record.name

The name of the resource.

resources[].details.aws_certificate_manager_certificate.domain_validation_options[].resource_record.type

The type of resource.

resources[].details.aws_certificate_manager_certificate.domain_validation_options[].resource_record.value

The value of the resource.

resources[].details.aws_certificate_manager_certificate.domain_validation_options[].validation_domain

The domain name that Certificate Manager uses to send domain validation emails.

resources[].details.aws_certificate_manager_certificate.domain_validation_options[].validation_emails[]
resources[].details.aws_certificate_manager_certificate.domain_validation_options[].validation_method

The method used to validate the domain name.

resources[].details.aws_certificate_manager_certificate.domain_validation_options[].validation_status

The validation status of the domain name.

resources[].details.aws_certificate_manager_certificate.extended_key_usages[]
Show child fields
resources[].details.aws_certificate_manager_certificate.extended_key_usages[].name

The name of an extension value. Indicates the purpose for which the certificate public key can be used.

resources[].details.aws_certificate_manager_certificate.extended_key_usages[].o_id

An object identifier (OID) for the extension value.

The format is numbers separated by periods.

resources[].details.aws_certificate_manager_certificate.failure_reason

For a failed certificate request, the reason for the failure.

Valid values: NO_AVAILABLE_CONTACTS | ADDITIONAL_VERIFICATION_REQUIRED | DOMAIN_NOT_ALLOWED | INVALID_PUBLIC_DOMAIN | DOMAIN_VALIDATION_DENIED | CAA_ERROR | PCA_LIMIT_EXCEEDED | PCA_INVALID_ARN | PCA_INVALID_STATE | PCA_REQUEST_FAILED | PCA_NAME_CONSTRAINTS_VALIDATION | PCA_RESOURCE_NOT_FOUND | PCA_INVALID_ARGS | PCA_INVALID_DURATION | PCA_ACCESS_DENIED | SLR_NOT_FOUND | OTHER

resources[].details.aws_certificate_manager_certificate.imported_at

Indicates when the certificate was imported. Provided if the certificate type is IMPORTED.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_certificate_manager_certificate.in_use_by[]
resources[].details.aws_certificate_manager_certificate.issued_at

Indicates when the certificate was issued. Provided if the certificate type is AMAZON_ISSUED.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_certificate_manager_certificate.issuer

The name of the certificate authority that issued and signed the certificate.

resources[].details.aws_certificate_manager_certificate.key_algorithm

The algorithm that was used to generate the public-private key pair.

Valid values: RSA_2048 | RSA_1024 | RSA_4096 | EC_prime256v1 | EC_secp384r1 | EC_secp521r1

resources[].details.aws_certificate_manager_certificate.key_usages[]
Show child fields
resources[].details.aws_certificate_manager_certificate.key_usages[].name

The key usage extension name.

resources[].details.aws_certificate_manager_certificate.not_after

The time after which the certificate becomes invalid.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_certificate_manager_certificate.not_before

The time before which the certificate is not valid.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_certificate_manager_certificate.options

Provides a value that specifies whether to add the certificate to a transparency log.

Show child fields
resources[].details.aws_certificate_manager_certificate.options.certificate_transparency_logging_preference

Whether to add the certificate to a transparency log.

Valid values: DISABLED | ENABLED

resources[].details.aws_certificate_manager_certificate.renewal_eligibility

Whether the certificate is eligible for renewal.

Valid values: ELIGIBLE | INELIGIBLE

resources[].details.aws_certificate_manager_certificate.renewal_summary

Information about the status of the Certificate Manager managed renewal for the certificate. Provided only when the certificate type is AMAZON_ISSUED.

Show child fields
resources[].details.aws_certificate_manager_certificate.renewal_summary.domain_validation_options[]
Show child fields
resources[].details.aws_certificate_manager_certificate.renewal_summary.domain_validation_options[].domain_name

A fully qualified domain name (FQDN) in the certificate.

resources[].details.aws_certificate_manager_certificate.renewal_summary.domain_validation_options[].resource_record

The CNAME record that is added to the DNS database for domain validation.

Show child fields
resources[].details.aws_certificate_manager_certificate.renewal_summary.domain_validation_options[].resource_record.name

The name of the resource.

resources[].details.aws_certificate_manager_certificate.renewal_summary.domain_validation_options[].resource_record.type

The type of resource.

resources[].details.aws_certificate_manager_certificate.renewal_summary.domain_validation_options[].resource_record.value

The value of the resource.

resources[].details.aws_certificate_manager_certificate.renewal_summary.domain_validation_options[].validation_domain

The domain name that Certificate Manager uses to send domain validation emails.

resources[].details.aws_certificate_manager_certificate.renewal_summary.domain_validation_options[].validation_emails[]
resources[].details.aws_certificate_manager_certificate.renewal_summary.domain_validation_options[].validation_method

The method used to validate the domain name.

resources[].details.aws_certificate_manager_certificate.renewal_summary.domain_validation_options[].validation_status

The validation status of the domain name.

resources[].details.aws_certificate_manager_certificate.renewal_summary.renewal_status

The status of the Certificate Manager managed renewal of the certificate.

Valid values: PENDING_AUTO_RENEWAL | PENDING_VALIDATION | SUCCESS | FAILED

resources[].details.aws_certificate_manager_certificate.renewal_summary.renewal_status_reason

The reason that a renewal request was unsuccessful. This attribute is used only when RenewalStatus is FAILED.

Valid values: NO_AVAILABLE_CONTACTS | ADDITIONAL_VERIFICATION_REQUIRED | DOMAIN_NOT_ALLOWED | INVALID_PUBLIC_DOMAIN | DOMAIN_VALIDATION_DENIED | CAA_ERROR | PCA_LIMIT_EXCEEDED | PCA_INVALID_ARN | PCA_INVALID_STATE | PCA_REQUEST_FAILED | PCA_NAME_CONSTRAINTS_VALIDATION | PCA_RESOURCE_NOT_FOUND | PCA_INVALID_ARGS | PCA_INVALID_DURATION | PCA_ACCESS_DENIED | SLR_NOT_FOUND | OTHER

resources[].details.aws_certificate_manager_certificate.renewal_summary.updated_at

Indicates when the renewal summary was last updated.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_certificate_manager_certificate.serial

The serial number of the certificate.

resources[].details.aws_certificate_manager_certificate.signature_algorithm

The algorithm that was used to sign the certificate.

resources[].details.aws_certificate_manager_certificate.status

The status of the certificate.

Valid values: PENDING_VALIDATION | ISSUED | INACTIVE | EXPIRED | VALIDATION_TIMED_OUT | REVOKED | FAILED

resources[].details.aws_certificate_manager_certificate.subject

The name of the entity that is associated with the public key contained in the certificate.

resources[].details.aws_certificate_manager_certificate.subject_alternative_names[]
resources[].details.aws_certificate_manager_certificate.type

The source of the certificate. For certificates that Certificate Manager provides, Type is AMAZON_ISSUED. For certificates that are imported with ImportCertificate, Type is IMPORTED.

Valid values: IMPORTED | AMAZON_ISSUED | PRIVATE

resources[].details.aws_cloud_formation_stack

Details about an CloudFormation stack. A stack is a collection of Amazon Web Services resources that you can manage as a single unit.

Show child fields
resources[].details.aws_cloud_formation_stack.capabilities[]
resources[].details.aws_cloud_formation_stack.creation_time

The time at which the stack was created.

resources[].details.aws_cloud_formation_stack.description

A user-defined description associated with the stack.

resources[].details.aws_cloud_formation_stack.disable_rollback

Boolean to enable or disable rollback on stack creation failures.

resources[].details.aws_cloud_formation_stack.drift_information

Information about whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters.

Show child fields
resources[].details.aws_cloud_formation_stack.drift_information.stack_drift_status

Status of the stack's actual configuration compared to its expected template configuration.

resources[].details.aws_cloud_formation_stack.enable_termination_protection

Whether termination protection is enabled for the stack.

resources[].details.aws_cloud_formation_stack.last_updated_time

The time the nested stack was last updated. This field will only be returned if the stack has been updated at least once.

resources[].details.aws_cloud_formation_stack.notification_arns[]
resources[].details.aws_cloud_formation_stack.outputs[]
Show child fields
resources[].details.aws_cloud_formation_stack.outputs[].description

A user-defined description associated with the output.

resources[].details.aws_cloud_formation_stack.outputs[].output_key

The key associated with the output.

resources[].details.aws_cloud_formation_stack.outputs[].output_value

The value associated with the output.

resources[].details.aws_cloud_formation_stack.role_arn

The ARN of an IAM role that's associated with the stack.

resources[].details.aws_cloud_formation_stack.stack_id

Unique identifier of the stack.

resources[].details.aws_cloud_formation_stack.stack_name

The name associated with the stack.

resources[].details.aws_cloud_formation_stack.stack_status

Current status of the stack.

resources[].details.aws_cloud_formation_stack.stack_status_reason

Success or failure message associated with the stack status.

resources[].details.aws_cloud_formation_stack.timeout_in_minutes

The length of time, in minutes, that CloudFormation waits for the nested stack to reach the CREATE_COMPLETE state.

resources[].details.aws_cloud_front_distribution

Details about a CloudFront distribution.

Show child fields
resources[].details.aws_cloud_front_distribution.cache_behaviors

Provides information about the cache configuration for the distribution.

Show child fields
resources[].details.aws_cloud_front_distribution.cache_behaviors.items[]
Show child fields
resources[].details.aws_cloud_front_distribution.cache_behaviors.items[].viewer_protocol_policy

The protocol that viewers can use to access the files in an origin. You can specify the following options:

  • allow-all - Viewers can use HTTP or HTTPS.

  • redirect-to-https - CloudFront responds to HTTP requests with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL. The viewer then uses the new URL to resubmit.

  • https-only - CloudFront responds to HTTP request with an HTTP status code of 403 (Forbidden).

resources[].details.aws_cloud_front_distribution.default_cache_behavior

The default cache behavior for the configuration.

Show child fields
resources[].details.aws_cloud_front_distribution.default_cache_behavior.viewer_protocol_policy

The protocol that viewers can use to access the files in an origin. You can specify the following options:

  • allow-all - Viewers can use HTTP or HTTPS.

  • redirect-to-https - CloudFront responds to HTTP requests with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL. The viewer then uses the new URL to resubmit.

  • https-only - CloudFront responds to HTTP request with an HTTP status code of 403 (Forbidden).

resources[].details.aws_cloud_front_distribution.default_root_object

The object that CloudFront sends in response to requests from the origin (for example, index.html) when a viewer requests the root URL for the distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/product-description.html).

resources[].details.aws_cloud_front_distribution.domain_name

The domain name corresponding to the distribution.

resources[].details.aws_cloud_front_distribution.e_tag

The entity tag is a hash of the object.

resources[].details.aws_cloud_front_distribution.last_modified_time

Indicates when that the distribution was last modified.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_cloud_front_distribution.logging

A complex type that controls whether access logs are written for the distribution.

Show child fields
resources[].details.aws_cloud_front_distribution.logging.bucket

The S3 bucket to store the access logs in.

resources[].details.aws_cloud_front_distribution.logging.enabled

With this field, you can enable or disable the selected distribution.

resources[].details.aws_cloud_front_distribution.logging.include_cookies

Specifies whether you want CloudFront to include cookies in access logs.

resources[].details.aws_cloud_front_distribution.logging.prefix

An optional string that you want CloudFront to use as a prefix to the access log filenames for this distribution.

resources[].details.aws_cloud_front_distribution.origin_groups

Provides information about the origin groups in the distribution.

Show child fields
resources[].details.aws_cloud_front_distribution.origin_groups.items[]
Show child fields
resources[].details.aws_cloud_front_distribution.origin_groups.items[].failover_criteria

Provides the criteria for an origin group to fail over.

Show child fields
resources[].details.aws_cloud_front_distribution.origin_groups.items[].failover_criteria.status_codes

Information about the status codes that cause an origin group to fail over.

Show child fields
resources[].details.aws_cloud_front_distribution.origin_groups.items[].failover_criteria.status_codes.items[]
resources[].details.aws_cloud_front_distribution.origin_groups.items[].failover_criteria.status_codes.quantity

The number of status codes that can cause a failover.

resources[].details.aws_cloud_front_distribution.origins

A complex type that contains information about origins for this distribution.

Show child fields
resources[].details.aws_cloud_front_distribution.origins.items[]
Show child fields
resources[].details.aws_cloud_front_distribution.origins.items[].custom_origin_config

An origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this attribute. If the Amazon S3 bucket is not configured with static website hosting, use the S3OriginConfig type instead.

Show child fields
resources[].details.aws_cloud_front_distribution.origins.items[].custom_origin_config.http_port

The HTTP port that CloudFront uses to connect to the origin.

resources[].details.aws_cloud_front_distribution.origins.items[].custom_origin_config.https_port

The HTTPS port that CloudFront uses to connect to the origin.

resources[].details.aws_cloud_front_distribution.origins.items[].custom_origin_config.origin_keepalive_timeout

Specifies how long, in seconds, CloudFront persists its connection to the origin.

resources[].details.aws_cloud_front_distribution.origins.items[].custom_origin_config.origin_protocol_policy

Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin.

resources[].details.aws_cloud_front_distribution.origins.items[].custom_origin_config.origin_read_timeout

Specifies how long, in seconds, CloudFront waits for a response from the origin.

resources[].details.aws_cloud_front_distribution.origins.items[].custom_origin_config.origin_ssl_protocols

Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS.

Show child fields
resources[].details.aws_cloud_front_distribution.origins.items[].custom_origin_config.origin_ssl_protocols.items[]
resources[].details.aws_cloud_front_distribution.origins.items[].custom_origin_config.origin_ssl_protocols.quantity

The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.

resources[].details.aws_cloud_front_distribution.origins.items[].domain_name

Amazon S3 origins: The DNS name of the S3 bucket from which you want CloudFront to get objects for this origin.

resources[].details.aws_cloud_front_distribution.origins.items[].id

A unique identifier for the origin or origin group.

resources[].details.aws_cloud_front_distribution.origins.items[].origin_path

An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin.

resources[].details.aws_cloud_front_distribution.origins.items[].s3_origin_config

An origin that is an S3 bucket that is not configured with static website hosting.

Show child fields
resources[].details.aws_cloud_front_distribution.origins.items[].s3_origin_config.origin_access_identity

The CloudFront origin access identity to associate with the origin.

resources[].details.aws_cloud_front_distribution.status

Indicates the current status of the distribution.

resources[].details.aws_cloud_front_distribution.viewer_certificate

Provides information about the TLS/SSL configuration that the distribution uses to communicate with viewers.

Show child fields
resources[].details.aws_cloud_front_distribution.viewer_certificate.acm_certificate_arn

The ARN of the ACM certificate. Used if the certificate is stored in ACM. If you provide an ACM certificate ARN, you must also provide MinimumCertificateVersion and SslSupportMethod.

resources[].details.aws_cloud_front_distribution.viewer_certificate.certificate

The identifier of the certificate. Note that in CloudFront, this attribute is deprecated.

resources[].details.aws_cloud_front_distribution.viewer_certificate.certificate_source

The source of the certificate identified by Certificate. Note that in CloudFront, this attribute is deprecated.

resources[].details.aws_cloud_front_distribution.viewer_certificate.cloud_front_default_certificate

Whether the distribution uses the CloudFront domain name. If set to false, then you provide either AcmCertificateArn or IamCertificateId.

resources[].details.aws_cloud_front_distribution.viewer_certificate.iam_certificate_id

The identifier of the IAM certificate. Used if the certificate is stored in IAM. If you provide IamCertificateId, then you also must provide MinimumProtocolVersion and SslSupportMethod.

resources[].details.aws_cloud_front_distribution.viewer_certificate.minimum_protocol_version

The security policy that CloudFront uses for HTTPS connections with viewers. If SslSupportMethod is sni-only, then MinimumProtocolVersion must be TLSv1 or higher.

resources[].details.aws_cloud_front_distribution.viewer_certificate.ssl_support_method

The viewers that the distribution accepts HTTPS connections from.

resources[].details.aws_cloud_front_distribution.web_acl_id

A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution.

resources[].details.aws_cloud_trail_trail

Provides details about a CloudTrail trail.

Show child fields
resources[].details.aws_cloud_trail_trail.cloud_watch_logs_log_group_arn

The ARN of the log group that CloudTrail logs are delivered to.

resources[].details.aws_cloud_trail_trail.cloud_watch_logs_role_arn

The ARN of the role that the CloudWatch Events endpoint assumes when it writes to the log group.

resources[].details.aws_cloud_trail_trail.has_custom_event_selectors

Indicates whether the trail has custom event selectors.

resources[].details.aws_cloud_trail_trail.home_region

The Region where the trail was created.

resources[].details.aws_cloud_trail_trail.include_global_service_events

Indicates whether the trail publishes events from global services such as IAM to the log files.

resources[].details.aws_cloud_trail_trail.is_multi_region_trail

Indicates whether the trail applies only to the current Region or to all Regions.

resources[].details.aws_cloud_trail_trail.is_organization_trail

Whether the trail is created for all accounts in an organization in Organizations, or only for the current Amazon Web Services account.

resources[].details.aws_cloud_trail_trail.kms_key_id

The KMS key ID to use to encrypt the logs.

resources[].details.aws_cloud_trail_trail.log_file_validation_enabled

Indicates whether CloudTrail log file validation is enabled.

resources[].details.aws_cloud_trail_trail.name

The name of the trail.

resources[].details.aws_cloud_trail_trail.s3_bucket_name

The name of the S3 bucket where the log files are published.

resources[].details.aws_cloud_trail_trail.s3_key_prefix

The S3 key prefix. The key prefix is added after the name of the S3 bucket where the log files are published.

resources[].details.aws_cloud_trail_trail.sns_topic_arn

The ARN of the SNS topic that is used for notifications of log file delivery.

resources[].details.aws_cloud_trail_trail.sns_topic_name

The name of the SNS topic that is used for notifications of log file delivery.

resources[].details.aws_cloud_trail_trail.trail_arn

The ARN of the trail.

resources[].details.aws_cloud_watch_alarm

Details about an Amazon CloudWatch alarm. An alarm allows you to monitor and receive alerts about your Amazon Web Services resources and applications across multiple Regions.

Show child fields
resources[].details.aws_cloud_watch_alarm.actions_enabled

Indicates whether actions should be executed during any changes to the alarm state.

resources[].details.aws_cloud_watch_alarm.alarm_actions[]
resources[].details.aws_cloud_watch_alarm.alarm_arn

The ARN of the alarm.

resources[].details.aws_cloud_watch_alarm.alarm_configuration_updated_timestamp

The time stamp of the last update to the alarm configuration.

resources[].details.aws_cloud_watch_alarm.alarm_description

The description of the alarm.

resources[].details.aws_cloud_watch_alarm.alarm_name

The name of the alarm. If you don't specify a name, CloudFront generates a unique physical ID and uses that ID for the alarm name.

resources[].details.aws_cloud_watch_alarm.comparison_operator

The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.

resources[].details.aws_cloud_watch_alarm.datapoints_to_alarm

The number of datapoints that must be breaching to trigger the alarm.

resources[].details.aws_cloud_watch_alarm.dimensions[]
Show child fields
resources[].details.aws_cloud_watch_alarm.dimensions[].name

The name of a dimension.

resources[].details.aws_cloud_watch_alarm.dimensions[].value

The value of a dimension.

resources[].details.aws_cloud_watch_alarm.evaluate_low_sample_count_percentile

Used only for alarms based on percentiles. If ignore, the alarm state does not change during periods with too few data points to be statistically significant. If evaluate or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.

resources[].details.aws_cloud_watch_alarm.evaluation_periods

The number of periods over which data is compared to the specified threshold.

resources[].details.aws_cloud_watch_alarm.extended_statistic

The percentile statistic for the metric associated with the alarm.

resources[].details.aws_cloud_watch_alarm.insufficient_data_actions[]
resources[].details.aws_cloud_watch_alarm.metric_name

The name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use Metrics instead and you can't specify MetricName.

resources[].details.aws_cloud_watch_alarm.namespace

The namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify Namespace and you use Metrics instead.

resources[].details.aws_cloud_watch_alarm.ok_actions[]
resources[].details.aws_cloud_watch_alarm.period

The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric.

resources[].details.aws_cloud_watch_alarm.statistic

The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.

For an alarm based on a metric, you must specify either Statistic or ExtendedStatistic but not both.

For an alarm based on a math expression, you can't specify Statistic. Instead, you use Metrics.

resources[].details.aws_cloud_watch_alarm.threshold

The value to compare with the specified statistic.

resources[].details.aws_cloud_watch_alarm.threshold_metric_id

n an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm.

resources[].details.aws_cloud_watch_alarm.treat_missing_data

Sets how this alarm is to handle missing data points.

resources[].details.aws_cloud_watch_alarm.unit

The unit of the metric associated with the alarm.

resources[].details.aws_code_build_project

Details for an CodeBuild project.

Show child fields
resources[].details.aws_code_build_project.artifacts[]
Show child fields
resources[].details.aws_code_build_project.artifacts[].artifact_identifier

An identifier for the artifact definition.

resources[].details.aws_code_build_project.artifacts[].encryption_disabled

Indicates whether to disable encryption on the artifact. Only valid when Type is S3.

resources[].details.aws_code_build_project.artifacts[].location

Only used when Type is S3. The name of the S3 bucket where the artifact is located.

resources[].details.aws_code_build_project.artifacts[].name

Only used when Type is S3. The name of the artifact. Used with NamepaceType and Path to determine the pattern for storing the artifact.

resources[].details.aws_code_build_project.artifacts[].namespace_type

Only used when Type is S3. The value to use for the namespace. Used with Name and Path to determine the pattern for storing the artifact.

resources[].details.aws_code_build_project.artifacts[].override_artifact_name

Whether the name specified in the buildspec file overrides the artifact name.

resources[].details.aws_code_build_project.artifacts[].packaging

Only used when Type is S3. The type of output artifact to create.

resources[].details.aws_code_build_project.artifacts[].path

Only used when Type is S3. The path to the artifact. Used with Name and NamespaceType to determine the pattern for storing the artifact.

resources[].details.aws_code_build_project.artifacts[].type

The type of build artifact.

resources[].details.aws_code_build_project.encryption_key

The KMS key used to encrypt the build output artifacts.

You can specify either the ARN of the KMS key or, if available, the KMS key alias (using the format alias/alias-name).

resources[].details.aws_code_build_project.environment

Information about the build environment for this build project.

Show child fields
resources[].details.aws_code_build_project.environment.certificate

The certificate to use with this build project.

resources[].details.aws_code_build_project.environment.environment_variables[]
Show child fields
resources[].details.aws_code_build_project.environment.environment_variables[].name

The name of the environment variable.

resources[].details.aws_code_build_project.environment.environment_variables[].type

The type of environment variable.

resources[].details.aws_code_build_project.environment.environment_variables[].value

The value of the environment variable.

resources[].details.aws_code_build_project.environment.image_pull_credentials_type

The type of credentials CodeBuild uses to pull images in your build.

Valid values:

  • CODEBUILD specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust the CodeBuild service principal.

  • SERVICE_ROLE specifies that CodeBuild uses your build project's service role.

When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an CodeBuild curated image, you must use CODEBUILD credentials.

resources[].details.aws_code_build_project.environment.privileged_mode

Whether to allow the Docker daemon to run inside a Docker container. Set to true if the build project is used to build Docker images.

resources[].details.aws_code_build_project.environment.registry_credential

The credentials for access to a private registry.

Show child fields
resources[].details.aws_code_build_project.environment.registry_credential.credential

The ARN or name of credentials created using Secrets Manager.

The credential can use the name of the credentials only if they exist in your current Amazon Web Services Region.

resources[].details.aws_code_build_project.environment.registry_credential.credential_provider

The service that created the credentials to access a private Docker registry.

The valid value, SECRETS_MANAGER, is for Secrets Manager.

resources[].details.aws_code_build_project.environment.type

The type of build environment to use for related builds.

The environment type ARM_CONTAINER is available only in Regions US East (N. Virginia), US East (Ohio), US West (Oregon), Europe (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and Europe (Frankfurt).

The environment type LINUX_CONTAINER with compute type build.general1.2xlarge is available only in Regions US East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).

The environment type LINUX_GPU_CONTAINER is available only in Regions US East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).

Valid values: WINDOWS_CONTAINER | LINUX_CONTAINER | LINUX_GPU_CONTAINER | ARM_CONTAINER

resources[].details.aws_code_build_project.logs_config

Information about logs for the build project.

Show child fields
resources[].details.aws_code_build_project.logs_config.cloud_watch_logs

Information about CloudWatch Logs for the build project.

Show child fields
resources[].details.aws_code_build_project.logs_config.cloud_watch_logs.group_name

The group name of the logs in CloudWatch Logs.

resources[].details.aws_code_build_project.logs_config.cloud_watch_logs.status

The current status of the logs in CloudWatch Logs for a build project.

resources[].details.aws_code_build_project.logs_config.cloud_watch_logs.stream_name

The prefix of the stream name of the CloudWatch Logs.

resources[].details.aws_code_build_project.logs_config.s3_logs

Information about logs built to an S3 bucket for a build project.

Show child fields
resources[].details.aws_code_build_project.logs_config.s3_logs.encryption_disabled

Whether to disable encryption of the S3 build log output.

resources[].details.aws_code_build_project.logs_config.s3_logs.location

The ARN of the S3 bucket and the path prefix for S3 logs.

resources[].details.aws_code_build_project.logs_config.s3_logs.status

The current status of the S3 build logs.

resources[].details.aws_code_build_project.name

The name of the build project.

resources[].details.aws_code_build_project.secondary_artifacts[]
Show child fields
resources[].details.aws_code_build_project.secondary_artifacts[].artifact_identifier

An identifier for the artifact definition.

resources[].details.aws_code_build_project.secondary_artifacts[].encryption_disabled

Indicates whether to disable encryption on the artifact. Only valid when Type is S3.

resources[].details.aws_code_build_project.secondary_artifacts[].location

Only used when Type is S3. The name of the S3 bucket where the artifact is located.

resources[].details.aws_code_build_project.secondary_artifacts[].name

Only used when Type is S3. The name of the artifact. Used with NamepaceType and Path to determine the pattern for storing the artifact.

resources[].details.aws_code_build_project.secondary_artifacts[].namespace_type

Only used when Type is S3. The value to use for the namespace. Used with Name and Path to determine the pattern for storing the artifact.

resources[].details.aws_code_build_project.secondary_artifacts[].override_artifact_name

Whether the name specified in the buildspec file overrides the artifact name.

resources[].details.aws_code_build_project.secondary_artifacts[].packaging

Only used when Type is S3. The type of output artifact to create.

resources[].details.aws_code_build_project.secondary_artifacts[].path

Only used when Type is S3. The path to the artifact. Used with Name and NamespaceType to determine the pattern for storing the artifact.

resources[].details.aws_code_build_project.secondary_artifacts[].type

The type of build artifact.

resources[].details.aws_code_build_project.service_role

The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.

resources[].details.aws_code_build_project.source

Information about the build input source code for this build project.

Show child fields
resources[].details.aws_code_build_project.source.git_clone_depth

Information about the Git clone depth for the build project.

resources[].details.aws_code_build_project.source.insecure_ssl

Whether to ignore SSL warnings while connecting to the project source code.

resources[].details.aws_code_build_project.source.location

Information about the location of the source code to be built.

Valid values include:

  • For source code settings that are specified in the source action of a pipeline in CodePipeline, location should not be specified. If it is specified, CodePipeline ignores it. This is because CodePipeline uses the settings in a pipeline's source action instead of this value.

  • For source code in an CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec file (for example, https://git-codecommit.region-ID.amazonaws.com/v1/repos/repo-name ).

  • For source code in an S3 input bucket, one of the following.

    • The path to the ZIP file that contains the source code (for example, bucket-name/path/to/object-name.zip).

    • The path to the folder that contains the source code (for example, bucket-name/path/to/source-code/folder/).

  • For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the build spec file.

  • For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the build spec file.

resources[].details.aws_code_build_project.source.type

The type of repository that contains the source code to be built. Valid values are:

  • BITBUCKET - The source code is in a Bitbucket repository.

  • CODECOMMIT - The source code is in an CodeCommit repository.

  • CODEPIPELINE - The source code settings are specified in the source action of a pipeline in CodePipeline.

  • GITHUB - The source code is in a GitHub repository.

  • GITHUB_ENTERPRISE - The source code is in a GitHub Enterprise repository.

  • NO_SOURCE - The project does not have input source code.

  • S3 - The source code is in an S3 input bucket.

resources[].details.aws_code_build_project.vpc_config

Information about the VPC configuration that CodeBuild accesses.

Show child fields
resources[].details.aws_code_build_project.vpc_config.security_group_ids[]
resources[].details.aws_code_build_project.vpc_config.subnets[]
resources[].details.aws_code_build_project.vpc_config.vpc_id

The ID of the VPC.

resources[].details.aws_dms_endpoint

Provides details about an Database Migration Service (DMS) endpoint. An endpoint provides connection, data store type, and location information about your data store.

Show child fields
resources[].details.aws_dms_endpoint.certificate_arn

The Amazon Resource Name (ARN) for the SSL certificate that encrypts connections between the DMS endpoint and the replication instance.

resources[].details.aws_dms_endpoint.database_name

The name of the endpoint database.

resources[].details.aws_dms_endpoint.endpoint_arn

The Amazon Resource Name (ARN) of the endpoint.

resources[].details.aws_dms_endpoint.endpoint_identifier

The database endpoint identifier.

resources[].details.aws_dms_endpoint.endpoint_type

The type of endpoint. Valid values are source and target.

resources[].details.aws_dms_endpoint.engine_name

The type of engine for the endpoint, depending on the EndpointType value.

resources[].details.aws_dms_endpoint.external_id

A value that can be used for cross-account validation.

resources[].details.aws_dms_endpoint.extra_connection_attributes

Additional attributes associated with the connection.

resources[].details.aws_dms_endpoint.kms_key_id

An DMS key identifier that is used to encrypt the connection parameters for the endpoint. If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key. KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.

resources[].details.aws_dms_endpoint.port

The port used to access the endpoint.

resources[].details.aws_dms_endpoint.server_name

The name of the server where the endpoint database resides.

resources[].details.aws_dms_endpoint.ssl_mode

The SSL mode used to connect to the endpoint. The default is none.

resources[].details.aws_dms_endpoint.username

The user name to be used to log in to the endpoint database.

resources[].details.aws_dms_replication_instance

Provides details about an DMS replication instance. DMS uses a replication instance to connect to your source data store, read the source data, and format the data for consumption by the target data store.

Show child fields
resources[].details.aws_dms_replication_instance.allocated_storage

The amount of storage (in gigabytes) that is allocated for the replication instance.

resources[].details.aws_dms_replication_instance.auto_minor_version_upgrade

Indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window.

resources[].details.aws_dms_replication_instance.availability_zone

The Availability Zone that the replication instance is created in. The default value is a random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region, such as us-east-1d.

resources[].details.aws_dms_replication_instance.engine_version

The engine version number of the replication instance. If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.

resources[].details.aws_dms_replication_instance.kms_key_id

An KMS key identifier that is used to encrypt the data on the replication instance. If you don't specify a value for the KmsKeyId parameter, DMS uses your default encryption key. KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.

resources[].details.aws_dms_replication_instance.multi_az

Specifies whether the replication instance is deployed across multiple Availability Zones (AZs). You can't set the AvailabilityZone parameter if the MultiAZ parameter is set to true.

resources[].details.aws_dms_replication_instance.preferred_maintenance_window

The maintenance window times for the replication instance. Upgrades to the replication instance are performed during this time.

resources[].details.aws_dms_replication_instance.publicly_accessible

Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address. The default value is true.

resources[].details.aws_dms_replication_instance.replication_instance_class

The compute and memory capacity of the replication instance as defined for the specified replication instance class.

resources[].details.aws_dms_replication_instance.replication_instance_identifier

The replication instance identifier.

resources[].details.aws_dms_replication_instance.replication_subnet_group

The subnet group for the replication instance.

Show child fields
resources[].details.aws_dms_replication_instance.replication_subnet_group.replication_subnet_group_identifier

The identifier of the replication subnet group.

resources[].details.aws_dms_replication_instance.vpc_security_groups[]
Show child fields
resources[].details.aws_dms_replication_instance.vpc_security_groups[].vpc_security_group_id

The identifier of the VPC security group that’s associated with the replication instance.

resources[].details.aws_dms_replication_task

Provides details about an DMS replication task. A replication task moves a set of data from the source endpoint to the target endpoint.

Show child fields
resources[].details.aws_dms_replication_task.cdc_start_position

Indicates when you want a change data capture (CDC) operation to start. CCdcStartPosition or CCdcStartTime specifies when you want a CDC operation to start. Only a value for one of these fields is included.

resources[].details.aws_dms_replication_task.cdc_start_time

Indicates the start time for a CDC operation. CdcStartPosition or CCdcStartTime specifies when you want a CDC operation to start. Only a value for one of these fields is included.

resources[].details.aws_dms_replication_task.cdc_stop_position

Indicates when you want a CDC operation to stop. The value can be either server time or commit time.

resources[].details.aws_dms_replication_task.id

The identifier of the replication task.

resources[].details.aws_dms_replication_task.migration_type

The migration type.

resources[].details.aws_dms_replication_task.replication_instance_arn

The Amazon Resource Name (ARN) of a replication instance.

resources[].details.aws_dms_replication_task.replication_task_identifier

The user-defined replication task identifier or name.

resources[].details.aws_dms_replication_task.replication_task_settings

The settings for the replication task.

resources[].details.aws_dms_replication_task.resource_identifier

A display name for the resource identifier at the end of the EndpointArn response parameter. If you don't specify a ResourceIdentifier value, DMS generates a default identifier value for the end of EndpointArn.

resources[].details.aws_dms_replication_task.source_endpoint_arn

The ARN of the source endpoint.

resources[].details.aws_dms_replication_task.table_mappings

The table mappings for the replication task, in JSON format.

resources[].details.aws_dms_replication_task.target_endpoint_arn

The ARN of the target endpoint.

resources[].details.aws_dms_replication_task.task_data

Supplemental information that the task requires to migrate the data for certain source and target endpoints.

resources[].details.aws_dynamo_db_table

Details about a DynamoDB table.

Show child fields
resources[].details.aws_dynamo_db_table.attribute_definitions[]
Show child fields
resources[].details.aws_dynamo_db_table.attribute_definitions[].attribute_name

The name of the attribute.

resources[].details.aws_dynamo_db_table.attribute_definitions[].attribute_type

The type of the attribute.

resources[].details.aws_dynamo_db_table.billing_mode_summary

Information about the billing for read/write capacity on the table.

Show child fields
resources[].details.aws_dynamo_db_table.billing_mode_summary.billing_mode

The method used to charge for read and write throughput and to manage capacity.

resources[].details.aws_dynamo_db_table.billing_mode_summary.last_update_to_pay_per_request_date_time

If the billing mode is PAY_PER_REQUEST, indicates when the billing mode was set to that value.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_dynamo_db_table.creation_date_time

Indicates when the table was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_dynamo_db_table.deletion_protection_enabled

Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.

resources[].details.aws_dynamo_db_table.global_secondary_indexes[]
Show child fields
resources[].details.aws_dynamo_db_table.global_secondary_indexes[].backfilling

Whether the index is currently backfilling.

resources[].details.aws_dynamo_db_table.global_secondary_indexes[].index_arn

The ARN of the index.

resources[].details.aws_dynamo_db_table.global_secondary_indexes[].index_name

The name of the index.

resources[].details.aws_dynamo_db_table.global_secondary_indexes[].index_size_bytes

The total size in bytes of the index.

resources[].details.aws_dynamo_db_table.global_secondary_indexes[].index_status

The current status of the index.

  • ACTIVE

  • CREATING

  • DELETING

  • UPDATING

resources[].details.aws_dynamo_db_table.global_secondary_indexes[].item_count

The number of items in the index.

resources[].details.aws_dynamo_db_table.global_secondary_indexes[].key_schema[]
Show child fields
resources[].details.aws_dynamo_db_table.global_secondary_indexes[].key_schema[].attribute_name

The name of the key schema attribute.

resources[].details.aws_dynamo_db_table.global_secondary_indexes[].key_schema[].key_type

The type of key used for the key schema attribute. Valid values are HASH or RANGE.

resources[].details.aws_dynamo_db_table.global_secondary_indexes[].projection

Attributes that are copied from the table into an index.

Show child fields
resources[].details.aws_dynamo_db_table.global_secondary_indexes[].projection.non_key_attributes[]
resources[].details.aws_dynamo_db_table.global_secondary_indexes[].projection.projection_type

The types of attributes that are projected into the index. Valid values are as follows:

  • ALL

  • INCLUDE

  • KEYS_ONLY

resources[].details.aws_dynamo_db_table.global_secondary_indexes[].provisioned_throughput

Information about the provisioned throughput settings for the indexes.

Show child fields
resources[].details.aws_dynamo_db_table.global_secondary_indexes[].provisioned_throughput.last_decrease_date_time

Indicates when the provisioned throughput was last decreased.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_dynamo_db_table.global_secondary_indexes[].provisioned_throughput.last_increase_date_time

Indicates when the provisioned throughput was last increased.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_dynamo_db_table.global_secondary_indexes[].provisioned_throughput.number_of_decreases_today

The number of times during the current UTC calendar day that the provisioned throughput was decreased.

resources[].details.aws_dynamo_db_table.global_secondary_indexes[].provisioned_throughput.read_capacity_units

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.

resources[].details.aws_dynamo_db_table.global_secondary_indexes[].provisioned_throughput.write_capacity_units

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

resources[].details.aws_dynamo_db_table.global_table_version

The version of global tables being used.

resources[].details.aws_dynamo_db_table.item_count

The number of items in the table.

resources[].details.aws_dynamo_db_table.key_schema[]
Show child fields
resources[].details.aws_dynamo_db_table.key_schema[].attribute_name

The name of the key schema attribute.

resources[].details.aws_dynamo_db_table.key_schema[].key_type

The type of key used for the key schema attribute. Valid values are HASH or RANGE.

resources[].details.aws_dynamo_db_table.latest_stream_arn

The ARN of the latest stream for the table.

resources[].details.aws_dynamo_db_table.latest_stream_label

The label of the latest stream. The label is not a unique identifier.

resources[].details.aws_dynamo_db_table.local_secondary_indexes[]
Show child fields
resources[].details.aws_dynamo_db_table.local_secondary_indexes[].index_arn

The ARN of the index.

resources[].details.aws_dynamo_db_table.local_secondary_indexes[].index_name

The name of the index.

resources[].details.aws_dynamo_db_table.local_secondary_indexes[].key_schema[]
Show child fields
resources[].details.aws_dynamo_db_table.local_secondary_indexes[].key_schema[].attribute_name

The name of the key schema attribute.

resources[].details.aws_dynamo_db_table.local_secondary_indexes[].key_schema[].key_type

The type of key used for the key schema attribute. Valid values are HASH or RANGE.

resources[].details.aws_dynamo_db_table.local_secondary_indexes[].projection

Attributes that are copied from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

Show child fields
resources[].details.aws_dynamo_db_table.local_secondary_indexes[].projection.non_key_attributes[]
resources[].details.aws_dynamo_db_table.local_secondary_indexes[].projection.projection_type

The types of attributes that are projected into the index. Valid values are as follows:

  • ALL

  • INCLUDE

  • KEYS_ONLY

resources[].details.aws_dynamo_db_table.provisioned_throughput

Information about the provisioned throughput for the table.

Show child fields
resources[].details.aws_dynamo_db_table.provisioned_throughput.last_decrease_date_time

Indicates when the provisioned throughput was last decreased.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_dynamo_db_table.provisioned_throughput.last_increase_date_time

Indicates when the provisioned throughput was last increased.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_dynamo_db_table.provisioned_throughput.number_of_decreases_today

The number of times during the current UTC calendar day that the provisioned throughput was decreased.

resources[].details.aws_dynamo_db_table.provisioned_throughput.read_capacity_units

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.

resources[].details.aws_dynamo_db_table.provisioned_throughput.write_capacity_units

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

resources[].details.aws_dynamo_db_table.replicas[]
Show child fields
resources[].details.aws_dynamo_db_table.replicas[].global_secondary_indexes[]
Show child fields
resources[].details.aws_dynamo_db_table.replicas[].global_secondary_indexes[].index_name

The name of the index.

resources[].details.aws_dynamo_db_table.replicas[].global_secondary_indexes[].provisioned_throughput_override

Replica-specific configuration for the provisioned throughput for the index.

Show child fields
resources[].details.aws_dynamo_db_table.replicas[].global_secondary_indexes[].provisioned_throughput_override.read_capacity_units

The read capacity units for the replica.

resources[].details.aws_dynamo_db_table.replicas[].kms_master_key_id

The identifier of the KMS key that will be used for KMS encryption for the replica.

resources[].details.aws_dynamo_db_table.replicas[].provisioned_throughput_override

Replica-specific configuration for the provisioned throughput.

Show child fields
resources[].details.aws_dynamo_db_table.replicas[].provisioned_throughput_override.read_capacity_units

The read capacity units for the replica.

resources[].details.aws_dynamo_db_table.replicas[].region_name

The name of the Region where the replica is located.

resources[].details.aws_dynamo_db_table.replicas[].replica_status

The current status of the replica. Valid values are as follows:

  • ACTIVE

  • CREATING

  • CREATION_FAILED

  • DELETING

  • UPDATING

resources[].details.aws_dynamo_db_table.replicas[].replica_status_description

Detailed information about the replica status.

resources[].details.aws_dynamo_db_table.restore_summary

Information about the restore for the table.

Show child fields
resources[].details.aws_dynamo_db_table.restore_summary.restore_date_time

Indicates the point in time that the table was restored to.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_dynamo_db_table.restore_summary.restore_in_progress

Whether a restore is currently in progress.

resources[].details.aws_dynamo_db_table.restore_summary.source_backup_arn

The ARN of the source backup from which the table was restored.

resources[].details.aws_dynamo_db_table.restore_summary.source_table_arn

The ARN of the source table for the backup.

resources[].details.aws_dynamo_db_table.sse_description

Information about the server-side encryption for the table.

Show child fields
resources[].details.aws_dynamo_db_table.sse_description.inaccessible_encryption_date_time

If the key is inaccessible, the date and time when DynamoDB detected that the key was inaccessible.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_dynamo_db_table.sse_description.kms_master_key_arn

The ARN of the KMS key that is used for the KMS encryption.

resources[].details.aws_dynamo_db_table.sse_description.sse_type

The type of server-side encryption.

resources[].details.aws_dynamo_db_table.sse_description.status

The status of the server-side encryption.

resources[].details.aws_dynamo_db_table.stream_specification

The current DynamoDB Streams configuration for the table.

Show child fields
resources[].details.aws_dynamo_db_table.stream_specification.stream_enabled

Indicates whether DynamoDB Streams is enabled on the table.

resources[].details.aws_dynamo_db_table.stream_specification.stream_view_type

Determines the information that is written to the table.

resources[].details.aws_dynamo_db_table.table_id

The identifier of the table.

resources[].details.aws_dynamo_db_table.table_name

The name of the table.

resources[].details.aws_dynamo_db_table.table_size_bytes

The total size of the table in bytes.

resources[].details.aws_dynamo_db_table.table_status

The current status of the table. Valid values are as follows:

  • ACTIVE

  • ARCHIVED

  • ARCHIVING

  • CREATING

  • DELETING

  • INACCESSIBLE_ENCRYPTION_CREDENTIALS

  • UPDATING

resources[].details.aws_ec2_client_vpn_endpoint

Provides details about an Client VPN endpoint. A Client VPN endpoint is the resource that you create and configure to enable and manage client VPN sessions. It's the termination point for all client VPN sessions.

Show child fields
resources[].details.aws_ec2_client_vpn_endpoint.authentication_options[]
Show child fields
resources[].details.aws_ec2_client_vpn_endpoint.authentication_options[].active_directory

Information about the Active Directory, if applicable. With Active Directory authentication, clients are authenticated against existing Active Directory groups.

Show child fields
resources[].details.aws_ec2_client_vpn_endpoint.authentication_options[].active_directory.directory_id

The ID of the Active Directory used for authentication.

resources[].details.aws_ec2_client_vpn_endpoint.authentication_options[].federated_authentication

Information about the IAM SAML identity provider, if applicable.

Show child fields
resources[].details.aws_ec2_client_vpn_endpoint.authentication_options[].federated_authentication.saml_provider_arn

The Amazon Resource Name (ARN) of the IAM SAML identity provider.

resources[].details.aws_ec2_client_vpn_endpoint.authentication_options[].federated_authentication.self_service_saml_provider_arn

The Amazon Resource Name (ARN) of the IAM SAML identity provider for the self-service portal.

resources[].details.aws_ec2_client_vpn_endpoint.authentication_options[].mutual_authentication

Information about the authentication certificates, if applicable.

Show child fields
resources[].details.aws_ec2_client_vpn_endpoint.authentication_options[].mutual_authentication.client_root_certificate_chain

The Amazon Resource Name (ARN) of the client certificate.

resources[].details.aws_ec2_client_vpn_endpoint.authentication_options[].type

The authentication type used.

resources[].details.aws_ec2_client_vpn_endpoint.client_cidr_block

The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.

resources[].details.aws_ec2_client_vpn_endpoint.client_connect_options

The options for managing connection authorization for new client connections.

Show child fields
resources[].details.aws_ec2_client_vpn_endpoint.client_connect_options.enabled

Indicates whether client connect options are enabled.

resources[].details.aws_ec2_client_vpn_endpoint.client_connect_options.lambda_function_arn

The Amazon Resource Name (ARN) of the Lambda function used for connection authorization.

resources[].details.aws_ec2_client_vpn_endpoint.client_connect_options.status

The status of any updates to the client connect options.

Show child fields
resources[].details.aws_ec2_client_vpn_endpoint.client_connect_options.status.code

The status code.

resources[].details.aws_ec2_client_vpn_endpoint.client_connect_options.status.message

The status message.

resources[].details.aws_ec2_client_vpn_endpoint.client_login_banner_options

Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.

Show child fields
resources[].details.aws_ec2_client_vpn_endpoint.client_login_banner_options.banner_text

Customizable text that will be displayed in a banner on Amazon Web Services provided clients when a VPN session is established.

resources[].details.aws_ec2_client_vpn_endpoint.client_login_banner_options.enabled

Current state of text banner feature.

resources[].details.aws_ec2_client_vpn_endpoint.client_vpn_endpoint_id

The ID of the Client VPN endpoint.

resources[].details.aws_ec2_client_vpn_endpoint.connection_log_options

Information about the client connection logging options for the Client VPN endpoint.

Show child fields
resources[].details.aws_ec2_client_vpn_endpoint.connection_log_options.cloudwatch_log_group

The name of the Amazon CloudWatch Logs log group to which connection logging data is published.

resources[].details.aws_ec2_client_vpn_endpoint.connection_log_options.cloudwatch_log_stream

The name of the Amazon CloudWatch Logs log stream to which connection logging data is published.

resources[].details.aws_ec2_client_vpn_endpoint.connection_log_options.enabled

Indicates whether client connection logging is enabled for the Client VPN endpoint.

resources[].details.aws_ec2_client_vpn_endpoint.description

A brief description of the endpoint.

resources[].details.aws_ec2_client_vpn_endpoint.dns_server[]
resources[].details.aws_ec2_client_vpn_endpoint.security_group_id_set[]
resources[].details.aws_ec2_client_vpn_endpoint.self_service_portal_url

The URL of the self-service portal.

resources[].details.aws_ec2_client_vpn_endpoint.server_certificate_arn

The Amazon Resource Name (ARN) of the server certificate.

resources[].details.aws_ec2_client_vpn_endpoint.session_timeout_hours

The maximum VPN session duration time in hours.

resources[].details.aws_ec2_client_vpn_endpoint.split_tunnel

Indicates whether split-tunnel is enabled in the Client VPN endpoint.

resources[].details.aws_ec2_client_vpn_endpoint.transport_protocol

The transport protocol used by the Client VPN endpoint.

resources[].details.aws_ec2_client_vpn_endpoint.vpc_id

The ID of the VPC.

resources[].details.aws_ec2_client_vpn_endpoint.vpn_port

The port number for the Client VPN endpoint.

resources[].details.aws_ec2_eip

Details about an Elastic IP address.

Show child fields
resources[].details.aws_ec2_eip.allocation_id

The identifier that Amazon Web Services assigns to represent the allocation of the Elastic IP address for use with Amazon VPC.

resources[].details.aws_ec2_eip.association_id

The identifier that represents the association of the Elastic IP address with an EC2 instance.

resources[].details.aws_ec2_eip.domain

The domain in which to allocate the address.

If the address is for use with EC2 instances in a VPC, then Domain is vpc. Otherwise, Domain is standard.

resources[].details.aws_ec2_eip.instance_id

The identifier of the EC2 instance.

resources[].details.aws_ec2_eip.network_border_group

The name of the location from which the Elastic IP address is advertised.

resources[].details.aws_ec2_eip.network_interface_id

The identifier of the network interface.

resources[].details.aws_ec2_eip.network_interface_owner_id

The Amazon Web Services account ID of the owner of the network interface.

resources[].details.aws_ec2_eip.private_ip_address

The private IP address that is associated with the Elastic IP address.

resources[].details.aws_ec2_eip.public_ip

A public IP address that is associated with the EC2 instance.

resources[].details.aws_ec2_eip.public_ipv4_pool

The identifier of an IP address pool. This parameter allows Amazon EC2 to select an IP address from the address pool.

resources[].details.aws_ec2_instance

Details about an EC2 instance related to a finding.

Show child fields
resources[].details.aws_ec2_instance.iam_instance_profile_arn

The IAM profile ARN of the instance.

resources[].details.aws_ec2_instance.image_id

The Amazon Machine Image (AMI) ID of the instance.

resources[].details.aws_ec2_instance.ip_v4_addresses[]
resources[].details.aws_ec2_instance.ip_v6_addresses[]
resources[].details.aws_ec2_instance.key_name

The key name associated with the instance.

resources[].details.aws_ec2_instance.launched_at

Indicates when the instance was launched.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_ec2_instance.metadata_options

Details about the metadata options for the Amazon EC2 instance.

Show child fields
resources[].details.aws_ec2_instance.metadata_options.http_endpoint

Enables or disables the HTTP metadata endpoint on the instance.

resources[].details.aws_ec2_instance.metadata_options.http_protocol_ipv6

Enables or disables the IPv6 endpoint for the instance metadata service.

resources[].details.aws_ec2_instance.metadata_options.http_put_response_hop_limit

The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.

resources[].details.aws_ec2_instance.metadata_options.http_tokens

The state of token usage for your instance metadata requests.

resources[].details.aws_ec2_instance.metadata_options.instance_metadata_tags

Specifies whether to allow access to instance tags from the instance metadata.

resources[].details.aws_ec2_instance.monitoring

Describes the type of monitoring that’s turned on for an instance.

Show child fields
resources[].details.aws_ec2_instance.monitoring.state

Indicates whether detailed monitoring is turned on. Otherwise, basic monitoring is turned on.

resources[].details.aws_ec2_instance.network_interfaces[]
Show child fields
resources[].details.aws_ec2_instance.network_interfaces[].network_interface_id

The identifier of the network interface. The details are in a corresponding AwsEc2NetworkInterfacesDetails object.

resources[].details.aws_ec2_instance.subnet_id

The identifier of the subnet that the instance was launched in.

resources[].details.aws_ec2_instance.type

The instance type of the instance.

resources[].details.aws_ec2_instance.virtualization_type

The virtualization type of the Amazon Machine Image (AMI) required to launch the instance.

resources[].details.aws_ec2_instance.vpc_id

The identifier of the VPC that the instance was launched in.

resources[].details.aws_ec2_launch_template

Specifies the properties for creating an Amazon Elastic Compute Cloud (Amazon EC2) launch template.

Show child fields
resources[].details.aws_ec2_launch_template.default_version_number

The default version of the launch template.

resources[].details.aws_ec2_launch_template.id

An ID for the launch template.

resources[].details.aws_ec2_launch_template.latest_version_number

The latest version of the launch template.

resources[].details.aws_ec2_launch_template.launch_template_data

The information to include in the launch template.

Show child fields
resources[].details.aws_ec2_launch_template.launch_template_data.block_device_mapping_set[]
Show child fields
resources[].details.aws_ec2_launch_template.launch_template_data.block_device_mapping_set[].device_name

The device name.

resources[].details.aws_ec2_launch_template.launch_template_data.block_device_mapping_set[].ebs

Parameters used to automatically set up Amazon EBS volumes when the instance is launched.

Show child fields
resources[].details.aws_ec2_launch_template.launch_template_data.block_device_mapping_set[].ebs.delete_on_termination

Indicates whether the EBS volume is deleted on instance termination.

resources[].details.aws_ec2_launch_template.launch_template_data.block_device_mapping_set[].ebs.encrypted

Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you're creating a volume from a snapshot, you can't specify an encryption value.

resources[].details.aws_ec2_launch_template.launch_template_data.block_device_mapping_set[].ebs.iops

The number of I/O operations per second (IOPS).

resources[].details.aws_ec2_launch_template.launch_template_data.block_device_mapping_set[].ebs.kms_key_id

The Amazon Resource Name (ARN) of the symmetric Key Management Service (KMS) customer managed key used for encryption.

resources[].details.aws_ec2_launch_template.launch_template_data.block_device_mapping_set[].ebs.snapshot_id

The ID of the EBS snapshot.

resources[].details.aws_ec2_launch_template.launch_template_data.block_device_mapping_set[].ebs.throughput

The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s.

resources[].details.aws_ec2_launch_template.launch_template_data.block_device_mapping_set[].ebs.volume_size

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size.

resources[].details.aws_ec2_launch_template.launch_template_data.block_device_mapping_set[].ebs.volume_type

The volume type.

resources[].details.aws_ec2_launch_template.launch_template_data.block_device_mapping_set[].no_device

Omits the device from the block device mapping when an empty string is specified.

resources[].details.aws_ec2_launch_template.launch_template_data.block_device_mapping_set[].virtual_name

The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type.

resources[].details.aws_ec2_launch_template.launch_template_data.capacity_reservation_specification

Specifies an instance's Capacity Reservation targeting option. You can specify only one option at a time.

Show child fields
resources[].details.aws_ec2_launch_template.launch_template_data.capacity_reservation_specification.capacity_reservation_preference

Indicates the instance's Capacity Reservation preferences. If equal to open, the instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). If equal to none, the instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.

resources[].details.aws_ec2_launch_template.launch_template_data.capacity_reservation_specification.capacity_reservation_target

Specifies a target Capacity Reservation.

Show child fields
resources[].details.aws_ec2_launch_template.launch_template_data.capacity_reservation_specification.capacity_reservation_target.capacity_reservation_id

The ID of the Capacity Reservation in which to run the instance.

resources[].details.aws_ec2_launch_template.launch_template_data.capacity_reservation_specification.capacity_reservation_target.capacity_reservation_resource_group_arn

The Amazon Resource Name (ARN) of the Capacity Reservation resource group in which to run the instance.

resources[].details.aws_ec2_launch_template.launch_template_data.cpu_options

Specifies the CPU options for an instance. For more information, see Optimize CPU options in the Amazon Elastic Compute Cloud User Guide.

Show child fields
resources[].details.aws_ec2_launch_template.launch_template_data.cpu_options.core_count

The number of CPU cores for the instance.

resources[].details.aws_ec2_launch_template.launch_template_data.cpu_options.threads_per_core

The number of threads per CPU core. A value of 1 disables multithreading for the instance, The default value is 2.

resources[].details.aws_ec2_launch_template.launch_template_data.credit_specification

Specifies the credit option for CPU usage of a T2, T3, or T3a instance.

Show child fields
resources[].details.aws_ec2_launch_template.launch_template_data.credit_specification.cpu_credits

The credit option for CPU usage of a T instance.

resources[].details.aws_ec2_launch_template.launch_template_data.disable_api_stop

Indicates whether to enable the instance for stop protection. For more information, see Enable stop protection in the Amazon EC2 User Guide.

resources[].details.aws_ec2_launch_template.launch_template_data.disable_api_termination

If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API. If set to true, you can.

resources[].details.aws_ec2_launch_template.launch_template_data.ebs_optimized

Indicates whether the instance is optimized for Amazon EBS I/O.

resources[].details.aws_ec2_launch_template.launch_template_data.elastic_gpu_specification_set[]
Show child fields
resources[].details.aws_ec2_launch_template.launch_template_data.elastic_gpu_specification_set[].type

The type of Elastic Graphics accelerator.

resources[].details.aws_ec2_launch_template.launch_template_data.elastic_inference_accelerator_set[]
Show child fields
resources[].details.aws_ec2_launch_template.launch_template_data.elastic_inference_accelerator_set[].count

The number of Elastic Inference accelerators to attach to the instance.

resources[].details.aws_ec2_launch_template.launch_template_data.elastic_inference_accelerator_set[].type

The type of Elastic Inference accelerator.

resources[].details.aws_ec2_launch_template.launch_template_data.enclave_options

Indicates whether the Amazon EC2 instance is enabled for Amazon Web Services Nitro Enclaves.

Show child fields
resources[].details.aws_ec2_launch_template.launch_template_data.enclave_options.enabled

If this parameter is set to true, the instance is enabled for Amazon Web Services Nitro Enclaves.

resources[].details.aws_ec2_launch_template.launch_template_data.hibernation_options

Specifies whether your Amazon EC2 instance is configured for hibernation.

Show child fields
resources[].details.aws_ec2_launch_template.launch_template_data.hibernation_options.configured

If you set this parameter to true, the instance is enabled for hibernation.

resources[].details.aws_ec2_launch_template.launch_template_data.iam_instance_profile

The name or Amazon Resource Name (ARN) of an IAM instance profile.

Show child fields
resources[].details.aws_ec2_launch_template.launch_template_data.iam_instance_profile.arn

The Amazon Resource Name (ARN) of the instance profile.

resources[].details.aws_ec2_launch_template.launch_template_data.iam_instance_profile.name

The name of the instance profile.

resources[].details.aws_ec2_launch_template.launch_template_data.image_id

The ID of the Amazon Machine Image (AMI).

resources[].details.aws_ec2_launch_template.launch_template_data.instance_initiated_shutdown_behavior

Provides the options for specifying the instance initiated shutdown behavior.

resources[].details.aws_ec2_launch_template.launch_template_data.instance_market_options

Specifies the market (purchasing) option for an instance.

Show child fields
resources[].details.aws_ec2_launch_template.launch_template_data.instance_market_options.market_type

The market type.

resources[].details.aws_ec2_launch_template.launch_template_data.instance_market_options.spot_options

The options for Spot Instances.

Show child fields
resources[].details.aws_ec2_launch_template.launch_template_data.instance_market_options.spot_options.block_duration_minutes

Deprecated.

resources[].details.aws_ec2_launch_template.launch_template_data.instance_market_options.spot_options.instance_interruption_behavior

The behavior when a Spot Instance is interrupted.

resources[].details.aws_ec2_launch_template.launch_template_data.instance_market_options.spot_options.max_price

The maximum hourly price you're willing to pay for the Spot Instances.

resources[].details.aws_ec2_launch_template.launch_template_data.instance_market_options.spot_options.spot_instance_type

The Spot Instance request type.

resources[].details.aws_ec2_launch_template.launch_template_data.instance_market_options.spot_options.valid_until

The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ), for persistent requests.

resources[].details.aws_ec2_launch_template.launch_template_data.instance_requirements

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes. If you specify InstanceRequirements, you can't specify InstanceType.

Show child fields
resources[].details.aws_ec2_launch_template.launch_template_data.instance_requirements.accelerator_count

The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance.

Show child fields
resources[].details.aws_ec2_launch_template.launch_template_data.instance_requirements.accelerator_count.max

The maximum number of accelerators. If this parameter isn't specified, there's no maximum limit. To exclude accelerator-enabled instance types, set Max to 0.

resources[].details.aws_ec2_launch_template.launch_template_data.instance_requirements.accelerator_count.min

The minimum number of accelerators. If this parameter isn't specified, there's no minimum limit.

resources[].details.aws_ec2_launch_template.launch_template_data.instance_requirements.accelerator_manufacturers[]
resources[].details.aws_ec2_launch_template.launch_template_data.instance_requirements.accelerator_names[]
resources[].details.aws_ec2_launch_template.launch_template_data.instance_requirements.accelerator_total_memory_mi_b

The minimum and maximum amount of total accelerator memory, in MiB.

Show child fields
resources[].details.aws_ec2_launch_template.launch_template_data.instance_requirements.accelerator_total_memory_mi_b.max

The maximum amount of memory, in MiB. If this parameter isn't specified, there's no maximum limit.

resources[].details.aws_ec2_launch_template.launch_template_data.instance_requirements.accelerator_total_memory_mi_b.min

The minimum amount of memory, in MiB. If 0 is specified, there's no maximum limit.

resources[].details.aws_ec2_launch_template.launch_template_data.instance_requirements.accelerator_types[]
resources[].details.aws_ec2_launch_template.launch_template_data.instance_requirements.bare_metal

Indicates whether bare metal instance types must be included, excluded, or required.

resources[].details.aws_ec2_launch_template.launch_template_data.instance_requirements.baseline_ebs_bandwidth_mbps

The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS optimized instances in the Amazon EC2 User Guide.

Show child fields
resources[].details.aws_ec2_launch_template.launch_template_data.instance_requirements.baseline_ebs_bandwidth_mbps.max

The maximum baseline bandwidth, in Mbps. If this parameter is omitted, there's no maximum limit.

resources[].details.aws_ec2_launch_template.launch_template_data.instance_requirements.baseline_ebs_bandwidth_mbps.min

The minimum baseline bandwidth, in Mbps. If this parameter is omitted, there's no minimum limit.

resources[].details.aws_ec2_launch_template.launch_template_data.instance_requirements.burstable_performance

Indicates whether burstable performance T instance types are included, excluded, or required. For more information, Burstable performance instances in the Amazon EC2 User Guide.

resources[].details.aws_ec2_launch_template.launch_template_data.instance_requirements.cpu_manufacturers[]
resources[].details.aws_ec2_launch_template.launch_template_data.instance_requirements.excluded_instance_types[]
resources[].details.aws_ec2_launch_template.launch_template_data.instance_requirements.instance_generations[]
resources[].details.aws_ec2_launch_template.launch_template_data.instance_requirements.local_storage

Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, see Amazon EC2 instance store in the Amazon EC2 User Guide.

resources[].details.aws_ec2_launch_template.launch_template_data.instance_requirements.local_storage_types[]
resources[].details.aws_ec2_launch_template.launch_template_data.instance_requirements.memory_gi_b_per_v_cpu

The minimum and maximum amount of memory per vCPU, in GiB.

Show child fields
resources[].details.aws_ec2_launch_template.launch_template_data.instance_requirements.memory_gi_b_per_v_cpu.max

The maximum amount of memory per vCPU, in GiB. If this parameter is omitted, there's no maximum limit.

resources[].details.aws_ec2_launch_template.launch_template_data.instance_requirements.memory_gi_b_per_v_cpu.min

The minimum amount of memory per vCPU, in GiB. If this parameter is omitted, there's no maximum limit.

resources[].details.aws_ec2_launch_template.launch_template_data.instance_requirements.memory_mi_b

The minimum and maximum amount of memory, in MiB.

Show child fields
resources[].details.aws_ec2_launch_template.launch_template_data.instance_requirements.memory_mi_b.max

The maximum amount of memory, in MiB.

resources[].details.aws_ec2_launch_template.launch_template_data.instance_requirements.memory_mi_b.min

The minimum amount of memory, in MiB.

resources[].details.aws_ec2_launch_template.launch_template_data.instance_requirements.network_interface_count

The minimum and maximum number of network interfaces.

Show child fields
resources[].details.aws_ec2_launch_template.launch_template_data.instance_requirements.network_interface_count.max

The maximum number of network interfaces.

resources[].details.aws_ec2_launch_template.launch_template_data.instance_requirements.network_interface_count.min

The minimum number of network interfaces.

resources[].details.aws_ec2_launch_template.launch_template_data.instance_requirements.on_demand_max_price_percentage_over_lowest_price

The price protection threshold for On-Demand Instances. This is the maximum you'll pay for an On-Demand Instance, expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

A high value, such as 999999, turns off price protection.

resources[].details.aws_ec2_launch_template.launch_template_data.instance_requirements.require_hibernate_support

Indicates whether instance types must support hibernation for On-Demand Instances.

resources[].details.aws_ec2_launch_template.launch_template_data.instance_requirements.spot_max_price_percentage_over_lowest_price

The price protection threshold for Spot Instances. This is the maximum you'll pay for a Spot Instance, expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

A high value, such as 999999, turns off price protection.

resources[].details.aws_ec2_launch_template.launch_template_data.instance_requirements.total_local_storage_gb

The minimum and maximum amount of total local storage, in GB.

Show child fields
resources[].details.aws_ec2_launch_template.launch_template_data.instance_requirements.total_local_storage_gb.max

The maximum amount of total local storage, in GB.

resources[].details.aws_ec2_launch_template.launch_template_data.instance_requirements.total_local_storage_gb.min

The minimum amount of total local storage, in GB.

resources[].details.aws_ec2_launch_template.launch_template_data.instance_requirements.v_cpu_count

The minimum and maximum number of vCPUs.

Show child fields
resources[].details.aws_ec2_launch_template.launch_template_data.instance_requirements.v_cpu_count.max

The maximum number of vCPUs.

resources[].details.aws_ec2_launch_template.launch_template_data.instance_requirements.v_cpu_count.min

The minimum number of vCPUs.

resources[].details.aws_ec2_launch_template.launch_template_data.instance_type

The instance type. For more information, see Instance types in the Amazon EC2 User Guide. If you specify InstanceType, you can't specify InstanceRequirements.

resources[].details.aws_ec2_launch_template.launch_template_data.kernel_id

The ID of the kernel.

resources[].details.aws_ec2_launch_template.launch_template_data.key_name

The name of the key pair that allows users to connect to the instance.

resources[].details.aws_ec2_launch_template.launch_template_data.license_set[]
Show child fields
resources[].details.aws_ec2_launch_template.launch_template_data.license_set[].license_configuration_arn

The Amazon Resource Name (ARN) of the license configuration.

resources[].details.aws_ec2_launch_template.launch_template_data.maintenance_options

The maintenance options of your instance.

Show child fields
resources[].details.aws_ec2_launch_template.launch_template_data.maintenance_options.auto_recovery

Disables the automatic recovery behavior of your instance or sets it to default.

resources[].details.aws_ec2_launch_template.launch_template_data.metadata_options

The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon EC2 User Guide.

Show child fields
resources[].details.aws_ec2_launch_template.launch_template_data.metadata_options.http_endpoint

Enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled, and you won't be able to access your instance metadata.

resources[].details.aws_ec2_launch_template.launch_template_data.metadata_options.http_protocol_ipv6

Enables or disables the IPv6 endpoint for the instance metadata service.

resources[].details.aws_ec2_launch_template.launch_template_data.metadata_options.http_put_response_hop_limit

The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.

resources[].details.aws_ec2_launch_template.launch_template_data.metadata_options.http_tokens

The state of token usage for your instance metadata requests.

resources[].details.aws_ec2_launch_template.launch_template_data.metadata_options.instance_metadata_tags

When set to enabled, this parameter allows access to instance tags from the instance metadata. When set to disabled, it turns off access to instance tags from the instance metadata. For more information, see Work with instance tags in instance metadata in the Amazon EC2 User Guide.

resources[].details.aws_ec2_launch_template.launch_template_data.monitoring

The monitoring for the instance.

Show child fields
resources[].details.aws_ec2_launch_template.launch_template_data.monitoring.enabled

Enables detailed monitoring when true is specified. Otherwise, basic monitoring is enabled. For more information about detailed monitoring, see Enable or turn off detailed monitoring for your instances in the Amazon EC2 User Guide.

resources[].details.aws_ec2_launch_template.launch_template_data.network_interface_set[]
Show child fields
resources[].details.aws_ec2_launch_template.launch_template_data.network_interface_set[].associate_carrier_ip_address

Indicates whether to associate a Carrier IP address with eth0 for a new network interface. You use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information, see Carrier IP address in the Wavelength Developer Guide.

resources[].details.aws_ec2_launch_template.launch_template_data.network_interface_set[].associate_public_ip_address

Associates a public IPv4 address with eth0 for a new network interface.

resources[].details.aws_ec2_launch_template.launch_template_data.network_interface_set[].delete_on_termination

Indicates whether the network interface is deleted when the instance is terminated.

resources[].details.aws_ec2_launch_template.launch_template_data.network_interface_set[].description

A description for the network interface.

resources[].details.aws_ec2_launch_template.launch_template_data.network_interface_set[].device_index

The device index for the network interface attachment.

resources[].details.aws_ec2_launch_template.launch_template_data.network_interface_set[].groups[]
resources[].details.aws_ec2_launch_template.launch_template_data.network_interface_set[].interface_type

The type of network interface.

resources[].details.aws_ec2_launch_template.launch_template_data.network_interface_set[].ipv4_prefix_count

The number of IPv4 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv4Prefixes option.

resources[].details.aws_ec2_launch_template.launch_template_data.network_interface_set[].ipv4_prefixes[]
Show child fields
resources[].details.aws_ec2_launch_template.launch_template_data.network_interface_set[].ipv4_prefixes[].ipv4_prefix

The IPv4 prefix. For more information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.

resources[].details.aws_ec2_launch_template.launch_template_data.network_interface_set[].ipv6_address_count

The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if you use Ipv6Addresses.

resources[].details.aws_ec2_launch_template.launch_template_data.network_interface_set[].ipv6_addresses[]
Show child fields
resources[].details.aws_ec2_launch_template.launch_template_data.network_interface_set[].ipv6_addresses[].ipv6_address

One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet.

resources[].details.aws_ec2_launch_template.launch_template_data.network_interface_set[].ipv6_prefix_count

The number of IPv6 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv6Prefix option.

resources[].details.aws_ec2_launch_template.launch_template_data.network_interface_set[].ipv6_prefixes[]
Show child fields
resources[].details.aws_ec2_launch_template.launch_template_data.network_interface_set[].ipv6_prefixes[].ipv6_prefix

The IPv6 prefix.

resources[].details.aws_ec2_launch_template.launch_template_data.network_interface_set[].network_card_index

The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.

resources[].details.aws_ec2_launch_template.launch_template_data.network_interface_set[].network_interface_id

The ID of the network interface.

resources[].details.aws_ec2_launch_template.launch_template_data.network_interface_set[].private_ip_address

The primary private IPv4 address of the network interface.

resources[].details.aws_ec2_launch_template.launch_template_data.network_interface_set[].private_ip_addresses[]
Show child fields
resources[].details.aws_ec2_launch_template.launch_template_data.network_interface_set[].private_ip_addresses[].primary

Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.

resources[].details.aws_ec2_launch_template.launch_template_data.network_interface_set[].private_ip_addresses[].private_ip_address

The private IPv4 address.

resources[].details.aws_ec2_launch_template.launch_template_data.network_interface_set[].secondary_private_ip_address_count

The number of secondary private IPv4 addresses to assign to a network interface.

resources[].details.aws_ec2_launch_template.launch_template_data.network_interface_set[].subnet_id

The ID of the subnet for the network interface.

resources[].details.aws_ec2_launch_template.launch_template_data.placement

Specifies the placement of an instance.

Show child fields
resources[].details.aws_ec2_launch_template.launch_template_data.placement.affinity

The affinity setting for an instance on an EC2 Dedicated Host.

resources[].details.aws_ec2_launch_template.launch_template_data.placement.availability_zone

The Availability Zone for the instance.

resources[].details.aws_ec2_launch_template.launch_template_data.placement.group_name

The name of the placement group for the instance.

resources[].details.aws_ec2_launch_template.launch_template_data.placement.host_id

The ID of the Dedicated Host for the instance.

resources[].details.aws_ec2_launch_template.launch_template_data.placement.host_resource_group_arn

The Amazon Resource Name (ARN) of the host resource group in which to launch the instances.

resources[].details.aws_ec2_launch_template.launch_template_data.placement.partition_number

The number of the partition the instance should launch in.

resources[].details.aws_ec2_launch_template.launch_template_data.placement.spread_domain

Reserved for future use.

resources[].details.aws_ec2_launch_template.launch_template_data.placement.tenancy

The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.

resources[].details.aws_ec2_launch_template.launch_template_data.private_dns_name_options

The options for the instance hostname.

Show child fields
resources[].details.aws_ec2_launch_template.launch_template_data.private_dns_name_options.enable_resource_name_dns_a_record

Indicates whether to respond to DNS queries for instance hostnames with DNS A records.

resources[].details.aws_ec2_launch_template.launch_template_data.private_dns_name_options.enable_resource_name_dns_aaaa_record

Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.

resources[].details.aws_ec2_launch_template.launch_template_data.private_dns_name_options.hostname_type

The type of hostname for EC2 instances.

resources[].details.aws_ec2_launch_template.launch_template_data.ram_disk_id

The ID of the RAM disk.

resources[].details.aws_ec2_launch_template.launch_template_data.security_group_id_set[]
resources[].details.aws_ec2_launch_template.launch_template_data.security_group_set[]
resources[].details.aws_ec2_launch_template.launch_template_data.user_data

The user data to make available to the instance.

resources[].details.aws_ec2_launch_template.launch_template_name

A name for the launch template.

resources[].details.aws_ec2_network_acl

Details about an EC2 network access control list (ACL).

Show child fields
resources[].details.aws_ec2_network_acl.associations[]
Show child fields
resources[].details.aws_ec2_network_acl.associations[].network_acl_association_id

The identifier of the association between the network ACL and the subnet.

resources[].details.aws_ec2_network_acl.associations[].network_acl_id

The identifier of the network ACL.

resources[].details.aws_ec2_network_acl.associations[].subnet_id

The identifier of the subnet that is associated with the network ACL.

resources[].details.aws_ec2_network_acl.entries[]
Show child fields
resources[].details.aws_ec2_network_acl.entries[].cidr_block

The IPV4 network range for which to deny or allow access.

resources[].details.aws_ec2_network_acl.entries[].egress

Whether the rule is an egress rule. An egress rule is a rule that applies to traffic that leaves the subnet.

resources[].details.aws_ec2_network_acl.entries[].icmp_type_code

The Internet Control Message Protocol (ICMP) type and code for which to deny or allow access.

Show child fields
resources[].details.aws_ec2_network_acl.entries[].icmp_type_code.code

The ICMP code for which to deny or allow access. To deny or allow all codes, use the value -1.

resources[].details.aws_ec2_network_acl.entries[].icmp_type_code.type

The ICMP type for which to deny or allow access. To deny or allow all types, use the value -1.

resources[].details.aws_ec2_network_acl.entries[].ipv6_cidr_block

The IPV6 network range for which to deny or allow access.

resources[].details.aws_ec2_network_acl.entries[].port_range

For TCP or UDP protocols, the range of ports that the rule applies to.

Show child fields
resources[].details.aws_ec2_network_acl.entries[].port_range.from

The first port in the port range.

resources[].details.aws_ec2_network_acl.entries[].port_range.to

The last port in the port range.

resources[].details.aws_ec2_network_acl.entries[].protocol

The protocol that the rule applies to. To deny or allow access to all protocols, use the value -1.

resources[].details.aws_ec2_network_acl.entries[].rule_action

Whether the rule is used to allow access or deny access.

resources[].details.aws_ec2_network_acl.entries[].rule_number

The rule number. The rules are processed in order by their number.

resources[].details.aws_ec2_network_acl.is_default

Whether this is the default network ACL for the VPC.

resources[].details.aws_ec2_network_acl.network_acl_id

The identifier of the network ACL.

resources[].details.aws_ec2_network_acl.owner_id

The identifier of the Amazon Web Services account that owns the network ACL.

resources[].details.aws_ec2_network_acl.vpc_id

The identifier of the VPC for the network ACL.

resources[].details.aws_ec2_network_interface

Details for an EC2 network interface.

Show child fields
resources[].details.aws_ec2_network_interface.attachment

The network interface attachment.

Show child fields
resources[].details.aws_ec2_network_interface.attachment.attach_time

Indicates when the attachment initiated.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_ec2_network_interface.attachment.attachment_id

The identifier of the network interface attachment

resources[].details.aws_ec2_network_interface.attachment.delete_on_termination

Indicates whether the network interface is deleted when the instance is terminated.

resources[].details.aws_ec2_network_interface.attachment.device_index

The device index of the network interface attachment on the instance.

resources[].details.aws_ec2_network_interface.attachment.instance_id

The ID of the instance.

resources[].details.aws_ec2_network_interface.attachment.instance_owner_id

The Amazon Web Services account ID of the owner of the instance.

resources[].details.aws_ec2_network_interface.attachment.status

The attachment state.

Valid values: attaching | attached | detaching | detached

resources[].details.aws_ec2_network_interface.ip_v6_addresses[]
Show child fields
resources[].details.aws_ec2_network_interface.ip_v6_addresses[].ip_v6_address

The IPV6 address.

resources[].details.aws_ec2_network_interface.network_interface_id

The ID of the network interface.

resources[].details.aws_ec2_network_interface.private_ip_addresses[]
Show child fields
resources[].details.aws_ec2_network_interface.private_ip_addresses[].private_dns_name

The private DNS name for the IP address.

resources[].details.aws_ec2_network_interface.private_ip_addresses[].private_ip_address

The IP address.

resources[].details.aws_ec2_network_interface.public_dns_name

The public DNS name of the network interface.

resources[].details.aws_ec2_network_interface.public_ip

The address of the Elastic IP address bound to the network interface.

resources[].details.aws_ec2_network_interface.security_groups[]
Show child fields
resources[].details.aws_ec2_network_interface.security_groups[].group_id

The ID of the security group.

resources[].details.aws_ec2_network_interface.security_groups[].group_name

The name of the security group.

resources[].details.aws_ec2_network_interface.source_dest_check

Indicates whether traffic to or from the instance is validated.

resources[].details.aws_ec2_route_table

Provides details about a route table. A route table contains a set of rules, called routes, that determine where to direct network traffic from your subnet or gateway.

Show child fields
resources[].details.aws_ec2_route_table.association_set[]
Show child fields
resources[].details.aws_ec2_route_table.association_set[].association_state

The state of the association between a route table and a subnet or gateway.

Show child fields
resources[].details.aws_ec2_route_table.association_set[].association_state.state

The state of the association.

resources[].details.aws_ec2_route_table.association_set[].association_state.status_message

The status message, if applicable.

resources[].details.aws_ec2_route_table.association_set[].gateway_id

The ID of the internet gateway or virtual private gateway.

resources[].details.aws_ec2_route_table.association_set[].main

Indicates whether this is the main route table.

resources[].details.aws_ec2_route_table.association_set[].route_table_association_id

The ID of the association.

resources[].details.aws_ec2_route_table.association_set[].route_table_id

The ID of the route table.

resources[].details.aws_ec2_route_table.association_set[].subnet_id

The ID of the subnet. A subnet ID is not returned for an implicit association.

resources[].details.aws_ec2_route_table.owner_id

The ID of the Amazon Web Services account that owns the route table.

resources[].details.aws_ec2_route_table.propagating_vgw_set[]
Show child fields
resources[].details.aws_ec2_route_table.propagating_vgw_set[].gateway_id

The ID of the virtual private gateway.

resources[].details.aws_ec2_route_table.route_set[]
Show child fields
resources[].details.aws_ec2_route_table.route_set[].carrier_gateway_id

The ID of the carrier gateway.

resources[].details.aws_ec2_route_table.route_set[].core_network_arn

The Amazon Resource Name (ARN) of the core network.

resources[].details.aws_ec2_route_table.route_set[].destination_cidr_block

The IPv4 CIDR block used for the destination match.

resources[].details.aws_ec2_route_table.route_set[].destination_ipv6_cidr_block

The IPv6 CIDR block used for the destination match.

resources[].details.aws_ec2_route_table.route_set[].destination_prefix_list_id

The prefix of the destination Amazon Web Servicesservice.

resources[].details.aws_ec2_route_table.route_set[].egress_only_internet_gateway_id

The ID of the egress-only internet gateway.

resources[].details.aws_ec2_route_table.route_set[].gateway_id

The ID of a gateway attached to your VPC.

resources[].details.aws_ec2_route_table.route_set[].instance_id

The ID of a NAT instance in your VPC.

resources[].details.aws_ec2_route_table.route_set[].instance_owner_id

The ID of the Amazon Web Services account that owns the instance.

resources[].details.aws_ec2_route_table.route_set[].local_gateway_id

The ID of the local gateway.

resources[].details.aws_ec2_route_table.route_set[].nat_gateway_id

The ID of a NAT gateway.

resources[].details.aws_ec2_route_table.route_set[].network_interface_id

The ID of the network interface.

resources[].details.aws_ec2_route_table.route_set[].origin

Describes how the route was created.

resources[].details.aws_ec2_route_table.route_set[].state

The state of the route.

resources[].details.aws_ec2_route_table.route_set[].transit_gateway_id

The ID of a transit gateway.

resources[].details.aws_ec2_route_table.route_set[].vpc_peering_connection_id

The ID of a VPC peering connection.

resources[].details.aws_ec2_route_table.route_table_id

The ID of the route table.

resources[].details.aws_ec2_route_table.vpc_id

The ID of the virtual private cloud (VPC).

resources[].details.aws_ec2_security_group

Details for an EC2 security group.

Show child fields
resources[].details.aws_ec2_security_group.group_id

The ID of the security group.

resources[].details.aws_ec2_security_group.group_name

The name of the security group.

resources[].details.aws_ec2_security_group.ip_permissions[]
Show child fields
resources[].details.aws_ec2_security_group.ip_permissions[].from_port

The start of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.

A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.

resources[].details.aws_ec2_security_group.ip_permissions[].ip_protocol

The IP protocol name (tcp, udp, icmp, icmpv6) or number.

[VPC only] Use -1 to specify all protocols.

When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify.

For tcp, udp, and icmp, you must specify a port range.

For icmpv6, the port range is optional. If you omit the port range, traffic for all types and codes is allowed.

resources[].details.aws_ec2_security_group.ip_permissions[].ip_ranges[]
Show child fields
resources[].details.aws_ec2_security_group.ip_permissions[].ip_ranges[].cidr_ip

The IPv4 CIDR range. You can specify either a CIDR range or a source security group, but not both. To specify a single IPv4 address, use the /32 prefix length.

resources[].details.aws_ec2_security_group.ip_permissions[].ipv6_ranges[]
Show child fields
resources[].details.aws_ec2_security_group.ip_permissions[].ipv6_ranges[].cidr_ipv6

The IPv6 CIDR range. You can specify either a CIDR range or a source security group, but not both. To specify a single IPv6 address, use the /128 prefix length.

resources[].details.aws_ec2_security_group.ip_permissions[].prefix_list_ids[]
Show child fields
resources[].details.aws_ec2_security_group.ip_permissions[].prefix_list_ids[].prefix_list_id

The ID of the prefix.

resources[].details.aws_ec2_security_group.ip_permissions[].to_port

The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.

A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.

resources[].details.aws_ec2_security_group.ip_permissions[].user_id_group_pairs[]
Show child fields
resources[].details.aws_ec2_security_group.ip_permissions[].user_id_group_pairs[].group_id

The ID of the security group.

resources[].details.aws_ec2_security_group.ip_permissions[].user_id_group_pairs[].group_name

The name of the security group.

resources[].details.aws_ec2_security_group.ip_permissions[].user_id_group_pairs[].peering_status

The status of a VPC peering connection, if applicable.

resources[].details.aws_ec2_security_group.ip_permissions[].user_id_group_pairs[].user_id

The ID of an Amazon Web Services account.

For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.

[EC2-Classic] Required when adding or removing rules that reference a security group in another VPC.

resources[].details.aws_ec2_security_group.ip_permissions[].user_id_group_pairs[].vpc_id

The ID of the VPC for the referenced security group, if applicable.

resources[].details.aws_ec2_security_group.ip_permissions[].user_id_group_pairs[].vpc_peering_connection_id

The ID of the VPC peering connection, if applicable.

resources[].details.aws_ec2_security_group.ip_permissions_egress[]
Show child fields
resources[].details.aws_ec2_security_group.ip_permissions_egress[].from_port

The start of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.

A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.

resources[].details.aws_ec2_security_group.ip_permissions_egress[].ip_protocol

The IP protocol name (tcp, udp, icmp, icmpv6) or number.

[VPC only] Use -1 to specify all protocols.

When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify.

For tcp, udp, and icmp, you must specify a port range.

For icmpv6, the port range is optional. If you omit the port range, traffic for all types and codes is allowed.

resources[].details.aws_ec2_security_group.ip_permissions_egress[].ip_ranges[]
Show child fields
resources[].details.aws_ec2_security_group.ip_permissions_egress[].ip_ranges[].cidr_ip

The IPv4 CIDR range. You can specify either a CIDR range or a source security group, but not both. To specify a single IPv4 address, use the /32 prefix length.

resources[].details.aws_ec2_security_group.ip_permissions_egress[].ipv6_ranges[]
Show child fields
resources[].details.aws_ec2_security_group.ip_permissions_egress[].ipv6_ranges[].cidr_ipv6

The IPv6 CIDR range. You can specify either a CIDR range or a source security group, but not both. To specify a single IPv6 address, use the /128 prefix length.

resources[].details.aws_ec2_security_group.ip_permissions_egress[].prefix_list_ids[]
Show child fields
resources[].details.aws_ec2_security_group.ip_permissions_egress[].prefix_list_ids[].prefix_list_id

The ID of the prefix.

resources[].details.aws_ec2_security_group.ip_permissions_egress[].to_port

The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.

A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.

resources[].details.aws_ec2_security_group.ip_permissions_egress[].user_id_group_pairs[]
Show child fields
resources[].details.aws_ec2_security_group.ip_permissions_egress[].user_id_group_pairs[].group_id

The ID of the security group.

resources[].details.aws_ec2_security_group.ip_permissions_egress[].user_id_group_pairs[].group_name

The name of the security group.

resources[].details.aws_ec2_security_group.ip_permissions_egress[].user_id_group_pairs[].peering_status

The status of a VPC peering connection, if applicable.

resources[].details.aws_ec2_security_group.ip_permissions_egress[].user_id_group_pairs[].user_id

The ID of an Amazon Web Services account.

For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.

[EC2-Classic] Required when adding or removing rules that reference a security group in another VPC.

resources[].details.aws_ec2_security_group.ip_permissions_egress[].user_id_group_pairs[].vpc_id

The ID of the VPC for the referenced security group, if applicable.

resources[].details.aws_ec2_security_group.ip_permissions_egress[].user_id_group_pairs[].vpc_peering_connection_id

The ID of the VPC peering connection, if applicable.

resources[].details.aws_ec2_security_group.owner_id

The Amazon Web Services account ID of the owner of the security group.

resources[].details.aws_ec2_security_group.vpc_id

[VPC only] The ID of the VPC for the security group.

resources[].details.aws_ec2_subnet

Details about a subnet in Amazon EC2.

Show child fields
resources[].details.aws_ec2_subnet.assign_ipv6_address_on_creation

Whether to assign an IPV6 address to a network interface that is created in this subnet.

resources[].details.aws_ec2_subnet.availability_zone

The Availability Zone for the subnet.

resources[].details.aws_ec2_subnet.availability_zone_id

The identifier of the Availability Zone for the subnet.

resources[].details.aws_ec2_subnet.available_ip_address_count

The number of available IPV4 addresses in the subnet. Does not include addresses for stopped instances.

resources[].details.aws_ec2_subnet.cidr_block

The IPV4 CIDR block that is assigned to the subnet.

resources[].details.aws_ec2_subnet.default_for_az

Whether this subnet is the default subnet for the Availability Zone.

resources[].details.aws_ec2_subnet.ipv6_cidr_block_association_set[]
Show child fields
resources[].details.aws_ec2_subnet.ipv6_cidr_block_association_set[].association_id

The association ID for the IPv6 CIDR block.

resources[].details.aws_ec2_subnet.ipv6_cidr_block_association_set[].cidr_block_state

Information about the state of the CIDR block. Valid values are as follows:

  • associating

  • associated

  • disassociating

  • disassociated

  • failed

  • failing

resources[].details.aws_ec2_subnet.ipv6_cidr_block_association_set[].ipv6_cidr_block

The IPv6 CIDR block.

resources[].details.aws_ec2_subnet.map_public_ip_on_launch

Whether instances in this subnet receive a public IP address.

resources[].details.aws_ec2_subnet.owner_id

The identifier of the Amazon Web Services account that owns the subnet.

resources[].details.aws_ec2_subnet.state

The current state of the subnet. Valid values are available or pending.

resources[].details.aws_ec2_subnet.subnet_arn

The ARN of the subnet.

resources[].details.aws_ec2_subnet.subnet_id

The identifier of the subnet.

resources[].details.aws_ec2_subnet.vpc_id

The identifier of the VPC that contains the subnet.

resources[].details.aws_ec2_transit_gateway

Details about an Amazon EC2 transit gateway that interconnects your virtual private clouds (VPC) and on-premises networks.

Show child fields
resources[].details.aws_ec2_transit_gateway.amazon_side_asn

A private Autonomous System Number (ASN) for the Amazon side of a BGP session.

resources[].details.aws_ec2_transit_gateway.association_default_route_table_id

The ID of the default association route table.

resources[].details.aws_ec2_transit_gateway.auto_accept_shared_attachments

Turn on or turn off automatic acceptance of attachment requests.

resources[].details.aws_ec2_transit_gateway.default_route_table_association

Turn on or turn off automatic association with the default association route table.

resources[].details.aws_ec2_transit_gateway.default_route_table_propagation

Turn on or turn off automatic propagation of routes to the default propagation route table.

resources[].details.aws_ec2_transit_gateway.description

The description of the transit gateway.

resources[].details.aws_ec2_transit_gateway.dns_support

Turn on or turn off DNS support.

resources[].details.aws_ec2_transit_gateway.id

The ID of the transit gateway.

resources[].details.aws_ec2_transit_gateway.multicast_support

Indicates whether multicast is supported on the transit gateway.

resources[].details.aws_ec2_transit_gateway.propagation_default_route_table_id

The ID of the default propagation route table.

resources[].details.aws_ec2_transit_gateway.transit_gateway_cidr_blocks[]
resources[].details.aws_ec2_transit_gateway.vpn_ecmp_support

Turn on or turn off Equal Cost Multipath Protocol (ECMP) support.

resources[].details.aws_ec2_volume

Details for an Amazon EC2 volume.

Show child fields
resources[].details.aws_ec2_volume.attachments[]
Show child fields
resources[].details.aws_ec2_volume.attachments[].attach_time

The datetime when the attachment initiated.

resources[].details.aws_ec2_volume.attachments[].delete_on_termination

Whether the EBS volume is deleted when the EC2 instance is terminated.

resources[].details.aws_ec2_volume.attachments[].instance_id

The identifier of the EC2 instance.

resources[].details.aws_ec2_volume.attachments[].status

The attachment state of the volume. Valid values are as follows:

  • attaching

  • attached

  • busy

  • detaching

  • detached

resources[].details.aws_ec2_volume.create_time

Indicates when the volume was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_ec2_volume.device_name

The device name for the volume that is attached to the instance.

resources[].details.aws_ec2_volume.encrypted

Specifies whether the volume is encrypted.

resources[].details.aws_ec2_volume.kms_key_id

The ARN of the KMS key that was used to protect the volume encryption key for the volume.

resources[].details.aws_ec2_volume.size

The size of the volume, in GiBs.

resources[].details.aws_ec2_volume.snapshot_id

The snapshot from which the volume was created.

resources[].details.aws_ec2_volume.status

The volume state. Valid values are as follows:

  • available

  • creating

  • deleted

  • deleting

  • error

  • in-use

resources[].details.aws_ec2_volume.volume_id

The ID of the volume.

resources[].details.aws_ec2_volume.volume_scan_status

Indicates whether the volume was scanned or skipped.

resources[].details.aws_ec2_volume.volume_type

The volume type.

resources[].details.aws_ec2_vpc

Details for an Amazon EC2 VPC.

Show child fields
resources[].details.aws_ec2_vpc.cidr_block_association_set[]
Show child fields
resources[].details.aws_ec2_vpc.cidr_block_association_set[].association_id

The association ID for the IPv4 CIDR block.

resources[].details.aws_ec2_vpc.cidr_block_association_set[].cidr_block

The IPv4 CIDR block.

resources[].details.aws_ec2_vpc.cidr_block_association_set[].cidr_block_state

Information about the state of the IPv4 CIDR block.

resources[].details.aws_ec2_vpc.dhcp_options_id

The identifier of the set of Dynamic Host Configuration Protocol (DHCP) options that are associated with the VPC. If the default options are associated with the VPC, then this is default.

resources[].details.aws_ec2_vpc.ipv6_cidr_block_association_set[]
Show child fields
resources[].details.aws_ec2_vpc.ipv6_cidr_block_association_set[].association_id

The association ID for the IPv6 CIDR block.

resources[].details.aws_ec2_vpc.ipv6_cidr_block_association_set[].cidr_block_state

Information about the state of the CIDR block. Valid values are as follows:

  • associating

  • associated

  • disassociating

  • disassociated

  • failed

  • failing

resources[].details.aws_ec2_vpc.ipv6_cidr_block_association_set[].ipv6_cidr_block

The IPv6 CIDR block.

resources[].details.aws_ec2_vpc.state

The current state of the VPC. Valid values are available or pending.

resources[].details.aws_ec2_vpc_endpoint_service

Details about the service configuration for a VPC endpoint service.

Show child fields
resources[].details.aws_ec2_vpc_endpoint_service.acceptance_required

Whether requests from other Amazon Web Services accounts to create an endpoint to the service must first be accepted.

resources[].details.aws_ec2_vpc_endpoint_service.availability_zones[]
resources[].details.aws_ec2_vpc_endpoint_service.base_endpoint_dns_names[]
resources[].details.aws_ec2_vpc_endpoint_service.gateway_load_balancer_arns[]
resources[].details.aws_ec2_vpc_endpoint_service.manages_vpc_endpoints

Whether the service manages its VPC endpoints.

resources[].details.aws_ec2_vpc_endpoint_service.network_load_balancer_arns[]
resources[].details.aws_ec2_vpc_endpoint_service.private_dns_name

The private DNS name for the service.

resources[].details.aws_ec2_vpc_endpoint_service.service_id

The identifier of the service.

resources[].details.aws_ec2_vpc_endpoint_service.service_name

The name of the service.

resources[].details.aws_ec2_vpc_endpoint_service.service_state

The current state of the service. Valid values are as follows:

  • Available

  • Deleted

  • Deleting

  • Failed

  • Pending

resources[].details.aws_ec2_vpc_endpoint_service.service_type[]
Show child fields
resources[].details.aws_ec2_vpc_endpoint_service.service_type[].service_type

The type of service.

resources[].details.aws_ec2_vpc_peering_connection

Details about an Amazon EC2 VPC peering connection. A VPC peering connection is a networking connection between two VPCs that enables you to route traffic between them privately.

Show child fields
resources[].details.aws_ec2_vpc_peering_connection.accepter_vpc_info

Information about the accepter VPC.

Show child fields
resources[].details.aws_ec2_vpc_peering_connection.accepter_vpc_info.cidr_block

The IPv4 CIDR block for the VPC.

resources[].details.aws_ec2_vpc_peering_connection.accepter_vpc_info.cidr_block_set[]
Show child fields
resources[].details.aws_ec2_vpc_peering_connection.accepter_vpc_info.cidr_block_set[].cidr_block

The IPv4 CIDR block for the VPC.

resources[].details.aws_ec2_vpc_peering_connection.accepter_vpc_info.ipv6_cidr_block_set[]
Show child fields
resources[].details.aws_ec2_vpc_peering_connection.accepter_vpc_info.ipv6_cidr_block_set[].ipv6_cidr_block

The IPv6 CIDR block for the VPC.

resources[].details.aws_ec2_vpc_peering_connection.accepter_vpc_info.owner_id

The ID of the Amazon Web Services account that owns the VPC.

resources[].details.aws_ec2_vpc_peering_connection.accepter_vpc_info.peering_options

Information about the VPC peering connection options for the accepter or requester VPC.

Show child fields
resources[].details.aws_ec2_vpc_peering_connection.accepter_vpc_info.peering_options.allow_dns_resolution_from_remote_vpc

Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.

resources[].details.aws_ec2_vpc_peering_connection.accepter_vpc_info.peering_options.allow_egress_from_local_classic_link_to_remote_vpc

Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.

resources[].details.aws_ec2_vpc_peering_connection.accepter_vpc_info.peering_options.allow_egress_from_local_vpc_to_remote_classic_link

Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection.

resources[].details.aws_ec2_vpc_peering_connection.accepter_vpc_info.region

The Amazon Web Services Region in which the VPC is located.

resources[].details.aws_ec2_vpc_peering_connection.accepter_vpc_info.vpc_id

The ID of the VPC.

resources[].details.aws_ec2_vpc_peering_connection.expiration_time

The time at which an unaccepted VPC peering connection will expire.

resources[].details.aws_ec2_vpc_peering_connection.requester_vpc_info

Information about the requester VPC.

Show child fields
resources[].details.aws_ec2_vpc_peering_connection.requester_vpc_info.cidr_block

The IPv4 CIDR block for the VPC.

resources[].details.aws_ec2_vpc_peering_connection.requester_vpc_info.cidr_block_set[]
Show child fields
resources[].details.aws_ec2_vpc_peering_connection.requester_vpc_info.cidr_block_set[].cidr_block

The IPv4 CIDR block for the VPC.

resources[].details.aws_ec2_vpc_peering_connection.requester_vpc_info.ipv6_cidr_block_set[]
Show child fields
resources[].details.aws_ec2_vpc_peering_connection.requester_vpc_info.ipv6_cidr_block_set[].ipv6_cidr_block

The IPv6 CIDR block for the VPC.

resources[].details.aws_ec2_vpc_peering_connection.requester_vpc_info.owner_id

The ID of the Amazon Web Services account that owns the VPC.

resources[].details.aws_ec2_vpc_peering_connection.requester_vpc_info.peering_options

Information about the VPC peering connection options for the accepter or requester VPC.

Show child fields
resources[].details.aws_ec2_vpc_peering_connection.requester_vpc_info.peering_options.allow_dns_resolution_from_remote_vpc

Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.

resources[].details.aws_ec2_vpc_peering_connection.requester_vpc_info.peering_options.allow_egress_from_local_classic_link_to_remote_vpc

Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.

resources[].details.aws_ec2_vpc_peering_connection.requester_vpc_info.peering_options.allow_egress_from_local_vpc_to_remote_classic_link

Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection.

resources[].details.aws_ec2_vpc_peering_connection.requester_vpc_info.region

The Amazon Web Services Region in which the VPC is located.

resources[].details.aws_ec2_vpc_peering_connection.requester_vpc_info.vpc_id

The ID of the VPC.

resources[].details.aws_ec2_vpc_peering_connection.status

The status of the VPC peering connection.

Show child fields
resources[].details.aws_ec2_vpc_peering_connection.status.code

The status of the VPC peering connection.

resources[].details.aws_ec2_vpc_peering_connection.status.message

A message that provides more information about the status, if applicable.

resources[].details.aws_ec2_vpc_peering_connection.vpc_peering_connection_id

The ID of the VPC peering connection.

resources[].details.aws_ec2_vpn_connection

Details about an Amazon EC2 VPN connection.

Show child fields
resources[].details.aws_ec2_vpn_connection.category

The category of the VPN connection. VPN indicates an Amazon Web Services VPN connection. VPN-Classic indicates an Amazon Web Services Classic VPN connection.

resources[].details.aws_ec2_vpn_connection.customer_gateway_configuration

The configuration information for the VPN connection's customer gateway, in the native XML format.

resources[].details.aws_ec2_vpn_connection.customer_gateway_id

The identifier of the customer gateway that is at your end of the VPN connection.

resources[].details.aws_ec2_vpn_connection.options

The VPN connection options.

Show child fields
resources[].details.aws_ec2_vpn_connection.options.static_routes_only

Whether the VPN connection uses static routes only.

resources[].details.aws_ec2_vpn_connection.options.tunnel_options[]
Show child fields
resources[].details.aws_ec2_vpn_connection.options.tunnel_options[].dpd_timeout_seconds

The number of seconds after which a Dead Peer Detection (DPD) timeout occurs.

resources[].details.aws_ec2_vpn_connection.options.tunnel_options[].ike_versions[]
resources[].details.aws_ec2_vpn_connection.options.tunnel_options[].outside_ip_address

The external IP address of the VPN tunnel.

resources[].details.aws_ec2_vpn_connection.options.tunnel_options[].phase1_dh_group_numbers[]
resources[].details.aws_ec2_vpn_connection.options.tunnel_options[].phase1_encryption_algorithms[]
resources[].details.aws_ec2_vpn_connection.options.tunnel_options[].phase1_integrity_algorithms[]
resources[].details.aws_ec2_vpn_connection.options.tunnel_options[].phase1_lifetime_seconds

The lifetime for phase 1 of the IKE negotiation, in seconds.

resources[].details.aws_ec2_vpn_connection.options.tunnel_options[].phase2_dh_group_numbers[]
resources[].details.aws_ec2_vpn_connection.options.tunnel_options[].phase2_encryption_algorithms[]
resources[].details.aws_ec2_vpn_connection.options.tunnel_options[].phase2_integrity_algorithms[]
resources[].details.aws_ec2_vpn_connection.options.tunnel_options[].phase2_lifetime_seconds

The lifetime for phase 2 of the IKE negotiation, in seconds.

resources[].details.aws_ec2_vpn_connection.options.tunnel_options[].pre_shared_key

The preshared key to establish initial authentication between the virtual private gateway and the customer gateway.

resources[].details.aws_ec2_vpn_connection.options.tunnel_options[].rekey_fuzz_percentage

The percentage of the rekey window, which is determined by RekeyMarginTimeSeconds during which the rekey time is randomly selected.

resources[].details.aws_ec2_vpn_connection.options.tunnel_options[].rekey_margin_time_seconds

The margin time, in seconds, before the phase 2 lifetime expires, during which the Amazon Web Services side of the VPN connection performs an IKE rekey.

resources[].details.aws_ec2_vpn_connection.options.tunnel_options[].replay_window_size

The number of packets in an IKE replay window.

resources[].details.aws_ec2_vpn_connection.options.tunnel_options[].tunnel_inside_cidr

The range of inside IPv4 addresses for the tunnel.

resources[].details.aws_ec2_vpn_connection.routes[]
Show child fields
resources[].details.aws_ec2_vpn_connection.routes[].destination_cidr_block

The CIDR block associated with the local subnet of the customer data center.

resources[].details.aws_ec2_vpn_connection.routes[].state

The current state of the static route.

resources[].details.aws_ec2_vpn_connection.state

The current state of the VPN connection. Valid values are as follows:

  • available

  • deleted

  • deleting

  • pending

resources[].details.aws_ec2_vpn_connection.transit_gateway_id

The identifier of the transit gateway that is associated with the VPN connection.

resources[].details.aws_ec2_vpn_connection.type

The type of VPN connection.

resources[].details.aws_ec2_vpn_connection.vgw_telemetry[]
Show child fields
resources[].details.aws_ec2_vpn_connection.vgw_telemetry[].accepted_route_count

The number of accepted routes.

resources[].details.aws_ec2_vpn_connection.vgw_telemetry[].certificate_arn

The ARN of the VPN tunnel endpoint certificate.

resources[].details.aws_ec2_vpn_connection.vgw_telemetry[].last_status_change

The date and time of the last change in status.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_ec2_vpn_connection.vgw_telemetry[].outside_ip_address

The Internet-routable IP address of the virtual private gateway's outside interface.

resources[].details.aws_ec2_vpn_connection.vgw_telemetry[].status

The status of the VPN tunnel. Valid values are DOWN or UP.

resources[].details.aws_ec2_vpn_connection.vgw_telemetry[].status_message

If an error occurs, a description of the error.

resources[].details.aws_ec2_vpn_connection.vpn_connection_id

The identifier of the VPN connection.

resources[].details.aws_ec2_vpn_connection.vpn_gateway_id

The identifier of the virtual private gateway that is at the Amazon Web Services side of the VPN connection.

resources[].details.aws_ecr_container_image

Information about an Amazon ECR image.

Show child fields
resources[].details.aws_ecr_container_image.architecture

The architecture of the image. Valid values are as follows:

  • arm64

  • i386

  • x86_64

resources[].details.aws_ecr_container_image.image_digest

The sha256 digest of the image manifest.

resources[].details.aws_ecr_container_image.image_published_at

The date and time when the image was pushed to the repository.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_ecr_container_image.image_tags[]
resources[].details.aws_ecr_container_image.registry_id

The Amazon Web Services account identifier that is associated with the registry that the image belongs to.

resources[].details.aws_ecr_container_image.repository_name

The name of the repository that the image belongs to.

resources[].details.aws_ecr_repository

Information about an Amazon Elastic Container Registry repository.

Show child fields
resources[].details.aws_ecr_repository.arn

The ARN of the repository.

resources[].details.aws_ecr_repository.image_scanning_configuration

The image scanning configuration for a repository.

Show child fields
resources[].details.aws_ecr_repository.image_scanning_configuration.scan_on_push

Whether to scan images after they are pushed to a repository.

resources[].details.aws_ecr_repository.image_tag_mutability

The tag mutability setting for the repository. Valid values are IMMUTABLE or MUTABLE.

resources[].details.aws_ecr_repository.lifecycle_policy

Information about the lifecycle policy for the repository.

Show child fields
resources[].details.aws_ecr_repository.lifecycle_policy.lifecycle_policy_text

The text of the lifecycle policy.

resources[].details.aws_ecr_repository.lifecycle_policy.registry_id

The Amazon Web Services account identifier that is associated with the registry that contains the repository.

resources[].details.aws_ecr_repository.repository_name

The name of the repository.

resources[].details.aws_ecr_repository.repository_policy_text

The text of the repository policy.

resources[].details.aws_ecs_cluster

Details about an Amazon ECS cluster.

Show child fields
resources[].details.aws_ecs_cluster.active_services_count

The number of services that are running on the cluster in an ACTIVE state. You can view these services with the Amazon ECS ListServices API operation.

resources[].details.aws_ecs_cluster.capacity_providers[]
resources[].details.aws_ecs_cluster.cluster_arn

The Amazon Resource Name (ARN) that identifies the cluster.

resources[].details.aws_ecs_cluster.cluster_name

A name that you use to identify your cluster.

resources[].details.aws_ecs_cluster.cluster_settings[]
Show child fields
resources[].details.aws_ecs_cluster.cluster_settings[].name

The name of the setting. The valid value is containerInsights.

resources[].details.aws_ecs_cluster.cluster_settings[].value

The value of the setting. Valid values are disabled or enabled.

resources[].details.aws_ecs_cluster.configuration

The run command configuration for the cluster.

Show child fields
resources[].details.aws_ecs_cluster.configuration.execute_command_configuration

Contains the run command configuration for the cluster.

Show child fields
resources[].details.aws_ecs_cluster.configuration.execute_command_configuration.kms_key_id

The identifier of the KMS key that is used to encrypt the data between the local client and the container.

resources[].details.aws_ecs_cluster.configuration.execute_command_configuration.log_configuration

The log configuration for the results of the run command actions. Required if Logging is NONE.

Show child fields
resources[].details.aws_ecs_cluster.configuration.execute_command_configuration.log_configuration.cloud_watch_encryption_enabled

Whether to enable encryption on the CloudWatch logs.

resources[].details.aws_ecs_cluster.configuration.execute_command_configuration.log_configuration.cloud_watch_log_group_name

The name of the CloudWatch log group to send the logs to.

resources[].details.aws_ecs_cluster.configuration.execute_command_configuration.log_configuration.s3_bucket_name

The name of the S3 bucket to send logs to.

resources[].details.aws_ecs_cluster.configuration.execute_command_configuration.log_configuration.s3_encryption_enabled

Whether to encrypt the logs that are sent to the S3 bucket.

resources[].details.aws_ecs_cluster.configuration.execute_command_configuration.log_configuration.s3_key_prefix

Identifies the folder in the S3 bucket to send the logs to.

resources[].details.aws_ecs_cluster.configuration.execute_command_configuration.logging

The log setting to use for redirecting logs for run command results.

resources[].details.aws_ecs_cluster.default_capacity_provider_strategy[]
Show child fields
resources[].details.aws_ecs_cluster.default_capacity_provider_strategy[].base

The minimum number of tasks to run on the specified capacity provider.

resources[].details.aws_ecs_cluster.default_capacity_provider_strategy[].capacity_provider

The name of the capacity provider.

resources[].details.aws_ecs_cluster.default_capacity_provider_strategy[].weight

The relative percentage of the total number of tasks launched that should use the capacity provider.

resources[].details.aws_ecs_cluster.registered_container_instances_count

The number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status.

resources[].details.aws_ecs_cluster.running_tasks_count

The number of tasks in the cluster that are in the RUNNING state.

resources[].details.aws_ecs_cluster.status

The status of the cluster.

resources[].details.aws_ecs_container

Provides information about a Docker container that's part of a task.

Show child fields
resources[].details.aws_ecs_container.image

The image used for the container.

resources[].details.aws_ecs_container.mount_points[]
Show child fields
resources[].details.aws_ecs_container.mount_points[].container_path

The path on the container to mount the host volume at.

resources[].details.aws_ecs_container.mount_points[].source_volume

The name of the volume to mount. Must be a volume name referenced in the name parameter of task definition volume.

resources[].details.aws_ecs_container.name

The name of the container.

resources[].details.aws_ecs_container.privileged

When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user).

resources[].details.aws_ecs_service

Details about a service within an ECS cluster.

Show child fields
resources[].details.aws_ecs_service.capacity_provider_strategy[]
Show child fields
resources[].details.aws_ecs_service.capacity_provider_strategy[].base

The minimum number of tasks to run on the capacity provider. Only one strategy item can specify a value for Base.

The value must be between 0 and 100000.

resources[].details.aws_ecs_service.capacity_provider_strategy[].capacity_provider

The short name of the capacity provider.

resources[].details.aws_ecs_service.capacity_provider_strategy[].weight

The relative percentage of the total number of tasks that should use the capacity provider.

If no weight is specified, the default value is 0. At least one capacity provider must have a weight greater than 0.

The value can be between 0 and 1000.

resources[].details.aws_ecs_service.cluster

The ARN of the cluster that hosts the service.

resources[].details.aws_ecs_service.deployment_configuration

Deployment parameters for the service. Includes the number of tasks that run and the order in which to start and stop tasks.

Show child fields
resources[].details.aws_ecs_service.deployment_configuration.deployment_circuit_breaker

Determines whether a service deployment fails if a service cannot reach a steady state.

Show child fields
resources[].details.aws_ecs_service.deployment_configuration.deployment_circuit_breaker.enable

Whether to enable the deployment circuit breaker logic for the service.

resources[].details.aws_ecs_service.deployment_configuration.deployment_circuit_breaker.rollback

Whether to roll back the service if a service deployment fails. If rollback is enabled, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.

resources[].details.aws_ecs_service.deployment_configuration.maximum_percent

For a service that uses the rolling update (ECS) deployment type, the maximum number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment, and for tasks that use the EC2 launch type, when any container instances are in the DRAINING state. Provided as a percentage of the desired number of tasks. The default value is 200%.

For a service that uses the blue/green (CODE_DEPLOY) or EXTERNAL deployment types, and tasks that use the EC2 launch type, the maximum number of tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state.

For the Fargate launch type, the maximum percent value is not used.

resources[].details.aws_ecs_service.deployment_configuration.minimum_healthy_percent

For a service that uses the rolling update (ECS) deployment type, the minimum number of tasks in a service that must remain in the RUNNING state during a deployment, and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. Expressed as a percentage of the desired number of tasks. The default value is 100%.

For a service that uses the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and tasks that use the EC2 launch type, the minimum number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state.

For the Fargate launch type, the minimum healthy percent value is not used.

resources[].details.aws_ecs_service.deployment_controller

Contains the deployment controller type that the service uses.

Show child fields
resources[].details.aws_ecs_service.deployment_controller.type

The rolling update (ECS) deployment type replaces the current running version of the container with the latest version.

The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment model that is powered by CodeDeploy. This deployment model a new deployment of a service can be verified before production traffic is sent to it.

The external (EXTERNAL) deployment type allows the use of any third-party deployment controller for full control over the deployment process for an Amazon ECS service.

Valid values: ECS | CODE_DEPLOY | EXTERNAL

resources[].details.aws_ecs_service.desired_count

The number of instantiations of the task definition to run on the service.

resources[].details.aws_ecs_service.enable_ecs_managed_tags

Whether to enable Amazon ECS managed tags for the tasks in the service.

resources[].details.aws_ecs_service.enable_execute_command

Whether the execute command functionality is enabled for the service.

resources[].details.aws_ecs_service.health_check_grace_period_seconds

After a task starts, the amount of time in seconds that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks.

resources[].details.aws_ecs_service.launch_type

The launch type that the service uses.

Valid values: EC2 | FARGATE | EXTERNAL

resources[].details.aws_ecs_service.load_balancers[]
Show child fields
resources[].details.aws_ecs_service.load_balancers[].container_name

The name of the container to associate with the load balancer.

resources[].details.aws_ecs_service.load_balancers[].container_port

The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping.

resources[].details.aws_ecs_service.load_balancers[].load_balancer_name

The name of the load balancer to associate with the Amazon ECS service or task set.

Only specified when using a Classic Load Balancer. For an Application Load Balancer or a Network Load Balancer, the load balancer name is omitted.

resources[].details.aws_ecs_service.load_balancers[].target_group_arn

The ARN of the Elastic Load Balancing target group or groups associated with a service or task set.

Only specified when using an Application Load Balancer or a Network Load Balancer. For a Classic Load Balancer, the target group ARN is omitted.

resources[].details.aws_ecs_service.name

The name of the service.

resources[].details.aws_ecs_service.network_configuration

For tasks that use the awsvpc networking mode, the VPC subnet and security group configuration.

Show child fields
resources[].details.aws_ecs_service.network_configuration.aws_vpc_configuration

The VPC subnet and security group configuration.

Show child fields
resources[].details.aws_ecs_service.network_configuration.aws_vpc_configuration.assign_public_ip

Whether the task's elastic network interface receives a public IP address. The default value is DISABLED.

Valid values: ENABLED | DISABLED

resources[].details.aws_ecs_service.network_configuration.aws_vpc_configuration.security_groups[]
resources[].details.aws_ecs_service.network_configuration.aws_vpc_configuration.subnets[]
resources[].details.aws_ecs_service.placement_constraints[]
Show child fields
resources[].details.aws_ecs_service.placement_constraints[].expression

A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance.

resources[].details.aws_ecs_service.placement_constraints[].type

The type of constraint. Use distinctInstance to run each task in a particular group on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.

Valid values: distinctInstance | memberOf

resources[].details.aws_ecs_service.placement_strategies[]
Show child fields
resources[].details.aws_ecs_service.placement_strategies[].field

The field to apply the placement strategy against.

For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone.

For the binpack placement strategy, valid values are cpu and memory.

For the random placement strategy, this attribute is not used.

resources[].details.aws_ecs_service.placement_strategies[].type

The type of placement strategy.

The random placement strategy randomly places tasks on available candidates.

The spread placement strategy spreads placement across available candidates evenly based on the value of Field.

The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified in Field.

Valid values: random | spread | binpack

resources[].details.aws_ecs_service.platform_version

The platform version on which to run the service. Only specified for tasks that are hosted on Fargate. If a platform version is not specified, the LATEST platform version is used by default.

resources[].details.aws_ecs_service.propagate_tags

Indicates whether to propagate the tags from the task definition to the task or from the service to the task. If no value is provided, then tags are not propagated.

Valid values: TASK_DEFINITION | SERVICE

resources[].details.aws_ecs_service.role

The ARN of the IAM role that is associated with the service. The role allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.

resources[].details.aws_ecs_service.scheduling_strategy

The scheduling strategy to use for the service.

The REPLICA scheduling strategy places and maintains the desired number of tasks across the cluster. By default, the service scheduler spreads tasks across Availability Zones. Task placement strategies and constraints are used to customize task placement decisions.

The DAEMON scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that are specified in the cluster. The service scheduler also evaluates the task placement constraints for running tasks and stops tasks that do not meet the placement constraints.

Valid values: REPLICA | DAEMON

resources[].details.aws_ecs_service.service_arn

The ARN of the service.

resources[].details.aws_ecs_service.service_name

The name of the service.

The name can contain up to 255 characters. It can use letters, numbers, underscores, and hyphens.

resources[].details.aws_ecs_service.service_registries[]
Show child fields
resources[].details.aws_ecs_service.service_registries[].container_name

The container name value to use for the service discovery service.

If the task definition uses the bridge or host network mode, you must specify ContainerName and ContainerPort.

If the task definition uses the awsvpc network mode and a type SRV DNS record, you must specify either ContainerName and ContainerPort, or Port , but not both.

resources[].details.aws_ecs_service.service_registries[].container_port

The port value to use for the service discovery service.

If the task definition uses the bridge or host network mode, you must specify ContainerName and ContainerPort.

If the task definition uses the awsvpc network mode and a type SRV DNS record, you must specify either ContainerName and ContainerPort, or Port , but not both.

resources[].details.aws_ecs_service.service_registries[].port

The port value to use for a service discovery service that specifies an SRV record. This field can be used if both the awsvpcawsvpc network mode and SRV records are used.

resources[].details.aws_ecs_service.service_registries[].registry_arn

The ARN of the service registry.

resources[].details.aws_ecs_service.task_definition

The task definition to use for tasks in the service.

resources[].details.aws_ecs_task

Details about a task in a cluster.

Show child fields
resources[].details.aws_ecs_task.cluster_arn

The Amazon Resource Name (ARN) of the cluster that hosts the task.

resources[].details.aws_ecs_task.containers[]
Show child fields
resources[].details.aws_ecs_task.containers[].image

The image used for the container.

resources[].details.aws_ecs_task.containers[].mount_points[]
Show child fields
resources[].details.aws_ecs_task.containers[].mount_points[].container_path

The path on the container to mount the host volume at.

resources[].details.aws_ecs_task.containers[].mount_points[].source_volume

The name of the volume to mount. Must be a volume name referenced in the name parameter of task definition volume.

resources[].details.aws_ecs_task.containers[].name

The name of the container.

resources[].details.aws_ecs_task.containers[].privileged

When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user).

resources[].details.aws_ecs_task.created_at

The Unix timestamp for the time when the task was created. More specifically, it's for the time when the task entered the PENDING state.

resources[].details.aws_ecs_task.group

The name of the task group that's associated with the task.

resources[].details.aws_ecs_task.started_at

The Unix timestamp for the time when the task started. More specifically, it's for the time when the task transitioned from the PENDING state to the RUNNING state.

resources[].details.aws_ecs_task.started_by

The tag specified when a task is started. If an Amazon ECS service started the task, the startedBy parameter contains the deployment ID of that service.

resources[].details.aws_ecs_task.task_definition_arn

The ARN of the task definition that creates the task.

resources[].details.aws_ecs_task.version

The version counter for the task.

resources[].details.aws_ecs_task.volumes[]
Show child fields
resources[].details.aws_ecs_task.volumes[].host

This parameter is specified when you use bind mount host volumes. The contents of the host parameter determine whether your bind mount host volume persists on the host container instance and where it's stored.

Show child fields
resources[].details.aws_ecs_task.volumes[].host.source_path

When the host parameter is used, specify a sourcePath to declare the path on the host container instance that's presented to the container.

resources[].details.aws_ecs_task.volumes[].name

The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.

resources[].details.aws_ecs_task_definition

Details about a task definition. A task definition describes the container and volume definitions of an Amazon Elastic Container Service task.

Show child fields
resources[].details.aws_ecs_task_definition.container_definitions[]
Show child fields
resources[].details.aws_ecs_task_definition.container_definitions[].command[]
resources[].details.aws_ecs_task_definition.container_definitions[].cpu

The number of CPU units reserved for the container.

resources[].details.aws_ecs_task_definition.container_definitions[].depends_on[]
Show child fields
resources[].details.aws_ecs_task_definition.container_definitions[].depends_on[].condition

The dependency condition of the dependent container. Indicates the required status of the dependent container before the current container can start. Valid values are as follows:

  • COMPLETE

  • HEALTHY

  • SUCCESS

  • START

resources[].details.aws_ecs_task_definition.container_definitions[].depends_on[].container_name

The name of the dependent container.

resources[].details.aws_ecs_task_definition.container_definitions[].disable_networking

Whether to disable networking within the container.

resources[].details.aws_ecs_task_definition.container_definitions[].dns_search_domains[]
resources[].details.aws_ecs_task_definition.container_definitions[].dns_servers[]
resources[].details.aws_ecs_task_definition.container_definitions[].docker_labels

A key-value map of labels to add to the container.

resources[].details.aws_ecs_task_definition.container_definitions[].docker_security_options[]
resources[].details.aws_ecs_task_definition.container_definitions[].entry_point[]
resources[].details.aws_ecs_task_definition.container_definitions[].environment[]
Show child fields
resources[].details.aws_ecs_task_definition.container_definitions[].environment[].name

The name of the environment variable.

resources[].details.aws_ecs_task_definition.container_definitions[].environment[].value

The value of the environment variable.

resources[].details.aws_ecs_task_definition.container_definitions[].environment_files[]
Show child fields
resources[].details.aws_ecs_task_definition.container_definitions[].environment_files[].type

The type of environment file. The valid value is s3.

resources[].details.aws_ecs_task_definition.container_definitions[].environment_files[].value

The ARN of the S3 object that contains the environment variable file.

resources[].details.aws_ecs_task_definition.container_definitions[].essential

Whether the container is essential. All tasks must have at least one essential container.

resources[].details.aws_ecs_task_definition.container_definitions[].extra_hosts[]
Show child fields
resources[].details.aws_ecs_task_definition.container_definitions[].extra_hosts[].hostname

The hostname to use in the /etc/hosts entry.

resources[].details.aws_ecs_task_definition.container_definitions[].extra_hosts[].ip_address

The IP address to use in the /etc/hosts entry.

resources[].details.aws_ecs_task_definition.container_definitions[].firelens_configuration

The FireLens configuration for the container. Specifies and configures a log router for container logs.

Show child fields
resources[].details.aws_ecs_task_definition.container_definitions[].firelens_configuration.options

The options to use to configure the log router.

The valid option keys are as follows:

  • enable-ecs-log-metadata. The value can be true or false.

  • config-file-type. The value can be s3 or file.

  • config-file-value. The value is either an S3 ARN or a file path.

resources[].details.aws_ecs_task_definition.container_definitions[].firelens_configuration.type

The log router to use. Valid values are fluentbit or fluentd.

resources[].details.aws_ecs_task_definition.container_definitions[].health_check

The container health check command and associated configuration parameters for the container.

Show child fields
resources[].details.aws_ecs_task_definition.container_definitions[].health_check.command[]
resources[].details.aws_ecs_task_definition.container_definitions[].health_check.interval

The time period in seconds between each health check execution. The default value is 30 seconds.

resources[].details.aws_ecs_task_definition.container_definitions[].health_check.retries

The number of times to retry a failed health check before the container is considered unhealthy. The default value is 3.

resources[].details.aws_ecs_task_definition.container_definitions[].health_check.start_period

The optional grace period in seconds that allows containers time to bootstrap before failed health checks count towards the maximum number of retries.

resources[].details.aws_ecs_task_definition.container_definitions[].health_check.timeout

The time period in seconds to wait for a health check to succeed before it is considered a failure. The default value is 5.

resources[].details.aws_ecs_task_definition.container_definitions[].hostname

The hostname to use for the container.

resources[].details.aws_ecs_task_definition.container_definitions[].image

The image used to start the container.

resources[].details.aws_ecs_task_definition.container_definitions[].interactive

If set to true, then containerized applications can be deployed that require stdin or a tty to be allocated.

resources[].details.aws_ecs_task_definition.container_definitions[].links[]
resources[].details.aws_ecs_task_definition.container_definitions[].linux_parameters

Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.

Show child fields
resources[].details.aws_ecs_task_definition.container_definitions[].linux_parameters.capabilities

The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.

Show child fields
resources[].details.aws_ecs_task_definition.container_definitions[].linux_parameters.capabilities.add[]
resources[].details.aws_ecs_task_definition.container_definitions[].linux_parameters.capabilities.drop[]
resources[].details.aws_ecs_task_definition.container_definitions[].linux_parameters.devices[]
Show child fields
resources[].details.aws_ecs_task_definition.container_definitions[].linux_parameters.devices[].container_path

The path inside the container at which to expose the host device.

resources[].details.aws_ecs_task_definition.container_definitions[].linux_parameters.devices[].host_path

The path for the device on the host container instance.

resources[].details.aws_ecs_task_definition.container_definitions[].linux_parameters.devices[].permissions[]
resources[].details.aws_ecs_task_definition.container_definitions[].linux_parameters.init_process_enabled

Whether to run an init process inside the container that forwards signals and reaps processes.

resources[].details.aws_ecs_task_definition.container_definitions[].linux_parameters.max_swap

The total amount of swap memory (in MiB) that a container can use.

resources[].details.aws_ecs_task_definition.container_definitions[].linux_parameters.shared_memory_size

The value for the size (in MiB) of the /dev/shm volume.

resources[].details.aws_ecs_task_definition.container_definitions[].linux_parameters.swappiness

Configures the container's memory swappiness behavior. Determines how aggressively pages are swapped. The higher the value, the more aggressive the swappiness. The default is 60.

resources[].details.aws_ecs_task_definition.container_definitions[].linux_parameters.tmpfs[]
Show child fields
resources[].details.aws_ecs_task_definition.container_definitions[].linux_parameters.tmpfs[].container_path

The absolute file path where the tmpfs volume is to be mounted.

resources[].details.aws_ecs_task_definition.container_definitions[].linux_parameters.tmpfs[].mount_options[]
resources[].details.aws_ecs_task_definition.container_definitions[].linux_parameters.tmpfs[].size

The maximum size (in MiB) of the tmpfs volume.

resources[].details.aws_ecs_task_definition.container_definitions[].log_configuration

The log configuration specification for the container.

Show child fields
resources[].details.aws_ecs_task_definition.container_definitions[].log_configuration.log_driver

The log driver to use for the container.

Valid values on Fargate are as follows:

  • awsfirelens

  • awslogs

  • splunk

Valid values on Amazon EC2 are as follows:

  • awsfirelens

  • awslogs

  • fluentd

  • gelf

  • journald

  • json-file

  • logentries

  • splunk

  • syslog

resources[].details.aws_ecs_task_definition.container_definitions[].log_configuration.options

The configuration options to send to the log driver. Requires version 1.19 of the Docker Remote API or greater on your container instance.

resources[].details.aws_ecs_task_definition.container_definitions[].log_configuration.secret_options[]
Show child fields
resources[].details.aws_ecs_task_definition.container_definitions[].log_configuration.secret_options[].name

The name of the secret.

resources[].details.aws_ecs_task_definition.container_definitions[].log_configuration.secret_options[].value_from

The secret to expose to the container.

The value is either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the Systems Manager Parameter Store.

resources[].details.aws_ecs_task_definition.container_definitions[].memory

The amount (in MiB) of memory to present to the container. If the container attempts to exceed the memory specified here, the container is shut down. The total amount of memory reserved for all containers within a task must be lower than the task memory value, if one is specified.

resources[].details.aws_ecs_task_definition.container_definitions[].memory_reservation

The soft limit (in MiB) of memory to reserve for the container.

resources[].details.aws_ecs_task_definition.container_definitions[].mount_points[]
Show child fields
resources[].details.aws_ecs_task_definition.container_definitions[].mount_points[].container_path

The path on the container to mount the host volume at.

resources[].details.aws_ecs_task_definition.container_definitions[].mount_points[].read_only

Whether the container has read-only access to the volume.

resources[].details.aws_ecs_task_definition.container_definitions[].mount_points[].source_volume

The name of the volume to mount. Must match the name of a volume listed in VolumeDetails for the task definition.

resources[].details.aws_ecs_task_definition.container_definitions[].name

The name of the container.

resources[].details.aws_ecs_task_definition.container_definitions[].port_mappings[]
Show child fields
resources[].details.aws_ecs_task_definition.container_definitions[].port_mappings[].container_port

The port number on the container that is bound to the user-specified or automatically assigned host port.

resources[].details.aws_ecs_task_definition.container_definitions[].port_mappings[].host_port

The port number on the container instance to reserve for the container.

resources[].details.aws_ecs_task_definition.container_definitions[].port_mappings[].protocol

The protocol used for the port mapping. The default is tcp.

resources[].details.aws_ecs_task_definition.container_definitions[].privileged

Whether the container is given elevated privileges on the host container instance. The elevated privileges are similar to the root user.

resources[].details.aws_ecs_task_definition.container_definitions[].pseudo_terminal

Whether to allocate a TTY to the container.

resources[].details.aws_ecs_task_definition.container_definitions[].readonly_root_filesystem

Whether the container is given read-only access to its root file system.

resources[].details.aws_ecs_task_definition.container_definitions[].repository_credentials

The private repository authentication credentials to use.

Show child fields
resources[].details.aws_ecs_task_definition.container_definitions[].repository_credentials.credentials_parameter

The ARN of the secret that contains the private repository credentials.

resources[].details.aws_ecs_task_definition.container_definitions[].resource_requirements[]
Show child fields
resources[].details.aws_ecs_task_definition.container_definitions[].resource_requirements[].type

The type of resource to assign to a container. Valid values are GPU or InferenceAccelerator.

resources[].details.aws_ecs_task_definition.container_definitions[].resource_requirements[].value

The value for the specified resource type.

For GPU, the value is the number of physical GPUs the Amazon ECS container agent reserves for the container.

For InferenceAccelerator, the value should match the DeviceName attribute of an entry in InferenceAccelerators.

resources[].details.aws_ecs_task_definition.container_definitions[].secrets[]
Show child fields
resources[].details.aws_ecs_task_definition.container_definitions[].secrets[].name

The name of the secret.

resources[].details.aws_ecs_task_definition.container_definitions[].secrets[].value_from

The secret to expose to the container. The value is either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the Systems Manager Parameter Store.

resources[].details.aws_ecs_task_definition.container_definitions[].start_timeout

The number of seconds to wait before giving up on resolving dependencies for a container.

resources[].details.aws_ecs_task_definition.container_definitions[].stop_timeout

The number of seconds to wait before the container is stopped if it doesn't shut down normally on its own.

resources[].details.aws_ecs_task_definition.container_definitions[].system_controls[]
Show child fields
resources[].details.aws_ecs_task_definition.container_definitions[].system_controls[].namespace

The namespaced kernel parameter for which to set a value.

resources[].details.aws_ecs_task_definition.container_definitions[].system_controls[].value

The value of the parameter.

resources[].details.aws_ecs_task_definition.container_definitions[].ulimits[]
Show child fields
resources[].details.aws_ecs_task_definition.container_definitions[].ulimits[].hard_limit

The hard limit for the ulimit type.

resources[].details.aws_ecs_task_definition.container_definitions[].ulimits[].name

The type of the ulimit. Valid values are as follows:

  • core

  • cpu

  • data

  • fsize

  • locks

  • memlock

  • msgqueue

  • nice

  • nofile

  • nproc

  • rss

  • rtprio

  • rttime

  • sigpending

  • stack

resources[].details.aws_ecs_task_definition.container_definitions[].ulimits[].soft_limit

The soft limit for the ulimit type.

resources[].details.aws_ecs_task_definition.container_definitions[].user

The user to use inside the container.

The value can use one of the following formats.

  • user

  • user : group

  • uid

  • uid : gid

  • user : gid

  • uid : group

resources[].details.aws_ecs_task_definition.container_definitions[].volumes_from[]
Show child fields
resources[].details.aws_ecs_task_definition.container_definitions[].volumes_from[].read_only

Whether the container has read-only access to the volume.

resources[].details.aws_ecs_task_definition.container_definitions[].volumes_from[].source_container

The name of another container within the same task definition from which to mount volumes.

resources[].details.aws_ecs_task_definition.container_definitions[].working_directory

The working directory in which to run commands inside the container.

resources[].details.aws_ecs_task_definition.cpu

The number of CPU units used by the task.Valid values are as follows:

  • 256 (.25 vCPU)

  • 512 (.5 vCPU)

  • 1024 (1 vCPU)

  • 2048 (2 vCPU)

  • 4096 (4 vCPU)

resources[].details.aws_ecs_task_definition.execution_role_arn

The ARN of the task execution role that grants the container agent permission to make API calls on behalf of the container user.

resources[].details.aws_ecs_task_definition.family

The name of a family that this task definition is registered to.

resources[].details.aws_ecs_task_definition.inference_accelerators[]
Show child fields
resources[].details.aws_ecs_task_definition.inference_accelerators[].device_name

The Elastic Inference accelerator device name.

resources[].details.aws_ecs_task_definition.inference_accelerators[].device_type

The Elastic Inference accelerator type to use.

resources[].details.aws_ecs_task_definition.ipc_mode

The inter-process communication (IPC) resource namespace to use for the containers in the task. Valid values are as follows:

  • host

  • none

  • task

resources[].details.aws_ecs_task_definition.memory

The amount (in MiB) of memory used by the task.

For tasks that are hosted on Amazon EC2, you can provide a task-level memory value or a container-level memory value. For tasks that are hosted on Fargate, you must use one of the specified values in the Amazon Elastic Container Service Developer Guide , which determines your range of supported values for the Cpu and Memory parameters.

resources[].details.aws_ecs_task_definition.network_mode

The Docker networking mode to use for the containers in the task. Valid values are as follows:

  • awsvpc

  • bridge

  • host

  • none

resources[].details.aws_ecs_task_definition.pid_mode

The process namespace to use for the containers in the task. Valid values are host or task.

resources[].details.aws_ecs_task_definition.placement_constraints[]
Show child fields
resources[].details.aws_ecs_task_definition.placement_constraints[].expression

A cluster query language expression to apply to the constraint.

resources[].details.aws_ecs_task_definition.placement_constraints[].type

The type of constraint.

resources[].details.aws_ecs_task_definition.proxy_configuration

The configuration details for the App Mesh proxy.

Show child fields
resources[].details.aws_ecs_task_definition.proxy_configuration.container_name

The name of the container that will serve as the App Mesh proxy.

resources[].details.aws_ecs_task_definition.proxy_configuration.proxy_configuration_properties[]
Show child fields
resources[].details.aws_ecs_task_definition.proxy_configuration.proxy_configuration_properties[].name

The name of the property.

resources[].details.aws_ecs_task_definition.proxy_configuration.proxy_configuration_properties[].value

The value of the property.

resources[].details.aws_ecs_task_definition.proxy_configuration.type

The proxy type.

resources[].details.aws_ecs_task_definition.requires_compatibilities[]
resources[].details.aws_ecs_task_definition.status

The status of the task definition.

resources[].details.aws_ecs_task_definition.task_role_arn

The short name or ARN of the IAM role that grants containers in the task permission to call Amazon Web Services API operations on your behalf.

resources[].details.aws_ecs_task_definition.volumes[]
Show child fields
resources[].details.aws_ecs_task_definition.volumes[].docker_volume_configuration

Information about a Docker volume.

Show child fields
resources[].details.aws_ecs_task_definition.volumes[].docker_volume_configuration.autoprovision

Whether to create the Docker volume automatically if it does not already exist.

resources[].details.aws_ecs_task_definition.volumes[].docker_volume_configuration.driver

The Docker volume driver to use.

resources[].details.aws_ecs_task_definition.volumes[].docker_volume_configuration.driver_opts

A map of Docker driver-specific options that are passed through.

resources[].details.aws_ecs_task_definition.volumes[].docker_volume_configuration.labels

Custom metadata to add to the Docker volume.

resources[].details.aws_ecs_task_definition.volumes[].docker_volume_configuration.scope

The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a task are provisioned automatically when the task starts and destroyed when the task stops. Docker volumes that are shared persist after the task stops. Valid values are shared or task.

resources[].details.aws_ecs_task_definition.volumes[].efs_volume_configuration

Information about the Amazon Elastic File System file system that is used for task storage.

Show child fields
resources[].details.aws_ecs_task_definition.volumes[].efs_volume_configuration.authorization_config

The authorization configuration details for the Amazon EFS file system.

Show child fields
resources[].details.aws_ecs_task_definition.volumes[].efs_volume_configuration.authorization_config.access_point_id

The Amazon EFS access point identifier to use.

resources[].details.aws_ecs_task_definition.volumes[].efs_volume_configuration.authorization_config.iam

Whether to use the Amazon ECS task IAM role defined in a task definition when mounting the Amazon EFS file system.

resources[].details.aws_ecs_task_definition.volumes[].efs_volume_configuration.filesystem_id

The Amazon EFS file system identifier to use.

resources[].details.aws_ecs_task_definition.volumes[].efs_volume_configuration.root_directory

The directory within the Amazon EFS file system to mount as the root directory inside the host.

resources[].details.aws_ecs_task_definition.volumes[].efs_volume_configuration.transit_encryption

Whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server.

resources[].details.aws_ecs_task_definition.volumes[].efs_volume_configuration.transit_encryption_port

The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server.

resources[].details.aws_ecs_task_definition.volumes[].host

Information about a bind mount host volume.

Show child fields
resources[].details.aws_ecs_task_definition.volumes[].host.source_path

The path on the host container instance that is presented to the container.

resources[].details.aws_ecs_task_definition.volumes[].name

The name of the data volume.

resources[].details.aws_efs_access_point

Details about an Amazon EFS access point. An access point is an application-specific view into an EFS file system that applies an operating system user and group, and a file system path, to any file system request made through the access point.

Show child fields
resources[].details.aws_efs_access_point.access_point_id

The ID of the Amazon EFS access point.

resources[].details.aws_efs_access_point.arn

The Amazon Resource Name (ARN) of the Amazon EFS access point.

resources[].details.aws_efs_access_point.client_token

The opaque string specified in the request to ensure idempotent creation.

resources[].details.aws_efs_access_point.file_system_id

The ID of the Amazon EFS file system that the access point applies to.

resources[].details.aws_efs_access_point.posix_user

The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point, that is used for all file operations by NFS clients using the access point.

Show child fields
resources[].details.aws_efs_access_point.posix_user.gid

The POSIX group ID used for all file system operations using this access point.

resources[].details.aws_efs_access_point.posix_user.secondary_gids[]
resources[].details.aws_efs_access_point.posix_user.uid

The POSIX user ID used for all file system operations using this access point.

resources[].details.aws_efs_access_point.root_directory

The directory on the Amazon EFS file system that the access point exposes as the root directory to NFS clients using the access point.

Show child fields
resources[].details.aws_efs_access_point.root_directory.creation_info

Specifies the POSIX IDs and permissions to apply to the access point's root directory.

Show child fields
resources[].details.aws_efs_access_point.root_directory.creation_info.owner_gid

Specifies the POSIX group ID to apply to the root directory.

resources[].details.aws_efs_access_point.root_directory.creation_info.owner_uid

Specifies the POSIX user ID to apply to the root directory.

resources[].details.aws_efs_access_point.root_directory.creation_info.permissions

Specifies the POSIX permissions to apply to the root directory, in the format of an octal number representing the file's mode bits.

resources[].details.aws_efs_access_point.root_directory.path

Specifies the path on the Amazon EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist, you are required to provide CreationInfo.

resources[].details.aws_eks_cluster

Details about an Amazon EKS cluster.

Show child fields
resources[].details.aws_eks_cluster.arn

The ARN of the cluster.

resources[].details.aws_eks_cluster.certificate_authority_data

The certificate authority data for the cluster.

resources[].details.aws_eks_cluster.cluster_status

The status of the cluster. Valid values are as follows:

  • ACTIVE

  • CREATING

  • DELETING

  • FAILED

  • PENDING

  • UPDATING

resources[].details.aws_eks_cluster.endpoint

The endpoint for the Amazon EKS API server.

resources[].details.aws_eks_cluster.logging

The logging configuration for the cluster.

Show child fields
resources[].details.aws_eks_cluster.logging.cluster_logging[]
Show child fields
resources[].details.aws_eks_cluster.logging.cluster_logging[].enabled

Whether the logging types that are listed in Types are enabled.

resources[].details.aws_eks_cluster.logging.cluster_logging[].types[]
resources[].details.aws_eks_cluster.name

The name of the cluster.

resources[].details.aws_eks_cluster.resources_vpc_config

The VPC configuration used by the cluster control plane.

Show child fields
resources[].details.aws_eks_cluster.resources_vpc_config.endpoint_public_access

Indicates whether the Amazon EKS public API server endpoint is turned on. If the Amazon EKS public API server endpoint is turned off, your cluster's Kubernetes API server can only receive requests that originate from within the cluster VPC.

resources[].details.aws_eks_cluster.resources_vpc_config.security_group_ids[]
resources[].details.aws_eks_cluster.resources_vpc_config.subnet_ids[]
resources[].details.aws_eks_cluster.role_arn

The ARN of the IAM role that provides permissions for the Amazon EKS control plane to make calls to Amazon Web Services API operations on your behalf.

resources[].details.aws_eks_cluster.version

The Amazon EKS server version for the cluster.

resources[].details.aws_elastic_beanstalk_environment

Details about an Elastic Beanstalk environment.

Show child fields
resources[].details.aws_elastic_beanstalk_environment.application_name

The name of the application that is associated with the environment.

resources[].details.aws_elastic_beanstalk_environment.cname

The URL to the CNAME for this environment.

resources[].details.aws_elastic_beanstalk_environment.date_created

The creation date for this environment.

resources[].details.aws_elastic_beanstalk_environment.date_updated

The date when this environment was last modified.

resources[].details.aws_elastic_beanstalk_environment.description

A description of the environment.

resources[].details.aws_elastic_beanstalk_environment.endpoint_url

For load-balanced, autoscaling environments, the URL to the load balancer. For single-instance environments, the IP address of the instance.

resources[].details.aws_elastic_beanstalk_environment.environment_arn

The ARN of the environment.

resources[].details.aws_elastic_beanstalk_environment.environment_id

The identifier of the environment.

resources[].details.aws_elastic_beanstalk_environment.environment_links[]
Show child fields
resources[].details.aws_elastic_beanstalk_environment.environment_links[].environment_name

The name of the linked environment.

resources[].details.aws_elastic_beanstalk_environment.environment_links[].link_name

The name of the environment link.

resources[].details.aws_elastic_beanstalk_environment.environment_name

The name of the environment.

resources[].details.aws_elastic_beanstalk_environment.option_settings[]
Show child fields
resources[].details.aws_elastic_beanstalk_environment.option_settings[].namespace

The type of resource that the configuration option is associated with.

resources[].details.aws_elastic_beanstalk_environment.option_settings[].option_name

The name of the option.

resources[].details.aws_elastic_beanstalk_environment.option_settings[].resource_name

The name of the resource.

resources[].details.aws_elastic_beanstalk_environment.option_settings[].value

The value of the configuration setting.

resources[].details.aws_elastic_beanstalk_environment.platform_arn

The ARN of the platform version for the environment.

resources[].details.aws_elastic_beanstalk_environment.solution_stack_name

The name of the solution stack that is deployed with the environment.

resources[].details.aws_elastic_beanstalk_environment.status

The current operational status of the environment. Valid values are as follows:

  • Aborting

  • Launching

  • LinkingFrom

  • LinkingTo

  • Ready

  • Terminated

  • Terminating

  • Updating

resources[].details.aws_elastic_beanstalk_environment.tier

The tier of the environment.

Show child fields
resources[].details.aws_elastic_beanstalk_environment.tier.name

The name of the environment tier. Valid values are WebServer or Worker.

resources[].details.aws_elastic_beanstalk_environment.tier.type

The type of environment tier. Valid values are Standard or SQS/HTTP.

resources[].details.aws_elastic_beanstalk_environment.tier.version

The version of the environment tier.

resources[].details.aws_elastic_beanstalk_environment.version_label

The application version of the environment.

resources[].details.aws_elasticsearch_domain

Details for an Elasticsearch domain.

Show child fields
resources[].details.aws_elasticsearch_domain.access_policies

IAM policy document specifying the access policies for the new Elasticsearch domain.

resources[].details.aws_elasticsearch_domain.domain_endpoint_options

Additional options for the domain endpoint.

Show child fields
resources[].details.aws_elasticsearch_domain.domain_endpoint_options.enforce_https

Whether to require that all traffic to the domain arrive over HTTPS.

resources[].details.aws_elasticsearch_domain.domain_endpoint_options.tls_security_policy

The TLS security policy to apply to the HTTPS endpoint of the OpenSearch domain.

Valid values:

  • Policy-Min-TLS-1-0-2019-07, which supports TLSv1.0 and higher

  • Policy-Min-TLS-1-2-2019-07, which only supports TLSv1.2

resources[].details.aws_elasticsearch_domain.domain_id

Unique identifier for an Elasticsearch domain.

resources[].details.aws_elasticsearch_domain.domain_name

Name of an Elasticsearch domain.

Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.

Domain names must start with a lowercase letter and must be between 3 and 28 characters.

Valid characters are a-z (lowercase only), 0-9, and – (hyphen).

resources[].details.aws_elasticsearch_domain.elasticsearch_cluster_config

Information about an OpenSearch cluster configuration.

Show child fields
resources[].details.aws_elasticsearch_domain.elasticsearch_cluster_config.dedicated_master_count

The number of instances to use for the master node. If this attribute is specified, then DedicatedMasterEnabled must be true.

resources[].details.aws_elasticsearch_domain.elasticsearch_cluster_config.dedicated_master_enabled

Whether to use a dedicated master node for the Elasticsearch domain. A dedicated master node performs cluster management tasks, but doesn't hold data or respond to data upload requests.

resources[].details.aws_elasticsearch_domain.elasticsearch_cluster_config.dedicated_master_type

The hardware configuration of the computer that hosts the dedicated master node. A sample value is m3.medium.elasticsearch. If this attribute is specified, then DedicatedMasterEnabled must be true.

For a list of valid values, see Supported instance types in Amazon OpenSearch Service in the Amazon OpenSearch Service Developer Guide.

resources[].details.aws_elasticsearch_domain.elasticsearch_cluster_config.instance_count

The number of data nodes to use in the Elasticsearch domain.

resources[].details.aws_elasticsearch_domain.elasticsearch_cluster_config.instance_type

The instance type for your data nodes. For example, m3.medium.elasticsearch.

For a list of valid values, see Supported instance types in Amazon OpenSearch Service in the Amazon OpenSearch Service Developer Guide.

resources[].details.aws_elasticsearch_domain.elasticsearch_cluster_config.zone_awareness_config

Configuration options for zone awareness. Provided if ZoneAwarenessEnabled is true.

Show child fields
resources[].details.aws_elasticsearch_domain.elasticsearch_cluster_config.zone_awareness_config.availability_zone_count

he number of Availability Zones that the domain uses. Valid values are 2 and 3. The default is 2.

resources[].details.aws_elasticsearch_domain.elasticsearch_cluster_config.zone_awareness_enabled

Whether to enable zone awareness for the Elasticsearch domain. When zone awareness is enabled, OpenSearch allocates the cluster's nodes and replica index shards across Availability Zones in the same Region. This prevents data loss and minimizes downtime if a node or data center fails.

resources[].details.aws_elasticsearch_domain.elasticsearch_version

OpenSearch version.

resources[].details.aws_elasticsearch_domain.encryption_at_rest_options

Details about the configuration for encryption at rest.

Show child fields
resources[].details.aws_elasticsearch_domain.encryption_at_rest_options.enabled

Whether encryption at rest is enabled.

resources[].details.aws_elasticsearch_domain.encryption_at_rest_options.kms_key_id

The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.

resources[].details.aws_elasticsearch_domain.endpoint

Domain-specific endpoint used to submit index, search, and data upload requests to an Elasticsearch domain.

The endpoint is a service URL.

resources[].details.aws_elasticsearch_domain.endpoints

The key-value pair that exists if the Elasticsearch domain uses VPC endpoints.

resources[].details.aws_elasticsearch_domain.log_publishing_options

Configures the CloudWatch Logs to publish for the Elasticsearch domain.

Show child fields
resources[].details.aws_elasticsearch_domain.log_publishing_options.audit_logs

The log configuration.

Show child fields
resources[].details.aws_elasticsearch_domain.log_publishing_options.audit_logs.cloud_watch_logs_log_group_arn

The ARN of the CloudWatch Logs group to publish the logs to.

resources[].details.aws_elasticsearch_domain.log_publishing_options.audit_logs.enabled

Whether the log publishing is enabled.

resources[].details.aws_elasticsearch_domain.log_publishing_options.index_slow_logs

Configures the OpenSearch index logs publishing.

Show child fields
resources[].details.aws_elasticsearch_domain.log_publishing_options.index_slow_logs.cloud_watch_logs_log_group_arn

The ARN of the CloudWatch Logs group to publish the logs to.

resources[].details.aws_elasticsearch_domain.log_publishing_options.index_slow_logs.enabled

Whether the log publishing is enabled.

resources[].details.aws_elasticsearch_domain.log_publishing_options.search_slow_logs

Configures the OpenSearch search slow log publishing.

Show child fields
resources[].details.aws_elasticsearch_domain.log_publishing_options.search_slow_logs.cloud_watch_logs_log_group_arn

The ARN of the CloudWatch Logs group to publish the logs to.

resources[].details.aws_elasticsearch_domain.log_publishing_options.search_slow_logs.enabled

Whether the log publishing is enabled.

resources[].details.aws_elasticsearch_domain.node_to_node_encryption_options

Details about the configuration for node-to-node encryption.

Show child fields
resources[].details.aws_elasticsearch_domain.node_to_node_encryption_options.enabled

Whether node-to-node encryption is enabled.

resources[].details.aws_elasticsearch_domain.service_software_options

Information about the status of a domain relative to the latest service software.

Show child fields
resources[].details.aws_elasticsearch_domain.service_software_options.automated_update_date

The epoch time when the deployment window closes for required updates. After this time, Amazon OpenSearch Service schedules the software upgrade automatically.

resources[].details.aws_elasticsearch_domain.service_software_options.cancellable

Whether a request to update the domain can be canceled.

resources[].details.aws_elasticsearch_domain.service_software_options.current_version

The version of the service software that is currently installed on the domain.

resources[].details.aws_elasticsearch_domain.service_software_options.description

A more detailed description of the service software status.

resources[].details.aws_elasticsearch_domain.service_software_options.new_version

The most recent version of the service software.

resources[].details.aws_elasticsearch_domain.service_software_options.update_available

Whether a service software update is available for the domain.

resources[].details.aws_elasticsearch_domain.service_software_options.update_status

The status of the service software update. Valid values are as follows:

  • COMPLETED

  • ELIGIBLE

  • IN_PROGRESS

  • NOT_ELIGIBLE

  • PENDING_UPDATE

resources[].details.aws_elasticsearch_domain.vpc_options

Information that OpenSearch derives based on VPCOptions for the domain.

Show child fields
resources[].details.aws_elasticsearch_domain.vpc_options.availability_zones[]
resources[].details.aws_elasticsearch_domain.vpc_options.security_group_ids[]
resources[].details.aws_elasticsearch_domain.vpc_options.subnet_ids[]
resources[].details.aws_elasticsearch_domain.vpc_options.vpc_id

ID for the VPC.

resources[].details.aws_elb_load_balancer

Contains details about a Classic Load Balancer.

Show child fields
resources[].details.aws_elb_load_balancer.availability_zones[]
resources[].details.aws_elb_load_balancer.backend_server_descriptions[]
Show child fields
resources[].details.aws_elb_load_balancer.backend_server_descriptions[].instance_port

The port on which the EC2 instance is listening.

resources[].details.aws_elb_load_balancer.backend_server_descriptions[].policy_names[]
resources[].details.aws_elb_load_balancer.canonical_hosted_zone_name

The name of the Amazon Route 53 hosted zone for the load balancer.

resources[].details.aws_elb_load_balancer.canonical_hosted_zone_name_id

The ID of the Amazon Route 53 hosted zone for the load balancer.

resources[].details.aws_elb_load_balancer.created_time

Indicates when the load balancer was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_elb_load_balancer.dns_name

The DNS name of the load balancer.

resources[].details.aws_elb_load_balancer.health_check

Information about the health checks that are conducted on the load balancer.

Show child fields
resources[].details.aws_elb_load_balancer.health_check.healthy_threshold

The number of consecutive health check successes required before the instance is moved to the Healthy state.

resources[].details.aws_elb_load_balancer.health_check.interval

The approximate interval, in seconds, between health checks of an individual instance.

resources[].details.aws_elb_load_balancer.health_check.target

The instance that is being checked. The target specifies the protocol and port. The available protocols are TCP, SSL, HTTP, and HTTPS. The range of valid ports is 1 through 65535.

For the HTTP and HTTPS protocols, the target also specifies the ping path.

For the TCP protocol, the target is specified as TCP: <port> .

For the SSL protocol, the target is specified as SSL.<port> .

For the HTTP and HTTPS protocols, the target is specified as <protocol>:<port>/<path to ping> .

resources[].details.aws_elb_load_balancer.health_check.timeout

The amount of time, in seconds, during which no response means a failed health check.

resources[].details.aws_elb_load_balancer.health_check.unhealthy_threshold

The number of consecutive health check failures that must occur before the instance is moved to the Unhealthy state.

resources[].details.aws_elb_load_balancer.instances[]
Show child fields
resources[].details.aws_elb_load_balancer.instances[].instance_id

The instance identifier.

resources[].details.aws_elb_load_balancer.listener_descriptions[]
Show child fields
resources[].details.aws_elb_load_balancer.listener_descriptions[].listener

Information about the listener.

Show child fields
resources[].details.aws_elb_load_balancer.listener_descriptions[].listener.instance_port

The port on which the instance is listening.

resources[].details.aws_elb_load_balancer.listener_descriptions[].listener.instance_protocol

The protocol to use to route traffic to instances.

Valid values: HTTP | HTTPS | TCP | SSL

resources[].details.aws_elb_load_balancer.listener_descriptions[].listener.load_balancer_port

The port on which the load balancer is listening.

On EC2-VPC, you can specify any port from the range 1-65535.

On EC2-Classic, you can specify any port from the following list: 25, 80, 443, 465, 587, 1024-65535.

resources[].details.aws_elb_load_balancer.listener_descriptions[].listener.protocol

The load balancer transport protocol to use for routing.

Valid values: HTTP | HTTPS | TCP | SSL

resources[].details.aws_elb_load_balancer.listener_descriptions[].listener.ssl_certificate_id

The ARN of the server certificate.

resources[].details.aws_elb_load_balancer.listener_descriptions[].policy_names[]
resources[].details.aws_elb_load_balancer.load_balancer_attributes

The attributes for a load balancer.

Show child fields
resources[].details.aws_elb_load_balancer.load_balancer_attributes.access_log

Information about the access log configuration for the load balancer.

If the access log is enabled, the load balancer captures detailed information about all requests. It delivers the information to a specified S3 bucket.

Show child fields
resources[].details.aws_elb_load_balancer.load_balancer_attributes.access_log.emit_interval

The interval in minutes for publishing the access logs.

You can publish access logs either every 5 minutes or every 60 minutes.

resources[].details.aws_elb_load_balancer.load_balancer_attributes.access_log.enabled

Indicates whether access logs are enabled for the load balancer.

resources[].details.aws_elb_load_balancer.load_balancer_attributes.access_log.s3_bucket_name

The name of the S3 bucket where the access logs are stored.

resources[].details.aws_elb_load_balancer.load_balancer_attributes.access_log.s3_bucket_prefix

The logical hierarchy that was created for the S3 bucket.

If a prefix is not provided, the log is placed at the root level of the bucket.

resources[].details.aws_elb_load_balancer.load_balancer_attributes.additional_attributes[]
Show child fields
resources[].details.aws_elb_load_balancer.load_balancer_attributes.additional_attributes[].key

The name of the attribute.

resources[].details.aws_elb_load_balancer.load_balancer_attributes.additional_attributes[].value

The value of the attribute.

resources[].details.aws_elb_load_balancer.load_balancer_attributes.connection_draining

Information about the connection draining configuration for the load balancer.

If connection draining is enabled, the load balancer allows existing requests to complete before it shifts traffic away from a deregistered or unhealthy instance.

Show child fields
resources[].details.aws_elb_load_balancer.load_balancer_attributes.connection_draining.enabled

Indicates whether connection draining is enabled for the load balancer.

resources[].details.aws_elb_load_balancer.load_balancer_attributes.connection_draining.timeout

The maximum time, in seconds, to keep the existing connections open before deregistering the instances.

resources[].details.aws_elb_load_balancer.load_balancer_attributes.connection_settings

Connection settings for the load balancer.

If an idle timeout is configured, the load balancer allows connections to remain idle for the specified duration. When a connection is idle, no data is sent over the connection.

Show child fields
resources[].details.aws_elb_load_balancer.load_balancer_attributes.connection_settings.idle_timeout

The time, in seconds, that the connection can be idle (no data is sent over the connection) before it is closed by the load balancer.

resources[].details.aws_elb_load_balancer.load_balancer_attributes.cross_zone_load_balancing

Cross-zone load balancing settings for the load balancer.

If cross-zone load balancing is enabled, the load balancer routes the request traffic evenly across all instances regardless of the Availability Zones.

Show child fields
resources[].details.aws_elb_load_balancer.load_balancer_attributes.cross_zone_load_balancing.enabled

Indicates whether cross-zone load balancing is enabled for the load balancer.

resources[].details.aws_elb_load_balancer.load_balancer_name

The name of the load balancer.

resources[].details.aws_elb_load_balancer.policies

The policies for a load balancer.

Show child fields
resources[].details.aws_elb_load_balancer.policies.app_cookie_stickiness_policies[]
Show child fields
resources[].details.aws_elb_load_balancer.policies.app_cookie_stickiness_policies[].cookie_name

The name of the application cookie used for stickiness.

resources[].details.aws_elb_load_balancer.policies.app_cookie_stickiness_policies[].policy_name

The mnemonic name for the policy being created. The name must be unique within the set of policies for the load balancer.

resources[].details.aws_elb_load_balancer.policies.lb_cookie_stickiness_policies[]
Show child fields
resources[].details.aws_elb_load_balancer.policies.lb_cookie_stickiness_policies[].cookie_expiration_period

The amount of time, in seconds, after which the cookie is considered stale. If an expiration period is not specified, the stickiness session lasts for the duration of the browser session.

resources[].details.aws_elb_load_balancer.policies.lb_cookie_stickiness_policies[].policy_name

The name of the policy. The name must be unique within the set of policies for the load balancer.

resources[].details.aws_elb_load_balancer.policies.other_policies[]
resources[].details.aws_elb_load_balancer.scheme

The type of load balancer. Only provided if the load balancer is in a VPC.

If Scheme is internet-facing, the load balancer has a public DNS name that resolves to a public IP address.

If Scheme is internal, the load balancer has a public DNS name that resolves to a private IP address.

resources[].details.aws_elb_load_balancer.security_groups[]
resources[].details.aws_elb_load_balancer.source_security_group

Information about the security group for the load balancer. This is the security group that is used for inbound rules.

Show child fields
resources[].details.aws_elb_load_balancer.source_security_group.group_name

The name of the security group.

resources[].details.aws_elb_load_balancer.source_security_group.owner_alias

The owner of the security group.

resources[].details.aws_elb_load_balancer.subnets[]
resources[].details.aws_elb_load_balancer.vpc_id

The identifier of the VPC for the load balancer.

resources[].details.aws_elbv2_load_balancer

Details about a load balancer.

Show child fields
resources[].details.aws_elbv2_load_balancer.availability_zones[]
Show child fields
resources[].details.aws_elbv2_load_balancer.availability_zones[].subnet_id

The ID of the subnet. You can specify one subnet per Availability Zone.

resources[].details.aws_elbv2_load_balancer.availability_zones[].zone_name

The name of the Availability Zone.

resources[].details.aws_elbv2_load_balancer.canonical_hosted_zone_id

The ID of the Amazon Route 53 hosted zone associated with the load balancer.

resources[].details.aws_elbv2_load_balancer.created_time

Indicates when the load balancer was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_elbv2_load_balancer.dns_name

The public DNS name of the load balancer.

resources[].details.aws_elbv2_load_balancer.ip_address_type

The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).

resources[].details.aws_elbv2_load_balancer.load_balancer_attributes[]
Show child fields
resources[].details.aws_elbv2_load_balancer.load_balancer_attributes[].key

The name of the load balancer attribute.

resources[].details.aws_elbv2_load_balancer.load_balancer_attributes[].value

The value of the load balancer attribute.

resources[].details.aws_elbv2_load_balancer.scheme

The nodes of an Internet-facing load balancer have public IP addresses.

resources[].details.aws_elbv2_load_balancer.security_groups[]
resources[].details.aws_elbv2_load_balancer.state

The state of the load balancer.

Show child fields
resources[].details.aws_elbv2_load_balancer.state.code

The state code. The initial state of the load balancer is provisioning.

After the load balancer is fully set up and ready to route traffic, its state is active.

If the load balancer could not be set up, its state is failed.

resources[].details.aws_elbv2_load_balancer.state.reason

A description of the state.

resources[].details.aws_elbv2_load_balancer.type

The type of load balancer.

resources[].details.aws_elbv2_load_balancer.vpc_id

The ID of the VPC for the load balancer.

resources[].details.aws_event_schemas_registry

A schema defines the structure of events that are sent to Amazon EventBridge. Schema registries are containers for schemas. They collect and organize schemas so that your schemas are in logical groups.

Show child fields
resources[].details.aws_event_schemas_registry.description

A description of the registry to be created.

resources[].details.aws_event_schemas_registry.registry_arn

The Amazon Resource Name (ARN) of the registry.

resources[].details.aws_event_schemas_registry.registry_name

The name of the schema registry.

resources[].details.aws_events_endpoint

Provides details about an Amazon EventBridge global endpoint. The endpoint can improve your application’s availability by making it Regional-fault tolerant.

Show child fields
resources[].details.aws_events_endpoint.arn

The Amazon Resource Name (ARN) of the endpoint.

resources[].details.aws_events_endpoint.description

A description of the endpoint.

resources[].details.aws_events_endpoint.endpoint_id

The URL subdomain of the endpoint. For example, if EndpointUrl is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo.

resources[].details.aws_events_endpoint.endpoint_url

The URL of the endpoint.

resources[].details.aws_events_endpoint.event_buses[]
Show child fields
resources[].details.aws_events_endpoint.event_buses[].event_bus_arn

The Amazon Resource Name (ARN) of the event bus that the endpoint is associated with.

resources[].details.aws_events_endpoint.name

The name of the endpoint.

resources[].details.aws_events_endpoint.replication_config

Whether event replication was enabled or disabled for this endpoint. The default state is ENABLED, which means you must supply a RoleArn. If you don't have a RoleArn or you don't want event replication enabled, set the state to DISABLED.

Show child fields
resources[].details.aws_events_endpoint.replication_config.state

The state of event replication.

resources[].details.aws_events_endpoint.role_arn

The ARN of the role used by event replication for the endpoint.

resources[].details.aws_events_endpoint.routing_config

The routing configuration of the endpoint.

Show child fields
resources[].details.aws_events_endpoint.routing_config.failover_config

The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.

Show child fields
resources[].details.aws_events_endpoint.routing_config.failover_config.primary

The main Region of the endpoint.

Show child fields
resources[].details.aws_events_endpoint.routing_config.failover_config.primary.health_check

The Amazon Resource Name (ARN) of the health check used by the endpoint to determine whether failover is triggered.

resources[].details.aws_events_endpoint.routing_config.failover_config.secondary

The Region that events are routed to when failover is triggered or event replication is enabled.

Show child fields
resources[].details.aws_events_endpoint.routing_config.failover_config.secondary.route

Defines the secondary Region.

resources[].details.aws_events_endpoint.state

The current state of the endpoint.

resources[].details.aws_events_endpoint.state_reason

The reason the endpoint is in its current state.

resources[].details.aws_events_eventbus

Provides details about Amazon EventBridge event bus for an endpoint. An event bus is a router that receives events and delivers them to zero or more destinations, or targets.

Show child fields
resources[].details.aws_events_eventbus.arn

The Amazon Resource Name (ARN) of the account permitted to write events to the current account.

resources[].details.aws_events_eventbus.name

The name of the event bus.

resources[].details.aws_events_eventbus.policy

The policy that enables the external account to send events to your account.

resources[].details.aws_guard_duty_detector

Provides details about an Amazon GuardDuty detector. A detector is an object that represents the GuardDuty service. A detector is required for GuardDuty to become operational.

Show child fields
resources[].details.aws_guard_duty_detector.data_sources

Describes which data sources are activated for the detector.

Show child fields
resources[].details.aws_guard_duty_detector.data_sources.cloud_trail

An object that contains information on the status of CloudTrail as a data source for the detector.

Show child fields
resources[].details.aws_guard_duty_detector.data_sources.cloud_trail.status

Specifies whether CloudTrail is activated as a data source for the detector.

resources[].details.aws_guard_duty_detector.data_sources.dns_logs

An object that contains information on the status of DNS logs as a data source for the detector.

Show child fields
resources[].details.aws_guard_duty_detector.data_sources.dns_logs.status

Describes whether DNS logs is enabled as a data source for the detector.

resources[].details.aws_guard_duty_detector.data_sources.flow_logs

An object that contains information on the status of VPC Flow Logs as a data source for the detector.

Show child fields
resources[].details.aws_guard_duty_detector.data_sources.flow_logs.status

Describes whether VPC Flow Logs are activated as a data source for the detector.

resources[].details.aws_guard_duty_detector.data_sources.kubernetes

An object that contains information on the status of Kubernetes data sources for the detector.

Show child fields
resources[].details.aws_guard_duty_detector.data_sources.kubernetes.audit_logs

Describes whether Kubernetes audit logs are activated as a data source for the detector.

Show child fields
resources[].details.aws_guard_duty_detector.data_sources.kubernetes.audit_logs.status

Describes whether Kubernetes audit logs are activated as a data source for the detector.

resources[].details.aws_guard_duty_detector.data_sources.malware_protection

An object that contains information on the status of Malware Protection as a data source for the detector.

Show child fields
resources[].details.aws_guard_duty_detector.data_sources.malware_protection.scan_ec2_instance_with_findings

Describes the configuration of Malware Protection for EC2 instances with findings.

Show child fields
resources[].details.aws_guard_duty_detector.data_sources.malware_protection.scan_ec2_instance_with_findings.ebs_volumes

Describes the configuration of scanning EBS volumes (Malware Protection) as a data source.

Show child fields
resources[].details.aws_guard_duty_detector.data_sources.malware_protection.scan_ec2_instance_with_findings.ebs_volumes.reason

Specifies the reason why scanning EBS volumes (Malware Protection) isn’t activated as a data source.

resources[].details.aws_guard_duty_detector.data_sources.malware_protection.scan_ec2_instance_with_findings.ebs_volumes.status

Describes whether scanning EBS volumes is activated as a data source for the detector.

resources[].details.aws_guard_duty_detector.data_sources.malware_protection.service_role

The GuardDuty Malware Protection service role.

resources[].details.aws_guard_duty_detector.data_sources.s3_logs

An object that contains information on the status of S3 Data event logs as a data source for the detector.

Show child fields
resources[].details.aws_guard_duty_detector.data_sources.s3_logs.status

A value that describes whether S3 data event logs are automatically enabled for new members of an organization.

resources[].details.aws_guard_duty_detector.features[]
Show child fields
resources[].details.aws_guard_duty_detector.features[].name

Indicates the name of the feature that is activated for the detector.

resources[].details.aws_guard_duty_detector.features[].status

Indicates the status of the feature that is activated for the detector.

resources[].details.aws_guard_duty_detector.finding_publishing_frequency

The publishing frequency of the finding.

resources[].details.aws_guard_duty_detector.service_role

The GuardDuty service role.

resources[].details.aws_guard_duty_detector.status

The activation status of the detector.

resources[].details.aws_iam_access_key

Details about an IAM access key related to a finding.

Show child fields
resources[].details.aws_iam_access_key.access_key_id

The identifier of the access key.

resources[].details.aws_iam_access_key.account_id

The Amazon Web Services account ID of the account for the key.

resources[].details.aws_iam_access_key.created_at

Indicates when the IAM access key was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_iam_access_key.principal_id

The ID of the principal associated with an access key.

resources[].details.aws_iam_access_key.principal_name

The name of the principal.

resources[].details.aws_iam_access_key.principal_type

The type of principal associated with an access key.

resources[].details.aws_iam_access_key.session_context

Information about the session that the key was used for.

Show child fields
resources[].details.aws_iam_access_key.session_context.attributes

Attributes of the session that the key was used for.

Show child fields
resources[].details.aws_iam_access_key.session_context.attributes.creation_date

Indicates when the session was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_iam_access_key.session_context.attributes.mfa_authenticated

Indicates whether the session used multi-factor authentication (MFA).

resources[].details.aws_iam_access_key.session_context.session_issuer

Information about the entity that created the session.

Show child fields
resources[].details.aws_iam_access_key.session_context.session_issuer.account_id

The identifier of the Amazon Web Services account that created the session.

resources[].details.aws_iam_access_key.session_context.session_issuer.arn

The ARN of the session.

resources[].details.aws_iam_access_key.session_context.session_issuer.principal_id

The principal ID of the principal (user, role, or group) that created the session.

resources[].details.aws_iam_access_key.session_context.session_issuer.type

The type of principal (user, role, or group) that created the session.

resources[].details.aws_iam_access_key.session_context.session_issuer.user_name

The name of the principal that created the session.

resources[].details.aws_iam_access_key.status

The status of the IAM access key related to a finding.

resources[].details.aws_iam_access_key.user_name

The user associated with the IAM access key related to a finding.

The UserName parameter has been replaced with the PrincipalName parameter because access keys can also be assigned to principals that are not IAM users.

resources[].details.aws_iam_group

Contains details about an IAM group.

Show child fields
resources[].details.aws_iam_group.attached_managed_policies[]
Show child fields
resources[].details.aws_iam_group.attached_managed_policies[].policy_arn

The ARN of the policy.

resources[].details.aws_iam_group.attached_managed_policies[].policy_name

The name of the policy.

resources[].details.aws_iam_group.create_date

Indicates when the IAM group was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_iam_group.group_id

The identifier of the IAM group.

resources[].details.aws_iam_group.group_name

The name of the IAM group.

resources[].details.aws_iam_group.group_policy_list[]
Show child fields
resources[].details.aws_iam_group.group_policy_list[].policy_name

The name of the policy.

resources[].details.aws_iam_group.path

The path to the group.

resources[].details.aws_iam_policy

Details about an IAM permissions policy.

Show child fields
resources[].details.aws_iam_policy.attachment_count

The number of users, groups, and roles that the policy is attached to.

resources[].details.aws_iam_policy.create_date

When the policy was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_iam_policy.default_version_id

The identifier of the default version of the policy.

resources[].details.aws_iam_policy.description

A description of the policy.

resources[].details.aws_iam_policy.is_attachable

Whether the policy can be attached to a user, group, or role.

resources[].details.aws_iam_policy.path

The path to the policy.

resources[].details.aws_iam_policy.permissions_boundary_usage_count

The number of users and roles that use the policy to set the permissions boundary.

resources[].details.aws_iam_policy.policy_id

The unique identifier of the policy.

resources[].details.aws_iam_policy.policy_name

The name of the policy.

resources[].details.aws_iam_policy.policy_version_list[]
Show child fields
resources[].details.aws_iam_policy.policy_version_list[].create_date

Indicates when the version was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_iam_policy.policy_version_list[].is_default_version

Whether the version is the default version.

resources[].details.aws_iam_policy.policy_version_list[].version_id

The identifier of the policy version.

resources[].details.aws_iam_policy.update_date

When the policy was most recently updated.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_iam_role

Details about an IAM role.

Show child fields
resources[].details.aws_iam_role.assume_role_policy_document

The trust policy that grants permission to assume the role.

resources[].details.aws_iam_role.attached_managed_policies[]
Show child fields
resources[].details.aws_iam_role.attached_managed_policies[].policy_arn

The ARN of the policy.

resources[].details.aws_iam_role.attached_managed_policies[].policy_name

The name of the policy.

resources[].details.aws_iam_role.create_date

Indicates when the role was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_iam_role.instance_profile_list[]
Show child fields
resources[].details.aws_iam_role.instance_profile_list[].arn

The ARN of the instance profile.

resources[].details.aws_iam_role.instance_profile_list[].create_date

Indicates when the instance profile was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_iam_role.instance_profile_list[].instance_profile_id

The identifier of the instance profile.

resources[].details.aws_iam_role.instance_profile_list[].instance_profile_name

The name of the instance profile.

resources[].details.aws_iam_role.instance_profile_list[].path

The path to the instance profile.

resources[].details.aws_iam_role.instance_profile_list[].roles[]
Show child fields
resources[].details.aws_iam_role.instance_profile_list[].roles[].arn

The ARN of the role.

resources[].details.aws_iam_role.instance_profile_list[].roles[].assume_role_policy_document

The policy that grants an entity permission to assume the role.

resources[].details.aws_iam_role.instance_profile_list[].roles[].create_date

Indicates when the role was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_iam_role.instance_profile_list[].roles[].path

The path to the role.

resources[].details.aws_iam_role.instance_profile_list[].roles[].role_id

The identifier of the role.

resources[].details.aws_iam_role.instance_profile_list[].roles[].role_name

The name of the role.

resources[].details.aws_iam_role.max_session_duration

The maximum session duration (in seconds) that you want to set for the specified role.

resources[].details.aws_iam_role.path

The path to the role.

resources[].details.aws_iam_role.permissions_boundary

Information about the policy used to set the permissions boundary for an IAM principal.

Show child fields
resources[].details.aws_iam_role.permissions_boundary.permissions_boundary_arn

The ARN of the policy used to set the permissions boundary.

resources[].details.aws_iam_role.permissions_boundary.permissions_boundary_type

The usage type for the permissions boundary.

resources[].details.aws_iam_role.role_id

The stable and unique string identifying the role.

resources[].details.aws_iam_role.role_name

The friendly name that identifies the role.

resources[].details.aws_iam_role.role_policy_list[]
Show child fields
resources[].details.aws_iam_role.role_policy_list[].policy_name

The name of the policy.

resources[].details.aws_iam_user

Details about an IAM user.

Show child fields
resources[].details.aws_iam_user.attached_managed_policies[]
Show child fields
resources[].details.aws_iam_user.attached_managed_policies[].policy_arn

The ARN of the policy.

resources[].details.aws_iam_user.attached_managed_policies[].policy_name

The name of the policy.

resources[].details.aws_iam_user.create_date

Indicates when the user was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_iam_user.group_list[]
resources[].details.aws_iam_user.path

The path to the user.

resources[].details.aws_iam_user.permissions_boundary

The permissions boundary for the user.

Show child fields
resources[].details.aws_iam_user.permissions_boundary.permissions_boundary_arn

The ARN of the policy used to set the permissions boundary.

resources[].details.aws_iam_user.permissions_boundary.permissions_boundary_type

The usage type for the permissions boundary.

resources[].details.aws_iam_user.user_id

The unique identifier for the user.

resources[].details.aws_iam_user.user_name

The name of the user.

resources[].details.aws_iam_user.user_policy_list[]
Show child fields
resources[].details.aws_iam_user.user_policy_list[].policy_name

The name of the policy.

resources[].details.aws_kinesis_stream

Details about an Amazon Kinesis data stream.

Show child fields
resources[].details.aws_kinesis_stream.arn

The Amazon Resource Name (ARN) of the Kinesis data stream.

resources[].details.aws_kinesis_stream.name

The name of the Kinesis stream. If you don't specify a name, CloudFront generates a unique physical ID and uses that ID for the stream name.

resources[].details.aws_kinesis_stream.retention_period_hours

The number of hours for the data records that are stored in shards to remain accessible.

resources[].details.aws_kinesis_stream.shard_count

The number of shards that the stream uses.

resources[].details.aws_kinesis_stream.stream_encryption

When specified, enables or updates server-side encryption using an KMS key for a specified stream. Removing this property from your stack template and updating your stack disables encryption.

Show child fields
resources[].details.aws_kinesis_stream.stream_encryption.encryption_type

The encryption type to use.

resources[].details.aws_kinesis_stream.stream_encryption.key_id

The globally unique identifier for the customer-managed KMS key to use for encryption.

resources[].details.aws_kms_key

Details about an KMS key.

Show child fields
resources[].details.aws_kms_key.aws_account_id

The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.

resources[].details.aws_kms_key.creation_date

Indicates when the KMS key was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_kms_key.description

A description of the KMS key.

resources[].details.aws_kms_key.key_id

The globally unique identifier for the KMS key.

resources[].details.aws_kms_key.key_manager

The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed.

resources[].details.aws_kms_key.key_rotation_status

Whether the key has key rotation enabled.

resources[].details.aws_kms_key.key_state

The state of the KMS key. Valid values are as follows:

  • Disabled

  • Enabled

  • PendingDeletion

  • PendingImport

  • Unavailable

resources[].details.aws_kms_key.origin

The source of the KMS key material.

When this value is AWS_KMS, KMS created the key material.

When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the KMS key lacks key material.

When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated with a custom key store.

resources[].details.aws_lambda_function

Details about a Lambda function.

Show child fields
resources[].details.aws_lambda_function.architectures[]
resources[].details.aws_lambda_function.code

An AwsLambdaFunctionCode object.

Show child fields
resources[].details.aws_lambda_function.code.s3_bucket

An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a different Amazon Web Services account.

resources[].details.aws_lambda_function.code.s3_key

The Amazon S3 key of the deployment package.

resources[].details.aws_lambda_function.code.s3_object_version

For versioned objects, the version of the deployment package object to use.

resources[].details.aws_lambda_function.code.zip_file

The base64-encoded contents of the deployment package. Amazon Web Services SDK and Amazon Web Services CLI clients handle the encoding for you.

resources[].details.aws_lambda_function.code_sha256

The SHA256 hash of the function's deployment package.

resources[].details.aws_lambda_function.dead_letter_config

The function's dead letter queue.

Show child fields
resources[].details.aws_lambda_function.dead_letter_config.target_arn

The ARN of an SQS queue or SNS topic.

resources[].details.aws_lambda_function.environment

The function's environment variables.

Show child fields
resources[].details.aws_lambda_function.environment.error

An AwsLambdaFunctionEnvironmentError object.

Show child fields
resources[].details.aws_lambda_function.environment.error.error_code

The error code.

resources[].details.aws_lambda_function.environment.error.message

The error message.

resources[].details.aws_lambda_function.environment.variables

Environment variable key-value pairs.

resources[].details.aws_lambda_function.function_name

The name of the function.

resources[].details.aws_lambda_function.handler

The function that Lambda calls to begin executing your function.

resources[].details.aws_lambda_function.kms_key_arn

The KMS key that is used to encrypt the function's environment variables. This key is only returned if you've configured a customer managed customer managed key.

resources[].details.aws_lambda_function.last_modified

Indicates when the function was last updated.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_lambda_function.layers[]
Show child fields
resources[].details.aws_lambda_function.layers[].arn

The ARN of the function layer.

resources[].details.aws_lambda_function.layers[].code_size

The size of the layer archive in bytes.

resources[].details.aws_lambda_function.master_arn

For Lambda@Edge functions, the ARN of the master function.

resources[].details.aws_lambda_function.memory_size

The memory that is allocated to the function.

resources[].details.aws_lambda_function.package_type

The type of deployment package that's used to deploy the function code to Lambda. Set to Image for a container image and Zip for a .zip file archive.

resources[].details.aws_lambda_function.revision_id

The latest updated revision of the function or alias.

resources[].details.aws_lambda_function.role

The function's execution role.

resources[].details.aws_lambda_function.runtime

The runtime environment for the Lambda function.

resources[].details.aws_lambda_function.timeout

The amount of time that Lambda allows a function to run before stopping it.

resources[].details.aws_lambda_function.tracing_config

The function's X-Ray tracing configuration.

Show child fields
resources[].details.aws_lambda_function.tracing_config.mode

The tracing mode.

resources[].details.aws_lambda_function.version

The version of the Lambda function.

resources[].details.aws_lambda_function.vpc_config

The function's networking configuration.

Show child fields
resources[].details.aws_lambda_function.vpc_config.security_group_ids[]
resources[].details.aws_lambda_function.vpc_config.subnet_ids[]
resources[].details.aws_lambda_function.vpc_config.vpc_id

The ID of the VPC.

resources[].details.aws_lambda_layer_version

Details for a Lambda layer version.

Show child fields
resources[].details.aws_lambda_layer_version.compatible_runtimes[]
resources[].details.aws_lambda_layer_version.created_date

Indicates when the version was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_lambda_layer_version.version

The version number.

resources[].details.aws_msk_cluster

Provides details about an Amazon Managed Streaming for Apache Kafka (Amazon MSK) cluster.

Show child fields
resources[].details.aws_msk_cluster.cluster_info

Provides information about a cluster.

Show child fields
resources[].details.aws_msk_cluster.cluster_info.client_authentication

Provides information for different modes of client authentication.

Show child fields
resources[].details.aws_msk_cluster.cluster_info.client_authentication.sasl

Provides details for client authentication using SASL.

Show child fields
resources[].details.aws_msk_cluster.cluster_info.client_authentication.sasl.iam

Provides details for SASL client authentication using IAM.

Show child fields
resources[].details.aws_msk_cluster.cluster_info.client_authentication.sasl.iam.enabled

Indicates whether SASL/IAM authentication is enabled or not.

resources[].details.aws_msk_cluster.cluster_info.client_authentication.sasl.scram

Details for SASL client authentication using SCRAM.

Show child fields
resources[].details.aws_msk_cluster.cluster_info.client_authentication.sasl.scram.enabled

Indicates whether SASL/SCRAM authentication is enabled or not.

resources[].details.aws_msk_cluster.cluster_info.client_authentication.tls

Provides details for client authentication using TLS.

Show child fields
resources[].details.aws_msk_cluster.cluster_info.client_authentication.tls.certificate_authority_arn_list[]
resources[].details.aws_msk_cluster.cluster_info.client_authentication.tls.enabled

Indicates whether TLS authentication is enabled or not.

resources[].details.aws_msk_cluster.cluster_info.client_authentication.unauthenticated

Provides details for allowing no client authentication.

Show child fields
resources[].details.aws_msk_cluster.cluster_info.client_authentication.unauthenticated.enabled

Indicates whether unauthenticated is allowed or not.

resources[].details.aws_msk_cluster.cluster_info.cluster_name

The name of the cluster.

resources[].details.aws_msk_cluster.cluster_info.current_version

The current version of the cluster.

resources[].details.aws_msk_cluster.cluster_info.encryption_info

Includes encryption-related information, such as the KMS key used for encrypting data at rest and whether you want Amazon MSK to encrypt your data in transit.

Show child fields
resources[].details.aws_msk_cluster.cluster_info.encryption_info.encryption_at_rest

The data-volume encryption details. You can't update encryption at rest settings for existing clusters.

Show child fields
resources[].details.aws_msk_cluster.cluster_info.encryption_info.encryption_at_rest.data_volume_kms_key_id

The Amazon Resource Name (ARN) of the KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.

resources[].details.aws_msk_cluster.cluster_info.encryption_info.encryption_in_transit

The settings for encrypting data in transit.

Show child fields
resources[].details.aws_msk_cluster.cluster_info.encryption_info.encryption_in_transit.client_broker

Indicates the encryption setting for data in transit between clients and brokers.

resources[].details.aws_msk_cluster.cluster_info.encryption_info.encryption_in_transit.in_cluster

When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plain text. The default value is true.

resources[].details.aws_msk_cluster.cluster_info.enhanced_monitoring

Specifies the level of monitoring for the cluster.

resources[].details.aws_msk_cluster.cluster_info.number_of_broker_nodes

The number of broker nodes in the cluster.

resources[].details.aws_network_firewall_firewall

Details about an Network Firewall firewall.

Show child fields
resources[].details.aws_network_firewall_firewall.delete_protection

Whether the firewall is protected from deletion. If set to true, then the firewall cannot be deleted.

resources[].details.aws_network_firewall_firewall.description

A description of the firewall.

resources[].details.aws_network_firewall_firewall.firewall_arn

The ARN of the firewall.

resources[].details.aws_network_firewall_firewall.firewall_id

The identifier of the firewall.

resources[].details.aws_network_firewall_firewall.firewall_name

A descriptive name of the firewall.

resources[].details.aws_network_firewall_firewall.firewall_policy_arn

The ARN of the firewall policy.

resources[].details.aws_network_firewall_firewall.firewall_policy_change_protection

Whether the firewall is protected from a change to the firewall policy. If set to true, you cannot associate a different policy with the firewall.

resources[].details.aws_network_firewall_firewall.subnet_change_protection

Whether the firewall is protected from a change to the subnet associations. If set to true, you cannot map different subnets to the firewall.

resources[].details.aws_network_firewall_firewall.subnet_mappings[]
Show child fields
resources[].details.aws_network_firewall_firewall.subnet_mappings[].subnet_id

The identifier of the subnet

resources[].details.aws_network_firewall_firewall.vpc_id

The identifier of the VPC where the firewall is used.

resources[].details.aws_network_firewall_firewall_policy

Details about an Network Firewall firewall policy.

Show child fields
resources[].details.aws_network_firewall_firewall_policy.description

A description of the firewall policy.

resources[].details.aws_network_firewall_firewall_policy.firewall_policy

The firewall policy configuration.

Show child fields
resources[].details.aws_network_firewall_firewall_policy.firewall_policy.stateful_rule_group_references[]
Show child fields
resources[].details.aws_network_firewall_firewall_policy.firewall_policy.stateful_rule_group_references[].resource_arn

The ARN of the stateful rule group.

resources[].details.aws_network_firewall_firewall_policy.firewall_policy.stateless_custom_actions[]
Show child fields
resources[].details.aws_network_firewall_firewall_policy.firewall_policy.stateless_custom_actions[].action_definition

The definition of the custom action.

Show child fields
resources[].details.aws_network_firewall_firewall_policy.firewall_policy.stateless_custom_actions[].action_definition.publish_metric_action

Information about metrics to publish to CloudWatch.

Show child fields
resources[].details.aws_network_firewall_firewall_policy.firewall_policy.stateless_custom_actions[].action_definition.publish_metric_action.dimensions[]
Show child fields
resources[].details.aws_network_firewall_firewall_policy.firewall_policy.stateless_custom_actions[].action_definition.publish_metric_action.dimensions[].value

The value to use for the custom metric dimension.

resources[].details.aws_network_firewall_firewall_policy.firewall_policy.stateless_custom_actions[].action_name

The name of the custom action.

resources[].details.aws_network_firewall_firewall_policy.firewall_policy.stateless_default_actions[]
resources[].details.aws_network_firewall_firewall_policy.firewall_policy.stateless_fragment_default_actions[]
resources[].details.aws_network_firewall_firewall_policy.firewall_policy.stateless_rule_group_references[]
Show child fields
resources[].details.aws_network_firewall_firewall_policy.firewall_policy.stateless_rule_group_references[].priority

The order in which to run the stateless rule group.

resources[].details.aws_network_firewall_firewall_policy.firewall_policy.stateless_rule_group_references[].resource_arn

The ARN of the stateless rule group.

resources[].details.aws_network_firewall_firewall_policy.firewall_policy_arn

The ARN of the firewall policy.

resources[].details.aws_network_firewall_firewall_policy.firewall_policy_id

The identifier of the firewall policy.

resources[].details.aws_network_firewall_firewall_policy.firewall_policy_name

The name of the firewall policy.

resources[].details.aws_network_firewall_rule_group

Details about an Network Firewall rule group.

Show child fields
resources[].details.aws_network_firewall_rule_group.capacity

The maximum number of operating resources that this rule group can use.

resources[].details.aws_network_firewall_rule_group.description

A description of the rule group.

resources[].details.aws_network_firewall_rule_group.rule_group

Details about the rule group.

Show child fields
resources[].details.aws_network_firewall_rule_group.rule_group.rule_variables

Additional settings to use in the specified rules.

Show child fields
resources[].details.aws_network_firewall_rule_group.rule_group.rule_variables.ip_sets

A list of IP addresses and address ranges, in CIDR notation.

Show child fields
resources[].details.aws_network_firewall_rule_group.rule_group.rule_variables.ip_sets.definition[]
resources[].details.aws_network_firewall_rule_group.rule_group.rule_variables.port_sets

A list of port ranges.

Show child fields
resources[].details.aws_network_firewall_rule_group.rule_group.rule_variables.port_sets.definition[]
resources[].details.aws_network_firewall_rule_group.rule_group.rules_source

The rules and actions for the rule group.

For stateful rule groups, can contain RulesString, RulesSourceList, or StatefulRules.

For stateless rule groups, contains StatelessRulesAndCustomActions.

Show child fields
resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.rules_source_list

Stateful inspection criteria for a domain list rule group. A domain list rule group determines access by specific protocols to specific domains.

Show child fields
resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.rules_source_list.generated_rules_type

Indicates whether to allow or deny access to the domains listed in Targets.

resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.rules_source_list.target_types[]
resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.rules_source_list.targets[]
resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.rules_string

Stateful inspection criteria, provided in Suricata compatible intrusion prevention system (IPS) rules.

resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.stateful_rules[]
Show child fields
resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.stateful_rules[].action

Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria.

resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.stateful_rules[].header

The stateful inspection criteria for the rule.

Show child fields
resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.stateful_rules[].header.destination

The destination IP address or address range to inspect for, in CIDR notation. To match with any address, specify ANY.

resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.stateful_rules[].header.destination_port

The destination port to inspect for. You can specify an individual port, such as 1994. You also can specify a port range, such as 1990:1994. To match with any port, specify ANY.

resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.stateful_rules[].header.direction

The direction of traffic flow to inspect. If set to ANY, the inspection matches bidirectional traffic, both from the source to the destination and from the destination to the source. If set to FORWARD, the inspection only matches traffic going from the source to the destination.

resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.stateful_rules[].header.protocol

The protocol to inspect for. To inspector for all protocols, use IP.

resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.stateful_rules[].header.source

The source IP address or address range to inspect for, in CIDR notation. To match with any address, specify ANY.

resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.stateful_rules[].header.source_port

The source port to inspect for. You can specify an individual port, such as 1994. You also can specify a port range, such as 1990:1994. To match with any port, specify ANY.

resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.stateful_rules[].rule_options[]
Show child fields
resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.stateful_rules[].rule_options[].keyword

A keyword to look for.

resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.stateful_rules[].rule_options[].settings[]
resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.stateless_rules_and_custom_actions

The stateless rules and custom actions used by a stateless rule group.

Show child fields
resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.stateless_rules_and_custom_actions.custom_actions[]
Show child fields
resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.stateless_rules_and_custom_actions.custom_actions[].action_definition

The definition of a custom action.

Show child fields
resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.stateless_rules_and_custom_actions.custom_actions[].action_definition.publish_metric_action

Information about metrics to publish to CloudWatch.

Show child fields
resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.stateless_rules_and_custom_actions.custom_actions[].action_definition.publish_metric_action.dimensions[]
Show child fields
resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.stateless_rules_and_custom_actions.custom_actions[].action_definition.publish_metric_action.dimensions[].value

The value to use for the custom metric dimension.

resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.stateless_rules_and_custom_actions.custom_actions[].action_name

A descriptive name of the custom action.

resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.stateless_rules_and_custom_actions.stateless_rules[]
Show child fields
resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.stateless_rules_and_custom_actions.stateless_rules[].priority

Indicates the order in which to run this rule relative to all of the rules in the stateless rule group.

resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.stateless_rules_and_custom_actions.stateless_rules[].rule_definition

Provides the definition of the stateless rule.

Show child fields
resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.stateless_rules_and_custom_actions.stateless_rules[].rule_definition.actions[]
resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.stateless_rules_and_custom_actions.stateless_rules[].rule_definition.match_attributes

The criteria for Network Firewall to use to inspect an individual packet in a stateless rule inspection.

Show child fields
resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.stateless_rules_and_custom_actions.stateless_rules[].rule_definition.match_attributes.destination_ports[]
Show child fields
resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.stateless_rules_and_custom_actions.stateless_rules[].rule_definition.match_attributes.destination_ports[].from_port

The starting port value for the port range.

resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.stateless_rules_and_custom_actions.stateless_rules[].rule_definition.match_attributes.destination_ports[].to_port

The ending port value for the port range.

resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.stateless_rules_and_custom_actions.stateless_rules[].rule_definition.match_attributes.destinations[]
Show child fields
resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.stateless_rules_and_custom_actions.stateless_rules[].rule_definition.match_attributes.destinations[].address_definition

An IP address or a block of IP addresses.

resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.stateless_rules_and_custom_actions.stateless_rules[].rule_definition.match_attributes.protocols[]
resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.stateless_rules_and_custom_actions.stateless_rules[].rule_definition.match_attributes.source_ports[]
Show child fields
resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.stateless_rules_and_custom_actions.stateless_rules[].rule_definition.match_attributes.source_ports[].from_port

The starting port value for the port range.

resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.stateless_rules_and_custom_actions.stateless_rules[].rule_definition.match_attributes.source_ports[].to_port

The ending port value for the port range.

resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.stateless_rules_and_custom_actions.stateless_rules[].rule_definition.match_attributes.sources[]
Show child fields
resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.stateless_rules_and_custom_actions.stateless_rules[].rule_definition.match_attributes.sources[].address_definition

An IP address or a block of IP addresses.

resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.stateless_rules_and_custom_actions.stateless_rules[].rule_definition.match_attributes.tcp_flags[]
Show child fields
resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.stateless_rules_and_custom_actions.stateless_rules[].rule_definition.match_attributes.tcp_flags[].flags[]
resources[].details.aws_network_firewall_rule_group.rule_group.rules_source.stateless_rules_and_custom_actions.stateless_rules[].rule_definition.match_attributes.tcp_flags[].masks[]
resources[].details.aws_network_firewall_rule_group.rule_group_arn

The ARN of the rule group.

resources[].details.aws_network_firewall_rule_group.rule_group_id

The identifier of the rule group.

resources[].details.aws_network_firewall_rule_group.rule_group_name

The descriptive name of the rule group.

resources[].details.aws_network_firewall_rule_group.type

The type of rule group. A rule group can be stateful or stateless.

resources[].details.aws_open_search_service_domain

Details about an Amazon OpenSearch Service domain.

Show child fields
resources[].details.aws_open_search_service_domain.access_policies

IAM policy document that specifies the access policies for the OpenSearch Service domain.

resources[].details.aws_open_search_service_domain.advanced_security_options

Specifies options for fine-grained access control.

Show child fields
resources[].details.aws_open_search_service_domain.advanced_security_options.enabled

Enables fine-grained access control.

resources[].details.aws_open_search_service_domain.advanced_security_options.internal_user_database_enabled

Enables the internal user database.

resources[].details.aws_open_search_service_domain.advanced_security_options.master_user_options

Specifies information about the master user of the domain.

Show child fields
resources[].details.aws_open_search_service_domain.advanced_security_options.master_user_options.master_user_arn

The Amazon Resource Name (ARN) for the master user.

resources[].details.aws_open_search_service_domain.advanced_security_options.master_user_options.master_user_name

The username for the master user.

resources[].details.aws_open_search_service_domain.advanced_security_options.master_user_options.master_user_password

The password for the master user.

resources[].details.aws_open_search_service_domain.arn

The ARN of the OpenSearch Service domain.

resources[].details.aws_open_search_service_domain.cluster_config

Details about the configuration of an OpenSearch cluster.

Show child fields
resources[].details.aws_open_search_service_domain.cluster_config.dedicated_master_count

The number of instances to use for the master node. If this attribute is specified, then DedicatedMasterEnabled must be true.

resources[].details.aws_open_search_service_domain.cluster_config.dedicated_master_enabled

Whether to use a dedicated master node for the OpenSearch domain. A dedicated master node performs cluster management tasks, but does not hold data or respond to data upload requests.

resources[].details.aws_open_search_service_domain.cluster_config.dedicated_master_type

The hardware configuration of the computer that hosts the dedicated master node.

If this attribute is specified, then DedicatedMasterEnabled must be true.

resources[].details.aws_open_search_service_domain.cluster_config.instance_count

The number of data nodes to use in the OpenSearch domain.

resources[].details.aws_open_search_service_domain.cluster_config.instance_type

The instance type for your data nodes.

For a list of valid values, see Supported instance types in Amazon OpenSearch Service in the Amazon OpenSearch Service Developer Guide.

resources[].details.aws_open_search_service_domain.cluster_config.warm_count

The number of UltraWarm instances.

resources[].details.aws_open_search_service_domain.cluster_config.warm_enabled

Whether UltraWarm is enabled.

resources[].details.aws_open_search_service_domain.cluster_config.warm_type

The type of UltraWarm instance.

resources[].details.aws_open_search_service_domain.cluster_config.zone_awareness_config

Configuration options for zone awareness. Provided if ZoneAwarenessEnabled is true.

Show child fields
resources[].details.aws_open_search_service_domain.cluster_config.zone_awareness_config.availability_zone_count

The number of Availability Zones that the domain uses. Valid values are 2 or 3. The default is 2.

resources[].details.aws_open_search_service_domain.cluster_config.zone_awareness_enabled

Whether to enable zone awareness for the OpenSearch domain. When zone awareness is enabled, OpenSearch Service allocates the cluster's nodes and replica index shards across Availability Zones (AZs) in the same Region. This prevents data loss and minimizes downtime if a node or data center fails.

resources[].details.aws_open_search_service_domain.domain_endpoint

The domain endpoint.

resources[].details.aws_open_search_service_domain.domain_endpoint_options

Additional options for the domain endpoint.

Show child fields
resources[].details.aws_open_search_service_domain.domain_endpoint_options.custom_endpoint

The fully qualified URL for the custom endpoint.

resources[].details.aws_open_search_service_domain.domain_endpoint_options.custom_endpoint_certificate_arn

The ARN for the security certificate. The certificate is managed in ACM.

resources[].details.aws_open_search_service_domain.domain_endpoint_options.custom_endpoint_enabled

Whether to enable a custom endpoint for the domain.

resources[].details.aws_open_search_service_domain.domain_endpoint_options.enforce_https

Whether to require that all traffic to the domain arrive over HTTPS.

resources[].details.aws_open_search_service_domain.domain_endpoint_options.tls_security_policy

The TLS security policy to apply to the HTTPS endpoint of the OpenSearch domain.

resources[].details.aws_open_search_service_domain.domain_endpoints

The domain endpoints. Used if the OpenSearch domain resides in a VPC.

This is a map of key-value pairs. The key is always vpc. The value is the endpoint.

resources[].details.aws_open_search_service_domain.domain_name

The name of the endpoint.

resources[].details.aws_open_search_service_domain.encryption_at_rest_options

Details about the configuration for encryption at rest.

Show child fields
resources[].details.aws_open_search_service_domain.encryption_at_rest_options.enabled

Whether encryption at rest is enabled.

resources[].details.aws_open_search_service_domain.encryption_at_rest_options.kms_key_id

The KMS key ID.

resources[].details.aws_open_search_service_domain.engine_version

The version of the domain engine.

resources[].details.aws_open_search_service_domain.id

The identifier of the domain.

resources[].details.aws_open_search_service_domain.log_publishing_options

Configures the CloudWatch Logs to publish for the OpenSearch domain.

Show child fields
resources[].details.aws_open_search_service_domain.log_publishing_options.audit_logs

Configures the OpenSearch audit logs publishing.

Show child fields
resources[].details.aws_open_search_service_domain.log_publishing_options.audit_logs.cloud_watch_logs_log_group_arn

The ARN of the CloudWatch Logs group to publish the logs to.

resources[].details.aws_open_search_service_domain.log_publishing_options.audit_logs.enabled

Whether the log publishing is enabled.

resources[].details.aws_open_search_service_domain.log_publishing_options.index_slow_logs

Configures the OpenSearch index logs publishing.

Show child fields
resources[].details.aws_open_search_service_domain.log_publishing_options.index_slow_logs.cloud_watch_logs_log_group_arn

The ARN of the CloudWatch Logs group to publish the logs to.

resources[].details.aws_open_search_service_domain.log_publishing_options.index_slow_logs.enabled

Whether the log publishing is enabled.

resources[].details.aws_open_search_service_domain.log_publishing_options.search_slow_logs

Configures the OpenSearch search slow log publishing.

Show child fields
resources[].details.aws_open_search_service_domain.log_publishing_options.search_slow_logs.cloud_watch_logs_log_group_arn

The ARN of the CloudWatch Logs group to publish the logs to.

resources[].details.aws_open_search_service_domain.log_publishing_options.search_slow_logs.enabled

Whether the log publishing is enabled.

resources[].details.aws_open_search_service_domain.node_to_node_encryption_options

Details about the configuration for node-to-node encryption.

Show child fields
resources[].details.aws_open_search_service_domain.node_to_node_encryption_options.enabled

Whether node-to-node encryption is enabled.

resources[].details.aws_open_search_service_domain.service_software_options

Information about the status of a domain relative to the latest service software.

Show child fields
resources[].details.aws_open_search_service_domain.service_software_options.automated_update_date

The epoch time when the deployment window closes for required updates. After this time, OpenSearch Service schedules the software upgrade automatically.

resources[].details.aws_open_search_service_domain.service_software_options.cancellable

Whether a request to update the domain can be canceled.

resources[].details.aws_open_search_service_domain.service_software_options.current_version

The version of the service software that is currently installed on the domain.

resources[].details.aws_open_search_service_domain.service_software_options.description

A more detailed description of the service software status.

resources[].details.aws_open_search_service_domain.service_software_options.new_version

The most recent version of the service software.

resources[].details.aws_open_search_service_domain.service_software_options.optional_deployment

Whether the service software update is optional.

resources[].details.aws_open_search_service_domain.service_software_options.update_available

Whether a service software update is available for the domain.

resources[].details.aws_open_search_service_domain.service_software_options.update_status

The status of the service software update. Valid values are as follows:

  • COMPLETED

  • ELIGIBLE

  • IN_PROGRESS

  • NOT_ELIGIBLE

  • PENDING_UPDATE

resources[].details.aws_open_search_service_domain.vpc_options

Information that OpenSearch Service derives based on VPCOptions for the domain.

Show child fields
resources[].details.aws_open_search_service_domain.vpc_options.security_group_ids[]
resources[].details.aws_open_search_service_domain.vpc_options.subnet_ids[]
resources[].details.aws_rds_db_cluster

Details about an Amazon RDS database cluster.

Show child fields
resources[].details.aws_rds_db_cluster.activity_stream_status

The status of the database activity stream. Valid values are as follows:

  • started

  • starting

  • stopped

  • stopping

resources[].details.aws_rds_db_cluster.allocated_storage

For all database engines except Aurora, specifies the allocated storage size in gibibytes (GiB).

resources[].details.aws_rds_db_cluster.associated_roles[]
Show child fields
resources[].details.aws_rds_db_cluster.associated_roles[].role_arn

The ARN of the IAM role.

resources[].details.aws_rds_db_cluster.associated_roles[].status

The status of the association between the IAM role and the DB cluster. Valid values are as follows:

  • ACTIVE

  • INVALID

  • PENDING

resources[].details.aws_rds_db_cluster.auto_minor_version_upgrade

Indicates if minor version upgrades are automatically applied to the cluster.

resources[].details.aws_rds_db_cluster.availability_zones[]
resources[].details.aws_rds_db_cluster.backup_retention_period

The number of days for which automated backups are retained.

resources[].details.aws_rds_db_cluster.cluster_create_time

Indicates when the DB cluster was created, in Universal Coordinated Time (UTC).

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_rds_db_cluster.copy_tags_to_snapshot

Whether tags are copied from the DB cluster to snapshots of the DB cluster.

resources[].details.aws_rds_db_cluster.cross_account_clone

Whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

resources[].details.aws_rds_db_cluster.custom_endpoints[]
resources[].details.aws_rds_db_cluster.database_name

The name of the database.

resources[].details.aws_rds_db_cluster.db_cluster_identifier

The DB cluster identifier that the user assigned to the cluster. This identifier is the unique key that identifies a DB cluster.

resources[].details.aws_rds_db_cluster.db_cluster_members[]
Show child fields
resources[].details.aws_rds_db_cluster.db_cluster_members[].db_cluster_parameter_group_status

The status of the DB cluster parameter group for this member of the DB cluster.

resources[].details.aws_rds_db_cluster.db_cluster_members[].db_instance_identifier

The instance identifier for this member of the DB cluster.

resources[].details.aws_rds_db_cluster.db_cluster_members[].is_cluster_writer

Whether the cluster member is the primary instance for the DB cluster.

resources[].details.aws_rds_db_cluster.db_cluster_members[].promotion_tier

Specifies the order in which an Aurora replica is promoted to the primary instance when the existing primary instance fails.

resources[].details.aws_rds_db_cluster.db_cluster_option_group_memberships[]
Show child fields
resources[].details.aws_rds_db_cluster.db_cluster_option_group_memberships[].db_cluster_option_group_name

The name of the DB cluster option group.

resources[].details.aws_rds_db_cluster.db_cluster_option_group_memberships[].status

The status of the DB cluster option group.

resources[].details.aws_rds_db_cluster.db_cluster_parameter_group

The name of the DB cluster parameter group for the DB cluster.

resources[].details.aws_rds_db_cluster.db_cluster_resource_id

The identifier of the DB cluster. The identifier must be unique within each Amazon Web Services Region and is immutable.

resources[].details.aws_rds_db_cluster.db_subnet_group

The subnet group that is associated with the DB cluster, including the name, description, and subnets in the subnet group.

resources[].details.aws_rds_db_cluster.deletion_protection

Whether the DB cluster has deletion protection enabled.

resources[].details.aws_rds_db_cluster.domain_memberships[]
Show child fields
resources[].details.aws_rds_db_cluster.domain_memberships[].domain

The identifier of the Active Directory domain.

resources[].details.aws_rds_db_cluster.domain_memberships[].fqdn

The fully qualified domain name of the Active Directory domain.

resources[].details.aws_rds_db_cluster.domain_memberships[].iam_role_name

The name of the IAM role to use when making API calls to the Directory Service.

resources[].details.aws_rds_db_cluster.domain_memberships[].status

The status of the Active Directory Domain membership for the DB instance.

resources[].details.aws_rds_db_cluster.enabled_cloud_watch_logs_exports[]
resources[].details.aws_rds_db_cluster.endpoint

The connection endpoint for the primary instance of the DB cluster.

resources[].details.aws_rds_db_cluster.engine

The name of the database engine to use for this DB cluster. Valid values are as follows:

  • aurora

  • aurora-mysql

  • aurora-postgresql

resources[].details.aws_rds_db_cluster.engine_mode

The database engine mode of the DB cluster.Valid values are as follows:

  • global

  • multimaster

  • parallelquery

  • provisioned

  • serverless

resources[].details.aws_rds_db_cluster.engine_version

The version number of the database engine to use.

resources[].details.aws_rds_db_cluster.hosted_zone_id

Specifies the identifier that Amazon Route 53 assigns when you create a hosted zone.

resources[].details.aws_rds_db_cluster.http_endpoint_enabled

Whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.

resources[].details.aws_rds_db_cluster.iam_database_authentication_enabled

Whether the mapping of IAM accounts to database accounts is enabled.

resources[].details.aws_rds_db_cluster.kms_key_id

The ARN of the KMS master key that is used to encrypt the database instances in the DB cluster.

resources[].details.aws_rds_db_cluster.master_username

The name of the master user for the DB cluster.

resources[].details.aws_rds_db_cluster.multi_az

Whether the DB cluster has instances in multiple Availability Zones.

resources[].details.aws_rds_db_cluster.port

The port number on which the DB instances in the DB cluster accept connections.

resources[].details.aws_rds_db_cluster.preferred_backup_window

The range of time each day when automated backups are created, if automated backups are enabled.

Uses the format HH:MM-HH:MM. For example, 04:52-05:22.

resources[].details.aws_rds_db_cluster.preferred_maintenance_window

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Uses the format <day>:HH:MM-<day>:HH:MM.

For the day values, use mon|tue|wed|thu|fri|sat|sun.

For example, sun:09:32-sun:10:02.

resources[].details.aws_rds_db_cluster.read_replica_identifiers[]
resources[].details.aws_rds_db_cluster.reader_endpoint

The reader endpoint for the DB cluster.

resources[].details.aws_rds_db_cluster.status

The current status of this DB cluster.

resources[].details.aws_rds_db_cluster.storage_encrypted

Whether the DB cluster is encrypted.

resources[].details.aws_rds_db_cluster.vpc_security_groups[]
Show child fields
resources[].details.aws_rds_db_cluster.vpc_security_groups[].status

The status of the VPC security group.

resources[].details.aws_rds_db_cluster.vpc_security_groups[].vpc_security_group_id

The name of the VPC security group.

resources[].details.aws_rds_db_cluster_snapshot

Details about an Amazon RDS database cluster snapshot.

Show child fields
resources[].details.aws_rds_db_cluster_snapshot.allocated_storage

Specifies the allocated storage size in gibibytes (GiB).

resources[].details.aws_rds_db_cluster_snapshot.availability_zones[]
resources[].details.aws_rds_db_cluster_snapshot.cluster_create_time

Indicates when the DB cluster was created, in Universal Coordinated Time (UTC).

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_rds_db_cluster_snapshot.db_cluster_identifier

The DB cluster identifier.

resources[].details.aws_rds_db_cluster_snapshot.db_cluster_snapshot_attributes[]
Show child fields
resources[].details.aws_rds_db_cluster_snapshot.db_cluster_snapshot_attributes[].attribute_name

The name of the manual DB cluster snapshot attribute. The attribute named restore refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual DB cluster snapshot.

resources[].details.aws_rds_db_cluster_snapshot.db_cluster_snapshot_attributes[].attribute_values[]
resources[].details.aws_rds_db_cluster_snapshot.db_cluster_snapshot_identifier

The identifier of the DB cluster snapshot.

resources[].details.aws_rds_db_cluster_snapshot.engine

The name of the database engine that you want to use for this DB instance.

resources[].details.aws_rds_db_cluster_snapshot.engine_version

The version of the database engine to use.

resources[].details.aws_rds_db_cluster_snapshot.iam_database_authentication_enabled

Whether mapping of IAM accounts to database accounts is enabled.

resources[].details.aws_rds_db_cluster_snapshot.kms_key_id

The ARN of the KMS master key that is used to encrypt the database instances in the DB cluster.

resources[].details.aws_rds_db_cluster_snapshot.license_model

The license model information for this DB cluster snapshot.

resources[].details.aws_rds_db_cluster_snapshot.master_username

The name of the master user for the DB cluster.

resources[].details.aws_rds_db_cluster_snapshot.percent_progress

Specifies the percentage of the estimated data that has been transferred.

resources[].details.aws_rds_db_cluster_snapshot.port

The port number on which the DB instances in the DB cluster accept connections.

resources[].details.aws_rds_db_cluster_snapshot.snapshot_create_time

Indicates when the snapshot was taken.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_rds_db_cluster_snapshot.snapshot_type

The type of DB cluster snapshot.

resources[].details.aws_rds_db_cluster_snapshot.status

The status of this DB cluster snapshot.

resources[].details.aws_rds_db_cluster_snapshot.storage_encrypted

Whether the DB cluster is encrypted.

resources[].details.aws_rds_db_cluster_snapshot.vpc_id

The VPC ID that is associated with the DB cluster snapshot.

resources[].details.aws_rds_db_instance

Details about an Amazon RDS database instance.

Show child fields
resources[].details.aws_rds_db_instance.allocated_storage

The amount of storage (in gigabytes) to initially allocate for the DB instance.

resources[].details.aws_rds_db_instance.associated_roles[]
Show child fields
resources[].details.aws_rds_db_instance.associated_roles[].feature_name

The name of the feature associated with the IAM role.

resources[].details.aws_rds_db_instance.associated_roles[].role_arn

The ARN of the IAM role that is associated with the DB instance.

resources[].details.aws_rds_db_instance.associated_roles[].status

Describes the state of the association between the IAM role and the DB instance. The Status property returns one of the following values:

  • ACTIVE - The IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.

  • PENDING - The IAM role ARN is being associated with the DB instance.

  • INVALID - The IAM role ARN is associated with the DB instance. But the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.

resources[].details.aws_rds_db_instance.auto_minor_version_upgrade

Indicates whether minor version patches are applied automatically.

resources[].details.aws_rds_db_instance.availability_zone

The Availability Zone where the DB instance will be created.

resources[].details.aws_rds_db_instance.backup_retention_period

The number of days for which to retain automated backups.

resources[].details.aws_rds_db_instance.ca_certificate_identifier

The identifier of the CA certificate for this DB instance.

resources[].details.aws_rds_db_instance.character_set_name

The name of the character set that this DB instance is associated with.

resources[].details.aws_rds_db_instance.copy_tags_to_snapshot

Whether to copy resource tags to snapshots of the DB instance.

resources[].details.aws_rds_db_instance.db_cluster_identifier

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

resources[].details.aws_rds_db_instance.db_instance_class

Contains the name of the compute and memory capacity class of the DB instance.

resources[].details.aws_rds_db_instance.db_instance_identifier

Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

resources[].details.aws_rds_db_instance.db_instance_port

Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

resources[].details.aws_rds_db_instance.db_instance_status

The current status of the DB instance.

resources[].details.aws_rds_db_instance.db_name

The meaning of this parameter differs according to the database engine you use.

MySQL, MariaDB, SQL Server, PostgreSQL

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

Oracle

Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

resources[].details.aws_rds_db_instance.db_parameter_groups[]
Show child fields
resources[].details.aws_rds_db_instance.db_parameter_groups[].db_parameter_group_name

The name of the parameter group.

resources[].details.aws_rds_db_instance.db_parameter_groups[].parameter_apply_status

The status of parameter updates.

resources[].details.aws_rds_db_instance.db_security_groups[]
resources[].details.aws_rds_db_instance.db_subnet_group

Information about the subnet group that is associated with the DB instance.

Show child fields
resources[].details.aws_rds_db_instance.db_subnet_group.db_subnet_group_arn

The ARN of the subnet group.

resources[].details.aws_rds_db_instance.db_subnet_group.db_subnet_group_description

The description of the subnet group.

resources[].details.aws_rds_db_instance.db_subnet_group.db_subnet_group_name

The name of the subnet group.

resources[].details.aws_rds_db_instance.db_subnet_group.subnet_group_status

The status of the subnet group.

resources[].details.aws_rds_db_instance.db_subnet_group.subnets[]
Show child fields
resources[].details.aws_rds_db_instance.db_subnet_group.subnets[].subnet_availability_zone

Information about the Availability Zone for a subnet in the subnet group.

Show child fields
resources[].details.aws_rds_db_instance.db_subnet_group.subnets[].subnet_availability_zone.name

The name of the Availability Zone for a subnet in the subnet group.

resources[].details.aws_rds_db_instance.db_subnet_group.subnets[].subnet_identifier

The identifier of a subnet in the subnet group.

resources[].details.aws_rds_db_instance.db_subnet_group.subnets[].subnet_status

The status of a subnet in the subnet group.

resources[].details.aws_rds_db_instance.db_subnet_group.vpc_id

The VPC ID of the subnet group.

resources[].details.aws_rds_db_instance.dbi_resource_id

The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in CloudTrail log entries whenever the KMS key for the DB instance is accessed.

resources[].details.aws_rds_db_instance.deletion_protection

Indicates whether the DB instance has deletion protection enabled.

When deletion protection is enabled, the database cannot be deleted.

resources[].details.aws_rds_db_instance.domain_memberships[]
Show child fields
resources[].details.aws_rds_db_instance.domain_memberships[].domain

The identifier of the Active Directory domain.

resources[].details.aws_rds_db_instance.domain_memberships[].fqdn

The fully qualified domain name of the Active Directory domain.

resources[].details.aws_rds_db_instance.domain_memberships[].iam_role_name

The name of the IAM role to use when making API calls to the Directory Service.

resources[].details.aws_rds_db_instance.domain_memberships[].status

The status of the Active Directory Domain membership for the DB instance.

resources[].details.aws_rds_db_instance.enabled_cloud_watch_logs_exports[]
resources[].details.aws_rds_db_instance.endpoint

Specifies the connection endpoint.

Show child fields
resources[].details.aws_rds_db_instance.endpoint.address

Specifies the DNS address of the DB instance.

resources[].details.aws_rds_db_instance.endpoint.hosted_zone_id

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

resources[].details.aws_rds_db_instance.endpoint.port

Specifies the port that the database engine is listening on.

resources[].details.aws_rds_db_instance.engine

Provides the name of the database engine to use for this DB instance.

resources[].details.aws_rds_db_instance.engine_version

Indicates the database engine version.

resources[].details.aws_rds_db_instance.enhanced_monitoring_resource_arn

The ARN of the CloudWatch Logs log stream that receives the enhanced monitoring metrics data for the DB instance.

resources[].details.aws_rds_db_instance.iam_database_authentication_enabled

True if mapping of IAM accounts to database accounts is enabled, and otherwise false.

IAM database authentication can be enabled for the following database engines.

  • For MySQL 5.6, minor version 5.6.34 or higher

  • For MySQL 5.7, minor version 5.7.16 or higher

  • Aurora 5.6 or higher

resources[].details.aws_rds_db_instance.instance_create_time

Indicates when the DB instance was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_rds_db_instance.iops

Specifies the provisioned IOPS (I/O operations per second) for this DB instance.

resources[].details.aws_rds_db_instance.kms_key_id

If StorageEncrypted is true, the KMS key identifier for the encrypted DB instance.

resources[].details.aws_rds_db_instance.latest_restorable_time

Specifies the latest time to which a database can be restored with point-in-time restore.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_rds_db_instance.license_model

License model information for this DB instance.

resources[].details.aws_rds_db_instance.listener_endpoint

Specifies the connection endpoint.

Show child fields
resources[].details.aws_rds_db_instance.listener_endpoint.address

Specifies the DNS address of the DB instance.

resources[].details.aws_rds_db_instance.listener_endpoint.hosted_zone_id

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

resources[].details.aws_rds_db_instance.listener_endpoint.port

Specifies the port that the database engine is listening on.

resources[].details.aws_rds_db_instance.master_username

The master user name of the DB instance.

resources[].details.aws_rds_db_instance.max_allocated_storage

The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

resources[].details.aws_rds_db_instance.monitoring_interval

The interval, in seconds, between points when enhanced monitoring metrics are collected for the DB instance.

resources[].details.aws_rds_db_instance.monitoring_role_arn

The ARN for the IAM role that permits Amazon RDS to send enhanced monitoring metrics to CloudWatch Logs.

resources[].details.aws_rds_db_instance.multi_az

Whether the DB instance is a multiple Availability Zone deployment.

resources[].details.aws_rds_db_instance.option_group_memberships[]
Show child fields
resources[].details.aws_rds_db_instance.option_group_memberships[].option_group_name

The name of the option group.

resources[].details.aws_rds_db_instance.option_group_memberships[].status

The status of the option group membership.

resources[].details.aws_rds_db_instance.pending_modified_values

Changes to the DB instance that are currently pending.

Show child fields
resources[].details.aws_rds_db_instance.pending_modified_values.allocated_storage

The new value of the allocated storage for the DB instance.

resources[].details.aws_rds_db_instance.pending_modified_values.backup_retention_period

The new backup retention period for the DB instance.

resources[].details.aws_rds_db_instance.pending_modified_values.ca_certificate_identifier

The new CA certificate identifier for the DB instance.

resources[].details.aws_rds_db_instance.pending_modified_values.db_instance_class

The new DB instance class for the DB instance.

resources[].details.aws_rds_db_instance.pending_modified_values.db_instance_identifier

The new DB instance identifier for the DB instance.

resources[].details.aws_rds_db_instance.pending_modified_values.db_subnet_group_name

The name of the new subnet group for the DB instance.

resources[].details.aws_rds_db_instance.pending_modified_values.engine_version

The new engine version for the DB instance.

resources[].details.aws_rds_db_instance.pending_modified_values.iops

The new provisioned IOPS value for the DB instance.

resources[].details.aws_rds_db_instance.pending_modified_values.license_model

The new license model value for the DB instance.

resources[].details.aws_rds_db_instance.pending_modified_values.master_user_password

The new master user password for the DB instance.

resources[].details.aws_rds_db_instance.pending_modified_values.multi_az

Indicates that a single Availability Zone DB instance is changing to a multiple Availability Zone deployment.

resources[].details.aws_rds_db_instance.pending_modified_values.pending_cloud_watch_logs_exports

A list of log types that are being enabled or disabled.

Show child fields
resources[].details.aws_rds_db_instance.pending_modified_values.pending_cloud_watch_logs_exports.log_types_to_disable[]
resources[].details.aws_rds_db_instance.pending_modified_values.pending_cloud_watch_logs_exports.log_types_to_enable[]
resources[].details.aws_rds_db_instance.pending_modified_values.port

The new port for the DB instance.

resources[].details.aws_rds_db_instance.pending_modified_values.processor_features[]
Show child fields
resources[].details.aws_rds_db_instance.pending_modified_values.processor_features[].name

The name of the processor feature. Valid values are coreCount or threadsPerCore.

resources[].details.aws_rds_db_instance.pending_modified_values.processor_features[].value

The value of the processor feature.

resources[].details.aws_rds_db_instance.pending_modified_values.storage_type

The new storage type for the DB instance.

resources[].details.aws_rds_db_instance.performance_insights_enabled

Indicates whether Performance Insights is enabled for the DB instance.

resources[].details.aws_rds_db_instance.performance_insights_kms_key_id

The identifier of the KMS key used to encrypt the Performance Insights data.

resources[].details.aws_rds_db_instance.performance_insights_retention_period

The number of days to retain Performance Insights data.

resources[].details.aws_rds_db_instance.preferred_backup_window

The range of time each day when automated backups are created, if automated backups are enabled.

Uses the format HH:MM-HH:MM. For example, 04:52-05:22.

resources[].details.aws_rds_db_instance.preferred_maintenance_window

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Uses the format <day>:HH:MM-<day>:HH:MM.

For the day values, use mon|tue|wed|thu|fri|sat|sun.

For example, sun:09:32-sun:10:02.

resources[].details.aws_rds_db_instance.processor_features[]
Show child fields
resources[].details.aws_rds_db_instance.processor_features[].name

The name of the processor feature. Valid values are coreCount or threadsPerCore.

resources[].details.aws_rds_db_instance.processor_features[].value

The value of the processor feature.

resources[].details.aws_rds_db_instance.promotion_tier

The order in which to promote an Aurora replica to the primary instance after a failure of the existing primary instance.

resources[].details.aws_rds_db_instance.publicly_accessible

Specifies the accessibility options for the DB instance.

A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address.

A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

resources[].details.aws_rds_db_instance.read_replica_db_cluster_identifiers[]
resources[].details.aws_rds_db_instance.read_replica_db_instance_identifiers[]
resources[].details.aws_rds_db_instance.read_replica_source_db_instance_identifier

If this DB instance is a read replica, contains the identifier of the source DB instance.

resources[].details.aws_rds_db_instance.secondary_availability_zone

For a DB instance with multi-Availability Zone support, the name of the secondary Availability Zone.

resources[].details.aws_rds_db_instance.status_infos[]
Show child fields
resources[].details.aws_rds_db_instance.status_infos[].message

If the read replica is currently in an error state, provides the error details.

resources[].details.aws_rds_db_instance.status_infos[].normal

Whether the read replica instance is operating normally.

resources[].details.aws_rds_db_instance.status_infos[].status

The status of the read replica instance.

resources[].details.aws_rds_db_instance.status_infos[].status_type

The type of status. For a read replica, the status type is read replication.

resources[].details.aws_rds_db_instance.storage_encrypted

Specifies whether the DB instance is encrypted.

resources[].details.aws_rds_db_instance.storage_type

The storage type for the DB instance.

resources[].details.aws_rds_db_instance.tde_credential_arn

The ARN from the key store with which the instance is associated for TDE encryption.

resources[].details.aws_rds_db_instance.timezone

The time zone of the DB instance.

resources[].details.aws_rds_db_instance.vpc_security_groups[]
Show child fields
resources[].details.aws_rds_db_instance.vpc_security_groups[].status

The status of the VPC security group.

resources[].details.aws_rds_db_instance.vpc_security_groups[].vpc_security_group_id

The name of the VPC security group.

resources[].details.aws_rds_db_security_group

Details about an Amazon RDS DB security group.

Show child fields
resources[].details.aws_rds_db_security_group.db_security_group_arn

The ARN for the DB security group.

resources[].details.aws_rds_db_security_group.db_security_group_description

Provides the description of the DB security group.

resources[].details.aws_rds_db_security_group.db_security_group_name

Specifies the name of the DB security group.

resources[].details.aws_rds_db_security_group.ec2_security_groups[]
Show child fields
resources[].details.aws_rds_db_security_group.ec2_security_groups[].ec2_security_group_id

Specifies the ID for the EC2 security group.

resources[].details.aws_rds_db_security_group.ec2_security_groups[].ec2_security_group_name

Specifies the name of the EC2 security group.

resources[].details.aws_rds_db_security_group.ec2_security_groups[].ec2_security_group_owner_id

Provides the Amazon Web Services ID of the owner of the EC2 security group.

resources[].details.aws_rds_db_security_group.ec2_security_groups[].status

Provides the status of the EC2 security group.

resources[].details.aws_rds_db_security_group.ip_ranges[]
Show child fields
resources[].details.aws_rds_db_security_group.ip_ranges[].cidr_ip

Specifies the IP range.

resources[].details.aws_rds_db_security_group.ip_ranges[].status

Specifies the status of the IP range.

resources[].details.aws_rds_db_security_group.owner_id

Provides the Amazon Web Services ID of the owner of a specific DB security group.

resources[].details.aws_rds_db_security_group.vpc_id

Provides VPC ID associated with the DB security group.

resources[].details.aws_rds_db_snapshot

Details about an Amazon RDS database snapshot.

Show child fields
resources[].details.aws_rds_db_snapshot.allocated_storage

The amount of storage (in gigabytes) to be initially allocated for the database instance.

resources[].details.aws_rds_db_snapshot.availability_zone

Specifies the name of the Availability Zone in which the DB instance was located at the time of the DB snapshot.

resources[].details.aws_rds_db_snapshot.db_instance_identifier

A name for the DB instance.

resources[].details.aws_rds_db_snapshot.db_snapshot_identifier

The name or ARN of the DB snapshot that is used to restore the DB instance.

resources[].details.aws_rds_db_snapshot.dbi_resource_id

The identifier for the source DB instance.

resources[].details.aws_rds_db_snapshot.encrypted

Whether the DB snapshot is encrypted.

resources[].details.aws_rds_db_snapshot.engine

The name of the database engine to use for this DB instance. Valid values are as follows:

  • aurora

  • aurora-mysql

  • aurora-postgresql

  • c

  • mariadb

  • mysql

  • oracle-ee

  • oracle-se

  • oracle-se1

  • oracle-se2

  • sqlserver-ee

  • sqlserver-ex

  • sqlserver-se

  • sqlserver-web

resources[].details.aws_rds_db_snapshot.engine_version

The version of the database engine.

resources[].details.aws_rds_db_snapshot.iam_database_authentication_enabled

Whether mapping of IAM accounts to database accounts is enabled.

resources[].details.aws_rds_db_snapshot.instance_create_time

Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.

resources[].details.aws_rds_db_snapshot.iops

The provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

resources[].details.aws_rds_db_snapshot.kms_key_id

If Encrypted is true, the KMS key identifier for the encrypted DB snapshot.

resources[].details.aws_rds_db_snapshot.license_model

License model information for the restored DB instance.

resources[].details.aws_rds_db_snapshot.master_username

The master user name for the DB snapshot.

resources[].details.aws_rds_db_snapshot.option_group_name

The option group name for the DB snapshot.

resources[].details.aws_rds_db_snapshot.percent_progress

The percentage of the estimated data that has been transferred.

resources[].details.aws_rds_db_snapshot.port

The port that the database engine was listening on at the time of the snapshot.

resources[].details.aws_rds_db_snapshot.processor_features[]
Show child fields
resources[].details.aws_rds_db_snapshot.processor_features[].name

The name of the processor feature. Valid values are coreCount or threadsPerCore.

resources[].details.aws_rds_db_snapshot.processor_features[].value

The value of the processor feature.

resources[].details.aws_rds_db_snapshot.snapshot_create_time

When the snapshot was taken in Coordinated Universal Time (UTC).

resources[].details.aws_rds_db_snapshot.snapshot_type

The type of the DB snapshot.

resources[].details.aws_rds_db_snapshot.source_db_snapshot_identifier

The DB snapshot ARN that the DB snapshot was copied from.

resources[].details.aws_rds_db_snapshot.source_region

The Amazon Web Services Region that the DB snapshot was created in or copied from.

resources[].details.aws_rds_db_snapshot.status

The status of this DB snapshot.

resources[].details.aws_rds_db_snapshot.storage_type

The storage type associated with the DB snapshot. Valid values are as follows:

  • gp2

  • io1

  • standard

resources[].details.aws_rds_db_snapshot.tde_credential_arn

The ARN from the key store with which to associate the instance for TDE encryption.

resources[].details.aws_rds_db_snapshot.timezone

The time zone of the DB snapshot.

resources[].details.aws_rds_db_snapshot.vpc_id

The VPC ID associated with the DB snapshot.

resources[].details.aws_rds_event_subscription

Details about an RDS event notification subscription.

Show child fields
resources[].details.aws_rds_event_subscription.cust_subscription_id

The identifier of the account that is associated with the event notification subscription.

resources[].details.aws_rds_event_subscription.customer_aws_id

The identifier of the event notification subscription.

resources[].details.aws_rds_event_subscription.enabled

Whether the event notification subscription is enabled.

resources[].details.aws_rds_event_subscription.event_categories_list[]
resources[].details.aws_rds_event_subscription.event_subscription_arn

The ARN of the event notification subscription.

resources[].details.aws_rds_event_subscription.sns_topic_arn

The ARN of the SNS topic to post the event notifications to.

resources[].details.aws_rds_event_subscription.source_ids_list[]
resources[].details.aws_rds_event_subscription.source_type

The source type for the event notification subscription.

resources[].details.aws_rds_event_subscription.status

The status of the event notification subscription.

Valid values: creating | modifying | deleting | active | no-permission | topic-not-exist

resources[].details.aws_rds_event_subscription.subscription_creation_time

The datetime when the event notification subscription was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_redshift_cluster

Contains details about an Amazon Redshift cluster.

Show child fields
resources[].details.aws_redshift_cluster.allow_version_upgrade

Indicates whether major version upgrades are applied automatically to the cluster during the maintenance window.

resources[].details.aws_redshift_cluster.automated_snapshot_retention_period

The number of days that automatic cluster snapshots are retained.

resources[].details.aws_redshift_cluster.availability_zone

The name of the Availability Zone in which the cluster is located.

resources[].details.aws_redshift_cluster.cluster_availability_status

The availability status of the cluster for queries. Possible values are the following:

  • Available - The cluster is available for queries.

  • Unavailable - The cluster is not available for queries.

  • Maintenance - The cluster is intermittently available for queries due to maintenance activities.

  • Modifying -The cluster is intermittently available for queries due to changes that modify the cluster.

  • Failed - The cluster failed and is not available for queries.

resources[].details.aws_redshift_cluster.cluster_create_time

Indicates when the cluster was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_redshift_cluster.cluster_identifier

The unique identifier of the cluster.

resources[].details.aws_redshift_cluster.cluster_nodes[]
Show child fields
resources[].details.aws_redshift_cluster.cluster_nodes[].node_role

The role of the node. A node might be a leader node or a compute node.

resources[].details.aws_redshift_cluster.cluster_nodes[].private_ip_address

The private IP address of the node.

resources[].details.aws_redshift_cluster.cluster_nodes[].public_ip_address

The public IP address of the node.

resources[].details.aws_redshift_cluster.cluster_parameter_groups[]
Show child fields
resources[].details.aws_redshift_cluster.cluster_parameter_groups[].cluster_parameter_status_list[]
Show child fields
resources[].details.aws_redshift_cluster.cluster_parameter_groups[].cluster_parameter_status_list[].parameter_apply_error_description

The error that prevented the parameter from being applied to the database.

resources[].details.aws_redshift_cluster.cluster_parameter_groups[].cluster_parameter_status_list[].parameter_apply_status

The status of the parameter. Indicates whether the parameter is in sync with the database, waiting for a cluster reboot, or encountered an error when it was applied.

Valid values: in-sync | pending-reboot | applying | invalid-parameter | apply-deferred | apply-error | unknown-error

resources[].details.aws_redshift_cluster.cluster_parameter_groups[].cluster_parameter_status_list[].parameter_name

The name of the parameter.

resources[].details.aws_redshift_cluster.cluster_parameter_groups[].parameter_apply_status

The status of updates to the parameters.

resources[].details.aws_redshift_cluster.cluster_parameter_groups[].parameter_group_name

The name of the parameter group.

resources[].details.aws_redshift_cluster.cluster_public_key

The public key for the cluster.

resources[].details.aws_redshift_cluster.cluster_revision_number

The specific revision number of the database in the cluster.

resources[].details.aws_redshift_cluster.cluster_security_groups[]
Show child fields
resources[].details.aws_redshift_cluster.cluster_security_groups[].cluster_security_group_name

The name of the cluster security group.

resources[].details.aws_redshift_cluster.cluster_security_groups[].status

The status of the cluster security group.

resources[].details.aws_redshift_cluster.cluster_snapshot_copy_status

Information about the destination Region and retention period for the cross-Region snapshot copy.

Show child fields
resources[].details.aws_redshift_cluster.cluster_snapshot_copy_status.destination_region

The destination Region that snapshots are automatically copied to when cross-Region snapshot copy is enabled.

resources[].details.aws_redshift_cluster.cluster_snapshot_copy_status.manual_snapshot_retention_period

The number of days that manual snapshots are retained in the destination Region after they are copied from a source Region.

If the value is -1, then the manual snapshot is retained indefinitely.

Valid values: Either -1 or an integer between 1 and 3,653

resources[].details.aws_redshift_cluster.cluster_snapshot_copy_status.retention_period

The number of days to retain automated snapshots in the destination Region after they are copied from a source Region.

resources[].details.aws_redshift_cluster.cluster_snapshot_copy_status.snapshot_copy_grant_name

The name of the snapshot copy grant.

resources[].details.aws_redshift_cluster.cluster_status

The current status of the cluster.

Valid values: available | available, prep-for-resize | available, resize-cleanup | cancelling-resize | creating | deleting | final-snapshot | hardware-failure | incompatible-hsm | incompatible-network | incompatible-parameters | incompatible-restore | modifying | paused | rebooting | renaming | resizing | rotating-keys | storage-full | updating-hsm

resources[].details.aws_redshift_cluster.cluster_subnet_group_name

The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.

resources[].details.aws_redshift_cluster.cluster_version

The version ID of the Amazon Redshift engine that runs on the cluster.

resources[].details.aws_redshift_cluster.db_name

The name of the initial database that was created when the cluster was created.

The same name is returned for the life of the cluster.

If an initial database is not specified, a database named devdev is created by default.

resources[].details.aws_redshift_cluster.deferred_maintenance_windows[]
Show child fields
resources[].details.aws_redshift_cluster.deferred_maintenance_windows[].defer_maintenance_end_time

The end of the time window for which maintenance was deferred.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_redshift_cluster.deferred_maintenance_windows[].defer_maintenance_identifier

The identifier of the maintenance window.

resources[].details.aws_redshift_cluster.deferred_maintenance_windows[].defer_maintenance_start_time

The start of the time window for which maintenance was deferred.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_redshift_cluster.elastic_ip_status

Information about the status of the Elastic IP (EIP) address.

Show child fields
resources[].details.aws_redshift_cluster.elastic_ip_status.elastic_ip

The elastic IP address for the cluster.

resources[].details.aws_redshift_cluster.elastic_ip_status.status

The status of the elastic IP address.

resources[].details.aws_redshift_cluster.elastic_resize_number_of_node_options

The number of nodes that you can use the elastic resize method to resize the cluster to.

resources[].details.aws_redshift_cluster.encrypted

Indicates whether the data in the cluster is encrypted at rest.

resources[].details.aws_redshift_cluster.endpoint

The connection endpoint.

Show child fields
resources[].details.aws_redshift_cluster.endpoint.address

The DNS address of the cluster.

resources[].details.aws_redshift_cluster.endpoint.port

The port that the database engine listens on.

resources[].details.aws_redshift_cluster.enhanced_vpc_routing

Indicates whether to create the cluster with enhanced VPC routing enabled.

resources[].details.aws_redshift_cluster.expected_next_snapshot_schedule_time

Indicates when the next snapshot is expected to be taken. The cluster must have a valid snapshot schedule and have backups enabled.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_redshift_cluster.expected_next_snapshot_schedule_time_status

The status of the next expected snapshot.

Valid values: OnTrack | Pending

resources[].details.aws_redshift_cluster.hsm_status

Information about whether the Amazon Redshift cluster finished applying any changes to hardware security module (HSM) settings that were specified in a modify cluster command.

Show child fields
resources[].details.aws_redshift_cluster.hsm_status.hsm_client_certificate_identifier

The name of the HSM client certificate that the Amazon Redshift cluster uses to retrieve the data encryption keys that are stored in an HSM.

resources[].details.aws_redshift_cluster.hsm_status.hsm_configuration_identifier

The name of the HSM configuration that contains the information that the Amazon Redshift cluster can use to retrieve and store keys in an HSM.

resources[].details.aws_redshift_cluster.hsm_status.status

Indicates whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.

Type: String

Valid values: active | applying

resources[].details.aws_redshift_cluster.iam_roles[]
Show child fields
resources[].details.aws_redshift_cluster.iam_roles[].apply_status

The status of the IAM role's association with the cluster.

Valid values: in-sync | adding | removing

resources[].details.aws_redshift_cluster.iam_roles[].iam_role_arn

The ARN of the IAM role.

resources[].details.aws_redshift_cluster.kms_key_id

The identifier of the KMS encryption key that is used to encrypt data in the cluster.

resources[].details.aws_redshift_cluster.logging_status

Information about the logging status of the cluster.

Show child fields
resources[].details.aws_redshift_cluster.logging_status.bucket_name

The name of the S3 bucket where the log files are stored.

resources[].details.aws_redshift_cluster.logging_status.last_failure_message

The message indicating that the logs failed to be delivered.

resources[].details.aws_redshift_cluster.logging_status.last_failure_time

The last time when logs failed to be delivered.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_redshift_cluster.logging_status.last_successful_delivery_time

The last time that logs were delivered successfully.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_redshift_cluster.logging_status.logging_enabled

Indicates whether logging is enabled.

resources[].details.aws_redshift_cluster.logging_status.s3_key_prefix

Provides the prefix applied to the log file names.

resources[].details.aws_redshift_cluster.maintenance_track_name

The name of the maintenance track for the cluster.

resources[].details.aws_redshift_cluster.manual_snapshot_retention_period

The default number of days to retain a manual snapshot.

If the value is -1, the snapshot is retained indefinitely.

This setting doesn't change the retention period of existing snapshots.

Valid values: Either -1 or an integer between 1 and 3,653

resources[].details.aws_redshift_cluster.master_username

The master user name for the cluster. This name is used to connect to the database that is specified in as the value of DBName.

resources[].details.aws_redshift_cluster.next_maintenance_window_start_time

Indicates the start of the next maintenance window.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_redshift_cluster.node_type

The node type for the nodes in the cluster.

resources[].details.aws_redshift_cluster.number_of_nodes

The number of compute nodes in the cluster.

resources[].details.aws_redshift_cluster.pending_actions[]
resources[].details.aws_redshift_cluster.pending_modified_values

A list of changes to the cluster that are currently pending.

Show child fields
resources[].details.aws_redshift_cluster.pending_modified_values.automated_snapshot_retention_period

The pending or in-progress change to the automated snapshot retention period.

resources[].details.aws_redshift_cluster.pending_modified_values.cluster_identifier

The pending or in-progress change to the identifier for the cluster.

resources[].details.aws_redshift_cluster.pending_modified_values.cluster_type

The pending or in-progress change to the cluster type.

resources[].details.aws_redshift_cluster.pending_modified_values.cluster_version

The pending or in-progress change to the service version.

resources[].details.aws_redshift_cluster.pending_modified_values.encryption_type

The encryption type for a cluster.

resources[].details.aws_redshift_cluster.pending_modified_values.enhanced_vpc_routing

Indicates whether to create the cluster with enhanced VPC routing enabled.

resources[].details.aws_redshift_cluster.pending_modified_values.maintenance_track_name

The name of the maintenance track that the cluster changes to during the next maintenance window.

resources[].details.aws_redshift_cluster.pending_modified_values.master_user_password

The pending or in-progress change to the master user password for the cluster.

resources[].details.aws_redshift_cluster.pending_modified_values.node_type

The pending or in-progress change to the cluster's node type.

resources[].details.aws_redshift_cluster.pending_modified_values.number_of_nodes

The pending or in-progress change to the number of nodes in the cluster.

resources[].details.aws_redshift_cluster.pending_modified_values.publicly_accessible

The pending or in-progress change to whether the cluster can be connected to from the public network.

resources[].details.aws_redshift_cluster.preferred_maintenance_window

The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.

Format: <day>:HH:MM-<day>:HH:MM

For the day values, use mon | tue | wed | thu | fri | sat | sun

For example, sun:09:32-sun:10:02

resources[].details.aws_redshift_cluster.publicly_accessible

Whether the cluster can be accessed from a public network.

resources[].details.aws_redshift_cluster.resize_info

Information about the resize operation for the cluster.

Show child fields
resources[].details.aws_redshift_cluster.resize_info.allow_cancel_resize

Indicates whether the resize operation can be canceled.

resources[].details.aws_redshift_cluster.resize_info.resize_type

The type of resize operation.

Valid values: ClassicResize

resources[].details.aws_redshift_cluster.restore_status

Information about the status of a cluster restore action. Only applies to a cluster that was created by restoring a snapshot.

Show child fields
resources[].details.aws_redshift_cluster.restore_status.current_restore_rate_in_mega_bytes_per_second

The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.

This field is only updated when you restore to DC2 and DS2 node types.

resources[].details.aws_redshift_cluster.restore_status.elapsed_time_in_seconds

The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.

This field is only updated when you restore to DC2 and DS2 node types.

resources[].details.aws_redshift_cluster.restore_status.estimated_time_to_completion_in_seconds

The estimate of the time remaining before the restore is complete. Returns 0 for a completed restore.

This field is only updated when you restore to DC2 and DS2 node types.

resources[].details.aws_redshift_cluster.restore_status.progress_in_mega_bytes

The number of megabytes that were transferred from snapshot storage.

This field is only updated when you restore to DC2 and DS2 node types.

resources[].details.aws_redshift_cluster.restore_status.snapshot_size_in_mega_bytes

The size of the set of snapshot data that was used to restore the cluster.

This field is only updated when you restore to DC2 and DS2 node types.

resources[].details.aws_redshift_cluster.restore_status.status

The status of the restore action.

Valid values: starting | restoring | completed | failed

resources[].details.aws_redshift_cluster.snapshot_schedule_identifier

A unique identifier for the cluster snapshot schedule.

resources[].details.aws_redshift_cluster.snapshot_schedule_state

The current state of the cluster snapshot schedule.

Valid values: MODIFYING | ACTIVE | FAILED

resources[].details.aws_redshift_cluster.vpc_id

The identifier of the VPC that the cluster is in, if the cluster is in a VPC.

resources[].details.aws_redshift_cluster.vpc_security_groups[]
Show child fields
resources[].details.aws_redshift_cluster.vpc_security_groups[].status

The status of the VPC security group.

resources[].details.aws_redshift_cluster.vpc_security_groups[].vpc_security_group_id

The identifier of the VPC security group.

resources[].details.aws_route53_hosted_zone

Provides details about an Amazon Route 53 hosted zone, including the four name servers assigned to the hosted zone. A hosted zone represents a collection of records that can be managed together, belonging to a single parent domain name.

Show child fields
resources[].details.aws_route53_hosted_zone.hosted_zone

An object that contains information about the specified hosted zone.

Show child fields
resources[].details.aws_route53_hosted_zone.hosted_zone.config

An object that includes the Comment element.

Show child fields
resources[].details.aws_route53_hosted_zone.hosted_zone.config.comment

Any comments that you include about the hosted zone.

resources[].details.aws_route53_hosted_zone.hosted_zone.id

The ID that Route 53 assigns to the hosted zone when you create it.

resources[].details.aws_route53_hosted_zone.hosted_zone.name

The name of the domain. For public hosted zones, this is the name that you have registered with your DNS registrar.

resources[].details.aws_route53_hosted_zone.name_servers[]
resources[].details.aws_route53_hosted_zone.query_logging_config

An array that contains one QueryLoggingConfig element for each DNS query logging configuration that is associated with the current Amazon Web Services account.

Show child fields
resources[].details.aws_route53_hosted_zone.query_logging_config.cloud_watch_logs_log_group_arn

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log group that Route 53 is publishing logs to.

Show child fields
resources[].details.aws_route53_hosted_zone.query_logging_config.cloud_watch_logs_log_group_arn.cloud_watch_logs_log_group_arn

The ARN of the CloudWatch Logs log group that Route 53 is publishing logs to.

resources[].details.aws_route53_hosted_zone.query_logging_config.cloud_watch_logs_log_group_arn.hosted_zone_id

The ID of the hosted zone that CloudWatch Logs is logging queries for.

resources[].details.aws_route53_hosted_zone.query_logging_config.cloud_watch_logs_log_group_arn.id

The ID for a DNS query logging configuration.

resources[].details.aws_route53_hosted_zone.vpcs[]
Show child fields
resources[].details.aws_route53_hosted_zone.vpcs[].id

The identifier of an Amazon VPC.

resources[].details.aws_route53_hosted_zone.vpcs[].region

The Amazon Web Services Region that an Amazon VPC was created in.

resources[].details.aws_s3_access_point

Provides details about an Amazon Simple Storage Service (Amazon S3) access point. S3 access points are named network endpoints that are attached to S3 buckets that you can use to perform S3 object operations.

Show child fields
resources[].details.aws_s3_access_point.access_point_arn

The Amazon Resource Name (ARN) of the access point.

resources[].details.aws_s3_access_point.alias

The name or alias of the access point.

resources[].details.aws_s3_access_point.bucket

The name of the S3 bucket associated with the specified access point.

resources[].details.aws_s3_access_point.bucket_account_id

The Amazon Web Services account ID associated with the S3 bucket associated with this access point.

resources[].details.aws_s3_access_point.name

The name of the specified access point.

resources[].details.aws_s3_access_point.network_origin

Indicates whether this access point allows access from the public internet.

resources[].details.aws_s3_access_point.public_access_block_configuration

provides information about the Amazon S3 Public Access Block configuration for accounts.

Show child fields
resources[].details.aws_s3_access_point.public_access_block_configuration.block_public_acls

Indicates whether to reject calls to update an S3 bucket if the calls include a public access control list (ACL).

resources[].details.aws_s3_access_point.public_access_block_configuration.block_public_policy

Indicates whether to reject calls to update the access policy for an S3 bucket or access point if the policy allows public access.

resources[].details.aws_s3_access_point.public_access_block_configuration.ignore_public_acls

Indicates whether Amazon S3 ignores public ACLs that are associated with an S3 bucket.

resources[].details.aws_s3_access_point.public_access_block_configuration.restrict_public_buckets

Indicates whether to restrict access to an access point or S3 bucket that has a public policy to only Amazon Web Services service principals and authorized users within the S3 bucket owner's account.

resources[].details.aws_s3_access_point.vpc_configuration

Contains the virtual private cloud (VPC) configuration for the specified access point.

Show child fields
resources[].details.aws_s3_access_point.vpc_configuration.vpc_id

If this field is specified, this access point will only allow connections from the specified VPC ID.

resources[].details.aws_s3_account_public_access_block

Details about the Amazon S3 Public Access Block configuration for an account.

Show child fields
resources[].details.aws_s3_account_public_access_block.block_public_acls

Indicates whether to reject calls to update an S3 bucket if the calls include a public access control list (ACL).

resources[].details.aws_s3_account_public_access_block.block_public_policy

Indicates whether to reject calls to update the access policy for an S3 bucket or access point if the policy allows public access.

resources[].details.aws_s3_account_public_access_block.ignore_public_acls

Indicates whether Amazon S3 ignores public ACLs that are associated with an S3 bucket.

resources[].details.aws_s3_account_public_access_block.restrict_public_buckets

Indicates whether to restrict access to an access point or S3 bucket that has a public policy to only Amazon Web Services service principals and authorized users within the S3 bucket owner's account.

resources[].details.aws_s3_bucket

Details about an S3 bucket related to a finding.

Show child fields
resources[].details.aws_s3_bucket.access_control_list

The access control list for the S3 bucket.

resources[].details.aws_s3_bucket.bucket_lifecycle_configuration

The lifecycle configuration for objects in the specified bucket.

Show child fields
resources[].details.aws_s3_bucket.bucket_lifecycle_configuration.rules[]
Show child fields
resources[].details.aws_s3_bucket.bucket_lifecycle_configuration.rules[].abort_incomplete_multipart_upload

How Amazon S3 responds when a multipart upload is incomplete. Specifically, provides a number of days before Amazon S3 cancels the entire upload.

Show child fields
resources[].details.aws_s3_bucket.bucket_lifecycle_configuration.rules[].abort_incomplete_multipart_upload.days_after_initiation

The number of days after which Amazon S3 cancels an incomplete multipart upload.

resources[].details.aws_s3_bucket.bucket_lifecycle_configuration.rules[].expiration_date

The date when objects are moved or deleted.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_s3_bucket.bucket_lifecycle_configuration.rules[].expiration_in_days

The length in days of the lifetime for objects that are subject to the rule.

resources[].details.aws_s3_bucket.bucket_lifecycle_configuration.rules[].expired_object_delete_marker

Whether Amazon S3 removes a delete marker that has no noncurrent versions. If set to true, the delete marker is expired. If set to false, the policy takes no action.

If you provide ExpiredObjectDeleteMarker, you cannot provide ExpirationInDays or ExpirationDate.

resources[].details.aws_s3_bucket.bucket_lifecycle_configuration.rules[].filter

Identifies the objects that a rule applies to.

Show child fields
resources[].details.aws_s3_bucket.bucket_lifecycle_configuration.rules[].filter.predicate

The configuration for the filter.

Show child fields
resources[].details.aws_s3_bucket.bucket_lifecycle_configuration.rules[].filter.predicate.operands[]
Show child fields
resources[].details.aws_s3_bucket.bucket_lifecycle_configuration.rules[].filter.predicate.operands[].prefix

Prefix text for matching objects.

resources[].details.aws_s3_bucket.bucket_lifecycle_configuration.rules[].filter.predicate.operands[].tag

A tag that is assigned to matching objects.

Show child fields
resources[].details.aws_s3_bucket.bucket_lifecycle_configuration.rules[].filter.predicate.operands[].tag.key

The tag key.

resources[].details.aws_s3_bucket.bucket_lifecycle_configuration.rules[].filter.predicate.operands[].tag.value

The tag value.

resources[].details.aws_s3_bucket.bucket_lifecycle_configuration.rules[].filter.predicate.operands[].type

The type of filter value. Valid values are LifecyclePrefixPredicate or LifecycleTagPredicate.

resources[].details.aws_s3_bucket.bucket_lifecycle_configuration.rules[].filter.predicate.prefix

A prefix filter.

resources[].details.aws_s3_bucket.bucket_lifecycle_configuration.rules[].filter.predicate.tag

A tag filter.

Show child fields
resources[].details.aws_s3_bucket.bucket_lifecycle_configuration.rules[].filter.predicate.tag.key

The tag key.

resources[].details.aws_s3_bucket.bucket_lifecycle_configuration.rules[].filter.predicate.tag.value

The tag value

resources[].details.aws_s3_bucket.bucket_lifecycle_configuration.rules[].filter.predicate.type

Whether to use AND or OR to join the operands. Valid values are LifecycleAndOperator or LifecycleOrOperator.

resources[].details.aws_s3_bucket.bucket_lifecycle_configuration.rules[].id

The unique identifier of the rule.

resources[].details.aws_s3_bucket.bucket_lifecycle_configuration.rules[].noncurrent_version_expiration_in_days

The number of days that an object is noncurrent before Amazon S3 can perform the associated action.

resources[].details.aws_s3_bucket.bucket_lifecycle_configuration.rules[].noncurrent_version_transitions[]
Show child fields
resources[].details.aws_s3_bucket.bucket_lifecycle_configuration.rules[].noncurrent_version_transitions[].days

The number of days that an object is noncurrent before Amazon S3 can perform the associated action.

resources[].details.aws_s3_bucket.bucket_lifecycle_configuration.rules[].noncurrent_version_transitions[].storage_class

The class of storage to change the object to after the object is noncurrent for the specified number of days.

resources[].details.aws_s3_bucket.bucket_lifecycle_configuration.rules[].prefix

A prefix that identifies one or more objects that the rule applies to.

resources[].details.aws_s3_bucket.bucket_lifecycle_configuration.rules[].status

The current status of the rule. Indicates whether the rule is currently being applied.

resources[].details.aws_s3_bucket.bucket_lifecycle_configuration.rules[].transitions[]
Show child fields
resources[].details.aws_s3_bucket.bucket_lifecycle_configuration.rules[].transitions[].date

A date on which to transition objects to the specified storage class. If you provide Date, you cannot provide Days.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_s3_bucket.bucket_lifecycle_configuration.rules[].transitions[].days

The number of days after which to transition the object to the specified storage class. If you provide Days, you cannot provide Date.

resources[].details.aws_s3_bucket.bucket_lifecycle_configuration.rules[].transitions[].storage_class

The storage class to transition the object to. Valid values are as follows:

  • DEEP_ARCHIVE

  • GLACIER

  • INTELLIGENT_TIERING

  • ONEZONE_IA

  • STANDARD_IA

resources[].details.aws_s3_bucket.bucket_logging_configuration

The logging configuration for the S3 bucket.

Show child fields
resources[].details.aws_s3_bucket.bucket_logging_configuration.destination_bucket_name

The name of the S3 bucket where log files for the S3 bucket are stored.

resources[].details.aws_s3_bucket.bucket_logging_configuration.log_file_prefix

The prefix added to log files for the S3 bucket.

resources[].details.aws_s3_bucket.bucket_notification_configuration

The notification configuration for the S3 bucket.

Show child fields
resources[].details.aws_s3_bucket.bucket_notification_configuration.configurations[]
Show child fields
resources[].details.aws_s3_bucket.bucket_notification_configuration.configurations[].destination

The ARN of the Lambda function, Amazon SQS queue, or Amazon SNS topic that generates the notification.

resources[].details.aws_s3_bucket.bucket_notification_configuration.configurations[].events[]
resources[].details.aws_s3_bucket.bucket_notification_configuration.configurations[].filter

The filters that determine which S3 buckets generate notifications.

Show child fields
resources[].details.aws_s3_bucket.bucket_notification_configuration.configurations[].filter.s3_key_filter

Details for an Amazon S3 filter.

Show child fields
resources[].details.aws_s3_bucket.bucket_notification_configuration.configurations[].filter.s3_key_filter.filter_rules[]
Show child fields
resources[].details.aws_s3_bucket.bucket_notification_configuration.configurations[].filter.s3_key_filter.filter_rules[].name

Indicates whether the filter is based on the prefix or suffix of the Amazon S3 key.

resources[].details.aws_s3_bucket.bucket_notification_configuration.configurations[].filter.s3_key_filter.filter_rules[].value

The filter value.

resources[].details.aws_s3_bucket.bucket_notification_configuration.configurations[].type

Indicates the type of notification. Notifications can be generated using Lambda functions, Amazon SQS queues, or Amazon SNS topics, with corresponding valid values as follows:

  • LambdaConfiguration

  • QueueConfiguration

  • TopicConfiguration

resources[].details.aws_s3_bucket.bucket_versioning_configuration

The versioning state of an S3 bucket.

Show child fields
resources[].details.aws_s3_bucket.bucket_versioning_configuration.is_mfa_delete_enabled

Specifies whether MFA delete is currently enabled in the S3 bucket versioning configuration. If the S3 bucket was never configured with MFA delete, then this attribute is not included.

resources[].details.aws_s3_bucket.bucket_versioning_configuration.status

The versioning status of the S3 bucket. Valid values are Enabled or Suspended.

resources[].details.aws_s3_bucket.bucket_website_configuration

The website configuration parameters for the S3 bucket.

Show child fields
resources[].details.aws_s3_bucket.bucket_website_configuration.error_document

The name of the error document for the website.

resources[].details.aws_s3_bucket.bucket_website_configuration.index_document_suffix

The name of the index document for the website.

resources[].details.aws_s3_bucket.bucket_website_configuration.redirect_all_requests_to

The redirect behavior for requests to the website.

Show child fields
resources[].details.aws_s3_bucket.bucket_website_configuration.redirect_all_requests_to.hostname

The name of the host to redirect requests to.

resources[].details.aws_s3_bucket.bucket_website_configuration.redirect_all_requests_to.protocol

The protocol to use when redirecting requests. By default, this field uses the same protocol as the original request. Valid values are http or https.

resources[].details.aws_s3_bucket.bucket_website_configuration.routing_rules[]
Show child fields
resources[].details.aws_s3_bucket.bucket_website_configuration.routing_rules[].condition

Provides the condition that must be met in order to apply the routing rule.

Show child fields
resources[].details.aws_s3_bucket.bucket_website_configuration.routing_rules[].condition.http_error_code_returned_equals

Indicates to redirect the request if the HTTP error code matches this value.

resources[].details.aws_s3_bucket.bucket_website_configuration.routing_rules[].condition.key_prefix_equals

Indicates to redirect the request if the key prefix matches this value.

resources[].details.aws_s3_bucket.bucket_website_configuration.routing_rules[].redirect

Provides the rules to redirect the request if the condition in Condition is met.

Show child fields
resources[].details.aws_s3_bucket.bucket_website_configuration.routing_rules[].redirect.hostname

The host name to use in the redirect request.

resources[].details.aws_s3_bucket.bucket_website_configuration.routing_rules[].redirect.http_redirect_code

The HTTP redirect code to use in the response.

resources[].details.aws_s3_bucket.bucket_website_configuration.routing_rules[].redirect.protocol

The protocol to use to redirect the request. By default, uses the protocol from the original request.

resources[].details.aws_s3_bucket.bucket_website_configuration.routing_rules[].redirect.replace_key_prefix_with

The object key prefix to use in the redirect request.

Cannot be provided if ReplaceKeyWith is present.

resources[].details.aws_s3_bucket.bucket_website_configuration.routing_rules[].redirect.replace_key_with

The specific object key to use in the redirect request.

Cannot be provided if ReplaceKeyPrefixWith is present.

resources[].details.aws_s3_bucket.created_at

Indicates when the S3 bucket was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_s3_bucket.name

The name of the bucket.

resources[].details.aws_s3_bucket.object_lock_configuration

Specifies which rule Amazon S3 applies by default to every new object placed in the bucket.

Show child fields
resources[].details.aws_s3_bucket.object_lock_configuration.object_lock_enabled

Indicates whether the bucket has an Object Lock configuration enabled.

resources[].details.aws_s3_bucket.object_lock_configuration.rule

Specifies the Object Lock rule for the specified object.

Show child fields
resources[].details.aws_s3_bucket.object_lock_configuration.rule.default_retention

The default Object Lock retention mode and period that you want to apply to new objects placed in the specified bucket.

Show child fields
resources[].details.aws_s3_bucket.object_lock_configuration.rule.default_retention.days

The number of days that you want to specify for the default retention period.

resources[].details.aws_s3_bucket.object_lock_configuration.rule.default_retention.mode

The default Object Lock retention mode you want to apply to new objects placed in the specified bucket.

resources[].details.aws_s3_bucket.object_lock_configuration.rule.default_retention.years

The number of years that you want to specify for the default retention period.

resources[].details.aws_s3_bucket.owner_account_id

The Amazon Web Services account identifier of the account that owns the S3 bucket.

resources[].details.aws_s3_bucket.owner_id

The canonical user ID of the owner of the S3 bucket.

resources[].details.aws_s3_bucket.owner_name

The display name of the owner of the S3 bucket.

resources[].details.aws_s3_bucket.public_access_block_configuration

Provides information about the Amazon S3 Public Access Block configuration for the S3 bucket.

Show child fields
resources[].details.aws_s3_bucket.public_access_block_configuration.block_public_acls

Indicates whether to reject calls to update an S3 bucket if the calls include a public access control list (ACL).

resources[].details.aws_s3_bucket.public_access_block_configuration.block_public_policy

Indicates whether to reject calls to update the access policy for an S3 bucket or access point if the policy allows public access.

resources[].details.aws_s3_bucket.public_access_block_configuration.ignore_public_acls

Indicates whether Amazon S3 ignores public ACLs that are associated with an S3 bucket.

resources[].details.aws_s3_bucket.public_access_block_configuration.restrict_public_buckets

Indicates whether to restrict access to an access point or S3 bucket that has a public policy to only Amazon Web Services service principals and authorized users within the S3 bucket owner's account.

resources[].details.aws_s3_bucket.server_side_encryption_configuration

The encryption rules that are applied to the S3 bucket.

Show child fields
resources[].details.aws_s3_bucket.server_side_encryption_configuration.rules[]
Show child fields
resources[].details.aws_s3_bucket.server_side_encryption_configuration.rules[].apply_server_side_encryption_by_default

Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT object request doesn't specify any server-side encryption, this default encryption is applied.

Show child fields
resources[].details.aws_s3_bucket.server_side_encryption_configuration.rules[].apply_server_side_encryption_by_default.kms_master_key_id

KMS key ID to use for the default encryption.

resources[].details.aws_s3_bucket.server_side_encryption_configuration.rules[].apply_server_side_encryption_by_default.sse_algorithm

Server-side encryption algorithm to use for the default encryption. Valid values are aws: kms or AES256.

resources[].details.aws_s3_object

Details about an S3 object related to a finding.

Show child fields
resources[].details.aws_s3_object.content_type

A standard MIME type describing the format of the object data.

resources[].details.aws_s3_object.e_tag

The opaque identifier assigned by a web server to a specific version of a resource found at a URL.

resources[].details.aws_s3_object.last_modified

Indicates when the object was last modified.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.aws_s3_object.server_side_encryption

If the object is stored using server-side encryption, the value of the server-side encryption algorithm used when storing this object in Amazon S3.

resources[].details.aws_s3_object.ssekms_key_id

The identifier of the KMS symmetric customer managed key that was used for the object.

resources[].details.aws_s3_object.version_id

The version of the object.

resources[].details.aws_sage_maker_notebook_instance

Provides details about an Amazon SageMaker notebook instance.

Show child fields
resources[].details.aws_sage_maker_notebook_instance.accelerator_types[]
resources[].details.aws_sage_maker_notebook_instance.additional_code_repositories[]
resources[].details.aws_sage_maker_notebook_instance.default_code_repository

The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git repositories with SageMaker notebook instances in the Amazon SageMaker Developer Guide.

resources[].details.aws_sage_maker_notebook_instance.direct_internet_access

Sets whether SageMaker provides internet access to the notebook instance. If you set this to Disabled, this notebook instance is able to access resources only in your VPC, and is not be able to connect to SageMaker training and endpoint services unless you configure a Network Address Translation (NAT) Gateway in your VPC.

resources[].details.aws_sage_maker_notebook_instance.failure_reason

If status of the instance is Failed, the reason it failed.

resources[].details.aws_sage_maker_notebook_instance.instance_metadata_service_configuration

Information on the IMDS configuration of the notebook instance.

Show child fields
resources[].details.aws_sage_maker_notebook_instance.instance_metadata_service_configuration.minimum_instance_metadata_service_version

Indicates the minimum IMDS version that the notebook instance supports.

resources[].details.aws_sage_maker_notebook_instance.instance_type

The type of machine learning (ML) compute instance to launch for the notebook instance.

resources[].details.aws_sage_maker_notebook_instance.kms_key_id

The Amazon Resource Name (ARN) of an Key Management Service (KMS) key that SageMaker uses to encrypt data on the storage volume attached to your notebook instance. The KMS key you provide must be enabled. For information, see Enabling and disabling keys in the Key Management Service Developer Guide.

resources[].details.aws_sage_maker_notebook_instance.network_interface_id

The network interface ID that SageMaker created when the instance was created.

resources[].details.aws_sage_maker_notebook_instance.notebook_instance_arn

The Amazon Resource Name (ARN) of the notebook instance.

resources[].details.aws_sage_maker_notebook_instance.notebook_instance_lifecycle_config_name

The name of a notebook instance lifecycle configuration.

resources[].details.aws_sage_maker_notebook_instance.notebook_instance_name

The name of the new notebook instance.

resources[].details.aws_sage_maker_notebook_instance.notebook_instance_status

The status of the notebook instance.

resources[].details.aws_sage_maker_notebook_instance.platform_identifier

The platform identifier of the notebook instance runtime environment.

resources[].details.aws_sage_maker_notebook_instance.role_arn

The Amazon Resource Name (ARN) of the IAM role associated with the instance.

resources[].details.aws_sage_maker_notebook_instance.root_access

Whether root access is enabled or disabled for users of the notebook instance.

resources[].details.aws_sage_maker_notebook_instance.security_groups[]
resources[].details.aws_sage_maker_notebook_instance.subnet_id

The ID of the VPC subnet to which you have a connectivity from your ML compute instance.

resources[].details.aws_sage_maker_notebook_instance.url

The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.

resources[].details.aws_sage_maker_notebook_instance.volume_size_in_gb

The size, in GB, of the ML storage volume to attach to the notebook instance.

resources[].details.aws_secrets_manager_secret

Details about a Secrets Manager secret.

Show child fields
resources[].details.aws_secrets_manager_secret.deleted

Whether the secret is deleted.

resources[].details.aws_secrets_manager_secret.description

The user-provided description of the secret.

resources[].details.aws_secrets_manager_secret.kms_key_id

The ARN, Key ID, or alias of the KMS key used to encrypt the SecretString or SecretBinary values for versions of this secret.

resources[].details.aws_secrets_manager_secret.name

The name of the secret.

resources[].details.aws_secrets_manager_secret.rotation_enabled

Whether rotation is enabled.

resources[].details.aws_secrets_manager_secret.rotation_lambda_arn

The ARN of the Lambda function that rotates the secret.

resources[].details.aws_secrets_manager_secret.rotation_occurred_within_frequency

Whether the rotation occurred within the specified rotation frequency.

resources[].details.aws_secrets_manager_secret.rotation_rules

Defines the rotation schedule for the secret.

Show child fields
resources[].details.aws_secrets_manager_secret.rotation_rules.automatically_after_days

The number of days after the previous rotation to rotate the secret.

resources[].details.aws_sns_topic

Details about an SNS topic.

Show child fields
resources[].details.aws_sns_topic.application_success_feedback_role_arn

Indicates failed message delivery status for an Amazon SNS topic that is subscribed to a platform application endpoint.

resources[].details.aws_sns_topic.firehose_failure_feedback_role_arn

Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.

resources[].details.aws_sns_topic.firehose_success_feedback_role_arn

Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.

resources[].details.aws_sns_topic.http_failure_feedback_role_arn

Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.

resources[].details.aws_sns_topic.http_success_feedback_role_arn

Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.

resources[].details.aws_sns_topic.kms_master_key_id

The ID of an Amazon Web Services managed key for Amazon SNS or a customer managed key.

resources[].details.aws_sns_topic.owner

The subscription's owner.

resources[].details.aws_sns_topic.sqs_failure_feedback_role_arn

Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.

resources[].details.aws_sns_topic.sqs_success_feedback_role_arn

Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.

resources[].details.aws_sns_topic.subscription[]
Show child fields
resources[].details.aws_sns_topic.subscription[].endpoint

The subscription's endpoint (format depends on the protocol).

resources[].details.aws_sns_topic.subscription[].protocol

The subscription's protocol.

resources[].details.aws_sns_topic.topic_name

The name of the Amazon SNS topic.

resources[].details.aws_sqs_queue

Details about an SQS queue.

Show child fields
resources[].details.aws_sqs_queue.dead_letter_target_arn

The ARN of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.

resources[].details.aws_sqs_queue.kms_data_key_reuse_period_seconds

The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling KMS again.

resources[].details.aws_sqs_queue.kms_master_key_id

The ID of an Amazon Web Services managed key for Amazon SQS or a custom KMS key.

resources[].details.aws_sqs_queue.queue_name

The name of the new queue.

resources[].details.aws_ssm_patch_compliance

Provides information about the state of a patch on an instance based on the patch baseline that was used to patch the instance.

Show child fields
resources[].details.aws_ssm_patch_compliance.patch

Information about the status of a patch.

Show child fields
resources[].details.aws_ssm_patch_compliance.patch.compliance_summary

The compliance status details for the patch.

Show child fields
resources[].details.aws_ssm_patch_compliance.patch.compliance_summary.compliance_type

The type of resource for which the compliance was determined. For AwsSsmPatchCompliance, ComplianceType is Patch.

resources[].details.aws_ssm_patch_compliance.patch.compliance_summary.compliant_critical_count

For the patches that are compliant, the number that have a severity of CRITICAL.

resources[].details.aws_ssm_patch_compliance.patch.compliance_summary.compliant_high_count

For the patches that are compliant, the number that have a severity of HIGH.

resources[].details.aws_ssm_patch_compliance.patch.compliance_summary.compliant_informational_count

For the patches that are compliant, the number that have a severity of INFORMATIONAL.

resources[].details.aws_ssm_patch_compliance.patch.compliance_summary.compliant_low_count

For the patches that are compliant, the number that have a severity of LOW.

resources[].details.aws_ssm_patch_compliance.patch.compliance_summary.compliant_medium_count

For the patches that are compliant, the number that have a severity of MEDIUM.

resources[].details.aws_ssm_patch_compliance.patch.compliance_summary.compliant_unspecified_count

For the patches that are compliant, the number that have a severity of UNSPECIFIED.

resources[].details.aws_ssm_patch_compliance.patch.compliance_summary.execution_type

The type of execution that was used determine compliance.

resources[].details.aws_ssm_patch_compliance.patch.compliance_summary.non_compliant_critical_count

For the patch items that are noncompliant, the number of items that have a severity of CRITICAL.

resources[].details.aws_ssm_patch_compliance.patch.compliance_summary.non_compliant_high_count

For the patches that are noncompliant, the number that have a severity of HIGH.

resources[].details.aws_ssm_patch_compliance.patch.compliance_summary.non_compliant_informational_count

For the patches that are noncompliant, the number that have a severity of INFORMATIONAL.

resources[].details.aws_ssm_patch_compliance.patch.compliance_summary.non_compliant_low_count

For the patches that are noncompliant, the number that have a severity of LOW.

resources[].details.aws_ssm_patch_compliance.patch.compliance_summary.non_compliant_medium_count

For the patches that are noncompliant, the number that have a severity of MEDIUM.

resources[].details.aws_ssm_patch_compliance.patch.compliance_summary.non_compliant_unspecified_count

For the patches that are noncompliant, the number that have a severity of UNSPECIFIED.

resources[].details.aws_ssm_patch_compliance.patch.compliance_summary.overall_severity

The highest severity for the patches. Valid values are as follows:

  • CRITICAL

  • HIGH

  • MEDIUM

  • LOW

  • INFORMATIONAL

  • UNSPECIFIED

resources[].details.aws_ssm_patch_compliance.patch.compliance_summary.patch_baseline_id

The identifier of the patch baseline. The patch baseline lists the patches that are approved for installation.

resources[].details.aws_ssm_patch_compliance.patch.compliance_summary.patch_group

The identifier of the patch group for which compliance was determined. A patch group uses tags to group EC2 instances that should have the same patch compliance.

resources[].details.aws_ssm_patch_compliance.patch.compliance_summary.status

The current patch compliance status. Valid values are as follows:

  • COMPLIANT

  • NON_COMPLIANT

  • UNSPECIFIED_DATA

resources[].details.aws_step_function_state_machine

Provides details about an Step Functions state machine, which is a workflow consisting of a series of event-driven steps.

Show child fields
resources[].details.aws_step_function_state_machine.label

A user-defined or an auto-generated string that identifies a Map state. This parameter is present only if the stateMachineArn specified in input is a qualified state machine ARN.

resources[].details.aws_step_function_state_machine.logging_configuration

Used to set CloudWatch Logs options.

Show child fields
resources[].details.aws_step_function_state_machine.logging_configuration.destinations[]
Show child fields
resources[].details.aws_step_function_state_machine.logging_configuration.destinations[].cloud_watch_logs_log_group

An object describing a CloudWatch Logs log group. For more information, see Amazon Web Services::Logs::LogGroup in the CloudFormation User Guide.

Show child fields
resources[].details.aws_step_function_state_machine.logging_configuration.destinations[].cloud_watch_logs_log_group.log_group_arn

The ARN (ends with :*) of the CloudWatch Logs log group to which you want your logs emitted.

resources[].details.aws_step_function_state_machine.logging_configuration.include_execution_data

Determines whether execution data is included in your log. When set to false, data is excluded.

resources[].details.aws_step_function_state_machine.logging_configuration.level

Defines which category of execution history events are logged.

resources[].details.aws_step_function_state_machine.name

The name of the state machine.

resources[].details.aws_step_function_state_machine.role_arn

The Amazon Resource Name (ARN) of the IAM role used when creating this state machine.

resources[].details.aws_step_function_state_machine.state_machine_arn

The ARN that identifies the state machine.

resources[].details.aws_step_function_state_machine.status

The current status of the state machine.

resources[].details.aws_step_function_state_machine.tracing_configuration

Specifies whether X-Ray tracing is enabled.

Show child fields
resources[].details.aws_step_function_state_machine.tracing_configuration.enabled

When set to true, X-Ray tracing is enabled.

resources[].details.aws_step_function_state_machine.type

The type of the state machine (STANDARD or EXPRESS).

resources[].details.aws_waf_rate_based_rule

Details about a rate-based rule for global resources.

Show child fields
resources[].details.aws_waf_rate_based_rule.match_predicates[]
Show child fields
resources[].details.aws_waf_rate_based_rule.match_predicates[].data_id

The unique identifier for the predicate.

resources[].details.aws_waf_rate_based_rule.match_predicates[].negated

If set to true, then the rule actions are performed on requests that match the predicate settings.

If set to false, then the rule actions are performed on all requests except those that match the predicate settings.

resources[].details.aws_waf_rate_based_rule.match_predicates[].type

The type of predicate. Valid values are as follows:

  • ByteMatch

  • GeoMatch

  • IPMatch

  • RegexMatch

  • SizeConstraint

  • SqlInjectionMatch

  • XssMatch

resources[].details.aws_waf_rate_based_rule.metric_name

The name of the metrics for the rate-based rule.

resources[].details.aws_waf_rate_based_rule.name

The name of the rate-based rule.

resources[].details.aws_waf_rate_based_rule.rate_key

The field that WAF uses to determine whether requests are likely arriving from single source and are subject to rate monitoring.

resources[].details.aws_waf_rate_based_rule.rate_limit

The maximum number of requests that have an identical value for the field specified in RateKey that are allowed within a five-minute period. If the number of requests exceeds RateLimit and the other predicates specified in the rule are met, WAF triggers the action for the rule.

resources[].details.aws_waf_rate_based_rule.rule_id

The unique identifier for the rate-based rule.

resources[].details.aws_waf_regional_rate_based_rule

Details about a rate-based rule for Regional resources.

Show child fields
resources[].details.aws_waf_regional_rate_based_rule.match_predicates[]
Show child fields
resources[].details.aws_waf_regional_rate_based_rule.match_predicates[].data_id

The unique identifier for the predicate.

resources[].details.aws_waf_regional_rate_based_rule.match_predicates[].negated

If set to true, then the rule actions are performed on requests that match the predicate settings.

If set to false, then the rule actions are performed on all requests except those that match the predicate settings.

resources[].details.aws_waf_regional_rate_based_rule.match_predicates[].type

The type of predicate. Valid values are as follows:

  • ByteMatch

  • GeoMatch

  • IPMatch

  • RegexMatch

  • SizeConstraint

  • SqlInjectionMatch

  • XssMatch

resources[].details.aws_waf_regional_rate_based_rule.metric_name

The name of the metrics for the rate-based rule.

resources[].details.aws_waf_regional_rate_based_rule.name

The name of the rate-based rule.

resources[].details.aws_waf_regional_rate_based_rule.rate_key

The field that WAF uses to determine whether requests are likely arriving from single source and are subject to rate monitoring.

resources[].details.aws_waf_regional_rate_based_rule.rate_limit

The maximum number of requests that have an identical value for the field specified in RateKey that are allowed within a five-minute period. If the number of requests exceeds RateLimit and the other predicates specified in the rule are met, WAF triggers the action for the rule.

resources[].details.aws_waf_regional_rate_based_rule.rule_id

The unique identifier for the rate-based rule.

resources[].details.aws_waf_regional_rule

Details about an WAF rule for Regional resources.

Show child fields
resources[].details.aws_waf_regional_rule.metric_name

A name for the metrics for the rule.

resources[].details.aws_waf_regional_rule.name

A descriptive name for the rule.

resources[].details.aws_waf_regional_rule.predicate_list[]
Show child fields
resources[].details.aws_waf_regional_rule.predicate_list[].data_id

A unique identifier for a predicate in a rule, such as ByteMatchSetId or IPSetId.

resources[].details.aws_waf_regional_rule.predicate_list[].negated

Specifies if you want WAF to allow, block, or count requests based on the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet.

resources[].details.aws_waf_regional_rule.predicate_list[].type

The type of predicate in a rule, such as ByteMatch or IPSet.

resources[].details.aws_waf_regional_rule.rule_id

The ID of the rule.

resources[].details.aws_waf_regional_rule_group

Details about an WAF rule group for Regional resources.

Show child fields
resources[].details.aws_waf_regional_rule_group.metric_name

A name for the metrics for this rule group.

resources[].details.aws_waf_regional_rule_group.name

The descriptive name of the rule group.

resources[].details.aws_waf_regional_rule_group.rule_group_id

The ID of the rule group.

resources[].details.aws_waf_regional_rule_group.rules[]
Show child fields
resources[].details.aws_waf_regional_rule_group.rules[].action

The action that WAF should take on a web request when it matches the criteria defined in the rule.

Show child fields
resources[].details.aws_waf_regional_rule_group.rules[].action.type

Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add to a rule and, for each object, indicates whether you want to negate the settings.

resources[].details.aws_waf_regional_rule_group.rules[].priority

If you define more than one rule in a web ACL, WAF evaluates each request against the rules in order based on the value of Priority.

resources[].details.aws_waf_regional_rule_group.rules[].rule_id

The ID for a rule.

resources[].details.aws_waf_regional_rule_group.rules[].type

The type of rule in the rule group.

resources[].details.aws_waf_regional_web_acl

Details about an WAF web access control list (web ACL) for Regional resources.

Show child fields
resources[].details.aws_waf_regional_web_acl.default_action

The action to perform if none of the rules contained in the web ACL match.

resources[].details.aws_waf_regional_web_acl.metric_name

A name for the metrics for this web ACL.

resources[].details.aws_waf_regional_web_acl.name

A descriptive name for the web ACL.

resources[].details.aws_waf_regional_web_acl.rules_list[]
Show child fields
resources[].details.aws_waf_regional_web_acl.rules_list[].action

The action that WAF takes when a web request matches all conditions in the rule, such as allow, block, or count the request.

Show child fields
resources[].details.aws_waf_regional_web_acl.rules_list[].action.type

For actions that are associated with a rule, the action that WAF takes when a web request matches all conditions in a rule.

resources[].details.aws_waf_regional_web_acl.rules_list[].override_action

Overrides the rule evaluation result in the rule group.

Show child fields
resources[].details.aws_waf_regional_web_acl.rules_list[].override_action.type

Overrides the rule evaluation result in the rule group.

resources[].details.aws_waf_regional_web_acl.rules_list[].priority

The order in which WAF evaluates the rules in a web ACL.

resources[].details.aws_waf_regional_web_acl.rules_list[].rule_id

The ID of an WAF Regional rule to associate with a web ACL.

resources[].details.aws_waf_regional_web_acl.rules_list[].type

For actions that are associated with a rule, the action that WAF takes when a web request matches all conditions in a rule.

resources[].details.aws_waf_regional_web_acl.web_acl_id

The ID of the web ACL.

resources[].details.aws_waf_rule

Details about an WAF rule for global resources.

Show child fields
resources[].details.aws_waf_rule.metric_name

The name of the metrics for this rule.

resources[].details.aws_waf_rule.name

A descriptive name for the rule.

resources[].details.aws_waf_rule.predicate_list[]
Show child fields
resources[].details.aws_waf_rule.predicate_list[].data_id

A unique identifier for a predicate in a rule, such as ByteMatchSetId or IPSetId.

resources[].details.aws_waf_rule.predicate_list[].negated

Specifies if you want WAF to allow, block, or count requests based on the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet.

resources[].details.aws_waf_rule.predicate_list[].type

The type of predicate in a rule, such as ByteMatch or IPSet.

resources[].details.aws_waf_rule.rule_id

The ID of the WAF rule.

resources[].details.aws_waf_rule_group

Details about an WAF rule group for global resources.

Show child fields
resources[].details.aws_waf_rule_group.metric_name

The name of the metrics for this rule group.

resources[].details.aws_waf_rule_group.name

The name of the rule group.

resources[].details.aws_waf_rule_group.rule_group_id

The ID of the rule group.

resources[].details.aws_waf_rule_group.rules[]
Show child fields
resources[].details.aws_waf_rule_group.rules[].action

Provides information about what action WAF should take on a web request when it matches the criteria defined in the rule.

Show child fields
resources[].details.aws_waf_rule_group.rules[].action.type

The action that WAF should take on a web request when it matches the rule's statement.

resources[].details.aws_waf_rule_group.rules[].priority

If you define more than one rule in a web ACL, WAF evaluates each request against the rules in order based on the value of Priority.

resources[].details.aws_waf_rule_group.rules[].rule_id

The rule ID for a rule.

resources[].details.aws_waf_rule_group.rules[].type

The type of rule.

resources[].details.aws_waf_web_acl

Details for an WAF web ACL.

Show child fields
resources[].details.aws_waf_web_acl.default_action

The action to perform if none of the rules contained in the web ACL match.

resources[].details.aws_waf_web_acl.name

A friendly name or description of the web ACL. You can't change the name of a web ACL after you create it.

resources[].details.aws_waf_web_acl.rules[]
Show child fields
resources[].details.aws_waf_web_acl.rules[].action

Specifies the action that CloudFront or WAF takes when a web request matches the conditions in the rule.

Show child fields
resources[].details.aws_waf_web_acl.rules[].action.type

Specifies how you want WAF to respond to requests that match the settings in a rule.

Valid settings include the following:

  • ALLOW - WAF allows requests

  • BLOCK - WAF blocks requests

  • COUNT - WAF increments a counter of the requests that match all of the conditions in the rule. WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify COUNT for the default action for a web ACL.

resources[].details.aws_waf_web_acl.rules[].excluded_rules[]
Show child fields
resources[].details.aws_waf_web_acl.rules[].excluded_rules[].rule_id

The unique identifier for the rule to exclude from the rule group.

resources[].details.aws_waf_web_acl.rules[].override_action

Use the OverrideAction to test your RuleGroup.

Any rule in a RuleGroup can potentially block a request. If you set the OverrideAction to None, the RuleGroup blocks a request if any individual rule in the RuleGroup matches the request and is configured to block that request.

However, if you first want to test the RuleGroup, set the OverrideAction to Count. The RuleGroup then overrides any block action specified by individual rules contained within the group. Instead of blocking matching requests, those requests are counted.

ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a web ACL. In this case you do not use ActivatedRule Action. For all other update requests, ActivatedRule Action is used instead of ActivatedRule OverrideAction.

Show child fields
resources[].details.aws_waf_web_acl.rules[].override_action.type

COUNT overrides the action specified by the individual rule within a RuleGroup .

If set to NONE, the rule's action takes place.

resources[].details.aws_waf_web_acl.rules[].priority

Specifies the order in which the rules in a web ACL are evaluated. Rules with a lower value for Priority are evaluated before rules with a higher value. The value must be a unique integer. If you add multiple rules to a web ACL, the values do not need to be consecutive.

resources[].details.aws_waf_web_acl.rules[].rule_id

The identifier for a rule.

resources[].details.aws_waf_web_acl.rules[].type

The rule type.

Valid values: REGULAR | RATE_BASED | GROUP

The default is REGULAR.

resources[].details.aws_waf_web_acl.web_acl_id

A unique identifier for a web ACL.

resources[].details.aws_wafv2_rule_group

Details about an WAFv2 rule group.

Show child fields
resources[].details.aws_wafv2_rule_group.arn

The Amazon Resource Name (ARN) of the entity.

resources[].details.aws_wafv2_rule_group.capacity

The web ACL capacity units (WCUs) required for this rule group.

resources[].details.aws_wafv2_rule_group.description

A description of the rule group that helps with identification.

resources[].details.aws_wafv2_rule_group.id

A unique identifier for the rule group.

resources[].details.aws_wafv2_rule_group.name

The name of the rule group. You cannot change the name of a rule group after you create it.

resources[].details.aws_wafv2_rule_group.rules[]
Show child fields
resources[].details.aws_wafv2_rule_group.rules[].action

The action that WAF should take on a web request when it matches the rule statement. Settings at the web ACL level can override the rule action setting.

Show child fields
resources[].details.aws_wafv2_rule_group.rules[].action.allow

Instructs WAF to allow the web request.

Show child fields
resources[].details.aws_wafv2_rule_group.rules[].action.allow.custom_request_handling

Defines custom handling for the web request. For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide..

Show child fields
resources[].details.aws_wafv2_rule_group.rules[].action.allow.custom_request_handling.insert_headers[]
Show child fields
resources[].details.aws_wafv2_rule_group.rules[].action.allow.custom_request_handling.insert_headers[].name

The name of the custom header.

resources[].details.aws_wafv2_rule_group.rules[].action.allow.custom_request_handling.insert_headers[].value

The value of the custom header.

resources[].details.aws_wafv2_rule_group.rules[].action.block

Instructs WAF to block the web request.

Show child fields
resources[].details.aws_wafv2_rule_group.rules[].action.block.custom_response

Defines a custom response for the web request. For information, see Customizing web requests and responses in WAF in the WAF Developer Guide..

Show child fields
resources[].details.aws_wafv2_rule_group.rules[].action.block.custom_response.custom_response_body_key

References the response body that you want WAF to return to the web request client. You can define a custom response for a rule action or a default web ACL action that is set to block.

resources[].details.aws_wafv2_rule_group.rules[].action.block.custom_response.response_code

The HTTP status code to return to the client. For a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the WAF Developer Guide.

resources[].details.aws_wafv2_rule_group.rules[].action.block.custom_response.response_headers[]
Show child fields
resources[].details.aws_wafv2_rule_group.rules[].action.block.custom_response.response_headers[].name

The name of the custom header.

resources[].details.aws_wafv2_rule_group.rules[].action.block.custom_response.response_headers[].value

The value of the custom header.

resources[].details.aws_wafv2_rule_group.rules[].action.captcha

Instructs WAF to run a CAPTCHA check against the web request.

Show child fields
resources[].details.aws_wafv2_rule_group.rules[].action.captcha.custom_request_handling

Defines custom handling for the web request, used when the CAPTCHA inspection determines that the request's token is valid and unexpired. For more information, see Customizing web requests and responses in WAF in the WAF Developer Guide..

Show child fields
resources[].details.aws_wafv2_rule_group.rules[].action.captcha.custom_request_handling.insert_headers[]
Show child fields
resources[].details.aws_wafv2_rule_group.rules[].action.captcha.custom_request_handling.insert_headers[].name

The name of the custom header.

resources[].details.aws_wafv2_rule_group.rules[].action.captcha.custom_request_handling.insert_headers[].value

The value of the custom header.

resources[].details.aws_wafv2_rule_group.rules[].action.count

Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.

Show child fields
resources[].details.aws_wafv2_rule_group.rules[].action.count.custom_request_handling

Defines custom handling for the web request. For more information, see Customizing web requests and responses in WAF in the WAF Developer Guide..

Show child fields
resources[].details.aws_wafv2_rule_group.rules[].action.count.custom_request_handling.insert_headers[]
Show child fields
resources[].details.aws_wafv2_rule_group.rules[].action.count.custom_request_handling.insert_headers[].name

The name of the custom header.

resources[].details.aws_wafv2_rule_group.rules[].action.count.custom_request_handling.insert_headers[].value

The value of the custom header.

resources[].details.aws_wafv2_rule_group.rules[].name

The name of the rule.

resources[].details.aws_wafv2_rule_group.rules[].override_action

The action to use in the place of the action that results from the rule group evaluation.

resources[].details.aws_wafv2_rule_group.rules[].priority

If you define more than one Rule in a WebACL, WAF evaluates each request against the Rules in order based on the value of Priority. WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.

resources[].details.aws_wafv2_rule_group.rules[].visibility_config

Defines and enables Amazon CloudWatch metrics and web request sample collection.

Show child fields
resources[].details.aws_wafv2_rule_group.rules[].visibility_config.cloud_watch_metrics_enabled

A boolean indicating whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF metrics and dimensions in the WAF Developer Guide.

resources[].details.aws_wafv2_rule_group.rules[].visibility_config.metric_name

A name of the Amazon CloudWatch metric.

resources[].details.aws_wafv2_rule_group.rules[].visibility_config.sampled_requests_enabled

A boolean indicating whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console.

resources[].details.aws_wafv2_rule_group.scope

Specifies whether the rule group is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.

resources[].details.aws_wafv2_rule_group.visibility_config

Defines and enables Amazon CloudWatch metrics and web request sample collection.

Show child fields
resources[].details.aws_wafv2_rule_group.visibility_config.cloud_watch_metrics_enabled

A boolean indicating whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF metrics and dimensions in the WAF Developer Guide.

resources[].details.aws_wafv2_rule_group.visibility_config.metric_name

A name of the Amazon CloudWatch metric.

resources[].details.aws_wafv2_rule_group.visibility_config.sampled_requests_enabled

A boolean indicating whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console.

resources[].details.aws_wafv2_web_acl

Details about an WAFv2 web Access Control List (ACL).

Show child fields
resources[].details.aws_wafv2_web_acl.arn

The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.

resources[].details.aws_wafv2_web_acl.capacity

The web ACL capacity units (WCUs) currently being used by this web ACL.

resources[].details.aws_wafv2_web_acl.captcha_config

Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings.

Show child fields
resources[].details.aws_wafv2_web_acl.captcha_config.immunity_time_property

Determines how long a CAPTCHA timestamp in the token remains valid after the client successfully solves a CAPTCHA puzzle.

Show child fields
resources[].details.aws_wafv2_web_acl.captcha_config.immunity_time_property.immunity_time

The amount of time, in seconds, that a CAPTCHA or challenge timestamp is considered valid by WAF.

resources[].details.aws_wafv2_web_acl.default_action

The action to perform if none of the Rules contained in the web ACL match.

Show child fields
resources[].details.aws_wafv2_web_acl.default_action.allow

Specifies that WAF should allow requests by default.

Show child fields
resources[].details.aws_wafv2_web_acl.default_action.allow.custom_request_handling

Defines custom handling for the web request. For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide..

Show child fields
resources[].details.aws_wafv2_web_acl.default_action.allow.custom_request_handling.insert_headers[]
Show child fields
resources[].details.aws_wafv2_web_acl.default_action.allow.custom_request_handling.insert_headers[].name

The name of the custom header.

resources[].details.aws_wafv2_web_acl.default_action.allow.custom_request_handling.insert_headers[].value

The value of the custom header.

resources[].details.aws_wafv2_web_acl.default_action.block

Specifies that WAF should block requests by default.

Show child fields
resources[].details.aws_wafv2_web_acl.default_action.block.custom_response

Defines a custom response for the web request. For information, see Customizing web requests and responses in WAF in the WAF Developer Guide..

Show child fields
resources[].details.aws_wafv2_web_acl.default_action.block.custom_response.custom_response_body_key

References the response body that you want WAF to return to the web request client. You can define a custom response for a rule action or a default web ACL action that is set to block.

resources[].details.aws_wafv2_web_acl.default_action.block.custom_response.response_code

The HTTP status code to return to the client. For a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the WAF Developer Guide.

resources[].details.aws_wafv2_web_acl.default_action.block.custom_response.response_headers[]
Show child fields
resources[].details.aws_wafv2_web_acl.default_action.block.custom_response.response_headers[].name

The name of the custom header.

resources[].details.aws_wafv2_web_acl.default_action.block.custom_response.response_headers[].value

The value of the custom header.

resources[].details.aws_wafv2_web_acl.description

A description of the web ACL that helps with identification.

resources[].details.aws_wafv2_web_acl.id

A unique identifier for the web ACL.

resources[].details.aws_wafv2_web_acl.managedby_firewall_manager

Indicates whether this web ACL is managed by Firewall Manager.

resources[].details.aws_wafv2_web_acl.name

The name of the web ACL.

resources[].details.aws_wafv2_web_acl.rules[]
Show child fields
resources[].details.aws_wafv2_web_acl.rules[].action

The action that WAF should take on a web request when it matches the rule statement. Settings at the web ACL level can override the rule action setting.

Show child fields
resources[].details.aws_wafv2_web_acl.rules[].action.allow

Instructs WAF to allow the web request.

Show child fields
resources[].details.aws_wafv2_web_acl.rules[].action.allow.custom_request_handling

Defines custom handling for the web request. For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide..

Show child fields
resources[].details.aws_wafv2_web_acl.rules[].action.allow.custom_request_handling.insert_headers[]
Show child fields
resources[].details.aws_wafv2_web_acl.rules[].action.allow.custom_request_handling.insert_headers[].name

The name of the custom header.

resources[].details.aws_wafv2_web_acl.rules[].action.allow.custom_request_handling.insert_headers[].value

The value of the custom header.

resources[].details.aws_wafv2_web_acl.rules[].action.block

Instructs WAF to block the web request.

Show child fields
resources[].details.aws_wafv2_web_acl.rules[].action.block.custom_response

Defines a custom response for the web request. For information, see Customizing web requests and responses in WAF in the WAF Developer Guide..

Show child fields
resources[].details.aws_wafv2_web_acl.rules[].action.block.custom_response.custom_response_body_key

References the response body that you want WAF to return to the web request client. You can define a custom response for a rule action or a default web ACL action that is set to block.

resources[].details.aws_wafv2_web_acl.rules[].action.block.custom_response.response_code

The HTTP status code to return to the client. For a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the WAF Developer Guide.

resources[].details.aws_wafv2_web_acl.rules[].action.block.custom_response.response_headers[]
Show child fields
resources[].details.aws_wafv2_web_acl.rules[].action.block.custom_response.response_headers[].name

The name of the custom header.

resources[].details.aws_wafv2_web_acl.rules[].action.block.custom_response.response_headers[].value

The value of the custom header.

resources[].details.aws_wafv2_web_acl.rules[].action.captcha

Instructs WAF to run a CAPTCHA check against the web request.

Show child fields
resources[].details.aws_wafv2_web_acl.rules[].action.captcha.custom_request_handling

Defines custom handling for the web request, used when the CAPTCHA inspection determines that the request's token is valid and unexpired. For more information, see Customizing web requests and responses in WAF in the WAF Developer Guide..

Show child fields
resources[].details.aws_wafv2_web_acl.rules[].action.captcha.custom_request_handling.insert_headers[]
Show child fields
resources[].details.aws_wafv2_web_acl.rules[].action.captcha.custom_request_handling.insert_headers[].name

The name of the custom header.

resources[].details.aws_wafv2_web_acl.rules[].action.captcha.custom_request_handling.insert_headers[].value

The value of the custom header.

resources[].details.aws_wafv2_web_acl.rules[].action.count

Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.

Show child fields
resources[].details.aws_wafv2_web_acl.rules[].action.count.custom_request_handling

Defines custom handling for the web request. For more information, see Customizing web requests and responses in WAF in the WAF Developer Guide..

Show child fields
resources[].details.aws_wafv2_web_acl.rules[].action.count.custom_request_handling.insert_headers[]
Show child fields
resources[].details.aws_wafv2_web_acl.rules[].action.count.custom_request_handling.insert_headers[].name

The name of the custom header.

resources[].details.aws_wafv2_web_acl.rules[].action.count.custom_request_handling.insert_headers[].value

The value of the custom header.

resources[].details.aws_wafv2_web_acl.rules[].name

The name of the rule.

resources[].details.aws_wafv2_web_acl.rules[].override_action

The action to use in the place of the action that results from the rule group evaluation.

resources[].details.aws_wafv2_web_acl.rules[].priority

If you define more than one Rule in a WebACL, WAF evaluates each request against the Rules in order based on the value of Priority. WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.

resources[].details.aws_wafv2_web_acl.rules[].visibility_config

Defines and enables Amazon CloudWatch metrics and web request sample collection.

Show child fields
resources[].details.aws_wafv2_web_acl.rules[].visibility_config.cloud_watch_metrics_enabled

A boolean indicating whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF metrics and dimensions in the WAF Developer Guide.

resources[].details.aws_wafv2_web_acl.rules[].visibility_config.metric_name

A name of the Amazon CloudWatch metric.

resources[].details.aws_wafv2_web_acl.rules[].visibility_config.sampled_requests_enabled

A boolean indicating whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console.

resources[].details.aws_wafv2_web_acl.visibility_config

Defines and enables Amazon CloudWatch metrics and web request sample collection.

Show child fields
resources[].details.aws_wafv2_web_acl.visibility_config.cloud_watch_metrics_enabled

A boolean indicating whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF metrics and dimensions in the WAF Developer Guide.

resources[].details.aws_wafv2_web_acl.visibility_config.metric_name

A name of the Amazon CloudWatch metric.

resources[].details.aws_wafv2_web_acl.visibility_config.sampled_requests_enabled

A boolean indicating whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console.

resources[].details.aws_xray_encryption_config

Information about the encryption configuration for X-Ray.

Show child fields
resources[].details.aws_xray_encryption_config.key_id

The identifier of the KMS key that is used for encryption. Provided if Type is KMS.

resources[].details.aws_xray_encryption_config.status

The current status of the encryption configuration. Valid values are ACTIVE or UPDATING.

When Status is equal to UPDATING, X-Ray might use both the old and new encryption.

resources[].details.aws_xray_encryption_config.type

The type of encryption. KMS indicates that the encryption uses KMS keys. NONE indicates the default encryption.

resources[].details.container

Details about a container resource related to a finding.

Show child fields
resources[].details.container.container_runtime

The runtime of the container.

resources[].details.container.image_id

The identifier of the container image related to a finding.

resources[].details.container.image_name

The name of the container image related to a finding.

resources[].details.container.launched_at

Indicates when the container started.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

resources[].details.container.name

The name of the container related to a finding.

resources[].details.container.privileged

When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user).

resources[].details.container.volume_mounts[]
Show child fields
resources[].details.container.volume_mounts[].mount_path

The path in the container at which the volume should be mounted.

resources[].details.container.volume_mounts[].name

The name of the volume.

resources[].details.other

Details about a resource that are not available in a type-specific details object. Use the Other object in the following cases.

  • The type-specific object does not contain all of the fields that you want to populate. In this case, first use the type-specific object to populate those fields. Use the Other object to populate the fields that are missing from the type-specific object.

  • The resource type does not have a corresponding object. This includes resources for which the type is Other.

resources[].id

The canonical identifier for the given resource type.

resources[].partition

The canonical Amazon Web Services partition name that the Region is assigned to.

resources[].region

The canonical Amazon Web Services external Region name where this resource is located.

Length Constraints: Minimum length of 1. Maximum length of 16.

resources[].resource_role

Identifies the role of the resource in the finding. A resource is either the actor or target of the finding activity,

resources[].tags

A list of Amazon Web Services tags associated with a resource at the time the finding was processed. Tags must follow Amazon Web Services tag naming limits and requirements.

resources[].type

The type of the resource that details are provided for. If possible, set Type to one of the supported resource types. For example, if the resource is an EC2 instance, then set Type to AwsEc2Instance.

If the resource does not match any of the provided types, then set Type to Other.

Length Constraints: Minimum length of 1. Maximum length of 256.

sample

Indicates whether the finding is a sample finding.

BOOLEAN
schema_version

The schema version that a finding is formatted for. The value is 2018-10-08.

VARCHAR
severity

A finding's severity.

STRUCT(
    "product" DOUBLE,
    "label" VARCHAR,
    "normalized" BIGINT,
    "original" VARCHAR
)
Show child fields
severity.label

The severity value of the finding. The allowed values are the following.

  • INFORMATIONAL - No issue was found.

  • LOW - The issue does not require action on its own.

  • 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.

If you provide Normalized and do not provide Label, then Label is set automatically as follows.

  • 0 - INFORMATIONAL

  • 1–39 - LOW

  • 40–69 - MEDIUM

  • 70–89 - HIGH

  • 90–100 - CRITICAL

severity.normalized

Deprecated. The normalized severity of a finding. Instead of providing Normalized, provide Label.

The value of Normalized can be an integer between 0 and 100.

If you provide Label and do not provide Normalized, then Normalized is set automatically as follows.

  • INFORMATIONAL - 0

  • LOW - 1

  • MEDIUM - 40

  • HIGH - 70

  • CRITICAL - 90

severity.original

The native severity from the finding product that generated the finding.

Length Constraints: Minimum length of 1. Maximum length of 64.

severity.product

Deprecated. This attribute isn't included in findings. Instead of providing Product, provide Original.

The native severity as defined by the Amazon Web Services service or integrated partner product that generated the finding.

source_url

A URL that links to a page about the current finding in the security findings provider's solution.

VARCHAR
threat_intel_indicators

Threat intelligence details related to a finding.

Array Members: Minimum number of 1 item. Maximum number of 5 items.

STRUCT(
    "type" VARCHAR,
    "value" VARCHAR,
    "category" VARCHAR,
    "last_observed_at" VARCHAR,
    "source" VARCHAR,
    "source_url" VARCHAR
)[]
Show child fields
threat_intel_indicators[]
Show child fields
threat_intel_indicators[].category

The category of a threat intelligence indicator.

threat_intel_indicators[].last_observed_at

Indicates when the most recent instance of a threat intelligence indicator was observed.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

threat_intel_indicators[].source

The source of the threat intelligence indicator.

Length Constraints: Minimum of 1 length. Maximum of 64 length.

threat_intel_indicators[].source_url

The URL to the page or site where you can get more information about the threat intelligence indicator.

threat_intel_indicators[].type

The type of threat intelligence indicator.

threat_intel_indicators[].value

The value of a threat intelligence indicator.

Length Constraints: Minimum of 1 length. Maximum of 512 length.

threats

Details about the threat detected in a security finding and the file paths that were affected by the threat.

Array Members: Minimum number of 1 item. Maximum number of 32 items.

STRUCT(
    "name" VARCHAR,
    "severity" VARCHAR,
    "item_count" BIGINT,
    "file_paths" STRUCT(
        "file_path" VARCHAR,
        "file_name" VARCHAR,
        "resource_id" VARCHAR,
        "hash" VARCHAR
    )[]
)[]
Show child fields
threats[]
Show child fields
threats[].file_paths[]
Show child fields
threats[].file_paths[].file_name

The name of the infected or suspicious file corresponding to the hash.

Length Constraints: Minimum of 1 length. Maximum of 128 length.

threats[].file_paths[].file_path

Path to the infected or suspicious file on the resource it was detected on.

Length Constraints: Minimum of 1 length. Maximum of 128 length.

threats[].file_paths[].hash

The hash value for the infected or suspicious file.

Length Constraints: Minimum of 1 length. Maximum of 128 length.

threats[].file_paths[].resource_id

The Amazon Resource Name (ARN) of the resource on which the threat was detected.

Length Constraints: Minimum of 1 length. Maximum of 128 length.

threats[].item_count

This total number of items in which the threat has been detected.

threats[].name

The name of the threat.

Length Constraints: Minimum of 1 length. Maximum of 128 length.

threats[].severity

The severity of the threat.

Length Constraints: Minimum of 1 length. Maximum of 128 length.

title

A finding's title. Title is a required property.

Length Constraints: Minimum length of 1. Maximum length of 256.

VARCHAR
types

One or more finding types in the format of namespace/category/classifier that classify a finding.

Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual Behaviors | Sensitive Data Identifications

Array Members: Maximum number of 50 items.

VARCHAR[]
Show child fields
types[]
updated_at

Indicates when the security findings provider last updated the finding record.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

VARCHAR
user_defined_fields

A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.

Can contain up to 50 key-value pairs. For each key-value pair, the key can contain up to 128 characters, and the value can contain up to 1024 characters.

MAP(VARCHAR, VARCHAR)
verification_state

Indicates the veracity of a finding. 

VARCHAR
vulnerabilities

Provides a list of vulnerabilities associated with the findings.

STRUCT(
    "id" VARCHAR,
    "vulnerable_packages" STRUCT(
        "name" VARCHAR,
        "version" VARCHAR,
        "epoch" VARCHAR,
        "release" VARCHAR,
        "architecture" VARCHAR,
        "package_manager" VARCHAR,
        "file_path" VARCHAR,
        "fixed_in_version" VARCHAR,
        "remediation" VARCHAR,
        "source_layer_hash" VARCHAR,
        "source_layer_arn" VARCHAR
    )[],
    "cvss" STRUCT(
        "version" VARCHAR,
        "base_score" DOUBLE,
        "base_vector" VARCHAR,
        "source" VARCHAR,
        "adjustments" STRUCT(
            "metric" VARCHAR,
            "reason" VARCHAR
        )[]
    )[],
    "related_vulnerabilities" VARCHAR[],
    "vendor" STRUCT(
        "name" VARCHAR,
        "url" VARCHAR,
        "vendor_severity" VARCHAR,
        "vendor_created_at" VARCHAR,
        "vendor_updated_at" VARCHAR
    ),
    "reference_urls" VARCHAR[],
    "fix_available" VARCHAR,
    "epss_score" DOUBLE,
    "exploit_available" VARCHAR,
    "last_known_exploit_at" VARCHAR,
    "code_vulnerabilities" STRUCT(
        "cwes" VARCHAR[],
        "file_path" STRUCT(
            "end_line" BIGINT,
            "file_name" VARCHAR,
            "file_path" VARCHAR,
            "start_line" BIGINT
        ),
        "source_arn" VARCHAR
    )[]
)[]
Show child fields
vulnerabilities[]
Show child fields
vulnerabilities[].code_vulnerabilities[]
Show child fields
vulnerabilities[].code_vulnerabilities[].cwes[]
vulnerabilities[].code_vulnerabilities[].file_path

Provides details about where a code vulnerability is located in your Lambda function.

Show child fields
vulnerabilities[].code_vulnerabilities[].file_path.end_line

The line number of the last line of code in which the vulnerability is located.

vulnerabilities[].code_vulnerabilities[].file_path.file_name

The name of the file in which the code vulnerability is located.

vulnerabilities[].code_vulnerabilities[].file_path.file_path

The file path to the code in which the vulnerability is located.

vulnerabilities[].code_vulnerabilities[].file_path.start_line

The line number of the first line of code in which the vulnerability is located.

vulnerabilities[].code_vulnerabilities[].source_arn

The Amazon Resource Name (ARN) of the Lambda layer in which the code vulnerability is located.

vulnerabilities[].cvss[]
Show child fields
vulnerabilities[].cvss[].adjustments[]
Show child fields
vulnerabilities[].cvss[].adjustments[].metric

The metric to adjust.

vulnerabilities[].cvss[].adjustments[].reason

The reason for the adjustment.

vulnerabilities[].cvss[].base_score

The base CVSS score.

vulnerabilities[].cvss[].base_vector

The base scoring vector for the CVSS score.

vulnerabilities[].cvss[].source

The origin of the original CVSS score and vector.

vulnerabilities[].cvss[].version

The version of CVSS for the CVSS score.

vulnerabilities[].epss_score

The Exploit Prediction Scoring System (EPSS) score for a finding.

vulnerabilities[].exploit_available

Whether an exploit is available for a finding.

vulnerabilities[].fix_available

Specifies if all vulnerable packages in a finding have a value for FixedInVersion and Remediation. This field is evaluated for each vulnerability Id based on the number of vulnerable packages that have a value for both FixedInVersion and Remediation. Valid values are as follows:

  • YES if all vulnerable packages have a value for both FixedInVersion and Remediation

  • NO if no vulnerable packages have a value for FixedInVersion and Remediation

  • PARTIAL otherwise

vulnerabilities[].id

The identifier of the vulnerability.

vulnerabilities[].last_known_exploit_at

The date and time of the last exploit associated with a finding discovered in your environment.

vulnerabilities[].reference_urls[]
vulnerabilities[].related_vulnerabilities[]
vulnerabilities[].vendor

Information about the vendor that generates the vulnerability report.

Show child fields
vulnerabilities[].vendor.name

The name of the vendor.

vulnerabilities[].vendor.url

The URL of the vulnerability advisory.

vulnerabilities[].vendor.vendor_created_at

Indicates when the vulnerability advisory was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

vulnerabilities[].vendor.vendor_severity

The severity that the vendor assigned to the vulnerability.

vulnerabilities[].vendor.vendor_updated_at

Indicates when the vulnerability advisory was last updated.

This field accepts only the specified formats. Timestamps can end with Z or ("+"/"-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

vulnerabilities[].vulnerable_packages[]
Show child fields
vulnerabilities[].vulnerable_packages[].architecture

The architecture used for the software package.

vulnerabilities[].vulnerable_packages[].epoch

The epoch of the software package.

vulnerabilities[].vulnerable_packages[].file_path

The file system path to the package manager inventory file.

vulnerabilities[].vulnerable_packages[].fixed_in_version

The version of the software package in which the vulnerability has been resolved.

vulnerabilities[].vulnerable_packages[].name

The name of the software package.

vulnerabilities[].vulnerable_packages[].package_manager

The source of the package.

vulnerabilities[].vulnerable_packages[].release

The release of the software package.

vulnerabilities[].vulnerable_packages[].remediation

Describes the actions a customer can take to resolve the vulnerability in the software package.

vulnerabilities[].vulnerable_packages[].source_layer_arn

The Amazon Resource Name (ARN) of the source layer.

vulnerabilities[].vulnerable_packages[].source_layer_hash

The source layer hash of the vulnerable package.

vulnerabilities[].vulnerable_packages[].version

The version of the software package.

workflow

Provides information about the status of the investigation into a finding.

STRUCT(
    "status" VARCHAR
)
Show child fields
workflow.status

The status of the investigation into the finding. The workflow status is specific to an individual finding. It does not affect the generation of new findings. For example, setting the workflow status to SUPPRESSED or RESOLVED does not prevent a new finding for the same issue.

The allowed values are the following.

  • NEW - The initial state of a finding, before it is reviewed.

    Security Hub also resets the workflow status from NOTIFIED or RESOLVED to NEW in the following cases:

    • RecordState changes from ARCHIVED to ACTIVE.

    • ComplianceStatus changes from PASSED to either WARNING, FAILED, or NOT_AVAILABLE.

  • 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.

  • SUPPRESSED - Indicates that you reviewed the finding and do not believe that any action is needed. The finding is no longer updated.

  • RESOLVED - The finding was reviewed and remediated and is now considered resolved.

workflow_state

The workflow state of a finding. 

VARCHAR