Skip to content

Create Repository

ecr_create_repository R Documentation

Creates a repository

Description

Creates a repository. For more information, see Amazon ECR repositories in the Amazon Elastic Container Registry User Guide.

Usage

ecr_create_repository(registryId, repositoryName, tags,
  imageTagMutability, imageScanningConfiguration, encryptionConfiguration)

Arguments

registryId

The Amazon Web Services account ID associated with the registry to create the repository. If you do not specify a registry, the default registry is assumed.

repositoryName

[required] The name to use for the repository. The repository name may be specified on its own (such as nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app).

The repository name must start with a letter and can only contain lowercase letters, numbers, hyphens, underscores, and forward slashes.

tags

The metadata that you apply to the repository to help you categorize and organize them. 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

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.

imageScanningConfiguration

The image scanning configuration for the repository. This determines whether images are scanned for known vulnerabilities after being pushed to the repository.

encryptionConfiguration

The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest.

Value

A list with the following syntax:

list(
  repository = list(
    repositoryArn = "string",
    registryId = "string",
    repositoryName = "string",
    repositoryUri = "string",
    createdAt = as.POSIXct(
      "2015-01-01"
    ),
    imageTagMutability = "MUTABLE"|"IMMUTABLE",
    imageScanningConfiguration = list(
      scanOnPush = TRUE|FALSE
    ),
    encryptionConfiguration = list(
      encryptionType = "AES256"|"KMS",
      kmsKey = "string"
    )
  )
)

Request syntax

svc$create_repository(
  registryId = "string",
  repositoryName = "string",
  tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  imageTagMutability = "MUTABLE"|"IMMUTABLE",
  imageScanningConfiguration = list(
    scanOnPush = TRUE|FALSE
  ),
  encryptionConfiguration = list(
    encryptionType = "AES256"|"KMS",
    kmsKey = "string"
  )
)

Examples

## Not run: 
# This example creates a repository called nginx-web-app inside the
# project-a namespace in the default registry for an account.
svc$create_repository(
  repositoryName = "project-a/nginx-web-app"
)

## End(Not run)