cdk-kaniko/API.md

CDK construct library that allows you to build docker images with kaniko in AWS Fargate

# API Reference

**Classes**

Name|Description
----|-----------
[Kaniko](#cdk-kaniko-kaniko)|*No description*


**Structs**

Name|Description
----|-----------
[KanikoProps](#cdk-kaniko-kanikoprops)|*No description*



## class Kaniko  <a id="cdk-kaniko-kaniko"></a>



__Implements__: [IConstruct](#constructs-iconstruct), [IDependable](#constructs-idependable)
__Extends__: [Construct](#constructs-construct)

### Initializer




```ts
new Kaniko(scope: Construct, id: string, props: KanikoProps)
```

* **scope** (<code>[Construct](#constructs-construct)</code>)  *No description*
* **id** (<code>string</code>)  *No description*
* **props** (<code>[KanikoProps](#cdk-kaniko-kanikoprops)</code>)  *No description*
  * **context** (<code>string</code>)  Kaniko build context. 
  * **contextSubPath** (<code>string</code>)  The context sub path. __*Optional*__
  * **destinationRepository** (<code>[aws_ecr.IRepository](#aws-cdk-lib-aws-ecr-irepository)</code>)  The target ECR repository. __*Default*__: create a new ECR private repository
  * **dockerfile** (<code>string</code>)  The Dockerfile for the image building. __*Default*__: Dockerfile
  * **fargateSpot** (<code>boolean</code>)  Use FARGATE_SPOT capacity provider. __*Optional*__



### Properties


Name | Type | Description 
-----|------|-------------
**cluster** | <code>[aws_ecs.ICluster](#aws-cdk-lib-aws-ecs-icluster)</code> | <span></span>
**destinationRepository** | <code>[aws_ecr.IRepository](#aws-cdk-lib-aws-ecr-irepository)</code> | <span></span>
**task** | <code>[aws_ecs.FargateTaskDefinition](#aws-cdk-lib-aws-ecs-fargatetaskdefinition)</code> | <span></span>
**vpc** | <code>[aws_ec2.IVpc](#aws-cdk-lib-aws-ec2-ivpc)</code> | <span></span>

### Methods


#### buildImage(id, schedule?) <a id="cdk-kaniko-kaniko-buildimage"></a>

Build the image with kaniko.

```ts
buildImage(id: string, schedule?: Schedule): void
```

* **id** (<code>string</code>)  *No description*
* **schedule** (<code>[aws_events.Schedule](#aws-cdk-lib-aws-events-schedule)</code>)  The schedule to repeatedly build the image.






## struct KanikoProps  <a id="cdk-kaniko-kanikoprops"></a>






Name | Type | Description 
-----|------|-------------
**context** | <code>string</code> | Kaniko build context.
**contextSubPath**? | <code>string</code> | The context sub path.<br/>__*Optional*__
**destinationRepository**? | <code>[aws_ecr.IRepository](#aws-cdk-lib-aws-ecr-irepository)</code> | The target ECR repository.<br/>__*Default*__: create a new ECR private repository
**dockerfile**? | <code>string</code> | The Dockerfile for the image building.<br/>__*Default*__: Dockerfile
**fargateSpot**? | <code>boolean</code> | Use FARGATE_SPOT capacity provider.<br/>__*Optional*__