Skip to content

Latest commit

 

History

History
218 lines (130 loc) · 7.28 KB

API.md

File metadata and controls

218 lines (130 loc) · 7.28 KB
Raw

API Reference

Constructs

PublicIPSupport

Initializers 

import { PublicIPSupport } from '@raykrueger/cdk-fargate-public-dns'

new PublicIPSupport(scope: Construct, id: string, props: PublicIPSupportProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props PublicIPSupportProps 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 { PublicIPSupport } from '@raykrueger/cdk-fargate-public-dns'

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

Structs

PublicIPSupportProps

Initializer 

import { PublicIPSupportProps } from '@raykrueger/cdk-fargate-public-dns'

const publicIPSupportProps: PublicIPSupportProps = { ... }

Properties

Name Type Description
cluster aws-cdk-lib.aws_ecs.ICluster No description.
dnsConfig Route53DomainProps No description.
service aws-cdk-lib.aws_ecs.IService No description.
logRetention aws-cdk-lib.aws_logs.RetentionDays No description.
clusterRequired 
public readonly cluster: ICluster;
  • Type: aws-cdk-lib.aws_ecs.ICluster
dnsConfigRequired 
public readonly dnsConfig: Route53DomainProps;
serviceRequired 
public readonly service: IService;
  • Type: aws-cdk-lib.aws_ecs.IService
logRetentionOptional 
public readonly logRetention: RetentionDays;
  • Type: aws-cdk-lib.aws_logs.RetentionDays

Route53DomainProps

Initializer 

import { Route53DomainProps } from '@raykrueger/cdk-fargate-public-dns'

const route53DomainProps: Route53DomainProps = { ... }

Properties

Name Type Description
domainName string No description.
hostzedZone string No description.
assumedRole string No description.
domainNameRequired 
public readonly domainName: string;
  • Type: string
hostzedZoneRequired 
public readonly hostzedZone: string;
  • Type: string
assumedRoleOptional 
public readonly assumedRole: string;
  • Type: string