PutReplicationConfiguration - Amazon Elastic Container Registry

PutReplicationConfiguration

Creates or updates the replication configuration for a registry. The existing replication configuration for a repository can be retrieved with the DescribeRegistry API action. The first time the PutReplicationConfiguration API is called, 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.

Note

When configuring cross-account replication, the destination account must grant the source account permission to replicate. This permission is controlled using a registry permissions policy. For more information, see PutRegistryPolicy.

Request Syntax

{ "replicationConfiguration": { "rules": [ { "destinations": [ { "region": "string", "registryId": "string" } ] } ] } }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

replicationConfiguration

An object representing the replication configuration for a registry.

Type: ReplicationConfiguration object

Required: Yes

Response Syntax

{ "replicationConfiguration": { "rules": [ { "destinations": [ { "region": "string", "registryId": "string" } ] } ] } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

replicationConfiguration

The contents of the replication configuration for the registry.

Type: ReplicationConfiguration object

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidParameterException

The specified parameter is invalid. Review the available parameters for the API request.

HTTP Status Code: 400

ServerException

These errors are usually caused by a server-side issue.

HTTP Status Code: 500

ValidationException

There was an exception validating this request.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: