pull_through_cache_rules

Creates, updates, deletes or gets a pull_through_cache_rule resource or lists pull_through_cache_rules in a region

Overview

Name	pull_through_cache_rules
Type	Resource
Description	The AWS::ECR::PullThroughCacheRule resource creates or updates a pull through cache rule. A pull through cache rule provides a way to cache images from an upstream registry in your Amazon ECR private registry.
Id	awscc.ecr.pull_through_cache_rules

Fields

get (all properties)

Name	Datatype	Description
ecr_repository_prefix	string	The Amazon ECR repository prefix associated with the pull through cache rule.
upstream_registry_url	string	The upstream registry URL associated with the pull through cache rule.
credential_arn	string	The ARN of the Secrets Manager secret associated with the pull through cache rule.
upstream_registry	string	The name of the upstream source registry associated with the pull through cache rule.
custom_role_arn	string	The ARN of the IAM role associated with the pull through cache rule.
upstream_repository_prefix	string	The upstream repository prefix associated with the pull through cache rule.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
ecr_repository_prefix	string	The Amazon ECR repository prefix associated with the pull through cache rule.
region	string	AWS region.

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

Methods

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

SELECT examples

get (all properties)

Gets all properties from an individual pull_through_cache_rule.

SELECT
  region,
  ecr_repository_prefix,
  upstream_registry_url,
  credential_arn,
  upstream_registry,
  custom_role_arn,
  upstream_repository_prefix
FROM awscc.ecr.pull_through_cache_rules
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ ecr_repository_prefix }}';

list (identifiers only)

Lists all pull_through_cache_rules in a region.

SELECT
  region,
  ecr_repository_prefix
FROM awscc.ecr.pull_through_cache_rules_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.ecr.pull_through_cache_rules (
  EcrRepositoryPrefix,
  UpstreamRegistryUrl,
  CredentialArn,
  UpstreamRegistry,
  CustomRoleArn,
  UpstreamRepositoryPrefix,
  region
)
SELECT
  '{{ ecr_repository_prefix }}',
  '{{ upstream_registry_url }}',
  '{{ credential_arn }}',
  '{{ upstream_registry }}',
  '{{ custom_role_arn }}',
  '{{ upstream_repository_prefix }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ecr.pull_through_cache_rules (
  EcrRepositoryPrefix,
  UpstreamRegistryUrl,
  CredentialArn,
  UpstreamRegistry,
  CustomRoleArn,
  UpstreamRepositoryPrefix,
  region
)
SELECT
  '{{ ecr_repository_prefix }}',
  '{{ upstream_registry_url }}',
  '{{ credential_arn }}',
  '{{ upstream_registry }}',
  '{{ custom_role_arn }}',
  '{{ upstream_repository_prefix }}',
  '{{ 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: pull_through_cache_rule
  props:
    - name: ecr_repository_prefix
      value: '{{ ecr_repository_prefix }}'
    - name: upstream_registry_url
      value: '{{ upstream_registry_url }}'
    - name: credential_arn
      value: '{{ credential_arn }}'
    - name: upstream_registry
      value: '{{ upstream_registry }}'
    - name: custom_role_arn
      value: '{{ custom_role_arn }}'
    - name: upstream_repository_prefix
      value: '{{ upstream_repository_prefix }}'

DELETE example

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

Create

ecr:DescribePullThroughCacheRules,
ecr:CreatePullThroughCacheRule,
ecr:DeletePullThroughCacheRule,
iam:CreateServiceLinkedRole,
secretsmanager:GetSecretValue,
iam:PassRole

Read

ecr:DescribePullThroughCacheRules

Update

ecr:DescribePullThroughCacheRules,
ecr:CreatePullThroughCacheRule,
ecr:DeletePullThroughCacheRule,
iam:CreateServiceLinkedRole,
secretsmanager:GetSecretValue,
iam:PassRole

Delete

ecr:DescribePullThroughCacheRules,
ecr:DeletePullThroughCacheRule

List

ecr:DescribePullThroughCacheRules