assessment_targets

Creates, updates, deletes or gets an assessment_target resource or lists assessment_targets in a region

Overview

Name	assessment_targets
Type	Resource
Description	Resource Type definition for AWS::Inspector::AssessmentTarget
Id	awscc.inspector.assessment_targets

Fields

get (all properties)

Name	Datatype	Description
arn	string
assessment_target_name	string
resource_group_arn	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
arn	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	assessment_targets	INSERT	region
delete_resource	assessment_targets	DELETE	Identifier, region
update_resource	assessment_targets	UPDATE	Identifier, PatchDocument, region
list_resources	assessment_targets_list_only	SELECT	region
get_resource	assessment_targets	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual assessment_target.

SELECT
  region,
  arn,
  assessment_target_name,
  resource_group_arn
FROM awscc.inspector.assessment_targets
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all assessment_targets in a region.

SELECT
  region,
  arn
FROM awscc.inspector.assessment_targets_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.inspector.assessment_targets (
  AssessmentTargetName,
  ResourceGroupArn,
  region
)
SELECT
  '{{ assessment_target_name }}',
  '{{ resource_group_arn }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.inspector.assessment_targets (
  AssessmentTargetName,
  ResourceGroupArn,
  region
)
SELECT
  '{{ assessment_target_name }}',
  '{{ resource_group_arn }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: assessment_target
  props:
    - name: assessment_target_name
      value: '{{ assessment_target_name }}'
    - name: resource_group_arn
      value: '{{ resource_group_arn }}'

UPDATE example

Use the following StackQL query and manifest file to update a assessment_target resource, using stack-deploy.

/*+ update */
UPDATE awscc.inspector.assessment_targets
SET PatchDocument = string('{{ {
    "ResourceGroupArn": resource_group_arn
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.inspector.assessment_targets
WHERE
  Identifier = '{{ arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

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

Create

inspector:CreateAssessmentTarget,
inspector:ListAssessmentTargets,
inspector:DescribeAssessmentTargets

Update

inspector:DescribeAssessmentTargets,
inspector:UpdateAssessmentTarget

Read

inspector:DescribeAssessmentTargets

Delete

inspector:DeleteAssessmentTarget

List

inspector:ListAssessmentTargets