Skip to content

Latest commit

 

History

History
2714 lines (1724 loc) · 96.8 KB

API.md

File metadata and controls

2714 lines (1724 loc) · 96.8 KB

API Reference

Constructs

HugoHosting

HugoHosting Construct.

Initializers 

import { HugoHosting } from '@mavogel/cdk-hugo-pipeline'

new HugoHosting(scope: Construct, id: string, props: HugoHostingProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props HugoHostingProps 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 { HugoHosting } from '@mavogel/cdk-hugo-pipeline'

HugoHosting.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.
buildStage string buildStage.
domainName string domainName.
siteDomain string siteDomain.
siteSubDomain string siteSubDomain.
staticSiteURL aws-cdk-lib.CfnOutput staticSiteURL.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

buildStageRequired 
public readonly buildStage: string;
  • Type: string

buildStage.

domainNameRequired 
public readonly domainName: string;
  • Type: string

domainName.

siteDomainRequired 
public readonly siteDomain: string;
  • Type: string

siteDomain.

siteSubDomainRequired 
public readonly siteSubDomain: string;
  • Type: string

siteSubDomain.

staticSiteURLRequired 
public readonly staticSiteURL: CfnOutput;
  • Type: aws-cdk-lib.CfnOutput

staticSiteURL.

HugoHostingStack

Hugo Hosting stack.

Initializers 

import { HugoHostingStack } from '@mavogel/cdk-hugo-pipeline'

new HugoHostingStack(scope: Construct, id: string, props: HugoHostingStackProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props HugoHostingStackProps No description.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsRequired

Methods

Name Description
toString Returns a string representation of this construct.
addDependency Add a dependency between this stack and another stack.
addMetadata Adds an arbitrary key-value pair, with information you want to record about the stack.
addTransform Add a Transform to this stack. A Transform is a macro that AWS CloudFormation uses to process your template.
exportStringListValue Create a CloudFormation Export for a string list value.
exportValue Create a CloudFormation Export for a string value.
formatArn Creates an ARN from components.
getLogicalId Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource.
regionalFact Look up a fact value for the given fact for the region of this stack.
renameLogicalId Rename a generated logical identities.
reportMissingContextKey Indicate that a context key was expected.
resolve Resolve a tokenized value in the context of the current stack.
splitArn Splits the provided ARN into its components.
toJsonString Convert an object, potentially containing tokens, to a JSON string.
toYamlString Convert an object, potentially containing tokens, to a YAML string.
toString 
public toString(): string

Returns a string representation of this construct.

addDependency 
public addDependency(target: Stack, reason?: string): void

Add a dependency between this stack and another stack.

This can be used to define dependencies between any two stacks within an app, and also supports nested stacks.

targetRequired
  • Type: aws-cdk-lib.Stack
reasonOptional
  • Type: string
addMetadata 
public addMetadata(key: string, value: any): void

Adds an arbitrary key-value pair, with information you want to record about the stack.

These get translated to the Metadata section of the generated template.

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

keyRequired
  • Type: string
valueRequired
  • Type: any
addTransform 
public addTransform(transform: string): void

Add a Transform to this stack. A Transform is a macro that AWS CloudFormation uses to process your template.

Duplicate values are removed when stack is synthesized.

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html

Example

declare const stack: Stack;

stack.addTransform('AWS::Serverless-2016-10-31')
transformRequired
  • Type: string

The transform to add.

exportStringListValue 
public exportStringListValue(exportedValue: any, options?: ExportValueOptions): string[]

Create a CloudFormation Export for a string list value.

Returns a string list representing the corresponding Fn.importValue() expression for this Export. The export expression is automatically wrapped with an Fn::Join and the import value with an Fn::Split, since CloudFormation can only export strings. You can control the name for the export by passing the name option.

If you don't supply a value for name, the value you're exporting must be a Resource attribute (for example: bucket.bucketName) and it will be given the same name as the automatic cross-stack reference that would be created if you used the attribute in another Stack.

One of the uses for this method is to remove the relationship between two Stacks established by automatic cross-stack references. It will temporarily ensure that the CloudFormation Export still exists while you remove the reference from the consuming stack. After that, you can remove the resource and the manual export.

See exportValue for an example of this process.

exportedValueRequired
  • Type: any
optionsOptional
  • Type: aws-cdk-lib.ExportValueOptions
exportValue 
public exportValue(exportedValue: any, options?: ExportValueOptions): string

Create a CloudFormation Export for a string value.

Returns a string representing the corresponding Fn.importValue() expression for this Export. You can control the name for the export by passing the name option.

If you don't supply a value for name, the value you're exporting must be a Resource attribute (for example: bucket.bucketName) and it will be given the same name as the automatic cross-stack reference that would be created if you used the attribute in another Stack.

One of the uses for this method is to remove the relationship between two Stacks established by automatic cross-stack references. It will temporarily ensure that the CloudFormation Export still exists while you remove the reference from the consuming stack. After that, you can remove the resource and the manual export.

Here is how the process works. Let's say there are two stacks, producerStack and consumerStack, and producerStack has a bucket called bucket, which is referenced by consumerStack (perhaps because an AWS Lambda Function writes into it, or something like that).

It is not safe to remove producerStack.bucket because as the bucket is being deleted, consumerStack might still be using it.

Instead, the process takes two deployments:

Deployment 1: break the relationship:

  • Make sure consumerStack no longer references bucket.bucketName (maybe the consumer stack now uses its own bucket, or it writes to an AWS DynamoDB table, or maybe you just remove the Lambda Function altogether).
  • In the ProducerStack class, call this.exportValue(this.bucket.bucketName). This will make sure the CloudFormation Export continues to exist while the relationship between the two stacks is being broken.
  • Deploy (this will effectively only change the consumerStack, but it's safe to deploy both).

Deployment 2: remove the bucket resource:

  • You are now free to remove the bucket resource from producerStack.
  • Don't forget to remove the exportValue() call as well.
  • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
exportedValueRequired
  • Type: any
optionsOptional
  • Type: aws-cdk-lib.ExportValueOptions
formatArn 
public formatArn(components: ArnComponents): string

Creates an ARN from components.

If partition, region or account are not specified, the stack's partition, region and account will be used.

If any component is the empty string, an empty string will be inserted into the generated ARN at the location that component corresponds to.

The ARN will be formatted as follows:

arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name}

The required ARN pieces that are omitted will be taken from the stack that the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope can be 'undefined'.

componentsRequired
  • Type: aws-cdk-lib.ArnComponents
getLogicalId 
public getLogicalId(element: CfnElement): string

Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource.

This method is called when a CfnElement is created and used to render the initial logical identity of resources. Logical ID renames are applied at this stage.

This method uses the protected method allocateLogicalId to render the logical ID for an element. To modify the naming scheme, extend the Stack class and override this method.

elementRequired
  • Type: aws-cdk-lib.CfnElement

The CloudFormation element for which a logical identity is needed.

regionalFact 
public regionalFact(factName: string, defaultValue?: string): string

Look up a fact value for the given fact for the region of this stack.

Will return a definite value only if the region of the current stack is resolved. If not, a lookup map will be added to the stack and the lookup will be done at CDK deployment time.

What regions will be included in the lookup map is controlled by the @aws-cdk/core:target-partitions context value: it must be set to a list of partitions, and only regions from the given partitions will be included. If no such context key is set, all regions will be included.

This function is intended to be used by construct library authors. Application builders can rely on the abstractions offered by construct libraries and do not have to worry about regional facts.

If defaultValue is not given, it is an error if the fact is unknown for the given region.

factNameRequired
  • Type: string
defaultValueOptional
  • Type: string
renameLogicalId 
public renameLogicalId(oldId: string, newId: string): void

Rename a generated logical identities.

To modify the naming scheme strategy, extend the Stack class and override the allocateLogicalId method.

oldIdRequired
  • Type: string
newIdRequired
  • Type: string
reportMissingContextKey 
public reportMissingContextKey(report: MissingContext): void

Indicate that a context key was expected.

Contains instructions which will be emitted into the cloud assembly on how the key should be supplied.

reportRequired
  • Type: aws-cdk-lib.cloud_assembly_schema.MissingContext

The set of parameters needed to obtain the context.

resolve 
public resolve(obj: any): any

Resolve a tokenized value in the context of the current stack.

objRequired
  • Type: any
splitArn 
public splitArn(arn: string, arnFormat: ArnFormat): ArnComponents

Splits the provided ARN into its components.

Works both if 'arn' is a string like 'arn:aws:s3:::bucket', and a Token representing a dynamic CloudFormation expression (in which case the returned components will also be dynamic CloudFormation expressions, encoded as Tokens).

arnRequired
  • Type: string

the ARN to split into its components.

arnFormatRequired
  • Type: aws-cdk-lib.ArnFormat

the expected format of 'arn' - depends on what format the service 'arn' represents uses.

toJsonString 
public toJsonString(obj: any, space?: number): string

Convert an object, potentially containing tokens, to a JSON string.

objRequired
  • Type: any
spaceOptional
  • Type: number
toYamlString 
public toYamlString(obj: any): string

Convert an object, potentially containing tokens, to a YAML string.

objRequired
  • Type: any

Static Functions

Name Description
isConstruct Checks if x is a construct.
isStack Return whether the given object is a Stack.
of Looks up the first stack scope in which construct is defined.
isConstruct 
import { HugoHostingStack } from '@mavogel/cdk-hugo-pipeline'

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

isStack 
import { HugoHostingStack } from '@mavogel/cdk-hugo-pipeline'

HugoHostingStack.isStack(x: any)

Return whether the given object is a Stack.

We do attribute detection since we can't reliably use 'instanceof'.

xRequired
  • Type: any
of 
import { HugoHostingStack } from '@mavogel/cdk-hugo-pipeline'

HugoHostingStack.of(construct: IConstruct)

Looks up the first stack scope in which construct is defined.

Fails if there is no stack up the tree.

constructRequired
  • Type: constructs.IConstruct

The construct to start the search from.

Properties

Name Type Description
node constructs.Node The tree node.
account string The AWS account into which this stack will be deployed.
artifactId string The ID of the cloud assembly artifact for this stack.
availabilityZones string[] Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack.
bundlingRequired boolean Indicates whether the stack requires bundling or not.
dependencies aws-cdk-lib.Stack[] Return the stacks this stack depends on.
environment string The environment coordinates in which this stack is deployed.
nested boolean Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.
notificationArns string[] Returns the list of notification Amazon Resource Names (ARNs) for the current stack.
partition string The partition in which this stack is defined.
region string The AWS region into which this stack will be deployed (e.g. us-west-2).
stackId string The ID of the stack.
stackName string The concrete CloudFormation physical stack name.
synthesizer aws-cdk-lib.IStackSynthesizer Synthesis method for this stack.
tags aws-cdk-lib.TagManager Tags to be applied to the stack.
templateFile string The name of the CloudFormation template file emitted to the output directory during synthesis.
templateOptions aws-cdk-lib.ITemplateOptions Options for CloudFormation template (like version, transform, description).
urlSuffix string The Amazon domain suffix for the region in which this stack is defined.
nestedStackParent aws-cdk-lib.Stack If this is a nested stack, returns it's parent stack.
nestedStackResource aws-cdk-lib.CfnResource If this is a nested stack, this represents its AWS::CloudFormation::Stack resource.
terminationProtection boolean Whether termination protection is enabled for this stack.
staticSiteURL aws-cdk-lib.CfnOutput staticSiteURL.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

accountRequired 
public readonly account: string;
  • Type: string

The AWS account into which this stack will be deployed.

This value is resolved according to the following rules:

  1. The value provided to env.account when the stack is defined. This can either be a concrete account (e.g. 585695031111) or the Aws.ACCOUNT_ID token.
  2. Aws.ACCOUNT_ID, which represents the CloudFormation intrinsic reference { "Ref": "AWS::AccountId" } encoded as a string token.

Preferably, you should use the return value as an opaque string and not attempt to parse it to implement your logic. If you do, you must first check that it is a concrete value an not an unresolved token. If this value is an unresolved token (Token.isUnresolved(stack.account) returns true), this implies that the user wishes that this stack will synthesize into a account-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other region-agnostic behavior.

artifactIdRequired 
public readonly artifactId: string;
  • Type: string

The ID of the cloud assembly artifact for this stack.

availabilityZonesRequired 
public readonly availabilityZones: string[];
  • Type: string[]

Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack.

If the stack is environment-agnostic (either account and/or region are tokens), this property will return an array with 2 tokens that will resolve at deploy-time to the first two availability zones returned from CloudFormation's Fn::GetAZs intrinsic function.

If they are not available in the context, returns a set of dummy values and reports them as missing, and let the CLI resolve them by calling EC2 DescribeAvailabilityZones on the target environment.

To specify a different strategy for selecting availability zones override this method.

bundlingRequiredRequired 
public readonly bundlingRequired: boolean;
  • Type: boolean

Indicates whether the stack requires bundling or not.

dependenciesRequired 
public readonly dependencies: Stack[];
  • Type: aws-cdk-lib.Stack[]

Return the stacks this stack depends on.

environmentRequired 
public readonly environment: string;
  • Type: string

The environment coordinates in which this stack is deployed.

In the form aws://account/region. Use stack.account and stack.region to obtain the specific values, no need to parse.

You can use this value to determine if two stacks are targeting the same environment.

If either stack.account or stack.region are not concrete values (e.g. Aws.ACCOUNT_ID or Aws.REGION) the special strings unknown-account and/or unknown-region will be used respectively to indicate this stack is region/account-agnostic.

nestedRequired 
public readonly nested: boolean;
  • Type: boolean

Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

notificationArnsRequired 
public readonly notificationArns: string[];
  • Type: string[]

Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

partitionRequired 
public readonly partition: string;
  • Type: string

The partition in which this stack is defined.

regionRequired 
public readonly region: string;
  • Type: string

The AWS region into which this stack will be deployed (e.g. us-west-2).

This value is resolved according to the following rules:

  1. The value provided to env.region when the stack is defined. This can either be a concrete region (e.g. us-west-2) or the Aws.REGION token.
  2. Aws.REGION, which is represents the CloudFormation intrinsic reference { "Ref": "AWS::Region" } encoded as a string token.

Preferably, you should use the return value as an opaque string and not attempt to parse it to implement your logic. If you do, you must first check that it is a concrete value an not an unresolved token. If this value is an unresolved token (Token.isUnresolved(stack.region) returns true), this implies that the user wishes that this stack will synthesize into a region-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other region-agnostic behavior.

stackIdRequired 
public readonly stackId: string;
  • Type: string

The ID of the stack.

Example

// After resolving, looks like
'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
stackNameRequired 
public readonly stackName: string;
  • Type: string

The concrete CloudFormation physical stack name.

This is either the name defined explicitly in the stackName prop or allocated based on the stack's location in the construct tree. Stacks that are directly defined under the app use their construct id as their stack name. Stacks that are defined deeper within the tree will use a hashed naming scheme based on the construct path to ensure uniqueness.

If you wish to obtain the deploy-time AWS::StackName intrinsic, you can use Aws.STACK_NAME directly.

synthesizerRequired 
public readonly synthesizer: IStackSynthesizer;
  • Type: aws-cdk-lib.IStackSynthesizer

Synthesis method for this stack.

tagsRequired 
public readonly tags: TagManager;
  • Type: aws-cdk-lib.TagManager

Tags to be applied to the stack.

templateFileRequired 
public readonly templateFile: string;
  • Type: string

The name of the CloudFormation template file emitted to the output directory during synthesis.

Example value: MyStack.template.json

templateOptionsRequired 
public readonly templateOptions: ITemplateOptions;
  • Type: aws-cdk-lib.ITemplateOptions

Options for CloudFormation template (like version, transform, description).

urlSuffixRequired 
public readonly urlSuffix: string;
  • Type: string

The Amazon domain suffix for the region in which this stack is defined.

nestedStackParentOptional 
public readonly nestedStackParent: Stack;
  • Type: aws-cdk-lib.Stack

If this is a nested stack, returns it's parent stack.

nestedStackResourceOptional 
public readonly nestedStackResource: CfnResource;
  • Type: aws-cdk-lib.CfnResource

If this is a nested stack, this represents its AWS::CloudFormation::Stack resource.

undefined for top-level (non-nested) stacks.

terminationProtectionRequired 
public readonly terminationProtection: boolean;
  • Type: boolean

Whether termination protection is enabled for this stack.

staticSiteURLRequired 
public readonly staticSiteURL: CfnOutput;
  • Type: aws-cdk-lib.CfnOutput

staticSiteURL.

HugoPageStage

Hugo Page stage.

Initializers 

import { HugoPageStage } from '@mavogel/cdk-hugo-pipeline'

new HugoPageStage(scope: Construct, id: string, props: HugoPageStageProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props HugoPageStageProps No description.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsRequired

Methods

Name Description
toString Returns a string representation of this construct.
synth Synthesize this stage into a cloud assembly.
toString 
public toString(): string

Returns a string representation of this construct.

synth 
public synth(options?: StageSynthesisOptions): CloudAssembly

Synthesize this stage into a cloud assembly.

Once an assembly has been synthesized, it cannot be modified. Subsequent calls will return the same assembly.

optionsOptional
  • Type: aws-cdk-lib.StageSynthesisOptions

Static Functions

Name Description
isConstruct Checks if x is a construct.
isStage Test whether the given construct is a stage.
of Return the stage this construct is contained with, if available.
isConstruct 
import { HugoPageStage } from '@mavogel/cdk-hugo-pipeline'

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

isStage 
import { HugoPageStage } from '@mavogel/cdk-hugo-pipeline'

HugoPageStage.isStage(x: any)

Test whether the given construct is a stage.

xRequired
  • Type: any
of 
import { HugoPageStage } from '@mavogel/cdk-hugo-pipeline'

HugoPageStage.of(construct: IConstruct)

Return the stage this construct is contained with, if available.

If called on a nested stage, returns its parent.

constructRequired
  • Type: constructs.IConstruct

Properties

Name Type Description
node constructs.Node The tree node.
artifactId string Artifact ID of the assembly if it is a nested stage. The root stage (app) will return an empty string.
assetOutdir string The cloud assembly asset output directory.
outdir string The cloud assembly output directory.
policyValidationBeta1 aws-cdk-lib.IPolicyValidationPluginBeta1[] Validation plugins to run during synthesis.
stageName string The name of the stage.
account string The default account for all resources defined within this stage.
parentStage aws-cdk-lib.Stage The parent stage or undefined if this is the app.
region string The default region for all resources defined within this stage.
staticSiteURL aws-cdk-lib.CfnOutput staticSiteURL.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

artifactIdRequired 
public readonly artifactId: string;
  • Type: string

Artifact ID of the assembly if it is a nested stage. The root stage (app) will return an empty string.

Derived from the construct path.

assetOutdirRequired 
public readonly assetOutdir: string;
  • Type: string

The cloud assembly asset output directory.

outdirRequired 
public readonly outdir: string;
  • Type: string

The cloud assembly output directory.

policyValidationBeta1Required 
public readonly policyValidationBeta1: IPolicyValidationPluginBeta1[];
  • Type: aws-cdk-lib.IPolicyValidationPluginBeta1[]
  • Default: no validation plugins are used

Validation plugins to run during synthesis.

If any plugin reports any violation, synthesis will be interrupted and the report displayed to the user.

stageNameRequired 
public readonly stageName: string;
  • Type: string

The name of the stage.

Based on names of the parent stages separated by hypens.

accountOptional 
public readonly account: string;
  • Type: string

The default account for all resources defined within this stage.

parentStageOptional 
public readonly parentStage: Stage;
  • Type: aws-cdk-lib.Stage

The parent stage or undefined if this is the app.

regionOptional 
public readonly region: string;
  • Type: string

The default region for all resources defined within this stage.

staticSiteURLRequired 
public readonly staticSiteURL: CfnOutput;
  • Type: aws-cdk-lib.CfnOutput

staticSiteURL.

HugoPipeline

Hugo Pipeline.

Initializers 

import { HugoPipeline } from '@mavogel/cdk-hugo-pipeline'

new HugoPipeline(scope: Construct, id: string, props: HugoPipelineProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props HugoPipelineProps 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 { HugoPipeline } from '@mavogel/cdk-hugo-pipeline'

HugoPipeline.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.
domainName string the domain name.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

domainNameRequired 
public readonly domainName: string;
  • Type: string

the domain name.

Structs

HugoHostingProps

Hugo Hosting properties.

Initializer 

import { HugoHostingProps } from '@mavogel/cdk-hugo-pipeline'

const hugoHostingProps: HugoHostingProps = { ... }

Properties

Name Type Description
domainName string Name of the domain to host the site on.
alpineHugoVersion string The hugo version to use in the alpine docker image.
basicAuthPassword string The password for basic auth on the development site.
basicAuthUsername string The username for basic auth on the development site.
buildStage string Name of the stage to deploy to.
cloudfrontCustomFunctionCode aws-cdk-lib.aws_cloudfront.FunctionCode The cloudfront custom function code.
cloudfrontRedirectReplacements {[ key: string ]: string} The cloudfront redirect replacements.
dockerImage string The docker image to use to build the hugo page.
http403ResponsePagePath string The path to the 403 error page.
http404ResponsePagePath string The path to the 404 error page.
hugoBuildCommand string The build command for the hugo site on which the '--environment' flag is appended.
hugoProjectPath string The absolute path to the hugo project.
s3deployAssetHash string The hash to use to build or rebuild the hugo page.
siteSubDomain string The subdomain to host the development site on, for example 'dev'.
domainNameRequired 
public readonly domainName: string;
  • Type: string

Name of the domain to host the site on.

alpineHugoVersionOptional 
public readonly alpineHugoVersion: string;
  • Type: string
  • Default: '', meaning the latest version. You can specify a specific version, for example '=0.106.0-r4'

The hugo version to use in the alpine docker image.

basicAuthPasswordOptional 
public readonly basicAuthPassword: string;
  • Type: string
  • Default: doe

The password for basic auth on the development site.

basicAuthUsernameOptional 
public readonly basicAuthUsername: string;
  • Type: string
  • Default: john

The username for basic auth on the development site.

buildStageOptional 
public readonly buildStage: string;
  • Type: string
  • Default: production

Name of the stage to deploy to.

Should be 'development' or 'production'

cloudfrontCustomFunctionCodeOptional 
public readonly cloudfrontCustomFunctionCode: FunctionCode;
  • Type: aws-cdk-lib.aws_cloudfront.FunctionCode
  • Default: undefined

The cloudfront custom function code.

cloudfrontRedirectReplacementsOptional 
public readonly cloudfrontRedirectReplacements: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
  • Default: {}

The cloudfront redirect replacements.

Those are string replacements for the request.uri. Note: the replacements are regular expressions. Note: if cloudfrontCustomFunctionCode is set, this property is ignored.

dockerImageOptional 
public readonly dockerImage: string;
  • Type: string
  • Default: 'public.ecr.aws/docker/library/node:lts-alpine'

The docker image to use to build the hugo page.

Note: you need to use the 'apk' package manager

http403ResponsePagePathOptional 
public readonly http403ResponsePagePath: string;
  • Type: string
  • Default: /en/404.html

The path to the 403 error page.

http404ResponsePagePathOptional 
public readonly http404ResponsePagePath: string;
  • Type: string
  • Default: /en/404.html

The path to the 404 error page.

hugoBuildCommandOptional 
public readonly hugoBuildCommand: string;
  • Type: string
  • Default: 'hugo --gc --minify --cleanDestinationDir'

The build command for the hugo site on which the '--environment' flag is appended.

hugoProjectPathOptional 
public readonly hugoProjectPath: string;
  • Type: string
  • Default: 'path.join(process.cwd(), 'blog')'

The absolute path to the hugo project.

s3deployAssetHashOptional 
public readonly s3deployAssetHash: string;
  • Type: string
  • Default: ${Number(Math.random())}-${props.buildStage}

The hash to use to build or rebuild the hugo page.

We use it to rebuild the site every time as cdk caching is too intelligent and it did not deploy updates.

For testing purposes we pass a static hash to avoid updates of the snapshot tests.

siteSubDomainOptional 
public readonly siteSubDomain: string;
  • Type: string
  • Default: dev

The subdomain to host the development site on, for example 'dev'.

HugoHostingStackProps

Hugo Hosting properties.

Initializer 

import { HugoHostingStackProps } from '@mavogel/cdk-hugo-pipeline'

const hugoHostingStackProps: HugoHostingStackProps = { ... }

Properties

Name Type Description
analyticsReporting boolean Include runtime versioning information in this Stack.
crossRegionReferences boolean Enable this flag to allow native cross region stack references.
description string A description of the stack.
env aws-cdk-lib.Environment The AWS environment (account/region) where this stack will be deployed.
notificationArns string[] SNS Topic ARNs that will receive stack events.
permissionsBoundary aws-cdk-lib.PermissionsBoundary Options for applying a permissions boundary to all IAM Roles and Users created within this Stage.
stackName string Name to deploy the stack with.
suppressTemplateIndentation boolean Enable this flag to suppress indentation in generated CloudFormation templates.
synthesizer aws-cdk-lib.IStackSynthesizer Synthesis method to use while deploying this stack.
tags {[ key: string ]: string} Stack tags that will be applied to all the taggable resources and the stack itself.
terminationProtection boolean Whether to enable termination protection for this stack.
buildStage string buildStage.
domainName string domainName.
basicAuthPassword string basicAuthPassword.
basicAuthUsername string basicAuthUsername.
cloudfrontCustomFunctionCode aws-cdk-lib.aws_cloudfront.FunctionCode cloudfrontCustomFunctionCode.
cloudfrontRedirectReplacements {[ key: string ]: string} cloudfrontRedirectReplacements.
dockerImage string dockerImage.
http403ResponsePagePath string http403ResponsePagePath.
http404ResponsePagePath string http404ResponsePagePath.
hugoBuildCommand string hugoBuildCommand.
hugoProjectPath string hugoProjectPath.
s3deployAssetHash string s3deployAssetHash.
siteSubDomain string siteSubDomain.
analyticsReportingOptional 
public readonly analyticsReporting: boolean;
  • Type: boolean
  • Default: analyticsReporting setting of containing App, or value of 'aws:cdk:version-reporting' context key

Include runtime versioning information in this Stack.

crossRegionReferencesOptional 
public readonly crossRegionReferences: boolean;
  • Type: boolean
  • Default: false

Enable this flag to allow native cross region stack references.

Enabling this will create a CloudFormation custom resource in both the producing stack and consuming stack in order to perform the export/import

This feature is currently experimental

descriptionOptional 
public readonly description: string;
  • Type: string
  • Default: No description.

A description of the stack.

envOptional 
public readonly env: Environment;
  • Type: aws-cdk-lib.Environment
  • Default: The environment of the containing Stage if available, otherwise create the stack will be environment-agnostic.

The AWS environment (account/region) where this stack will be deployed.

Set the region/account fields of env to either a concrete value to select the indicated environment (recommended for production stacks), or to the values of environment variables CDK_DEFAULT_REGION/CDK_DEFAULT_ACCOUNT to let the target environment depend on the AWS credentials/configuration that the CDK CLI is executed under (recommended for development stacks).

If the Stack is instantiated inside a Stage, any undefined region/account fields from env will default to the same field on the encompassing Stage, if configured there.

If either region or account are not set nor inherited from Stage, the Stack will be considered "environment-agnostic"". Environment-agnostic stacks can be deployed to any environment but may not be able to take advantage of all features of the CDK. For example, they will not be able to use environmental context lookups such as ec2.Vpc.fromLookup and will not automatically translate Service Principals to the right format based on the environment's AWS partition, and other such enhancements.

Example

// Use a concrete account and region to deploy this stack to:
// `.account` and `.region` will simply return these values.
new Stack(app, 'Stack1', {
  env: {
    account: '123456789012',
    region: 'us-east-1'
  },
});

// Use the CLI's current credentials to determine the target environment:
// `.account` and `.region` will reflect the account+region the CLI
// is configured to use (based on the user CLI credentials)
new Stack(app, 'Stack2', {
  env: {
    account: process.env.CDK_DEFAULT_ACCOUNT,
    region: process.env.CDK_DEFAULT_REGION
  },
});

// Define multiple stacks stage associated with an environment
const myStage = new Stage(app, 'MyStage', {
  env: {
    account: '123456789012',
    region: 'us-east-1'
  }
});

// both of these stacks will use the stage's account/region:
// `.account` and `.region` will resolve to the concrete values as above
new MyStack(myStage, 'Stack1');
new YourStack(myStage, 'Stack2');

// Define an environment-agnostic stack:
// `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
// which will only resolve to actual values by CloudFormation during deployment.
new MyStack(app, 'Stack1');
notificationArnsOptional 
public readonly notificationArns: string[];
  • Type: string[]
  • Default: no notfication arns.

SNS Topic ARNs that will receive stack events.

permissionsBoundaryOptional 
public readonly permissionsBoundary: PermissionsBoundary;
  • Type: aws-cdk-lib.PermissionsBoundary
  • Default: no permissions boundary is applied

Options for applying a permissions boundary to all IAM Roles and Users created within this Stage.

stackNameOptional 
public readonly stackName: string;
  • Type: string
  • Default: Derived from construct path.

Name to deploy the stack with.

suppressTemplateIndentationOptional 
public readonly suppressTemplateIndentation: boolean;
  • Type: boolean
  • Default: the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.

Enable this flag to suppress indentation in generated CloudFormation templates.

If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation context key will be used. If that is not specified, then the default value false will be used.

synthesizerOptional 
public readonly synthesizer: IStackSynthesizer;
  • Type: aws-cdk-lib.IStackSynthesizer
  • Default: The synthesizer specified on App, or DefaultStackSynthesizer otherwise.

Synthesis method to use while deploying this stack.

The Stack Synthesizer controls aspects of synthesis and deployment, like how assets are referenced and what IAM roles to use. For more information, see the README of the main CDK package.

If not specified, the defaultStackSynthesizer from App will be used. If that is not specified, DefaultStackSynthesizer is used if @aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major version is v2. In CDK v1 LegacyStackSynthesizer is the default if no other synthesizer is specified.

tagsOptional 
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
  • Default: {}

Stack tags that will be applied to all the taggable resources and the stack itself.

terminationProtectionOptional 
public readonly terminationProtection: boolean;
  • Type: boolean
  • Default: false

Whether to enable termination protection for this stack.

buildStageRequired 
public readonly buildStage: string;
  • Type: string

buildStage.

domainNameRequired 
public readonly domainName: string;
  • Type: string
  • Default: TBD

domainName.

basicAuthPasswordOptional 
public readonly basicAuthPassword: string;
  • Type: string
  • Default: TBD

basicAuthPassword.

basicAuthUsernameOptional 
public readonly basicAuthUsername: string;
  • Type: string
  • Default: TBD

basicAuthUsername.

cloudfrontCustomFunctionCodeOptional 
public readonly cloudfrontCustomFunctionCode: FunctionCode;
  • Type: aws-cdk-lib.aws_cloudfront.FunctionCode
  • Default: TBD

cloudfrontCustomFunctionCode.

cloudfrontRedirectReplacementsOptional 
public readonly cloudfrontRedirectReplacements: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
  • Default: TBD

cloudfrontRedirectReplacements.

dockerImageOptional 
public readonly dockerImage: string;
  • Type: string
  • Default: TBD

dockerImage.

http403ResponsePagePathOptional 
public readonly http403ResponsePagePath: string;
  • Type: string
  • Default: TBD

http403ResponsePagePath.

http404ResponsePagePathOptional 
public readonly http404ResponsePagePath: string;
  • Type: string
  • Default: TBD

http404ResponsePagePath.

hugoBuildCommandOptional 
public readonly hugoBuildCommand: string;
  • Type: string
  • Default: TBD

hugoBuildCommand.

hugoProjectPathOptional 
public readonly hugoProjectPath: string;
  • Type: string
  • Default: TBD

hugoProjectPath.

s3deployAssetHashOptional 
public readonly s3deployAssetHash: string;
  • Type: string
  • Default: TBD

s3deployAssetHash.

siteSubDomainOptional 
public readonly siteSubDomain: string;
  • Type: string
  • Default: TBD

siteSubDomain.

HugoPageStageProps

Hugo page stage properties.

Initializer 

import { HugoPageStageProps } from '@mavogel/cdk-hugo-pipeline'

const hugoPageStageProps: HugoPageStageProps = { ... }

Properties

Name Type Description
env aws-cdk-lib.Environment Default AWS environment (account/region) for Stacks in this Stage.
outdir string The output directory into which to emit synthesized artifacts.
permissionsBoundary aws-cdk-lib.PermissionsBoundary Options for applying a permissions boundary to all IAM Roles and Users created within this Stage.
policyValidationBeta1 aws-cdk-lib.IPolicyValidationPluginBeta1[] Validation plugins to run during synthesis.
stageName string Name of this stage.
buildStage string buildStage.
domainName string domainName.
basicAuthPassword string basicAuthPassword.
basicAuthUsername string basicAuthUsername.
cloudfrontCustomFunctionCode aws-cdk-lib.aws_cloudfront.FunctionCode cloudfrontCustomFunctionCode.
cloudfrontRedirectReplacements {[ key: string ]: string} cloudfrontRedirectReplacements.
dockerImage string dockerImage.
http403ResponsePagePath string http403ResponsePagePath.
http404ResponsePagePath string http404ResponsePagePath.
hugoBuildCommand string hugoBuildCommand.
hugoProjectPath string hugoProjectPath.
s3deployAssetHash string s3deployAssetHash.
siteSubDomain string siteSubDomain.
envOptional 
public readonly env: Environment;
  • Type: aws-cdk-lib.Environment
  • Default: The environments should be configured on the Stacks.

Default AWS environment (account/region) for Stacks in this Stage.

Stacks defined inside this Stage with either region or account missing from its env will use the corresponding field given here.

If either region or accountis is not configured for Stack (either on the Stack itself or on the containing Stage), the Stack will be environment-agnostic.

Environment-agnostic stacks can be deployed to any environment, may not be able to take advantage of all features of the CDK. For example, they will not be able to use environmental context lookups, will not automatically translate Service Principals to the right format based on the environment's AWS partition, and other such enhancements.

Example

// Use a concrete account and region to deploy this Stage to
new Stage(app, 'Stage1', {
  env: { account: '123456789012', region: 'us-east-1' },
});

// Use the CLI's current credentials to determine the target environment
new Stage(app, 'Stage2', {
  env: { account: process.env.CDK_DEFAULT_ACCOUNT, region: process.env.CDK_DEFAULT_REGION },
});
outdirOptional 
public readonly outdir: string;
  • Type: string
  • Default: for nested stages, outdir will be determined as a relative directory to the outdir of the app. For apps, if outdir is not specified, a temporary directory will be created.

The output directory into which to emit synthesized artifacts.

Can only be specified if this stage is the root stage (the app). If this is specified and this stage is nested within another stage, an error will be thrown.

permissionsBoundaryOptional 
public readonly permissionsBoundary: PermissionsBoundary;
  • Type: aws-cdk-lib.PermissionsBoundary
  • Default: no permissions boundary is applied

Options for applying a permissions boundary to all IAM Roles and Users created within this Stage.

policyValidationBeta1Optional 
public readonly policyValidationBeta1: IPolicyValidationPluginBeta1[];
  • Type: aws-cdk-lib.IPolicyValidationPluginBeta1[]
  • Default: no validation plugins are used

Validation plugins to run during synthesis.

If any plugin reports any violation, synthesis will be interrupted and the report displayed to the user.

stageNameOptional 
public readonly stageName: string;
  • Type: string
  • Default: Derived from the id.

Name of this stage.

buildStageRequired 
public readonly buildStage: string;
  • Type: string
  • Default: TBD

buildStage.

domainNameRequired 
public readonly domainName: string;
  • Type: string
  • Default: TBD

domainName.

basicAuthPasswordOptional 
public readonly basicAuthPassword: string;
  • Type: string
  • Default: TBD

basicAuthPassword.

basicAuthUsernameOptional 
public readonly basicAuthUsername: string;
  • Type: string
  • Default: TBD

basicAuthUsername.

cloudfrontCustomFunctionCodeOptional 
public readonly cloudfrontCustomFunctionCode: FunctionCode;
  • Type: aws-cdk-lib.aws_cloudfront.FunctionCode
  • Default: TBD

cloudfrontCustomFunctionCode.

cloudfrontRedirectReplacementsOptional 
public readonly cloudfrontRedirectReplacements: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
  • Default: TBD

cloudfrontRedirectReplacements.

dockerImageOptional 
public readonly dockerImage: string;
  • Type: string
  • Default: TBD

dockerImage.

http403ResponsePagePathOptional 
public readonly http403ResponsePagePath: string;
  • Type: string
  • Default: TBD

http403ResponsePagePath.

http404ResponsePagePathOptional 
public readonly http404ResponsePagePath: string;
  • Type: string
  • Default: TBD

http404ResponsePagePath.

hugoBuildCommandOptional 
public readonly hugoBuildCommand: string;
  • Type: string
  • Default: TBD

hugoBuildCommand.

hugoProjectPathOptional 
public readonly hugoProjectPath: string;
  • Type: string
  • Default: TBD

hugoProjectPath.

s3deployAssetHashOptional 
public readonly s3deployAssetHash: string;
  • Type: string
  • Default: TBD

s3deployAssetHash.

siteSubDomainOptional 
public readonly siteSubDomain: string;
  • Type: string
  • Default: TBD

siteSubDomain.

HugoPipelineProps

Hugo pipeline properties.

Initializer 

import { HugoPipelineProps } from '@mavogel/cdk-hugo-pipeline'

const hugoPipelineProps: HugoPipelineProps = { ... }

Properties

Name Type Description
domainName string Name of the domain to host the site on.
basicAuthPassword string The password for basic auth on the development site.
basicAuthUsername string The username for basic auth on the development site.
cloudfrontCustomFunctionCodeDevelopment aws-cdk-lib.aws_cloudfront.FunctionCode The cloudfront custom function code for the development stage.
cloudfrontCustomFunctionCodeProduction aws-cdk-lib.aws_cloudfront.FunctionCode The cloudfront custom function code for the production stage.
cloudfrontRedirectReplacements {[ key: string ]: string} The cloudfront redirect replacements.
dockerImage string The docker image to use to build the hugo page.
http403ResponsePagePath string The path to the 403 error page.
http404ResponsePagePath string The path to the 404 error page.
hugoBuildCommand string The build command for the hugo site on which the '--environment' flag is appended.
hugoProjectPath string The path to the hugo project.
name string Name of the codecommit repository.
s3deployAssetHash string The hash to use to build or rebuild the hugo page.
siteSubDomain string The subdomain to host the development site on, for example 'dev'.
domainNameRequired 
public readonly domainName: string;
  • Type: string

Name of the domain to host the site on.

basicAuthPasswordOptional 
public readonly basicAuthPassword: string;
  • Type: string
  • Default: doe

The password for basic auth on the development site.

basicAuthUsernameOptional 
public readonly basicAuthUsername: string;
  • Type: string
  • Default: john

The username for basic auth on the development site.

cloudfrontCustomFunctionCodeDevelopmentOptional 
public readonly cloudfrontCustomFunctionCodeDevelopment: FunctionCode;
  • Type: aws-cdk-lib.aws_cloudfront.FunctionCode
  • Default: undefined

The cloudfront custom function code for the development stage.

If not set it falls back to a function having basic auth with 'basicAuthUsername' and 'basicAuthPassword' as username and password and adding the default root object 'index.html'.

cloudfrontCustomFunctionCodeProductionOptional 
public readonly cloudfrontCustomFunctionCodeProduction: FunctionCode;
  • Type: aws-cdk-lib.aws_cloudfront.FunctionCode
  • Default: undefined

The cloudfront custom function code for the production stage.

If not set it falls back to a function adding the default root object 'index.html'.

cloudfrontRedirectReplacementsOptional 
public readonly cloudfrontRedirectReplacements: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
  • Default: {}

The cloudfront redirect replacements.

Those are string replacements for the request.uri. Note: the replacements are regular expressions. Note: if cloudfrontCustomFunctionCode(Development|Production) is set, this property is ignored.

dockerImageOptional 
public readonly dockerImage: string;
  • Type: string
  • Default: 'public.ecr.aws/docker/library/node:lts-alpine'

The docker image to use to build the hugo page.

Note: you need to use the 'apk' package manager

http403ResponsePagePathOptional 
public readonly http403ResponsePagePath: string;
  • Type: string
  • Default: /en/404.html

The path to the 403 error page.

http404ResponsePagePathOptional 
public readonly http404ResponsePagePath: string;
  • Type: string
  • Default: /en/404.html

The path to the 404 error page.

hugoBuildCommandOptional 
public readonly hugoBuildCommand: string;
  • Type: string
  • Default: 'hugo --gc --minify --cleanDestinationDir'

The build command for the hugo site on which the '--environment' flag is appended.

hugoProjectPathOptional 
public readonly hugoProjectPath: string;
  • Type: string
  • Default: path.join(process.cwd(), 'blog')

The path to the hugo project.

nameOptional 
public readonly name: string;
  • Type: string
  • Default: hugo blog

Name of the codecommit repository.

s3deployAssetHashOptional 
public readonly s3deployAssetHash: string;
  • Type: string
  • Default: ${Number(Math.random())}-${props.buildStage}

The hash to use to build or rebuild the hugo page.

We use it to rebuild the site every time as cdk caching is too intelligent and it did not deploy updates.

For testing purposes we pass a static hash to avoid updates of the snapshot tests.

siteSubDomainOptional 
public readonly siteSubDomain: string;
  • Type: string
  • Default: dev

The subdomain to host the development site on, for example 'dev'.