Skip to content

Commit

Permalink
Latest automated changes
Browse files Browse the repository at this point in the history
  • Loading branch information
@raykrueger
raykrueger committed Feb 16, 2022
1 parent b8056af commit fb2afc5
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 41 deletions.
4 changes: 2 additions & 2 deletions .projenrc.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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. */
Expand Down
78 changes: 39 additions & 39 deletions API.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,51 +2,51 @@

## Constructs <a name="Constructs" id="Constructs"></a>

### PublicIPSupport <a name="PublicIPSupport" id="cdk-fargate-public-dns.PublicIPSupport"></a>
### PublicIPSupport <a name="PublicIPSupport" id="@raykrueger/cdk-fargate-public-dns.PublicIPSupport"></a>

#### Initializers <a name="Initializers" id="cdk-fargate-public-dns.PublicIPSupport.Initializer"></a>
#### Initializers <a name="Initializers" id="@raykrueger/cdk-fargate-public-dns.PublicIPSupport.Initializer"></a>

```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** |
| --- | --- | --- |
| <code><a href="#cdk-fargate-public-dns.PublicIPSupport.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
| <code><a href="#cdk-fargate-public-dns.PublicIPSupport.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
| <code><a href="#cdk-fargate-public-dns.PublicIPSupport.Initializer.parameter.props">props</a></code> | <code><a href="#cdk-fargate-public-dns.PublicIPSupportProps">PublicIPSupportProps</a></code> | *No description.* |
| <code><a href="#@raykrueger/cdk-fargate-public-dns.PublicIPSupport.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
| <code><a href="#@raykrueger/cdk-fargate-public-dns.PublicIPSupport.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
| <code><a href="#@raykrueger/cdk-fargate-public-dns.PublicIPSupport.Initializer.parameter.props">props</a></code> | <code><a href="#@raykrueger/cdk-fargate-public-dns.PublicIPSupportProps">PublicIPSupportProps</a></code> | *No description.* |

---

##### `scope`<sup>Required</sup> <a name="scope" id="cdk-fargate-public-dns.PublicIPSupport.Initializer.parameter.scope"></a>
##### `scope`<sup>Required</sup> <a name="scope" id="@raykrueger/cdk-fargate-public-dns.PublicIPSupport.Initializer.parameter.scope"></a>

- *Type:* constructs.Construct

---

##### `id`<sup>Required</sup> <a name="id" id="cdk-fargate-public-dns.PublicIPSupport.Initializer.parameter.id"></a>
##### `id`<sup>Required</sup> <a name="id" id="@raykrueger/cdk-fargate-public-dns.PublicIPSupport.Initializer.parameter.id"></a>

- *Type:* string

---

##### `props`<sup>Required</sup> <a name="props" id="cdk-fargate-public-dns.PublicIPSupport.Initializer.parameter.props"></a>
##### `props`<sup>Required</sup> <a name="props" id="@raykrueger/cdk-fargate-public-dns.PublicIPSupport.Initializer.parameter.props"></a>

- *Type:* <a href="#cdk-fargate-public-dns.PublicIPSupportProps">PublicIPSupportProps</a>
- *Type:* <a href="#@raykrueger/cdk-fargate-public-dns.PublicIPSupportProps">PublicIPSupportProps</a>

---

#### Methods <a name="Methods" id="Methods"></a>

| **Name** | **Description** |
| --- | --- |
| <code><a href="#cdk-fargate-public-dns.PublicIPSupport.toString">toString</a></code> | Returns a string representation of this construct. |
| <code><a href="#@raykrueger/cdk-fargate-public-dns.PublicIPSupport.toString">toString</a></code> | Returns a string representation of this construct. |

---

##### `toString` <a name="toString" id="cdk-fargate-public-dns.PublicIPSupport.toString"></a>
##### `toString` <a name="toString" id="@raykrueger/cdk-fargate-public-dns.PublicIPSupport.toString"></a>

```typescript
public toString(): string
Expand All @@ -58,21 +58,21 @@ Returns a string representation of this construct.

| **Name** | **Description** |
| --- | --- |
| <code><a href="#cdk-fargate-public-dns.PublicIPSupport.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
| <code><a href="#@raykrueger/cdk-fargate-public-dns.PublicIPSupport.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |

---

##### ~~`isConstruct`~~ <a name="isConstruct" id="cdk-fargate-public-dns.PublicIPSupport.isConstruct"></a>
##### ~~`isConstruct`~~ <a name="isConstruct" id="@raykrueger/cdk-fargate-public-dns.PublicIPSupport.isConstruct"></a>

```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`<sup>Required</sup> <a name="x" id="cdk-fargate-public-dns.PublicIPSupport.isConstruct.parameter.x"></a>
###### `x`<sup>Required</sup> <a name="x" id="@raykrueger/cdk-fargate-public-dns.PublicIPSupport.isConstruct.parameter.x"></a>

- *Type:* any

Expand All @@ -84,11 +84,11 @@ Any object.

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#cdk-fargate-public-dns.PublicIPSupport.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
| <code><a href="#@raykrueger/cdk-fargate-public-dns.PublicIPSupport.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |

---

##### `node`<sup>Required</sup> <a name="node" id="cdk-fargate-public-dns.PublicIPSupport.property.node"></a>
##### `node`<sup>Required</sup> <a name="node" id="@raykrueger/cdk-fargate-public-dns.PublicIPSupport.property.node"></a>

```typescript
public readonly node: Node;
Expand All @@ -103,12 +103,12 @@ The tree node.

## Structs <a name="Structs" id="Structs"></a>

### PublicIPSupportProps <a name="PublicIPSupportProps" id="cdk-fargate-public-dns.PublicIPSupportProps"></a>
### PublicIPSupportProps <a name="PublicIPSupportProps" id="@raykrueger/cdk-fargate-public-dns.PublicIPSupportProps"></a>

#### Initializer <a name="Initializer" id="cdk-fargate-public-dns.PublicIPSupportProps.Initializer"></a>
#### Initializer <a name="Initializer" id="@raykrueger/cdk-fargate-public-dns.PublicIPSupportProps.Initializer"></a>

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

const publicIPSupportProps: PublicIPSupportProps = { ... }
```
Expand All @@ -117,14 +117,14 @@ const publicIPSupportProps: PublicIPSupportProps = { ... }

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#cdk-fargate-public-dns.PublicIPSupportProps.property.cluster">cluster</a></code> | <code>aws-cdk-lib.aws_ecs.ICluster</code> | *No description.* |
| <code><a href="#cdk-fargate-public-dns.PublicIPSupportProps.property.dnsConfig">dnsConfig</a></code> | <code><a href="#cdk-fargate-public-dns.Route53DomainProps">Route53DomainProps</a></code> | *No description.* |
| <code><a href="#cdk-fargate-public-dns.PublicIPSupportProps.property.service">service</a></code> | <code>aws-cdk-lib.aws_ecs.IService</code> | *No description.* |
| <code><a href="#cdk-fargate-public-dns.PublicIPSupportProps.property.logRetention">logRetention</a></code> | <code>aws-cdk-lib.aws_logs.RetentionDays</code> | *No description.* |
| <code><a href="#@raykrueger/cdk-fargate-public-dns.PublicIPSupportProps.property.cluster">cluster</a></code> | <code>aws-cdk-lib.aws_ecs.ICluster</code> | *No description.* |
| <code><a href="#@raykrueger/cdk-fargate-public-dns.PublicIPSupportProps.property.dnsConfig">dnsConfig</a></code> | <code><a href="#@raykrueger/cdk-fargate-public-dns.Route53DomainProps">Route53DomainProps</a></code> | *No description.* |
| <code><a href="#@raykrueger/cdk-fargate-public-dns.PublicIPSupportProps.property.service">service</a></code> | <code>aws-cdk-lib.aws_ecs.IService</code> | *No description.* |
| <code><a href="#@raykrueger/cdk-fargate-public-dns.PublicIPSupportProps.property.logRetention">logRetention</a></code> | <code>aws-cdk-lib.aws_logs.RetentionDays</code> | *No description.* |

---

##### `cluster`<sup>Required</sup> <a name="cluster" id="cdk-fargate-public-dns.PublicIPSupportProps.property.cluster"></a>
##### `cluster`<sup>Required</sup> <a name="cluster" id="@raykrueger/cdk-fargate-public-dns.PublicIPSupportProps.property.cluster"></a>

```typescript
public readonly cluster: ICluster;
Expand All @@ -134,17 +134,17 @@ public readonly cluster: ICluster;

---

##### `dnsConfig`<sup>Required</sup> <a name="dnsConfig" id="cdk-fargate-public-dns.PublicIPSupportProps.property.dnsConfig"></a>
##### `dnsConfig`<sup>Required</sup> <a name="dnsConfig" id="@raykrueger/cdk-fargate-public-dns.PublicIPSupportProps.property.dnsConfig"></a>

```typescript
public readonly dnsConfig: Route53DomainProps;
```

- *Type:* <a href="#cdk-fargate-public-dns.Route53DomainProps">Route53DomainProps</a>
- *Type:* <a href="#@raykrueger/cdk-fargate-public-dns.Route53DomainProps">Route53DomainProps</a>

---

##### `service`<sup>Required</sup> <a name="service" id="cdk-fargate-public-dns.PublicIPSupportProps.property.service"></a>
##### `service`<sup>Required</sup> <a name="service" id="@raykrueger/cdk-fargate-public-dns.PublicIPSupportProps.property.service"></a>

```typescript
public readonly service: IService;
Expand All @@ -154,7 +154,7 @@ public readonly service: IService;

---

##### `logRetention`<sup>Optional</sup> <a name="logRetention" id="cdk-fargate-public-dns.PublicIPSupportProps.property.logRetention"></a>
##### `logRetention`<sup>Optional</sup> <a name="logRetention" id="@raykrueger/cdk-fargate-public-dns.PublicIPSupportProps.property.logRetention"></a>

```typescript
public readonly logRetention: RetentionDays;
Expand All @@ -164,12 +164,12 @@ public readonly logRetention: RetentionDays;

---

### Route53DomainProps <a name="Route53DomainProps" id="cdk-fargate-public-dns.Route53DomainProps"></a>
### Route53DomainProps <a name="Route53DomainProps" id="@raykrueger/cdk-fargate-public-dns.Route53DomainProps"></a>

#### Initializer <a name="Initializer" id="cdk-fargate-public-dns.Route53DomainProps.Initializer"></a>
#### Initializer <a name="Initializer" id="@raykrueger/cdk-fargate-public-dns.Route53DomainProps.Initializer"></a>

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

const route53DomainProps: Route53DomainProps = { ... }
```
Expand All @@ -178,13 +178,13 @@ const route53DomainProps: Route53DomainProps = { ... }

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#cdk-fargate-public-dns.Route53DomainProps.property.domainName">domainName</a></code> | <code>string</code> | *No description.* |
| <code><a href="#cdk-fargate-public-dns.Route53DomainProps.property.hostzedZone">hostzedZone</a></code> | <code>string</code> | *No description.* |
| <code><a href="#cdk-fargate-public-dns.Route53DomainProps.property.assumedRole">assumedRole</a></code> | <code>string</code> | *No description.* |
| <code><a href="#@raykrueger/cdk-fargate-public-dns.Route53DomainProps.property.domainName">domainName</a></code> | <code>string</code> | *No description.* |
| <code><a href="#@raykrueger/cdk-fargate-public-dns.Route53DomainProps.property.hostzedZone">hostzedZone</a></code> | <code>string</code> | *No description.* |
| <code><a href="#@raykrueger/cdk-fargate-public-dns.Route53DomainProps.property.assumedRole">assumedRole</a></code> | <code>string</code> | *No description.* |

---

##### `domainName`<sup>Required</sup> <a name="domainName" id="cdk-fargate-public-dns.Route53DomainProps.property.domainName"></a>
##### `domainName`<sup>Required</sup> <a name="domainName" id="@raykrueger/cdk-fargate-public-dns.Route53DomainProps.property.domainName"></a>

```typescript
public readonly domainName: string;
Expand All @@ -194,7 +194,7 @@ public readonly domainName: string;

---

##### `hostzedZone`<sup>Required</sup> <a name="hostzedZone" id="cdk-fargate-public-dns.Route53DomainProps.property.hostzedZone"></a>
##### `hostzedZone`<sup>Required</sup> <a name="hostzedZone" id="@raykrueger/cdk-fargate-public-dns.Route53DomainProps.property.hostzedZone"></a>

```typescript
public readonly hostzedZone: string;
Expand All @@ -204,7 +204,7 @@ public readonly hostzedZone: string;

---

##### `assumedRole`<sup>Optional</sup> <a name="assumedRole" id="cdk-fargate-public-dns.Route53DomainProps.property.assumedRole"></a>
##### `assumedRole`<sup>Optional</sup> <a name="assumedRole" id="@raykrueger/cdk-fargate-public-dns.Route53DomainProps.property.assumedRole"></a>

```typescript
public readonly assumedRole: string;
Expand Down

0 comments on commit fb2afc5

Please sign in to comment.