interface CfnRepositoryProps

Language	Type name
.NET	`Amazon.CDK.AWS.ECR.CfnRepositoryProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsecr#CfnRepositoryProps`
Java	`software.amazon.awscdk.services.ecr.CfnRepositoryProps`
Python	`aws_cdk.aws_ecr.CfnRepositoryProps`
TypeScript	`aws-cdk-lib` » `aws_ecr` » `CfnRepositoryProps`

Properties for defining a CfnRepository.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ecr as ecr } from 'aws-cdk-lib';

declare const repositoryPolicyText: any;
const cfnRepositoryProps: ecr.CfnRepositoryProps = {
  emptyOnDelete: false,
  encryptionConfiguration: {
    encryptionType: 'encryptionType',

    // the properties below are optional
    kmsKey: 'kmsKey',
  },
  imageScanningConfiguration: {
    scanOnPush: false,
  },
  imageTagMutability: 'imageTagMutability',
  lifecyclePolicy: {
    lifecyclePolicyText: 'lifecyclePolicyText',
    registryId: 'registryId',
  },
  repositoryName: 'repositoryName',
  repositoryPolicyText: repositoryPolicyText,
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
emptyOnDelete?	`boolean \|` `IResolvable`	If true, deleting the repository force deletes the contents of the repository.
encryptionConfiguration?	`IResolvable` `\|` `EncryptionConfigurationProperty`	The encryption configuration for the repository.
imageScanningConfiguration?	`IResolvable` `\|` `ImageScanningConfigurationProperty`	The image scanning configuration for the repository.
imageTagMutability?	`string`	The tag mutability setting for the repository.
lifecyclePolicy?	`IResolvable` `\|` `LifecyclePolicyProperty`	Creates or updates a lifecycle policy.
repositoryName?	`string`	The name to use for the repository.
repositoryPolicyText?	`any`	The JSON repository policy text to apply to the repository.
tags?	`CfnTag[]`	An array of key-value pairs to apply to this resource.

emptyOnDelete?

Type: boolean | IResolvable (optional)

If true, deleting the repository force deletes the contents of the repository.

If false, the repository must be empty before attempting to delete it.

encryptionConfiguration?

Type: IResolvable | EncryptionConfigurationProperty (optional)

The encryption configuration for the repository.

This determines how the contents of your repository are encrypted at rest.

imageScanningConfiguration?

Type: IResolvable | ImageScanningConfigurationProperty (optional)

The image scanning configuration for the repository.

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

imageTagMutability?

Type: string (optional)

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.

lifecyclePolicy?

Type: IResolvable | LifecyclePolicyProperty (optional)

Creates or updates a lifecycle policy.

For information about lifecycle policy syntax, see Lifecycle policy template .

repositoryName?

Type: string (optional)

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 ). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the repository name. For more information, see Name type .

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

If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

repositoryPolicyText?

Type: any (optional)

The JSON repository policy text to apply to the repository.

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

tags?

Type: CfnTag[] (optional)

An array of key-value pairs to apply to this resource.