Skip to content

API.md

Latest commit

 

History

History
174 lines (102 loc) · 4.8 KB

API.md

File metadata and controls

174 lines (102 loc) · 4.8 KB

API Reference

Constructs

WordPress

Initializers 

import { WordPress } from 'cdk-wordpress'

new WordPress(scope: Construct, id: string, props?: WordPressProps)
Name Type Description
scope @aws-cdk/core.Construct No description.
id string No description.
props WordPressProps No description.
scopeRequired
  • Type: @aws-cdk/core.Construct
idRequired
  • Type: string
propsOptional

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 Return whether the given object is a Construct.
isConstruct 
import { WordPress } from 'cdk-wordpress'

WordPress.isConstruct(x: any)

Return whether the given object is a Construct.

xRequired
  • Type: any

Properties

Name Type Description
node @aws-cdk/core.ConstructNode The construct tree node associated with this construct.
endpoint string No description.
nodeRequired 
public readonly node: ConstructNode;
  • Type: @aws-cdk/core.ConstructNode

The construct tree node associated with this construct.

endpointRequired 
public readonly endpoint: string;
  • Type: string

Structs

WordPressProps

The interface for all wordpress.

Initializer 

import { WordPressProps } from 'cdk-wordpress'

const wordPressProps: WordPressProps = { ... }

Properties

Name Type Description
cluster @aws-cdk/aws-ecs.Cluster The WordPress cluster.
rdsInstance @aws-cdk/aws-rds.DatabaseInstance The WordPress RDS.
vpc @aws-cdk/aws-ec2.IVpc The WordPress VPC.
clusterOptional 
public readonly cluster: Cluster;
  • Type: @aws-cdk/aws-ecs.Cluster

The WordPress cluster.

rdsInstanceOptional 
public readonly rdsInstance: DatabaseInstance;
  • Type: @aws-cdk/aws-rds.DatabaseInstance

The WordPress RDS.

vpcOptional 
public readonly vpc: IVpc;
  • Type: @aws-cdk/aws-ec2.IVpc

The WordPress VPC.