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

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.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Rules, ScanType, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all properties from an individual registry_scanning_configuration.

SELECT
region,
rules,
scan_type,
registry_id
FROM awscc.ecr.registry_scanning_configurations
WHERE region = 'us-east-1' AND data__Identifier = '<RegistryId>';

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 }}',
 '{{ ScanType }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.ecr.registry_scanning_configurations (
 Rules,
 ScanType,
 region
)
SELECT 
 '{{ Rules }}',
 '{{ ScanType }}',
 '{{ region }}';

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:
          - RepositoryFilters:
              - Filter: '{{ Filter }}'
                FilterType: '{{ FilterType }}'
            ScanFrequency: '{{ ScanFrequency }}'
      - name: ScanType
        value: '{{ ScanType }}'

DELETE example

/*+ delete */
DELETE FROM awscc.ecr.registry_scanning_configurations
WHERE data__Identifier = '<RegistryId>'
AND region = 'us-east-1';

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