API.md

API Reference

Constructs

BashExecFunction

Initializers

import { BashExecFunction } from 'cdk-certbot-dns-route53'

new BashExecFunction(scope: Construct, id: string, props: BashExecFunctionProps)

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: cdk-certbot-dns-route53.BashExecFunctionProps

---

Properties

handler^Required

public readonly handler: DockerImageFunction;

• Type: aws-cdk-lib.aws_lambda.DockerImageFunction

---

CertbotDnsRoute53Job

Initializers

import { CertbotDnsRoute53Job } from 'cdk-certbot-dns-route53'

new CertbotDnsRoute53Job(scope: Construct, id: string, props: CertbotDnsRoute53JobProps)

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: cdk-certbot-dns-route53.CertbotDnsRoute53JobProps

---

CertbotDnsRoute53JobPython

Initializers

import { CertbotDnsRoute53JobPython } from 'cdk-certbot-dns-route53'

new CertbotDnsRoute53JobPython(scope: Construct, id: string, props: CertbotDnsRoute53JobProps)

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: cdk-certbot-dns-route53.CertbotDnsRoute53JobProps

---

LambdaPythonFunction

Initializers

import { LambdaPythonFunction } from 'cdk-certbot-dns-route53'

new LambdaPythonFunction(scope: Construct, id: string, props: LambdaFunctionProps)

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: cdk-certbot-dns-route53.LambdaFunctionProps

---

Properties

handler^Required

public readonly handler: PythonFunction;

• Type: @aws-cdk/aws-lambda-python-alpha.PythonFunction

---

Structs

BashExecFunctionProps

Initializer

import { BashExecFunctionProps } from 'cdk-certbot-dns-route53'

const bashExecFunctionProps: BashExecFunctionProps = { ... }

script^Required

public readonly script: string;

• Type: string

The path of the shell script to be executed.

---

architecture^Optional

public readonly architecture: Architecture;

• Type: aws-cdk-lib.aws_lambda.Architecture
• Default: lambda.Architecture.X86_64

Custom lambda Image Architecture.

---

dockerfile^Optional

public readonly dockerfile: string;

• Type: string

The path of your custom dockerfile.

---

environment^Optional

public readonly environment: {[ key: string ]: string};

• Type: {[ key: string ]: string}

Lambda environment variables.

---

role^Optional

public readonly role: IRole;

• Type: aws-cdk-lib.aws_iam.IRole
• Default: auto generated role.

Custom lambda execution role.

---

timeout^Optional

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

import { CertbotDnsRoute53JobProps } from 'cdk-certbot-dns-route53'

const certbotDnsRoute53JobProps: CertbotDnsRoute53JobProps = { ... }

certbotOptions^Required

public readonly certbotOptions: CertbotOptions;

• Type: cdk-certbot-dns-route53.CertbotOptions

certbot cmd options.

---

destinationBucket^Required

public readonly destinationBucket: IBucket;

• Type: aws-cdk-lib.aws_s3.IBucket

The S3 bucket to store certificate.

---

zone^Required

public readonly zone: IHostedZone;

• Type: aws-cdk-lib.aws_route53.IHostedZone

The HostZone on route53 to dns-01 challenge.

---

architecture^Optional

public readonly architecture: Architecture;

• Type: aws-cdk-lib.aws_lambda.Architecture
• Default: lambda.Architecture.X86_64

Custom lambda Image Architecture.

---

enabledLambdaFunctionUrl^Optional

public readonly enabledLambdaFunctionUrl: boolean;

• Type: boolean
• Default: false

Enabled Lambda Function URL.

---

functionUrlOptions^Optional

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

public readonly schedule: Schedule;

• Type: aws-cdk-lib.aws_events.Schedule
• Default: no schedule

run the Job with defined schedule.

---

CertbotOptions

Initializer

import { CertbotOptions } from 'cdk-certbot-dns-route53'

const certbotOptions: CertbotOptions = { ... }

domainName^Required

public readonly domainName: string;

• Type: string

the domain must host on route53 like example.com.

---

email^Required

public readonly email: string;

• Type: string

Email address for important account notifications.

---

customPrefixDirectory^Optional

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.

---

LambdaFunctionProps

Initializer

import { LambdaFunctionProps } from 'cdk-certbot-dns-route53'

const lambdaFunctionProps: LambdaFunctionProps = { ... }

architecture^Required

public readonly architecture: Architecture;

• Type: aws-cdk-lib.aws_lambda.Architecture

---

timeout^Required

public readonly timeout: Duration;

• Type: aws-cdk-lib.Duration

---

environment^Optional

public readonly environment: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

role^Optional

public readonly role: IRole;

• Type: aws-cdk-lib.aws_iam.IRole

---