@cloudcomponents/cdk-wordpress
@cloudcomponents/cdk-wordpress / Application
-
Construct↳
Application
- cloudFrontHashHeader
- distribution
- domainName
- domainZone
- listener
- node
- removalPolicy
- service
- targetGroup
- enableStaticContentOffload
- onPrepare
- onSynthesize
- onValidate
- prepare
- synthesize
- toString
- validate
- isConstruct
• new Application(scope, id, props)
| Name | Type |
|---|---|
scope |
Construct |
id |
string |
props |
ApplicationProps |
Construct.constructor
• Private Readonly cloudFrontHashHeader: string
• Readonly distribution: IDistribution
• Readonly domainName: string
• Readonly domainZone: IHostedZone
• Readonly listener: ApplicationListener
• Readonly node: ConstructNode
The construct tree node associated with this construct.
stability stable
Construct.node
• Private Optional Readonly removalPolicy: RemovalPolicy
• Readonly service: FargateService
• Readonly targetGroup: ApplicationTargetGroup
▸ enableStaticContentOffload(domainName, certificate): StaticContentOffload
| Name | Type |
|---|---|
domainName |
string |
certificate |
ICertificate |
▸ Protected onPrepare(): void
Perform final modifications before synthesis.
This method can be implemented by derived constructs in order to perform final changes before synthesis. prepare() will be called after child constructs have been prepared.
This is an advanced framework feature. Only use this if you understand the implications.
stability stable
void
Construct.onPrepare
▸ Protected onSynthesize(session): void
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack and Asset
as they participate in synthesizing the cloud assembly.
stability stable
| Name | Type | Description |
|---|---|---|
session |
ISynthesisSession |
The synthesis session. |
void
Construct.onSynthesize
▸ Protected onValidate(): string[]
Validate the current construct.
This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.
stability stable
string[]
An array of validation error messages, or an empty array if the construct is valid.
Construct.onValidate
▸ Protected prepare(): void
Perform final modifications before synthesis.
This method can be implemented by derived constructs in order to perform final changes before synthesis. prepare() will be called after child constructs have been prepared.
This is an advanced framework feature. Only use this if you understand the implications.
stability stable
void
Construct.prepare
▸ Protected synthesize(session): void
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack and Asset
as they participate in synthesizing the cloud assembly.
stability stable
| Name | Type | Description |
|---|---|---|
session |
ISynthesisSession |
The synthesis session. |
void
Construct.synthesize
▸ toString(): string
Returns a string representation of this construct.
stability stable
string
Construct.toString
▸ Protected validate(): string[]
Validate the current construct.
This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.
stability stable
string[]
An array of validation error messages, or an empty array if the construct is valid.
Construct.validate
▸ Static isConstruct(x): x is Construct
Return whether the given object is a Construct.
stability stable
| Name | Type |
|---|---|
x |
any |
x is Construct
Construct.isConstruct
@cloudcomponents/cdk-wordpress / Database
-
Construct↳
Database
- allowDefaultPortFrom
- onPrepare
- onSynthesize
- onValidate
- prepare
- synthesize
- toString
- validate
- isConstruct
• new Database(scope, id, props)
| Name | Type |
|---|---|
scope |
Construct |
id |
string |
props |
DatabaseProps |
Construct.constructor
• Readonly environment: Record<string, string>
• Private Readonly instance: DatabaseInstance
• Readonly node: ConstructNode
The construct tree node associated with this construct.
stability stable
Construct.node
• Readonly secrets: Record<string, Secret>
▸ allowDefaultPortFrom(other, description?): void
| Name | Type |
|---|---|
other |
IConnectable |
description? |
string |
void
▸ Protected onPrepare(): void
Perform final modifications before synthesis.
This method can be implemented by derived constructs in order to perform final changes before synthesis. prepare() will be called after child constructs have been prepared.
This is an advanced framework feature. Only use this if you understand the implications.
stability stable
void
Construct.onPrepare
▸ Protected onSynthesize(session): void
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack and Asset
as they participate in synthesizing the cloud assembly.
stability stable
| Name | Type | Description |
|---|---|---|
session |
ISynthesisSession |
The synthesis session. |
void
Construct.onSynthesize
▸ Protected onValidate(): string[]
Validate the current construct.
This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.
stability stable
string[]
An array of validation error messages, or an empty array if the construct is valid.
Construct.onValidate
▸ Protected prepare(): void
Perform final modifications before synthesis.
This method can be implemented by derived constructs in order to perform final changes before synthesis. prepare() will be called after child constructs have been prepared.
This is an advanced framework feature. Only use this if you understand the implications.
stability stable
void
Construct.prepare
▸ Protected synthesize(session): void
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack and Asset
as they participate in synthesizing the cloud assembly.
stability stable
| Name | Type | Description |
|---|---|---|
session |
ISynthesisSession |
The synthesis session. |
void
Construct.synthesize
▸ toString(): string
Returns a string representation of this construct.
stability stable
string
Construct.toString
▸ Protected validate(): string[]
Validate the current construct.
This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.
stability stable
string[]
An array of validation error messages, or an empty array if the construct is valid.
Construct.validate
▸ Static isConstruct(x): x is Construct
Return whether the given object is a Construct.
stability stable
| Name | Type |
|---|---|
x |
any |
x is Construct
Construct.isConstruct
@cloudcomponents/cdk-wordpress / Dns
-
Construct↳
Dns
• new Dns(scope, id, props)
| Name | Type |
|---|---|
scope |
Construct |
id |
string |
props |
DnsProps |
Construct.constructor
• Readonly node: ConstructNode
The construct tree node associated with this construct.
stability stable
Construct.node
▸ Protected onPrepare(): void
Perform final modifications before synthesis.
This method can be implemented by derived constructs in order to perform final changes before synthesis. prepare() will be called after child constructs have been prepared.
This is an advanced framework feature. Only use this if you understand the implications.
stability stable
void
Construct.onPrepare
▸ Protected onSynthesize(session): void
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack and Asset
as they participate in synthesizing the cloud assembly.
stability stable
| Name | Type | Description |
|---|---|---|
session |
ISynthesisSession |
The synthesis session. |
void
Construct.onSynthesize
▸ Protected onValidate(): string[]
Validate the current construct.
This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.
stability stable
string[]
An array of validation error messages, or an empty array if the construct is valid.
Construct.onValidate
▸ Protected prepare(): void
Perform final modifications before synthesis.
This method can be implemented by derived constructs in order to perform final changes before synthesis. prepare() will be called after child constructs have been prepared.
This is an advanced framework feature. Only use this if you understand the implications.
stability stable
void
Construct.prepare
▸ Protected synthesize(session): void
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack and Asset
as they participate in synthesizing the cloud assembly.
stability stable
| Name | Type | Description |
|---|---|---|
session |
ISynthesisSession |
The synthesis session. |
void
Construct.synthesize
▸ toString(): string
Returns a string representation of this construct.
stability stable
string
Construct.toString
▸ Protected validate(): string[]
Validate the current construct.
This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.
stability stable
string[]
An array of validation error messages, or an empty array if the construct is valid.
Construct.validate
▸ Static isConstruct(x): x is Construct
Return whether the given object is a Construct.
stability stable
| Name | Type |
|---|---|
x |
any |
x is Construct
Construct.isConstruct
@cloudcomponents/cdk-wordpress / EfsVolume
-
Construct↳
EfsVolume
- allowDefaultPortFrom
- onPrepare
- onSynthesize
- onValidate
- prepare
- synthesize
- toString
- validate
- isConstruct
• new EfsVolume(scope, id, props)
| Name | Type |
|---|---|
scope |
Construct |
id |
string |
props |
EfsVolumeProps |
Construct.constructor
• Readonly efsVolumeConfiguration: EfsVolumeConfiguration
• Private Readonly fileSystem: FileSystem
• Readonly name: string
• Readonly node: ConstructNode
The construct tree node associated with this construct.
stability stable
Construct.node
▸ allowDefaultPortFrom(other, description?): void
| Name | Type |
|---|---|
other |
IConnectable |
description? |
string |
void
▸ Protected onPrepare(): void
Perform final modifications before synthesis.
This method can be implemented by derived constructs in order to perform final changes before synthesis. prepare() will be called after child constructs have been prepared.
This is an advanced framework feature. Only use this if you understand the implications.
stability stable
void
Construct.onPrepare
▸ Protected onSynthesize(session): void
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack and Asset
as they participate in synthesizing the cloud assembly.
stability stable
| Name | Type | Description |
|---|---|---|
session |
ISynthesisSession |
The synthesis session. |
void
Construct.onSynthesize
▸ Protected onValidate(): string[]
Validate the current construct.
This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.
stability stable
string[]
An array of validation error messages, or an empty array if the construct is valid.
Construct.onValidate
▸ Protected prepare(): void
Perform final modifications before synthesis.
This method can be implemented by derived constructs in order to perform final changes before synthesis. prepare() will be called after child constructs have been prepared.
This is an advanced framework feature. Only use this if you understand the implications.
stability stable
void
Construct.prepare
▸ Protected synthesize(session): void
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack and Asset
as they participate in synthesizing the cloud assembly.
stability stable
| Name | Type | Description |
|---|---|---|
session |
ISynthesisSession |
The synthesis session. |
void
Construct.synthesize
▸ toString(): string
Returns a string representation of this construct.
stability stable
string
Construct.toString
▸ Protected validate(): string[]
Validate the current construct.
This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.
stability stable
string[]
An array of validation error messages, or an empty array if the construct is valid.
Construct.validate
▸ Static isConstruct(x): x is Construct
Return whether the given object is a Construct.
stability stable
| Name | Type |
|---|---|
x |
any |
x is Construct
Construct.isConstruct
@cloudcomponents/cdk-wordpress / Wordpress
-
Construct↳
Wordpress
• new Wordpress(scope, id, props)
| Name | Type |
|---|---|
scope |
Construct |
id |
string |
props |
WordpressProps |
Construct.constructor
• Readonly application: Application
• Readonly database: Database
• Readonly node: ConstructNode
The construct tree node associated with this construct.
stability stable
Construct.node
• Optional Readonly staticContentOffload: StaticContentOffload
• Readonly volume: EfsVolume
▸ Protected onPrepare(): void
Perform final modifications before synthesis.
This method can be implemented by derived constructs in order to perform final changes before synthesis. prepare() will be called after child constructs have been prepared.
This is an advanced framework feature. Only use this if you understand the implications.
stability stable
void
Construct.onPrepare
▸ Protected onSynthesize(session): void
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack and Asset
as they participate in synthesizing the cloud assembly.
stability stable
| Name | Type | Description |
|---|---|---|
session |
ISynthesisSession |
The synthesis session. |
void
Construct.onSynthesize
▸ Protected onValidate(): string[]
Validate the current construct.
This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.
stability stable
string[]
An array of validation error messages, or an empty array if the construct is valid.
Construct.onValidate
▸ Protected prepare(): void
Perform final modifications before synthesis.
This method can be implemented by derived constructs in order to perform final changes before synthesis. prepare() will be called after child constructs have been prepared.
This is an advanced framework feature. Only use this if you understand the implications.
stability stable
void
Construct.prepare
▸ Protected synthesize(session): void
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack and Asset
as they participate in synthesizing the cloud assembly.
stability stable
| Name | Type | Description |
|---|---|---|
session |
ISynthesisSession |
The synthesis session. |
void
Construct.synthesize
▸ toString(): string
Returns a string representation of this construct.
stability stable
string
Construct.toString
▸ Protected validate(): string[]
Validate the current construct.
This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.
stability stable
string[]
An array of validation error messages, or an empty array if the construct is valid.
Construct.validate
▸ Static isConstruct(x): x is Construct
Return whether the given object is a Construct.
stability stable
| Name | Type |
|---|---|
x |
any |
x is Construct
Construct.isConstruct
@cloudcomponents/cdk-wordpress / ApplicationProps
- certificate
- cloudFrontHashHeader
- database
- domainName
- domainZone
- environment
- image
- logDriver
- memoryLimitMiB
- removalPolicy
- secrets
- serviceName
- volume
- vpc
• Readonly certificate: ICertificate
• Optional Readonly cloudFrontHashHeader: string
• Readonly database: Database
• Readonly domainName: string
• Readonly domainZone: IHostedZone
• Optional Readonly environment: Record<string, string>
• Optional Readonly image: ContainerImage
• Optional Readonly logDriver: LogDriver
• Optional Readonly memoryLimitMiB: number
• Optional Readonly removalPolicy: RemovalPolicy
• Optional Readonly secrets: Record<string, Secret>
• Optional Readonly serviceName: string
• Readonly volume: EfsVolume
• Readonly vpc: IVpc
@cloudcomponents/cdk-wordpress / DatabaseProps
• Optional Readonly allocatedStorage: number
• Optional Readonly databaseName: string
• Optional Readonly engine: IInstanceEngine
• Optional Readonly instanceType: InstanceType
• Optional Readonly removalPolicy: RemovalPolicy
• Readonly vpc: IVpc
@cloudcomponents/cdk-wordpress / DnsProps
• Readonly distribution: IDistribution
• Readonly domainName: string
• Readonly domainZone: IHostedZone
@cloudcomponents/cdk-wordpress / EfsVolumeProps
• Optional Readonly name: string
• Optional Readonly removalPolicy: RemovalPolicy
• Readonly vpc: IVpc
@cloudcomponents/cdk-wordpress / StaticContentOffload
• Readonly distribution: IDistribution
• Readonly domainName: string
@cloudcomponents/cdk-wordpress / WordpressProps
- backupPlan
- cloudFrontHashHeader
- database
- domainName
- domainZone
- environment
- image
- logDriver
- memoryLimitMiB
- offloadStaticContent
- removalPolicy
- secrets
- serviceName
- subjectAlternativeNames
- volume
- vpc
• Optional Readonly backupPlan: BackupPlan
• Optional Readonly cloudFrontHashHeader: string
• Optional Readonly database: Database
• Readonly domainName: string
• Readonly domainZone: IHostedZone
• Optional Readonly environment: Record<string, string>
• Optional Readonly image: ContainerImage
• Optional Readonly logDriver: LogDriver
• Optional Readonly memoryLimitMiB: number
• Optional Readonly offloadStaticContent: boolean
• Optional Readonly removalPolicy: RemovalPolicy
• Optional Readonly secrets: Record<string, Secret>
• Optional Readonly serviceName: string
• Optional Readonly subjectAlternativeNames: string[]
• Optional Readonly volume: EfsVolume
• Optional Readonly vpc: IVpc