replication_configurations

Creates, updates, deletes or gets a replication_configuration resource or lists replication_configurations in a region

Overview

Name	replication_configurations
Type	Resource
Description	The AWS::ECR::ReplicationConfiguration resource creates or updates the replication configuration for a private registry. The first time a replication configuration is applied to a private registry, a service-linked IAM role is created in your account for the replication process. For more information, see Using Service-Linked Roles for Amazon ECR in the Amazon Elastic Container Registry User Guide. When configuring cross-account replication, the destination account must grant the source account permission to replicate. This permission is controlled using a private registry permissions policy. For more information, see AWS::ECR::RegistryPolicy.
Id	awscc.ecr.replication_configurations

Fields

get (all properties)

Name	Datatype	Description
▶replication_configuration	object	The replication configuration for a registry.
registry_id	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
registry_id	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	replication_configurations	INSERT	ReplicationConfiguration, region
delete_resource	replication_configurations	DELETE	Identifier, region
update_resource	replication_configurations	UPDATE	Identifier, PatchDocument, region
list_resources	replication_configurations_list_only	SELECT	region
get_resource	replication_configurations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual replication_configuration.

SELECT
  region,
  replication_configuration,
  registry_id
FROM awscc.ecr.replication_configurations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ registry_id }}';

list (identifiers only)

Lists all replication_configurations in a region.

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

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.ecr.replication_configurations (
  ReplicationConfiguration,
  region
)
SELECT
  '{{ replication_configuration }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ecr.replication_configurations (
  ReplicationConfiguration,
  region
)
SELECT
  '{{ replication_configuration }}',
  '{{ 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: replication_configuration
  props:
    - name: replication_configuration
      value:
        replication_configuration: null

UPDATE example

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

/*+ update */
UPDATE awscc.ecr.replication_configurations
SET PatchDocument = string('{{ {
    "ReplicationConfiguration": replication_configuration
} | 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.replication_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 replication_configurations resource, the following permissions are required:

Create

ecr:DescribeRegistry,
ecr:PutReplicationConfiguration,
iam:CreateServiceLinkedRole

Read

ecr:DescribeRegistry

Update

ecr:DescribeRegistry,
ecr:PutReplicationConfiguration,
iam:CreateServiceLinkedRole

Delete

ecr:DescribeRegistry,
ecr:PutReplicationConfiguration,
iam:CreateServiceLinkedRole

List

ecr:DescribeRegistry