# API Reference
## Constructs
### EcrSync
Construct to sync Docker images from DockerHub into ECR Repos.
#### Initializers
```typescript
import { EcrSync } from '@pgarbe/cdk-ecr-sync'
new EcrSync(scope: Construct, id: string, props: EcrSyncProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | EcrSyncProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Required
- *Type:* EcrSyncProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
| grantPull | Grant the given identity permissions to use the images in this repository. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
##### `grantPull`
```typescript
public grantPull(grantee: IGrantable): void
```
Grant the given identity permissions to use the images in this repository.
###### `grantee`Required
- *Type:* aws-cdk-lib.aws_iam.IGrantable
---
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### `isConstruct`
```typescript
import { EcrSync } from '@pgarbe/cdk-ecr-sync'
EcrSync.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
### EcrSyncProps
Properties for EcrSync.
#### Initializer
```typescript
import { EcrSyncProps } from '@pgarbe/cdk-ecr-sync'
const ecrSyncProps: EcrSyncProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| dockerImages | Image[] | Images from Docker Hub that should be pulled into ECR. |
| initScript | string | Optional. |
| lifcecyleRule | aws-cdk-lib.aws_ecr.LifecycleRule | An ECR lifecycle rule which is applied to all repositories. |
| repoPrefix | string | A prefix for all ECR repository names. |
| schedule | aws-cdk-lib.aws_events.Schedule | Optional. |
---
##### `dockerImages`Required
```typescript
public readonly dockerImages: Image[];
```
- *Type:* Image[]
Images from Docker Hub that should be pulled into ECR.
---
##### `initScript`Optional
```typescript
public readonly initScript: string;
```
- *Type:* string
- *Default:* Empty.
Optional.
Bash script injection for the docker image processing phase,
in order to log in to Dockerhub or do other initialization.
---
##### `lifcecyleRule`Optional
```typescript
public readonly lifcecyleRule: LifecycleRule;
```
- *Type:* aws-cdk-lib.aws_ecr.LifecycleRule
- *Default:* No lifecycle rules.
An ECR lifecycle rule which is applied to all repositories.
---
##### `repoPrefix`Optional
```typescript
public readonly repoPrefix: string;
```
- *Type:* string
- *Default:* Empty.
A prefix for all ECR repository names.
---
##### `schedule`Optional
```typescript
public readonly schedule: Schedule;
```
- *Type:* aws-cdk-lib.aws_events.Schedule
- *Default:* is once a day.
Optional.
Schedule when images should be synchronized.
---
### Image
Properties of a EcrSync image.
#### Initializer
```typescript
import { Image } from '@pgarbe/cdk-ecr-sync'
const image: Image = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| imageName | string | The name of the image that should be proxied by ECR. |
| excludeTags | string[] | A list of regular expression which tags should be included. Only one of the defined tags must match. |
| includeTags | string[] | A list of regular expression which tags should be included. Only one of the defined tags must match. |
---
##### `imageName`Required
```typescript
public readonly imageName: string;
```
- *Type:* string
The name of the image that should be proxied by ECR.
---
##### `excludeTags`Optional
```typescript
public readonly excludeTags: string[];
```
- *Type:* string[]
- *Default:* Empty. No tags are excluded
A list of regular expression which tags should be included. Only one of the defined tags must match.
If includeTags is also defined, excludeTags wins.
---
##### `includeTags`Optional
```typescript
public readonly includeTags: string[];
```
- *Type:* string[]
- *Default:* Emtpy. All tags are included
A list of regular expression which tags should be included. Only one of the defined tags must match.
If excludeTags is also defined, excludeTags wins.
---