registry_policies
Creates, updates, deletes or gets a registry_policy resource or lists registry_policies in a region
Overview
| Name | registry_policies |
| Type | Resource |
| Description | The ``AWS::ECR::RegistryPolicy`` resource creates or updates the permissions policy for a private registry. A private registry policy is used to specify permissions for another AWS-account and is used when configuring cross-account replication. For more information, see [Registry permissions](https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry-permissions.html) in the *Amazon Elastic Container Registry User Guide*. |
| Id | awscc.ecr.registry_policies |
Fields
- get (all properties)
- 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. |
policy_text | object | The JSON policy text for your registry. |
region | string | AWS region. |
| 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::RegistryPolicy.
Methods
| Name | Resource | Accessible by | Required Params |
|---|---|---|---|
create_resource | registry_policies | INSERT | PolicyText, region |
delete_resource | registry_policies | DELETE | Identifier, region |
update_resource | registry_policies | UPDATE | Identifier, PatchDocument, region |
list_resources | registry_policies_list_only | SELECT | region |
get_resource | registry_policies | SELECT | Identifier, region |
SELECT examples
- get (all properties)
- list (identifiers only)
Gets all properties from an individual registry_policy.
SELECT
region,
registry_id,
policy_text
FROM awscc.ecr.registry_policies
WHERE
region = 'us-east-1' AND
Identifier = '{{ registry_id }}';
Lists all registry_policies in a region.
SELECT
region,
registry_id
FROM awscc.ecr.registry_policies_list_only
WHERE
region = 'us-east-1';
INSERT example
Use the following StackQL query and manifest file to create a new registry_policy resource, using stack-deploy.
- Required Properties
- All Properties
- Manifest
/*+ create */
INSERT INTO awscc.ecr.registry_policies (
PolicyText,
region
)
SELECT
'{{ policy_text }}',
'{{ region }}';
/*+ create */
INSERT INTO awscc.ecr.registry_policies (
PolicyText,
region
)
SELECT
'{{ policy_text }}',
'{{ region }}';
version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
value: '{{ vars.AWS_REGION }}'
resources:
- name: registry_policy
props:
- name: policy_text
value: {}
UPDATE example
Use the following StackQL query and manifest file to update a registry_policy resource, using stack-deploy.
/*+ update */
UPDATE awscc.ecr.registry_policies
SET PatchDocument = string('{{ {
"PolicyText": policy_text
} | generate_patch_document }}')
WHERE
region = '{{ region }}' AND
Identifier = '{{ registry_id }}';
DELETE example
/*+ delete */
DELETE FROM awscc.ecr.registry_policies
WHERE
Identifier = '{{ registry_id }}' AND
region = 'us-east-1';
Permissions
To operate on the registry_policies resource, the following permissions are required:
- Create
- Read
- List
- Update
- Delete
ecr:GetRegistryPolicy,
ecr:PutRegistryPolicy
ecr:GetRegistryPolicy
ecr:GetRegistryPolicy
ecr:GetRegistryPolicy,
ecr:PutRegistryPolicy
ecr:DeleteRegistryPolicy