put-replication-configuration¶

Description¶

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 .

Synopsis¶

  put-replication-configuration
--replication-configuration <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--replication-configuration (structure)

An object representing the replication configuration for a registry.

rules -> (list)

An array of objects representing the replication destinations and repository filters for a replication configuration.

(structure)

An array of objects representing the replication destinations and repository filters for a replication configuration.

destinations -> (list)

An array of objects representing the destination for a replication rule.

(structure)

An array of objects representing the destination for a replication rule.

region -> (string)

The Region to replicate to.

registryId -> (string)

The Amazon Web Services account ID of the Amazon ECR private registry to replicate to. When configuring cross-Region replication within your own registry, specify your own account ID.

repositoryFilters -> (list)

An array of objects representing the filters for a replication rule. Specifying a repository filter for a replication rule provides a method for controlling which repositories in a private registry are replicated.

(structure)

The filter settings used with image replication. Specifying a repository filter to a replication rule provides a method for controlling which repositories in a private registry are replicated. If no repository filter is specified, all images in the repository are replicated.

filter -> (string)

The repository filter details. When the PREFIX_MATCH filter type is specified, this value is required and should be the repository name prefix to configure replication for.

filterType -> (string)

The repository filter type. The only supported value is PREFIX_MATCH , which is a repository name prefix specified with the filter parameter.

JSON Syntax:

{
  "rules": [
    {
      "destinations": [
        {
          "region": "string",
          "registryId": "string"
        }
        ...
      ],
      "repositoryFilters": [
        {
          "filter": "string",
          "filterType": "PREFIX_MATCH"
        }
        ...
      ]
    }
    ...
  ]
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output¶

replicationConfiguration -> (structure)

The contents of the replication configuration for the registry.

rules -> (list)

An array of objects representing the replication destinations and repository filters for a replication configuration.

(structure)

An array of objects representing the replication destinations and repository filters for a replication configuration.

destinations -> (list)

An array of objects representing the destination for a replication rule.

(structure)

An array of objects representing the destination for a replication rule.

region -> (string)

The Region to replicate to.

registryId -> (string)

The Amazon Web Services account ID of the Amazon ECR private registry to replicate to. When configuring cross-Region replication within your own registry, specify your own account ID.

repositoryFilters -> (list)

An array of objects representing the filters for a replication rule. Specifying a repository filter for a replication rule provides a method for controlling which repositories in a private registry are replicated.

(structure)

The filter settings used with image replication. Specifying a repository filter to a replication rule provides a method for controlling which repositories in a private registry are replicated. If no repository filter is specified, all images in the repository are replicated.

filter -> (string)

The repository filter details. When the PREFIX_MATCH filter type is specified, this value is required and should be the repository name prefix to configure replication for.

filterType -> (string)

The repository filter type. The only supported value is PREFIX_MATCH , which is a repository name prefix specified with the filter parameter.

Table of Contents

Feedback

User Guide