diff --git a/.projenrc.js b/.projenrc.js index cc9989a..4e5a8dc 100644 --- a/.projenrc.js +++ b/.projenrc.js @@ -10,8 +10,8 @@ const project = new awscdk.AwsCdkConstructLibrary({ releaseToNpm: true, catalog: { announce: false, - twitter: 'raykrueger' - } + twitter: 'raykrueger', + }, // deps: [], /* Runtime dependencies of this module. */ // description: undefined, /* The description is just a string that helps people understand the purpose of the package. */ // devDeps: [], /* Build dependencies for this module. */ diff --git a/API.md b/API.md index 5ffec97..162c053 100644 --- a/API.md +++ b/API.md @@ -2,39 +2,39 @@ ## Constructs -### PublicIPSupport +### PublicIPSupport -#### Initializers +#### Initializers ```typescript -import { PublicIPSupport } from 'cdk-fargate-public-dns' +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.* | +| scope | constructs.Construct | *No description.* | +| id | string | *No description.* | +| props | PublicIPSupportProps | *No description.* | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct --- -##### `id`Required +##### `id`Required - *Type:* string --- -##### `props`Required +##### `props`Required -- *Type:* PublicIPSupportProps +- *Type:* PublicIPSupportProps --- @@ -42,11 +42,11 @@ new PublicIPSupport(scope: Construct, id: string, props: PublicIPSupportProps) | **Name** | **Description** | | --- | --- | -| toString | Returns a string representation of this construct. | +| toString | Returns a string representation of this construct. | --- -##### `toString` +##### `toString` ```typescript public toString(): string @@ -58,21 +58,21 @@ Returns a string representation of this construct. | **Name** | **Description** | | --- | --- | -| isConstruct | Checks if `x` is a construct. | +| isConstruct | Checks if `x` is a construct. | --- -##### ~~`isConstruct`~~ +##### ~~`isConstruct`~~ ```typescript -import { PublicIPSupport } from 'cdk-fargate-public-dns' +import { PublicIPSupport } from '@raykrueger/cdk-fargate-public-dns' PublicIPSupport.isConstruct(x: any) ``` Checks if `x` is a construct. -###### `x`Required +###### `x`Required - *Type:* any @@ -84,11 +84,11 @@ Any object. | **Name** | **Type** | **Description** | | --- | --- | --- | -| node | constructs.Node | The tree node. | +| node | constructs.Node | The tree node. | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -103,12 +103,12 @@ The tree node. ## Structs -### PublicIPSupportProps +### PublicIPSupportProps -#### Initializer +#### Initializer ```typescript -import { PublicIPSupportProps } from 'cdk-fargate-public-dns' +import { PublicIPSupportProps } from '@raykrueger/cdk-fargate-public-dns' const publicIPSupportProps: PublicIPSupportProps = { ... } ``` @@ -117,14 +117,14 @@ const publicIPSupportProps: PublicIPSupportProps = { ... } | **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.* | +| 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.* | --- -##### `cluster`Required +##### `cluster`Required ```typescript public readonly cluster: ICluster; @@ -134,17 +134,17 @@ public readonly cluster: ICluster; --- -##### `dnsConfig`Required +##### `dnsConfig`Required ```typescript public readonly dnsConfig: Route53DomainProps; ``` -- *Type:* Route53DomainProps +- *Type:* Route53DomainProps --- -##### `service`Required +##### `service`Required ```typescript public readonly service: IService; @@ -154,7 +154,7 @@ public readonly service: IService; --- -##### `logRetention`Optional +##### `logRetention`Optional ```typescript public readonly logRetention: RetentionDays; @@ -164,12 +164,12 @@ public readonly logRetention: RetentionDays; --- -### Route53DomainProps +### Route53DomainProps -#### Initializer +#### Initializer ```typescript -import { Route53DomainProps } from 'cdk-fargate-public-dns' +import { Route53DomainProps } from '@raykrueger/cdk-fargate-public-dns' const route53DomainProps: Route53DomainProps = { ... } ``` @@ -178,13 +178,13 @@ const route53DomainProps: Route53DomainProps = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| domainName | string | *No description.* | -| hostzedZone | string | *No description.* | -| assumedRole | string | *No description.* | +| domainName | string | *No description.* | +| hostzedZone | string | *No description.* | +| assumedRole | string | *No description.* | --- -##### `domainName`Required +##### `domainName`Required ```typescript public readonly domainName: string; @@ -194,7 +194,7 @@ public readonly domainName: string; --- -##### `hostzedZone`Required +##### `hostzedZone`Required ```typescript public readonly hostzedZone: string; @@ -204,7 +204,7 @@ public readonly hostzedZone: string; --- -##### `assumedRole`Optional +##### `assumedRole`Optional ```typescript public readonly assumedRole: string;