# API Reference
## Constructs
### BashExecFunction
#### Initializers
```typescript
import { BashExecFunction } from 'cdk-certbot-dns-route53'
new BashExecFunction(scope: Construct, id: string, props: BashExecFunctionProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | BashExecFunctionProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Required
- *Type:* BashExecFunctionProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### ~~`isConstruct`~~
```typescript
import { BashExecFunction } from 'cdk-certbot-dns-route53'
BashExecFunction.isConstruct(x: any)
```
Checks if `x` is a construct.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| handler | aws-cdk-lib.aws_lambda.DockerImageFunction | *No description.* |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `handler`Required
```typescript
public readonly handler: DockerImageFunction;
```
- *Type:* aws-cdk-lib.aws_lambda.DockerImageFunction
---
### CertbotDnsRoute53Job
#### Initializers
```typescript
import { CertbotDnsRoute53Job } from 'cdk-certbot-dns-route53'
new CertbotDnsRoute53Job(scope: Construct, id: string, props: CertbotDnsRoute53JobProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | CertbotDnsRoute53JobProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Required
- *Type:* CertbotDnsRoute53JobProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### ~~`isConstruct`~~
```typescript
import { CertbotDnsRoute53Job } from 'cdk-certbot-dns-route53'
CertbotDnsRoute53Job.isConstruct(x: any)
```
Checks if `x` is a construct.
###### `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.
---
### CertbotDnsRoute53JobPython
#### Initializers
```typescript
import { CertbotDnsRoute53JobPython } from 'cdk-certbot-dns-route53'
new CertbotDnsRoute53JobPython(scope: Construct, id: string, props: CertbotDnsRoute53JobProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | CertbotDnsRoute53JobProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Required
- *Type:* CertbotDnsRoute53JobProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### ~~`isConstruct`~~
```typescript
import { CertbotDnsRoute53JobPython } from 'cdk-certbot-dns-route53'
CertbotDnsRoute53JobPython.isConstruct(x: any)
```
Checks if `x` is a construct.
###### `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.
---
### LambdaPythonFunction
#### Initializers
```typescript
import { LambdaPythonFunction } from 'cdk-certbot-dns-route53'
new LambdaPythonFunction(scope: Construct, id: string, props: LambdaFunctionProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | LambdaFunctionProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Required
- *Type:* LambdaFunctionProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### ~~`isConstruct`~~
```typescript
import { LambdaPythonFunction } from 'cdk-certbot-dns-route53'
LambdaPythonFunction.isConstruct(x: any)
```
Checks if `x` is a construct.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| handler | @aws-cdk/aws-lambda-python-alpha.PythonFunction | *No description.* |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `handler`Required
```typescript
public readonly handler: PythonFunction;
```
- *Type:* @aws-cdk/aws-lambda-python-alpha.PythonFunction
---
## Structs
### BashExecFunctionProps
#### Initializer
```typescript
import { BashExecFunctionProps } from 'cdk-certbot-dns-route53'
const bashExecFunctionProps: BashExecFunctionProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| script | string | The path of the shell script to be executed. |
| architecture | aws-cdk-lib.aws_lambda.Architecture | Custom lambda Image Architecture. |
| dockerfile | string | The path of your custom dockerfile. |
| environment | {[ key: string ]: string} | Lambda environment variables. |
| role | aws-cdk-lib.aws_iam.IRole | Custom lambda execution role. |
| timeout | aws-cdk-lib.Duration | The function execution time (in seconds) after which Lambda terminates the function. |
---
##### `script`Required
```typescript
public readonly script: string;
```
- *Type:* string
The path of the shell script to be executed.
---
##### `architecture`Optional
```typescript
public readonly architecture: Architecture;
```
- *Type:* aws-cdk-lib.aws_lambda.Architecture
- *Default:* lambda.Architecture.X86_64
Custom lambda Image Architecture.
---
##### `dockerfile`Optional
```typescript
public readonly dockerfile: string;
```
- *Type:* string
The path of your custom dockerfile.
---
##### `environment`Optional
```typescript
public readonly environment: {[ key: string ]: string};
```
- *Type:* {[ key: string ]: string}
Lambda environment variables.
---
##### `role`Optional
```typescript
public readonly role: IRole;
```
- *Type:* aws-cdk-lib.aws_iam.IRole
- *Default:* auto generated role.
Custom lambda execution role.
---
##### `timeout`Optional
```typescript
public readonly timeout: Duration;
```
- *Type:* aws-cdk-lib.Duration
- *Default:* Duration.seconds(60)
The function execution time (in seconds) after which Lambda terminates the function.
Because the execution time affects cost, set this value based on the function's expected execution time.
---
### CertbotDnsRoute53JobProps
#### Initializer
```typescript
import { CertbotDnsRoute53JobProps } from 'cdk-certbot-dns-route53'
const certbotDnsRoute53JobProps: CertbotDnsRoute53JobProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| certbotOptions | CertbotOptions | certbot cmd options. |
| destinationBucket | aws-cdk-lib.aws_s3.IBucket | The S3 bucket to store certificate. |
| zone | aws-cdk-lib.aws_route53.IHostedZone | The HostZone on route53 to dns-01 challenge. |
| architecture | aws-cdk-lib.aws_lambda.Architecture | Custom lambda Image Architecture. |
| enabledLambdaFunctionUrl | boolean | Enabled Lambda Function URL. |
| functionUrlOptions | aws-cdk-lib.aws_lambda.FunctionUrlOptions | Options to add a url to a Lambda function. |
| schedule | aws-cdk-lib.aws_events.Schedule | run the Job with defined schedule. |
---
##### `certbotOptions`Required
```typescript
public readonly certbotOptions: CertbotOptions;
```
- *Type:* CertbotOptions
certbot cmd options.
---
##### `destinationBucket`Required
```typescript
public readonly destinationBucket: IBucket;
```
- *Type:* aws-cdk-lib.aws_s3.IBucket
The S3 bucket to store certificate.
---
##### `zone`Required
```typescript
public readonly zone: IHostedZone;
```
- *Type:* aws-cdk-lib.aws_route53.IHostedZone
The HostZone on route53 to dns-01 challenge.
---
##### `architecture`Optional
```typescript
public readonly architecture: Architecture;
```
- *Type:* aws-cdk-lib.aws_lambda.Architecture
- *Default:* lambda.Architecture.X86_64
Custom lambda Image Architecture.
---
##### `enabledLambdaFunctionUrl`Optional
```typescript
public readonly enabledLambdaFunctionUrl: boolean;
```
- *Type:* boolean
- *Default:* false
Enabled Lambda Function URL.
---
##### `functionUrlOptions`Optional
```typescript
public readonly functionUrlOptions: FunctionUrlOptions;
```
- *Type:* aws-cdk-lib.aws_lambda.FunctionUrlOptions
- *Default:* authType: lambda.FunctionUrlAuthType.NONE
Options to add a url to a Lambda function.
---
##### `schedule`Optional
```typescript
public readonly schedule: Schedule;
```
- *Type:* aws-cdk-lib.aws_events.Schedule
- *Default:* no schedule
run the Job with defined schedule.
---
### CertbotOptions
#### Initializer
```typescript
import { CertbotOptions } from 'cdk-certbot-dns-route53'
const certbotOptions: CertbotOptions = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| domainName | string | the domain must host on route53 like example.com. |
| email | string | Email address for important account notifications. |
| customPrefixDirectory | string | Custom prefix directory on s3 bucket object path. |
---
##### `domainName`Required
```typescript
public readonly domainName: string;
```
- *Type:* string
the domain must host on route53 like example.com.
---
*Example*
```typescript
- `*.example.com` or `a.example.com` .
```
##### `email`Required
```typescript
public readonly email: string;
```
- *Type:* string
Email address for important account notifications.
---
##### `customPrefixDirectory`Optional
```typescript
public readonly customPrefixDirectory: string;
```
- *Type:* string
- *Default:* `s3://YOUR_BUCKET_NAME/2021-01-01/your.domain.name/`
Custom prefix directory on s3 bucket object path.
---
*Example*
```typescript
- customPrefixDirectory: 'abc' -> `s3://YOUR_BUCKET_NAME/abc/your.domain.name/`
```
### LambdaFunctionProps
#### Initializer
```typescript
import { LambdaFunctionProps } from 'cdk-certbot-dns-route53'
const lambdaFunctionProps: LambdaFunctionProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| architecture | aws-cdk-lib.aws_lambda.Architecture | *No description.* |
| timeout | aws-cdk-lib.Duration | *No description.* |
| environment | {[ key: string ]: string} | *No description.* |
| role | aws-cdk-lib.aws_iam.IRole | *No description.* |
---
##### `architecture`Required
```typescript
public readonly architecture: Architecture;
```
- *Type:* aws-cdk-lib.aws_lambda.Architecture
---
##### `timeout`Required
```typescript
public readonly timeout: Duration;
```
- *Type:* aws-cdk-lib.Duration
---
##### `environment`Optional
```typescript
public readonly environment: {[ key: string ]: string};
```
- *Type:* {[ key: string ]: string}
---
##### `role`Optional
```typescript
public readonly role: IRole;
```
- *Type:* aws-cdk-lib.aws_iam.IRole
---