Skip to content

Latest commit

 

History

History
214 lines (127 loc) · 6 KB

API.md.md

File metadata and controls

214 lines (127 loc) · 6 KB

API Reference

Constructs

HugoDeploy

Initializers 

import { HugoDeploy } from 'cdk-hugo-deploy'

new HugoDeploy(scope: Construct, id: string, props: HugoDeployProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props HugoDeployProps 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 { HugoDeploy } from 'cdk-hugo-deploy'

HugoDeploy.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
domainName string No description.
publicDir string No description.
region string No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

domainNameRequired 
public readonly domainName: string;
  • Type: string
publicDirRequired 
public readonly publicDir: string;
  • Type: string
regionOptional 
public readonly region: string;
  • Type: string

Structs

HugoDeployProps

Initializer 

import { HugoDeployProps } from 'cdk-hugo-deploy'

const hugoDeployProps: HugoDeployProps = { ... }

Properties

Name Type Description
domainName string Domain name of the site deploying to.
publicDir string Path to Hugo public directory, which is generated after running the hugo command.
region string Region deploying to.
zone aws-cdk-lib.aws_route53.HostedZone Zone the Domain Name is created in.
domainNameRequired 
public readonly domainName: string;
  • Type: string

Domain name of the site deploying to.

You should already have a hosted zone in the account you're deploying to with this domain name

publicDirRequired 
public readonly publicDir: string;
  • Type: string

Path to Hugo public directory, which is generated after running the hugo command.

By default, this will be the public directory in your hugo project

regionOptional 
public readonly region: string;
  • Type: string
  • Default: us-east-1

Region deploying to.

zoneOptional 
public readonly zone: HostedZone;
  • Type: aws-cdk-lib.aws_route53.HostedZone

Zone the Domain Name is created in.