Skip to content

API.md

Latest commit

 

History

History
533 lines (329 loc) · 18.1 KB

API.md

File metadata and controls

533 lines (329 loc) · 18.1 KB

API Reference

Constructs

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.
with Applies one or more mixins to this construct.
toString 
public toString(): string

Returns a string representation of this construct.

with 
public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixinsRequired
  • Type: ...constructs.IMixin[]

The mixins to apply.

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.

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.

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.
with Applies one or more mixins to this construct.
toString 
public toString(): string

Returns a string representation of this construct.

with 
public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixinsRequired
  • Type: ...constructs.IMixin[]

The mixins to apply.

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.

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.

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

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