-
Notifications
You must be signed in to change notification settings - Fork 17
/
awscdk_CfnRule.go
356 lines (316 loc) · 9.08 KB
/
awscdk_CfnRule.go
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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
// An experiment to bundle the entire CDK into a single module
package awscdk
import (
_init_ "github.com/aws/aws-cdk-go/awscdk/jsii"
_jsii_ "github.com/aws/jsii-runtime-go/runtime"
"github.com/aws/constructs-go/constructs/v3"
)
// The Rules that define template constraints in an AWS Service Catalog portfolio describe when end users can use the template and which values they can specify for parameters that are declared in the AWS CloudFormation template used to create the product they are attempting to use.
//
// Rules
// are useful for preventing end users from inadvertently specifying an incorrect value.
// For example, you can add a rule to verify whether end users specified a valid subnet in a
// given VPC or used m1.small instance types for test environments. AWS CloudFormation uses
// rules to validate parameter values before it creates the resources for the product.
//
// A rule can include a RuleCondition property and must include an Assertions property.
// For each rule, you can define only one rule condition; you can define one or more asserts within the Assertions property.
// You define a rule condition and assertions by using rule-specific intrinsic functions.
//
// Example:
// var cfnTemplate cfnInclude
//
// // mutating the rule
// var myParameter cfnParameter
//
// rule := cfnTemplate.getRule(jsii.String("MyRule"))
// rule.addAssertion(core.fn.conditionContains([]*string{
// jsii.String("m1.small"),
// }, myParameter.valueAsString), jsii.String("MyParameter has to be m1.small"))
//
// Experimental.
type CfnRule interface {
CfnRefElement
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
// Experimental.
CreationStack() *[]*string
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
// Experimental.
LogicalId() *string
// The construct tree node associated with this construct.
// Experimental.
Node() ConstructNode
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
// Experimental.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() Stack
// Adds an assertion to the rule.
// Experimental.
AddAssertion(condition ICfnConditionExpression, description *string)
// 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.
// Experimental.
OnPrepare()
// 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.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// 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.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// 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.
// Experimental.
Prepare()
// 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.
// Experimental.
Synthesize(session ISynthesisSession)
// Returns a string representation of this construct.
// Experimental.
ToString() *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.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
}
// The jsii proxy struct for CfnRule
type jsiiProxy_CfnRule struct {
jsiiProxy_CfnRefElement
}
func (j *jsiiProxy_CfnRule) CreationStack() *[]*string {
var returns *[]*string
_jsii_.Get(
j,
"creationStack",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnRule) LogicalId() *string {
var returns *string
_jsii_.Get(
j,
"logicalId",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnRule) Node() ConstructNode {
var returns ConstructNode
_jsii_.Get(
j,
"node",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnRule) Ref() *string {
var returns *string
_jsii_.Get(
j,
"ref",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnRule) Stack() Stack {
var returns Stack
_jsii_.Get(
j,
"stack",
&returns,
)
return returns
}
// Creates and adds a rule.
// Experimental.
func NewCfnRule(scope constructs.Construct, id *string, props *CfnRuleProps) CfnRule {
_init_.Initialize()
if err := validateNewCfnRuleParameters(scope, id, props); err != nil {
panic(err)
}
j := jsiiProxy_CfnRule{}
_jsii_.Create(
"monocdk.CfnRule",
[]interface{}{scope, id, props},
&j,
)
return &j
}
// Creates and adds a rule.
// Experimental.
func NewCfnRule_Override(c CfnRule, scope constructs.Construct, id *string, props *CfnRuleProps) {
_init_.Initialize()
_jsii_.Create(
"monocdk.CfnRule",
[]interface{}{scope, id, props},
c,
)
}
// Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
//
// Uses duck-typing instead of `instanceof` to allow stack elements from different
// versions of this library to be included in the same stack.
//
// Returns: The construct as a stack element or undefined if it is not a stack element.
// Experimental.
func CfnRule_IsCfnElement(x interface{}) *bool {
_init_.Initialize()
if err := validateCfnRule_IsCfnElementParameters(x); err != nil {
panic(err)
}
var returns *bool
_jsii_.StaticInvoke(
"monocdk.CfnRule",
"isCfnElement",
[]interface{}{x},
&returns,
)
return returns
}
// Return whether the given object is a Construct.
// Experimental.
func CfnRule_IsConstruct(x interface{}) *bool {
_init_.Initialize()
if err := validateCfnRule_IsConstructParameters(x); err != nil {
panic(err)
}
var returns *bool
_jsii_.StaticInvoke(
"monocdk.CfnRule",
"isConstruct",
[]interface{}{x},
&returns,
)
return returns
}
func (c *jsiiProxy_CfnRule) AddAssertion(condition ICfnConditionExpression, description *string) {
if err := c.validateAddAssertionParameters(condition, description); err != nil {
panic(err)
}
_jsii_.InvokeVoid(
c,
"addAssertion",
[]interface{}{condition, description},
)
}
func (c *jsiiProxy_CfnRule) OnPrepare() {
_jsii_.InvokeVoid(
c,
"onPrepare",
nil, // no parameters
)
}
func (c *jsiiProxy_CfnRule) OnSynthesize(session constructs.ISynthesisSession) {
if err := c.validateOnSynthesizeParameters(session); err != nil {
panic(err)
}
_jsii_.InvokeVoid(
c,
"onSynthesize",
[]interface{}{session},
)
}
func (c *jsiiProxy_CfnRule) OnValidate() *[]*string {
var returns *[]*string
_jsii_.Invoke(
c,
"onValidate",
nil, // no parameters
&returns,
)
return returns
}
func (c *jsiiProxy_CfnRule) OverrideLogicalId(newLogicalId *string) {
if err := c.validateOverrideLogicalIdParameters(newLogicalId); err != nil {
panic(err)
}
_jsii_.InvokeVoid(
c,
"overrideLogicalId",
[]interface{}{newLogicalId},
)
}
func (c *jsiiProxy_CfnRule) Prepare() {
_jsii_.InvokeVoid(
c,
"prepare",
nil, // no parameters
)
}
func (c *jsiiProxy_CfnRule) Synthesize(session ISynthesisSession) {
if err := c.validateSynthesizeParameters(session); err != nil {
panic(err)
}
_jsii_.InvokeVoid(
c,
"synthesize",
[]interface{}{session},
)
}
func (c *jsiiProxy_CfnRule) ToString() *string {
var returns *string
_jsii_.Invoke(
c,
"toString",
nil, // no parameters
&returns,
)
return returns
}
func (c *jsiiProxy_CfnRule) Validate() *[]*string {
var returns *[]*string
_jsii_.Invoke(
c,
"validate",
nil, // no parameters
&returns,
)
return returns
}