sbom_exports

Creates, updates, deletes, gets or lists a sbom_exports resource.

Overview

Name	sbom_exports
Type	Resource
Id	aws.inspector2.sbom_exports

Fields

The following fields are returned by SELECT queries:

get_sbom_export

Name	Datatype	Description
error_code	string	An error code. (INTERNAL_ERROR, INVALID_PERMISSIONS, NO_FINDINGS_FOUND, BUCKET_NOT_FOUND, INCOMPATIBLE_BUCKET_REGION, MALFORMED_KMS_KEY)
error_message	string	An error message.
filter_criteria	object	The resource filter criteria for a Software bill of materials (SBOM) report.
format_	string	The format of the software bill of materials (SBOM) report. (CYCLONEDX_1_4, SPDX_2_3)
report_id	string	The report ID of the software bill of materials (SBOM) report. (pattern: <code>.\b[a-f0-9]{8}\b-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-\b[a-f0-9]{12}\b.</code>)
s_3_destination	object	Contains details of the Amazon S3 bucket and KMS key used to export findings.
status	string	The status of the software bill of materials (SBOM) report. (SUCCEEDED, IN_PROGRESS, CANCELLED, FAILED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_sbom_export	select	region		Gets details of a software bill of materials (SBOM) report.
create_sbom_export	insert	region, reportFormat, s3Destination		Creates a software bill of materials (SBOM) report.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_sbom_export

Gets details of a software bill of materials (SBOM) report.

SELECT
error_code,
error_message,
filter_criteria,
format_,
report_id,
s_3_destination,
status
FROM aws.inspector2.sbom_exports
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_sbom_export

Creates a software bill of materials (SBOM) report.

INSERT INTO aws.inspector2.sbom_exports (
resourceFilterCriteria,
reportFormat,
s3Destination,
region
)
SELECT 
'{{ resourceFilterCriteria }}',
'{{ reportFormat }}' /* required */,
'{{ s3Destination }}' /* required */,
'{{ region }}'
RETURNING
report_id
;

Manifest

# Description fields are for documentation purposes
- name: sbom_exports
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the sbom_exports resource.
  - name: resourceFilterCriteria
    description: |
      The resource filter criteria for a Software bill of materials (SBOM) report.
    value:
      accountId:
        - comparison: "{{ comparison }}"
          value: "{{ value }}"
      resourceId:
        - comparison: "{{ comparison }}"
          value: "{{ value }}"
      resourceType:
        - comparison: "{{ comparison }}"
          value: "{{ value }}"
      ecrRepositoryName:
        - comparison: "{{ comparison }}"
          value: "{{ value }}"
      lambdaFunctionName:
        - comparison: "{{ comparison }}"
          value: "{{ value }}"
      ecrImageTags:
        - comparison: "{{ comparison }}"
          value: "{{ value }}"
      ec2InstanceTags:
        - comparison: "{{ comparison }}"
          key: "{{ key }}"
          value: "{{ value }}"
      lambdaFunctionTags:
        - comparison: "{{ comparison }}"
          key: "{{ key }}"
          value: "{{ value }}"
      cloudProvider:
        - comparison: "{{ comparison }}"
          value: "{{ value }}"
      cloudProviderAccountId:
        - comparison: "{{ comparison }}"
          value: "{{ value }}"
      cloudProviderOrgId:
        - comparison: "{{ comparison }}"
          value: "{{ value }}"
      cloudProviderRegion:
        - comparison: "{{ comparison }}"
          value: "{{ value }}"
      cloudVmInstanceTags:
        - comparison: "{{ comparison }}"
          key: "{{ key }}"
          value: "{{ value }}"
      cloudContainerImageTags:
        - comparison: "{{ comparison }}"
          value: "{{ value }}"
      cloudContainerRepositoryName:
        - comparison: "{{ comparison }}"
          value: "{{ value }}"
      cloudContainerRegistryName:
        - comparison: "{{ comparison }}"
          value: "{{ value }}"
      cloudServerlessFunctionName:
        - comparison: "{{ comparison }}"
          value: "{{ value }}"
      cloudServerlessFunctionRuntime:
        - comparison: "{{ comparison }}"
          value: "{{ value }}"
      cloudServerlessFunctionTags:
        - comparison: "{{ comparison }}"
          key: "{{ key }}"
          value: "{{ value }}"
  - name: reportFormat
    value: "{{ reportFormat }}"
    valid_values: ['CYCLONEDX_1_4', 'SPDX_2_3']
  - name: s3Destination
    description: |
      Contains details of the Amazon S3 bucket and KMS key used to export findings.
    value:
      bucketName: "{{ bucketName }}"
      keyPrefix: "{{ keyPrefix }}"
      kmsKeyArn: "{{ kmsKeyArn }}"