-
Notifications
You must be signed in to change notification settings - Fork 17
/
CfnParameter.go
545 lines (488 loc) · 12 KB
/
CfnParameter.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
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
package awscdk
import (
_init_ "github.com/aws/aws-cdk-go/awscdk/v2/jsii"
_jsii_ "github.com/aws/jsii-runtime-go/runtime"
"github.com/aws/constructs-go/constructs/v10"
)
// A CloudFormation parameter.
//
// Use the optional Parameters section to customize your templates.
// Parameters enable you to input custom values to your template each time you create or
// update a stack.
//
// Example:
// myTopic := sns.NewTopic(this, jsii.String("MyTopic"))
// url := awscdk.NewCfnParameter(this, jsii.String("url-param"))
//
// myTopic.AddSubscription(subscriptions.NewUrlSubscription(url.valueAsString))
//
type CfnParameter interface {
CfnElement
// A regular expression that represents the patterns to allow for String types.
// Default: - No constraints on patterns allowed for parameter.
//
AllowedPattern() *string
SetAllowedPattern(val *string)
// An array containing the list of values allowed for the parameter.
// Default: - No constraints on values allowed for parameter.
//
AllowedValues() *[]*string
SetAllowedValues(val *[]*string)
// A string that explains a constraint when the constraint is violated.
//
// For example, without a constraint description, a parameter that has an allowed
// pattern of [A-Za-z0-9]+ displays the following error message when the user specifies
// an invalid value:.
// Default: - No description with customized error message when user specifies invalid values.
//
ConstraintDescription() *string
SetConstraintDescription(val *string)
// 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.
CreationStack() *[]*string
// A value of the appropriate type for the template to use if no value is specified when a stack is created.
//
// If you define constraints for the parameter, you must specify
// a value that adheres to those constraints.
// Default: - No default value for parameter.
//
Default() interface{}
SetDefault(val interface{})
// A string of up to 4000 characters that describes the parameter.
// Default: - No description for the parameter.
//
Description() *string
SetDescription(val *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.
LogicalId() *string
// An integer value that determines the largest number of characters you want to allow for String types.
// Default: - None.
//
MaxLength() *float64
SetMaxLength(val *float64)
// A numeric value that determines the largest numeric value you want to allow for Number types.
// Default: - None.
//
MaxValue() *float64
SetMaxValue(val *float64)
// An integer value that determines the smallest number of characters you want to allow for String types.
// Default: - None.
//
MinLength() *float64
SetMinLength(val *float64)
// A numeric value that determines the smallest numeric value you want to allow for Number types.
// Default: - None.
//
MinValue() *float64
SetMinValue(val *float64)
// The tree node.
Node() constructs.Node
// Indicates if this parameter is configured with "NoEcho" enabled.
NoEcho() *bool
SetNoEcho(val *bool)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() Stack
// The data type for the parameter (DataType).
// Default: String.
//
Type() *string
SetType(val *string)
// The parameter value as a Token.
Value() IResolvable
// The parameter value, if it represents a string list.
ValueAsList() *[]*string
// The parameter value, if it represents a number.
ValueAsNumber() *float64
// The parameter value, if it represents a string.
ValueAsString() *string
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
Resolve(_context IResolveContext) interface{}
// Returns a string representation of this construct.
ToString() *string
}
// The jsii proxy struct for CfnParameter
type jsiiProxy_CfnParameter struct {
jsiiProxy_CfnElement
}
func (j *jsiiProxy_CfnParameter) AllowedPattern() *string {
var returns *string
_jsii_.Get(
j,
"allowedPattern",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnParameter) AllowedValues() *[]*string {
var returns *[]*string
_jsii_.Get(
j,
"allowedValues",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnParameter) ConstraintDescription() *string {
var returns *string
_jsii_.Get(
j,
"constraintDescription",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnParameter) CreationStack() *[]*string {
var returns *[]*string
_jsii_.Get(
j,
"creationStack",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnParameter) Default() interface{} {
var returns interface{}
_jsii_.Get(
j,
"default",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnParameter) Description() *string {
var returns *string
_jsii_.Get(
j,
"description",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnParameter) LogicalId() *string {
var returns *string
_jsii_.Get(
j,
"logicalId",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnParameter) MaxLength() *float64 {
var returns *float64
_jsii_.Get(
j,
"maxLength",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnParameter) MaxValue() *float64 {
var returns *float64
_jsii_.Get(
j,
"maxValue",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnParameter) MinLength() *float64 {
var returns *float64
_jsii_.Get(
j,
"minLength",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnParameter) MinValue() *float64 {
var returns *float64
_jsii_.Get(
j,
"minValue",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnParameter) Node() constructs.Node {
var returns constructs.Node
_jsii_.Get(
j,
"node",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnParameter) NoEcho() *bool {
var returns *bool
_jsii_.Get(
j,
"noEcho",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnParameter) Stack() Stack {
var returns Stack
_jsii_.Get(
j,
"stack",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnParameter) Type() *string {
var returns *string
_jsii_.Get(
j,
"type",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnParameter) Value() IResolvable {
var returns IResolvable
_jsii_.Get(
j,
"value",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnParameter) ValueAsList() *[]*string {
var returns *[]*string
_jsii_.Get(
j,
"valueAsList",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnParameter) ValueAsNumber() *float64 {
var returns *float64
_jsii_.Get(
j,
"valueAsNumber",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnParameter) ValueAsString() *string {
var returns *string
_jsii_.Get(
j,
"valueAsString",
&returns,
)
return returns
}
// Creates a parameter construct.
//
// Note that the name (logical ID) of the parameter will derive from it's `coname` and location
// within the stack. Therefore, it is recommended that parameters are defined at the stack level.
func NewCfnParameter(scope constructs.Construct, id *string, props *CfnParameterProps) CfnParameter {
_init_.Initialize()
if err := validateNewCfnParameterParameters(scope, id, props); err != nil {
panic(err)
}
j := jsiiProxy_CfnParameter{}
_jsii_.Create(
"aws-cdk-lib.CfnParameter",
[]interface{}{scope, id, props},
&j,
)
return &j
}
// Creates a parameter construct.
//
// Note that the name (logical ID) of the parameter will derive from it's `coname` and location
// within the stack. Therefore, it is recommended that parameters are defined at the stack level.
func NewCfnParameter_Override(c CfnParameter, scope constructs.Construct, id *string, props *CfnParameterProps) {
_init_.Initialize()
_jsii_.Create(
"aws-cdk-lib.CfnParameter",
[]interface{}{scope, id, props},
c,
)
}
func (j *jsiiProxy_CfnParameter)SetAllowedPattern(val *string) {
_jsii_.Set(
j,
"allowedPattern",
val,
)
}
func (j *jsiiProxy_CfnParameter)SetAllowedValues(val *[]*string) {
_jsii_.Set(
j,
"allowedValues",
val,
)
}
func (j *jsiiProxy_CfnParameter)SetConstraintDescription(val *string) {
_jsii_.Set(
j,
"constraintDescription",
val,
)
}
func (j *jsiiProxy_CfnParameter)SetDefault(val interface{}) {
if err := j.validateSetDefaultParameters(val); err != nil {
panic(err)
}
_jsii_.Set(
j,
"default",
val,
)
}
func (j *jsiiProxy_CfnParameter)SetDescription(val *string) {
_jsii_.Set(
j,
"description",
val,
)
}
func (j *jsiiProxy_CfnParameter)SetMaxLength(val *float64) {
_jsii_.Set(
j,
"maxLength",
val,
)
}
func (j *jsiiProxy_CfnParameter)SetMaxValue(val *float64) {
_jsii_.Set(
j,
"maxValue",
val,
)
}
func (j *jsiiProxy_CfnParameter)SetMinLength(val *float64) {
_jsii_.Set(
j,
"minLength",
val,
)
}
func (j *jsiiProxy_CfnParameter)SetMinValue(val *float64) {
_jsii_.Set(
j,
"minValue",
val,
)
}
func (j *jsiiProxy_CfnParameter)SetNoEcho(val *bool) {
if err := j.validateSetNoEchoParameters(val); err != nil {
panic(err)
}
_jsii_.Set(
j,
"noEcho",
val,
)
}
func (j *jsiiProxy_CfnParameter)SetType(val *string) {
if err := j.validateSetTypeParameters(val); err != nil {
panic(err)
}
_jsii_.Set(
j,
"type",
val,
)
}
// 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.
func CfnParameter_IsCfnElement(x interface{}) *bool {
_init_.Initialize()
if err := validateCfnParameter_IsCfnElementParameters(x); err != nil {
panic(err)
}
var returns *bool
_jsii_.StaticInvoke(
"aws-cdk-lib.CfnParameter",
"isCfnElement",
[]interface{}{x},
&returns,
)
return returns
}
// Checks if `x` is a construct.
//
// Use this method instead of `instanceof` to properly detect `Construct`
// instances, even when the construct library is symlinked.
//
// Explanation: in JavaScript, multiple copies of the `constructs` library on
// disk are seen as independent, completely different libraries. As a
// consequence, the class `Construct` in each copy of the `constructs` library
// is seen as a different class, and an instance of one class will not test as
// `instanceof` the other class. `npm install` will not create installations
// like this, but users may manually symlink construct libraries together or
// use a monorepo tool: in those cases, multiple copies of the `constructs`
// library can be accidentally installed, and `instanceof` will behave
// unpredictably. It is safest to avoid using `instanceof`, and using
// this type-testing method instead.
//
// Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnParameter_IsConstruct(x interface{}) *bool {
_init_.Initialize()
if err := validateCfnParameter_IsConstructParameters(x); err != nil {
panic(err)
}
var returns *bool
_jsii_.StaticInvoke(
"aws-cdk-lib.CfnParameter",
"isConstruct",
[]interface{}{x},
&returns,
)
return returns
}
func (c *jsiiProxy_CfnParameter) OverrideLogicalId(newLogicalId *string) {
if err := c.validateOverrideLogicalIdParameters(newLogicalId); err != nil {
panic(err)
}
_jsii_.InvokeVoid(
c,
"overrideLogicalId",
[]interface{}{newLogicalId},
)
}
func (c *jsiiProxy_CfnParameter) Resolve(_context IResolveContext) interface{} {
if err := c.validateResolveParameters(_context); err != nil {
panic(err)
}
var returns interface{}
_jsii_.Invoke(
c,
"resolve",
[]interface{}{_context},
&returns,
)
return returns
}
func (c *jsiiProxy_CfnParameter) ToString() *string {
var returns *string
_jsii_.Invoke(
c,
"toString",
nil, // no parameters
&returns,
)
return returns
}