Skip to content

Update Repository Creation Template

ecr_update_repository_creation_template R Documentation

Updates an existing repository creation template

Description

Updates an existing repository creation template.

Usage

ecr_update_repository_creation_template(prefix, description,
  encryptionConfiguration, resourceTags, imageTagMutability,
  repositoryPolicy, lifecyclePolicy, appliedFor, customRoleArn)

Arguments

prefix

[required] The repository namespace prefix that matches an existing repository creation template in the registry. All repositories created using this namespace prefix will have the settings defined in this template applied. For example, a prefix of prod would apply to all repositories beginning with ⁠prod/⁠. This includes a repository named prod/team1 as well as a repository named prod/repository1.

To apply a template to all repositories in your registry that don't have an associated creation template, you can use ROOT as the prefix.

description

A description for the repository creation template.

encryptionConfiguration
resourceTags

The metadata to apply to the repository to help you categorize and organize. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

imageTagMutability

Updates the tag mutability setting for the repository. If this parameter is omitted, the default setting of MUTABLE will be used which will allow image tags to be overwritten. If IMMUTABLE is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.

repositoryPolicy

Updates the repository policy created using the template. A repository policy is a permissions policy associated with a repository to control access permissions.

lifecyclePolicy

Updates the lifecycle policy associated with the specified repository creation template.

appliedFor

Updates the list of enumerable strings representing the Amazon ECR repository creation scenarios that this template will apply towards. The two supported scenarios are PULL_THROUGH_CACHE and REPLICATION

customRoleArn

The ARN of the role to be assumed by Amazon ECR. This role must be in the same account as the registry that you are configuring. Amazon ECR will assume your supplied role when the customRoleArn is specified. When this field isn't specified, Amazon ECR will use the service-linked role for the repository creation template.

Value

A list with the following syntax:

list(
  registryId = "string",
  repositoryCreationTemplate = list(
    prefix = "string",
    description = "string",
    encryptionConfiguration = list(
      encryptionType = "AES256"|"KMS",
      kmsKey = "string"
    ),
    resourceTags = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    imageTagMutability = "MUTABLE"|"IMMUTABLE",
    repositoryPolicy = "string",
    lifecyclePolicy = "string",
    appliedFor = list(
      "REPLICATION"|"PULL_THROUGH_CACHE"
    ),
    customRoleArn = "string",
    createdAt = as.POSIXct(
      "2015-01-01"
    ),
    updatedAt = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax

svc$update_repository_creation_template(
  prefix = "string",
  description = "string",
  encryptionConfiguration = list(
    encryptionType = "AES256"|"KMS",
    kmsKey = "string"
  ),
  resourceTags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  imageTagMutability = "MUTABLE"|"IMMUTABLE",
  repositoryPolicy = "string",
  lifecyclePolicy = "string",
  appliedFor = list(
    "REPLICATION"|"PULL_THROUGH_CACHE"
  ),
  customRoleArn = "string"
)

Examples

## Not run: 
# This example updates a repository creation template.
svc$update_repository_creation_template(
  appliedFor = list(
    "REPLICATION"
  ),
  prefix = "eng/test",
  resourceTags = list(
    list(
      Key = "environment",
      Value = "test"
    )
  )
)

## End(Not run)