assessment_templates

Creates, updates, deletes or gets an assessment_template resource or lists assessment_templates in a region

Overview

Name	assessment_templates
Type	Resource
Description	Resource Type definition for AWS::Inspector::AssessmentTemplate
Id	awscc.inspector.assessment_templates

Fields

get (all properties)

Name	Datatype	Description
arn	string
assessment_target_arn	string
duration_in_seconds	integer
assessment_template_name	string
rules_package_arns	array
▶user_attributes_for_findings	array
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
arn	string
region	string	AWS region.

For more information, see AWS::Inspector::AssessmentTemplate.

Methods

Name	Resource	Accessible by	Required Params
create_resource	assessment_templates	INSERT	AssessmentTargetArn, DurationInSeconds, RulesPackageArns, region
delete_resource	assessment_templates	DELETE	Identifier, region
list_resources	assessment_templates_list_only	SELECT	region
get_resource	assessment_templates	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual assessment_template.

SELECT
  region,
  arn,
  assessment_target_arn,
  duration_in_seconds,
  assessment_template_name,
  rules_package_arns,
  user_attributes_for_findings
FROM awscc.inspector.assessment_templates
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all assessment_templates in a region.

SELECT
  region,
  arn
FROM awscc.inspector.assessment_templates_list_only
WHERE
  region = 'us-east-1';

INSERT example

Use the following StackQL query and manifest file to create a new assessment_template resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.inspector.assessment_templates (
  AssessmentTargetArn,
  DurationInSeconds,
  RulesPackageArns,
  region
)
SELECT
  '{{ assessment_target_arn }}',
  '{{ duration_in_seconds }}',
  '{{ rules_package_arns }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.inspector.assessment_templates (
  AssessmentTargetArn,
  DurationInSeconds,
  AssessmentTemplateName,
  RulesPackageArns,
  UserAttributesForFindings,
  region
)
SELECT
  '{{ assessment_target_arn }}',
  '{{ duration_in_seconds }}',
  '{{ assessment_template_name }}',
  '{{ rules_package_arns }}',
  '{{ user_attributes_for_findings }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: assessment_template
    props:
      - name: assessment_target_arn
        value: '{{ assessment_target_arn }}'
      - name: duration_in_seconds
        value: '{{ duration_in_seconds }}'
      - name: assessment_template_name
        value: '{{ assessment_template_name }}'
      - name: rules_package_arns
        value:
          - '{{ rules_package_arns[0] }}'
      - name: user_attributes_for_findings
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

DELETE example

/*+ delete */
DELETE FROM awscc.inspector.assessment_templates
WHERE
  Identifier = '{{ arn }}' AND
  region = 'us-east-1';

Permissions

To operate on the assessment_templates resource, the following permissions are required:

Create

inspector:CreateAssessmentTemplate,
inspector:ListAssessmentTemplates,
inspector:DescribeAssessmentTemplates

Read

inspector:DescribeAssessmentTemplates

Delete

inspector:DeleteAssessmentTemplate

List

inspector:ListAssessmentTemplates