registry_scanning_configurations

Creates, updates, deletes or gets a registry_scanning_configuration resource or lists registry_scanning_configurations in a region

Overview

Name	registry_scanning_configurations
Type	Resource
Description	The scanning configuration for a private registry.
Id	awscc.ecr.registry_scanning_configurations

Fields

get (all properties)

Name	Datatype	Description
▶rules	array	The scanning rules associated with the registry.
scan_type	string	The type of scanning configured for the registry.
registry_id	string	The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
registry_id	string	The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
region	string	AWS region.

For more information, see AWS::ECR::RegistryScanningConfiguration.

Methods

Name	Resource	Accessible by	Required Params
create_resource	registry_scanning_configurations	INSERT	Rules, ScanType, region
delete_resource	registry_scanning_configurations	DELETE	Identifier, region
update_resource	registry_scanning_configurations	UPDATE	Identifier, PatchDocument, region
list_resources	registry_scanning_configurations_list_only	SELECT	region
get_resource	registry_scanning_configurations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual registry_scanning_configuration.

SELECT
  region,
  rules,
  scan_type,
  registry_id
FROM awscc.ecr.registry_scanning_configurations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ registry_id }}';

list (identifiers only)

Lists all registry_scanning_configurations in a region.

SELECT
  region,
  registry_id
FROM awscc.ecr.registry_scanning_configurations_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.ecr.registry_scanning_configurations (
  Rules,
  ScanType,
  region
)
SELECT
  '{{ rules }}',
  '{{ scan_type }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ecr.registry_scanning_configurations (
  Rules,
  ScanType,
  region
)
SELECT
  '{{ rules }}',
  '{{ scan_type }}',
  '{{ 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: registry_scanning_configuration
  props:
    - name: rules
      value:
        - repository_filters:
            - filter: '{{ filter }}'
              filter_type: '{{ filter_type }}'
          scan_frequency: '{{ scan_frequency }}'
    - name: scan_type
      value: '{{ scan_type }}'

UPDATE example

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

/*+ update */
UPDATE awscc.ecr.registry_scanning_configurations
SET PatchDocument = string('{{ {
    "Rules": rules,
    "ScanType": scan_type
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ registry_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.ecr.registry_scanning_configurations
WHERE
  Identifier = '{{ registry_id }}' 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 registry_scanning_configurations resource, the following permissions are required:

Create

ecr:PutRegistryScanningConfiguration,
ecr:GetRegistryScanningConfiguration,
inspector2:Enable,
iam:CreateServiceLinkedRole

Read

ecr:GetRegistryScanningConfiguration

Update

ecr:PutRegistryScanningConfiguration,
ecr:GetRegistryScanningConfiguration,
inspector2:Enable,
inspector2:Disable,
inspector2:ListAccountPermissions,
iam:CreateServiceLinkedRole

Delete

ecr:PutRegistryScanningConfiguration,
ecr:GetRegistryScanningConfiguration,
inspector2:ListAccountPermissions,
inspector2:Disable

List

ecr:GetRegistryScanningConfiguration