UNPKG

cdk-demo-construct

Version:

A sample L3 CDK project

github.com/neilkuan/cdk-demo-construct

neilkuan/cdk-demo-construct

112 lines (61 loc) • 2.52 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
# API Reference <a name="API Reference"></a> ## Constructs <a name="Constructs"></a> ### AlarmInstance <a name="cdk-demo-construct.AlarmInstance"></a> #### Initializers <a name="cdk-demo-construct.AlarmInstance.Initializer"></a> ```typescript import { AlarmInstance } from 'cdk-demo-construct' new AlarmInstance(scope: Construct, id: string, props: AlarmInstanceProps) ``` ##### `scope`<sup>Required</sup> <a name="cdk-demo-construct.AlarmInstance.parameter.scope"></a> - *Type:* [`@aws-cdk/core.Construct`](#@aws-cdk/core.Construct) --- ##### `id`<sup>Required</sup> <a name="cdk-demo-construct.AlarmInstance.parameter.id"></a> - *Type:* `string` --- ##### `props`<sup>Required</sup> <a name="cdk-demo-construct.AlarmInstance.parameter.props"></a> - *Type:* [`cdk-demo-construct.AlarmInstanceProps`](#cdk-demo-construct.AlarmInstanceProps) --- #### Properties <a name="Properties"></a> ##### `instance`<sup>Required</sup> <a name="cdk-demo-construct.AlarmInstance.property.instance"></a> ```typescript public readonly instance: Instance; ``` - *Type:* [`@aws-cdk/aws-ec2.Instance`](#@aws-cdk/aws-ec2.Instance) --- ##### `topic`<sup>Required</sup> <a name="cdk-demo-construct.AlarmInstance.property.topic"></a> ```typescript public readonly topic: Topic; ``` - *Type:* [`@aws-cdk/aws-sns.Topic`](#@aws-cdk/aws-sns.Topic) --- ## Structs <a name="Structs"></a> ### AlarmInstanceProps <a name="cdk-demo-construct.AlarmInstanceProps"></a> #### Initializer <a name="[object Object].Initializer"></a> ```typescript import { AlarmInstanceProps } from 'cdk-demo-construct' const alarmInstanceProps: AlarmInstanceProps = { ... } ``` ##### `vpc`<sup>Required</sup> <a name="cdk-demo-construct.AlarmInstanceProps.property.vpc"></a> ```typescript public readonly vpc: IVpc; ``` - *Type:* [`@aws-cdk/aws-ec2.IVpc`](#@aws-cdk/aws-ec2.IVpc) --- ##### `notifyMail`<sup>Optional</sup> <a name="cdk-demo-construct.AlarmInstanceProps.property.notifyMail"></a> ```typescript public readonly notifyMail: string[]; ``` - *Type:* `string`[] --- ##### `topic`<sup>Optional</sup> <a name="cdk-demo-construct.AlarmInstanceProps.property.topic"></a> ```typescript public readonly topic: Topic; ``` - *Type:* [`@aws-cdk/aws-sns.Topic`](#@aws-cdk/aws-sns.Topic) --- ##### `userData`<sup>Optional</sup> <a name="cdk-demo-construct.AlarmInstanceProps.property.userData"></a> ```typescript public readonly userData: UserData; ``` - *Type:* [`@aws-cdk/aws-ec2.UserData`](#@aws-cdk/aws-ec2.UserData) ---