Skip to content

Latest commit

 

History

History
770 lines (462 loc) · 25 KB

API.md

File metadata and controls

770 lines (462 loc) · 25 KB
Raw

API Reference

Constructs

BashExecFunction

Initializers 

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.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsRequired

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { BashExecFunction } from 'cdk-certbot-dns-route53'

BashExecFunction.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
handler aws-cdk-lib.aws_lambda.DockerImageFunction No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

handlerRequired 
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)
Name Type Description
scope constructs.Construct No description.
id string No description.
props CertbotDnsRoute53JobProps No description.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsRequired

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { CertbotDnsRoute53Job } from 'cdk-certbot-dns-route53'

CertbotDnsRoute53Job.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

CertbotDnsRoute53JobPython

Initializers 

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.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsRequired

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { CertbotDnsRoute53JobPython } from 'cdk-certbot-dns-route53'

CertbotDnsRoute53JobPython.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

LambdaPythonFunction

Initializers 

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.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsRequired

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { LambdaPythonFunction } from 'cdk-certbot-dns-route53'

LambdaPythonFunction.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
handler @aws-cdk/aws-lambda-python-alpha.PythonFunction No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

handlerRequired 
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 = { ... }

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.
scriptRequired 
public readonly script: string;
  • Type: string

The path of the shell script to be executed.

architectureOptional 
public readonly architecture: Architecture;
  • Type: aws-cdk-lib.aws_lambda.Architecture
  • Default: lambda.Architecture.X86_64

Custom lambda Image Architecture.

dockerfileOptional 
public readonly dockerfile: string;
  • Type: string

The path of your custom dockerfile.

environmentOptional 
public readonly environment: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Lambda environment variables.

roleOptional 
public readonly role: IRole;
  • Type: aws-cdk-lib.aws_iam.IRole
  • Default: auto generated role.

Custom lambda execution role.

timeoutOptional 
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 = { ... }

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.
certbotOptionsRequired 
public readonly certbotOptions: CertbotOptions;

certbot cmd options.

destinationBucketRequired 
public readonly destinationBucket: IBucket;
  • Type: aws-cdk-lib.aws_s3.IBucket

The S3 bucket to store certificate.

zoneRequired 
public readonly zone: IHostedZone;
  • Type: aws-cdk-lib.aws_route53.IHostedZone

The HostZone on route53 to dns-01 challenge.

architectureOptional 
public readonly architecture: Architecture;
  • Type: aws-cdk-lib.aws_lambda.Architecture
  • Default: lambda.Architecture.X86_64

Custom lambda Image Architecture.

enabledLambdaFunctionUrlOptional 
public readonly enabledLambdaFunctionUrl: boolean;
  • Type: boolean
  • Default: false

Enabled Lambda Function URL.

functionUrlOptionsOptional 
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.

scheduleOptional 
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 = { ... }

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.
domainNameRequired 
public readonly domainName: string;
  • Type: string

the domain must host on route53 like example.com.

Example

- `*.example.com` or `a.example.com` .
emailRequired 
public readonly email: string;
  • Type: string

Email address for important account notifications.

customPrefixDirectoryOptional 
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

- customPrefixDirectory: 'abc' -> `s3://YOUR_BUCKET_NAME/abc/your.domain.name/`

LambdaFunctionProps

Initializer 

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.
architectureRequired 
public readonly architecture: Architecture;
  • Type: aws-cdk-lib.aws_lambda.Architecture
timeoutRequired 
public readonly timeout: Duration;
  • Type: aws-cdk-lib.Duration
environmentOptional 
public readonly environment: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
roleOptional 
public readonly role: IRole;
  • Type: aws-cdk-lib.aws_iam.IRole