# API Reference
## Constructs
### ECRDeployment
#### Initializers
```typescript
import { ECRDeployment } from 'cdk-ecr-deployment'
new ECRDeployment(scope: Construct, id: string, props: ECRDeploymentProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | ECRDeploymentProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Required
- *Type:* ECRDeploymentProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
| with | Applies one or more mixins to this construct. |
| addToPrincipalPolicy | *No description.* |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
##### `with`
```typescript
public with(mixins: ...IMixin[]): IConstruct
```
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple `with()` calls if subsequent mixins should apply to added
constructs.
###### `mixins`Required
- *Type:* ...constructs.IMixin[]
The mixins to apply.
---
##### `addToPrincipalPolicy`
```typescript
public addToPrincipalPolicy(statement: PolicyStatement): AddToPrincipalPolicyResult
```
###### `statement`Required
- *Type:* aws-cdk-lib.aws_iam.PolicyStatement
---
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### `isConstruct`
```typescript
import { ECRDeployment } from 'cdk-ecr-deployment'
ECRDeployment.isConstruct(x: any)
```
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct`
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on
disk are seen as independent, completely different libraries. As a
consequence, the class `Construct` in each copy of the `constructs` library
is seen as a different class, and an instance of one class will not test as
`instanceof` the other class. `npm install` will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the `constructs`
library can be accidentally installed, and `instanceof` will behave
unpredictably. It is safest to avoid using `instanceof`, and using
this type-testing method instead.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
## Structs
### ECRDeploymentProps
#### Initializer
```typescript
import { ECRDeploymentProps } from 'cdk-ecr-deployment'
const eCRDeploymentProps: ECRDeploymentProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| dest | IImageName | The destination of the docker image. |
| src | IImageName | The source of the docker image. |
| archImageTags | {[ key: string ]: string} | Tags to apply to individual architecture-specific images when copyImageIndex is true. |
| copyImageIndex | boolean | Whether to copy a source docker image index (multi-arch manifest) to the destination. |
| imageArch | string[] | The image architecture to be copied. |
| memoryLimit | number | The amount of memory (in MiB) to allocate to the AWS Lambda function which replicates the files from the CDK bucket to the destination bucket. |
| retryConfigs | {[ key: string ]: number} | Retry configuration to apply to when copying images such as the number of retry attemtps, the base amount of delay (in seconds) between each retry, and the max amount of delay (in seconds) between each retry. |
| role | aws-cdk-lib.aws_iam.IRole | Execution role associated with this function. |
| securityGroups | aws-cdk-lib.aws_ec2.SecurityGroup[] | The list of security groups to associate with the Lambda's network interfaces. |
| vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC network to place the deployment lambda handler in. |
| vpcSubnets | aws-cdk-lib.aws_ec2.SubnetSelection | Where in the VPC to place the deployment lambda handler. |
---
##### `dest`Required
```typescript
public readonly dest: IImageName;
```
- *Type:* IImageName
The destination of the docker image.
---
##### `src`Required
```typescript
public readonly src: IImageName;
```
- *Type:* IImageName
The source of the docker image.
---
##### `archImageTags`Optional
```typescript
public readonly archImageTags: {[ key: string ]: string};
```
- *Type:* {[ key: string ]: string}
Tags to apply to individual architecture-specific images when copyImageIndex is true.
Can only be specified when copyImageIndex is true. Maps architecture names to
their respective tags. This makes individual architectures discoverable
by human-readable tags in addition to the image index tag.
For example, { 'arm64': 'image-arm64', 'amd64': 'image-amd64' }.
---
##### `copyImageIndex`Optional
```typescript
public readonly copyImageIndex: boolean;
```
- *Type:* boolean
- *Default:* False
Whether to copy a source docker image index (multi-arch manifest) to the destination.
When true, copies the image index and all underlying architecture-specific
images in a single operation.
---
##### `imageArch`Optional
```typescript
public readonly imageArch: string[];
```
- *Type:* string[]
- *Default:* ['amd64']
The image architecture to be copied.
The 'amd64' architecture will be copied by default. Specify the
architecture or architectures to copy here.
It is currently not possible to copy more than one architecture
at a time: the array you specify must contain exactly one string.
---
##### `memoryLimit`Optional
```typescript
public readonly memoryLimit: number;
```
- *Type:* number
- *Default:* 512
The amount of memory (in MiB) to allocate to the AWS Lambda function which replicates the files from the CDK bucket to the destination bucket.
If you are deploying large files, you will need to increase this number
accordingly.
---
##### `retryConfigs`Optional
```typescript
public readonly retryConfigs: {[ key: string ]: number};
```
- *Type:* {[ key: string ]: number}
Retry configuration to apply to when copying images such as the number of retry attemtps, the base amount of delay (in seconds) between each retry, and the max amount of delay (in seconds) between each retry.
For example, { 'numAttempts': 3, 'baseDelay': 1, 'maxDelay': 5 }
---
##### `role`Optional
```typescript
public readonly role: IRole;
```
- *Type:* aws-cdk-lib.aws_iam.IRole
- *Default:* A role is automatically created
Execution role associated with this function.
---
##### `securityGroups`Optional
```typescript
public readonly securityGroups: SecurityGroup[];
```
- *Type:* aws-cdk-lib.aws_ec2.SecurityGroup[]
- *Default:* If the function is placed within a VPC and a security group is not specified, either by this or securityGroup prop, a dedicated security group will be created for this function.
The list of security groups to associate with the Lambda's network interfaces.
Only used if 'vpc' is supplied.
---
##### `vpc`Optional
```typescript
public readonly vpc: IVpc;
```
- *Type:* aws-cdk-lib.aws_ec2.IVpc
- *Default:* None
The VPC network to place the deployment lambda handler in.
---
##### `vpcSubnets`Optional
```typescript
public readonly vpcSubnets: SubnetSelection;
```
- *Type:* aws-cdk-lib.aws_ec2.SubnetSelection
- *Default:* the Vpc default strategy if not specified
Where in the VPC to place the deployment lambda handler.
Only used if 'vpc' is supplied.
---
## Classes
### DockerImageName
- *Implements:* IImageName
#### Initializers
```typescript
import { DockerImageName } from 'cdk-ecr-deployment'
new DockerImageName(name: string, creds?: string)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| name | string | - The name of the image, e.g. retrieved from `DockerImageAsset.imageUri`. |
| creds | string | - The credentials of the docker image. |
---
##### `name`Required
- *Type:* string
The name of the image, e.g. retrieved from `DockerImageAsset.imageUri`.
---
##### `creds`Optional
- *Type:* string
The credentials of the docker image.
Format `user:password` or `AWS Secrets Manager secret arn` or `AWS Secrets Manager secret name`.
If specifying an AWS Secrets Manager secret, the format of the secret should be either plain text (`user:password`) or
JSON (`{"username":"","password":""}`).
For more details on JSON format, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/private-auth.html
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| uri | string | The uri of the docker image. |
| creds | string | - The credentials of the docker image. |
---
##### `uri`Required
```typescript
public readonly uri: string;
```
- *Type:* string
The uri of the docker image.
The uri spec follows https://github.com/containers/skopeo
---
##### `creds`Optional
```typescript
public readonly creds: string;
```
- *Type:* string
The credentials of the docker image.
Format `user:password` or `AWS Secrets Manager secret arn` or `AWS Secrets Manager secret name`.
If specifying an AWS Secrets Manager secret, the format of the secret should be either plain text (`user:password`) or
JSON (`{"username":"","password":""}`).
For more details on JSON format, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/private-auth.html
---
### S3ArchiveName
- *Implements:* IImageName
#### Initializers
```typescript
import { S3ArchiveName } from 'cdk-ecr-deployment'
new S3ArchiveName(p: string, ref?: string, creds?: string)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| p | string | - the S3 bucket name and path of the archive (a S3 URI without the s3://). |
| ref | string | - appended to the end of the name with a `:`, e.g. `:latest`. |
| creds | string | - The credentials of the docker image. |
---
##### `p`Required
- *Type:* string
the S3 bucket name and path of the archive (a S3 URI without the s3://).
---
##### `ref`Optional
- *Type:* string
appended to the end of the name with a `:`, e.g. `:latest`.
---
##### `creds`Optional
- *Type:* string
The credentials of the docker image.
Format `user:password` or `AWS Secrets Manager secret arn` or `AWS Secrets Manager secret name`.
If specifying an AWS Secrets Manager secret, the format of the secret should be either plain text (`user:password`) or
JSON (`{"username":"","password":""}`).
For more details on JSON format, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/private-auth.html
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| uri | string | The uri of the docker image. |
| creds | string | - The credentials of the docker image. |
---
##### `uri`Required
```typescript
public readonly uri: string;
```
- *Type:* string
The uri of the docker image.
The uri spec follows https://github.com/containers/skopeo
---
##### `creds`Optional
```typescript
public readonly creds: string;
```
- *Type:* string
The credentials of the docker image.
Format `user:password` or `AWS Secrets Manager secret arn` or `AWS Secrets Manager secret name`.
If specifying an AWS Secrets Manager secret, the format of the secret should be either plain text (`user:password`) or
JSON (`{"username":"","password":""}`).
For more details on JSON format, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/private-auth.html
---
## Protocols
### IImageName
- *Implemented By:* DockerImageName, S3ArchiveName, IImageName
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| uri | string | The uri of the docker image. |
| creds | string | The credentials of the docker image. |
---
##### `uri`Required
```typescript
public readonly uri: string;
```
- *Type:* string
The uri of the docker image.
The uri spec follows https://github.com/containers/skopeo
---
##### `creds`Optional
```typescript
public readonly creds: string;
```
- *Type:* string
The credentials of the docker image.
Format `user:password` or `AWS Secrets Manager secret arn` or `AWS Secrets Manager secret name`.
If specifying an AWS Secrets Manager secret, the format of the secret should be either plain text (`user:password`) or
JSON (`{"username":"","password":""}`).
For more details on JSON format, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/private-auth.html
---