/
apiKey.go
363 lines (308 loc) · 13.1 KB
/
apiKey.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
// Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT.
// *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***
package apigateway
import (
"context"
"reflect"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
// Provides an API Gateway API Key.
//
// > **NOTE:** Since the API Gateway usage plans feature was launched on August 11, 2016, usage plans are now **required** to associate an API key with an API stage.
//
// ## Example Usage
//
// ```go
// package main
//
// import (
//
// "github.com/pulumi/pulumi-aws/sdk/v5/go/aws/apigateway"
// "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
//
// )
//
// func main() {
// pulumi.Run(func(ctx *pulumi.Context) error {
// _, err := apigateway.NewApiKey(ctx, "myDemoApiKey", nil)
// if err != nil {
// return err
// }
// return nil
// })
// }
//
// ```
//
// ## Import
//
// API Gateway Keys can be imported using the `id`, e.g.,
//
// ```sh
//
// $ pulumi import aws:apigateway/apiKey:ApiKey my_demo_key 8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blk
//
// ```
type ApiKey struct {
pulumi.CustomResourceState
// ARN
Arn pulumi.StringOutput `pulumi:"arn"`
// Creation date of the API key
CreatedDate pulumi.StringOutput `pulumi:"createdDate"`
// API key description. Defaults to "Managed by Pulumi".
Description pulumi.StringOutput `pulumi:"description"`
// Whether the API key can be used by callers. Defaults to `true`.
Enabled pulumi.BoolPtrOutput `pulumi:"enabled"`
// Last update date of the API key
LastUpdatedDate pulumi.StringOutput `pulumi:"lastUpdatedDate"`
// Name of the API key.
Name pulumi.StringOutput `pulumi:"name"`
// Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Tags pulumi.StringMapOutput `pulumi:"tags"`
// Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"`
// Value of the API key. If specified, the value must be an alphanumeric string between 20 and 128 characters. If not specified, it will be automatically generated by AWS on creation.
Value pulumi.StringOutput `pulumi:"value"`
}
// NewApiKey registers a new resource with the given unique name, arguments, and options.
func NewApiKey(ctx *pulumi.Context,
name string, args *ApiKeyArgs, opts ...pulumi.ResourceOption) (*ApiKey, error) {
if args == nil {
args = &ApiKeyArgs{}
}
if args.Description == nil {
args.Description = pulumi.StringPtr("Managed by Pulumi")
}
if args.Value != nil {
args.Value = pulumi.ToSecret(args.Value).(pulumi.StringPtrInput)
}
secrets := pulumi.AdditionalSecretOutputs([]string{
"value",
})
opts = append(opts, secrets)
var resource ApiKey
err := ctx.RegisterResource("aws:apigateway/apiKey:ApiKey", name, args, &resource, opts...)
if err != nil {
return nil, err
}
return &resource, nil
}
// GetApiKey gets an existing ApiKey resource's state with the given name, ID, and optional
// state properties that are used to uniquely qualify the lookup (nil if not required).
func GetApiKey(ctx *pulumi.Context,
name string, id pulumi.IDInput, state *ApiKeyState, opts ...pulumi.ResourceOption) (*ApiKey, error) {
var resource ApiKey
err := ctx.ReadResource("aws:apigateway/apiKey:ApiKey", name, id, state, &resource, opts...)
if err != nil {
return nil, err
}
return &resource, nil
}
// Input properties used for looking up and filtering ApiKey resources.
type apiKeyState struct {
// ARN
Arn *string `pulumi:"arn"`
// Creation date of the API key
CreatedDate *string `pulumi:"createdDate"`
// API key description. Defaults to "Managed by Pulumi".
Description *string `pulumi:"description"`
// Whether the API key can be used by callers. Defaults to `true`.
Enabled *bool `pulumi:"enabled"`
// Last update date of the API key
LastUpdatedDate *string `pulumi:"lastUpdatedDate"`
// Name of the API key.
Name *string `pulumi:"name"`
// Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Tags map[string]string `pulumi:"tags"`
// Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
TagsAll map[string]string `pulumi:"tagsAll"`
// Value of the API key. If specified, the value must be an alphanumeric string between 20 and 128 characters. If not specified, it will be automatically generated by AWS on creation.
Value *string `pulumi:"value"`
}
type ApiKeyState struct {
// ARN
Arn pulumi.StringPtrInput
// Creation date of the API key
CreatedDate pulumi.StringPtrInput
// API key description. Defaults to "Managed by Pulumi".
Description pulumi.StringPtrInput
// Whether the API key can be used by callers. Defaults to `true`.
Enabled pulumi.BoolPtrInput
// Last update date of the API key
LastUpdatedDate pulumi.StringPtrInput
// Name of the API key.
Name pulumi.StringPtrInput
// Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Tags pulumi.StringMapInput
// Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
TagsAll pulumi.StringMapInput
// Value of the API key. If specified, the value must be an alphanumeric string between 20 and 128 characters. If not specified, it will be automatically generated by AWS on creation.
Value pulumi.StringPtrInput
}
func (ApiKeyState) ElementType() reflect.Type {
return reflect.TypeOf((*apiKeyState)(nil)).Elem()
}
type apiKeyArgs struct {
// API key description. Defaults to "Managed by Pulumi".
Description *string `pulumi:"description"`
// Whether the API key can be used by callers. Defaults to `true`.
Enabled *bool `pulumi:"enabled"`
// Name of the API key.
Name *string `pulumi:"name"`
// Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Tags map[string]string `pulumi:"tags"`
// Value of the API key. If specified, the value must be an alphanumeric string between 20 and 128 characters. If not specified, it will be automatically generated by AWS on creation.
Value *string `pulumi:"value"`
}
// The set of arguments for constructing a ApiKey resource.
type ApiKeyArgs struct {
// API key description. Defaults to "Managed by Pulumi".
Description pulumi.StringPtrInput
// Whether the API key can be used by callers. Defaults to `true`.
Enabled pulumi.BoolPtrInput
// Name of the API key.
Name pulumi.StringPtrInput
// Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Tags pulumi.StringMapInput
// Value of the API key. If specified, the value must be an alphanumeric string between 20 and 128 characters. If not specified, it will be automatically generated by AWS on creation.
Value pulumi.StringPtrInput
}
func (ApiKeyArgs) ElementType() reflect.Type {
return reflect.TypeOf((*apiKeyArgs)(nil)).Elem()
}
type ApiKeyInput interface {
pulumi.Input
ToApiKeyOutput() ApiKeyOutput
ToApiKeyOutputWithContext(ctx context.Context) ApiKeyOutput
}
func (*ApiKey) ElementType() reflect.Type {
return reflect.TypeOf((**ApiKey)(nil)).Elem()
}
func (i *ApiKey) ToApiKeyOutput() ApiKeyOutput {
return i.ToApiKeyOutputWithContext(context.Background())
}
func (i *ApiKey) ToApiKeyOutputWithContext(ctx context.Context) ApiKeyOutput {
return pulumi.ToOutputWithContext(ctx, i).(ApiKeyOutput)
}
// ApiKeyArrayInput is an input type that accepts ApiKeyArray and ApiKeyArrayOutput values.
// You can construct a concrete instance of `ApiKeyArrayInput` via:
//
// ApiKeyArray{ ApiKeyArgs{...} }
type ApiKeyArrayInput interface {
pulumi.Input
ToApiKeyArrayOutput() ApiKeyArrayOutput
ToApiKeyArrayOutputWithContext(context.Context) ApiKeyArrayOutput
}
type ApiKeyArray []ApiKeyInput
func (ApiKeyArray) ElementType() reflect.Type {
return reflect.TypeOf((*[]*ApiKey)(nil)).Elem()
}
func (i ApiKeyArray) ToApiKeyArrayOutput() ApiKeyArrayOutput {
return i.ToApiKeyArrayOutputWithContext(context.Background())
}
func (i ApiKeyArray) ToApiKeyArrayOutputWithContext(ctx context.Context) ApiKeyArrayOutput {
return pulumi.ToOutputWithContext(ctx, i).(ApiKeyArrayOutput)
}
// ApiKeyMapInput is an input type that accepts ApiKeyMap and ApiKeyMapOutput values.
// You can construct a concrete instance of `ApiKeyMapInput` via:
//
// ApiKeyMap{ "key": ApiKeyArgs{...} }
type ApiKeyMapInput interface {
pulumi.Input
ToApiKeyMapOutput() ApiKeyMapOutput
ToApiKeyMapOutputWithContext(context.Context) ApiKeyMapOutput
}
type ApiKeyMap map[string]ApiKeyInput
func (ApiKeyMap) ElementType() reflect.Type {
return reflect.TypeOf((*map[string]*ApiKey)(nil)).Elem()
}
func (i ApiKeyMap) ToApiKeyMapOutput() ApiKeyMapOutput {
return i.ToApiKeyMapOutputWithContext(context.Background())
}
func (i ApiKeyMap) ToApiKeyMapOutputWithContext(ctx context.Context) ApiKeyMapOutput {
return pulumi.ToOutputWithContext(ctx, i).(ApiKeyMapOutput)
}
type ApiKeyOutput struct{ *pulumi.OutputState }
func (ApiKeyOutput) ElementType() reflect.Type {
return reflect.TypeOf((**ApiKey)(nil)).Elem()
}
func (o ApiKeyOutput) ToApiKeyOutput() ApiKeyOutput {
return o
}
func (o ApiKeyOutput) ToApiKeyOutputWithContext(ctx context.Context) ApiKeyOutput {
return o
}
// ARN
func (o ApiKeyOutput) Arn() pulumi.StringOutput {
return o.ApplyT(func(v *ApiKey) pulumi.StringOutput { return v.Arn }).(pulumi.StringOutput)
}
// Creation date of the API key
func (o ApiKeyOutput) CreatedDate() pulumi.StringOutput {
return o.ApplyT(func(v *ApiKey) pulumi.StringOutput { return v.CreatedDate }).(pulumi.StringOutput)
}
// API key description. Defaults to "Managed by Pulumi".
func (o ApiKeyOutput) Description() pulumi.StringOutput {
return o.ApplyT(func(v *ApiKey) pulumi.StringOutput { return v.Description }).(pulumi.StringOutput)
}
// Whether the API key can be used by callers. Defaults to `true`.
func (o ApiKeyOutput) Enabled() pulumi.BoolPtrOutput {
return o.ApplyT(func(v *ApiKey) pulumi.BoolPtrOutput { return v.Enabled }).(pulumi.BoolPtrOutput)
}
// Last update date of the API key
func (o ApiKeyOutput) LastUpdatedDate() pulumi.StringOutput {
return o.ApplyT(func(v *ApiKey) pulumi.StringOutput { return v.LastUpdatedDate }).(pulumi.StringOutput)
}
// Name of the API key.
func (o ApiKeyOutput) Name() pulumi.StringOutput {
return o.ApplyT(func(v *ApiKey) pulumi.StringOutput { return v.Name }).(pulumi.StringOutput)
}
// Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
func (o ApiKeyOutput) Tags() pulumi.StringMapOutput {
return o.ApplyT(func(v *ApiKey) pulumi.StringMapOutput { return v.Tags }).(pulumi.StringMapOutput)
}
// Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
func (o ApiKeyOutput) TagsAll() pulumi.StringMapOutput {
return o.ApplyT(func(v *ApiKey) pulumi.StringMapOutput { return v.TagsAll }).(pulumi.StringMapOutput)
}
// Value of the API key. If specified, the value must be an alphanumeric string between 20 and 128 characters. If not specified, it will be automatically generated by AWS on creation.
func (o ApiKeyOutput) Value() pulumi.StringOutput {
return o.ApplyT(func(v *ApiKey) pulumi.StringOutput { return v.Value }).(pulumi.StringOutput)
}
type ApiKeyArrayOutput struct{ *pulumi.OutputState }
func (ApiKeyArrayOutput) ElementType() reflect.Type {
return reflect.TypeOf((*[]*ApiKey)(nil)).Elem()
}
func (o ApiKeyArrayOutput) ToApiKeyArrayOutput() ApiKeyArrayOutput {
return o
}
func (o ApiKeyArrayOutput) ToApiKeyArrayOutputWithContext(ctx context.Context) ApiKeyArrayOutput {
return o
}
func (o ApiKeyArrayOutput) Index(i pulumi.IntInput) ApiKeyOutput {
return pulumi.All(o, i).ApplyT(func(vs []interface{}) *ApiKey {
return vs[0].([]*ApiKey)[vs[1].(int)]
}).(ApiKeyOutput)
}
type ApiKeyMapOutput struct{ *pulumi.OutputState }
func (ApiKeyMapOutput) ElementType() reflect.Type {
return reflect.TypeOf((*map[string]*ApiKey)(nil)).Elem()
}
func (o ApiKeyMapOutput) ToApiKeyMapOutput() ApiKeyMapOutput {
return o
}
func (o ApiKeyMapOutput) ToApiKeyMapOutputWithContext(ctx context.Context) ApiKeyMapOutput {
return o
}
func (o ApiKeyMapOutput) MapIndex(k pulumi.StringInput) ApiKeyOutput {
return pulumi.All(o, k).ApplyT(func(vs []interface{}) *ApiKey {
return vs[0].(map[string]*ApiKey)[vs[1].(string)]
}).(ApiKeyOutput)
}
func init() {
pulumi.RegisterInputType(reflect.TypeOf((*ApiKeyInput)(nil)).Elem(), &ApiKey{})
pulumi.RegisterInputType(reflect.TypeOf((*ApiKeyArrayInput)(nil)).Elem(), ApiKeyArray{})
pulumi.RegisterInputType(reflect.TypeOf((*ApiKeyMapInput)(nil)).Elem(), ApiKeyMap{})
pulumi.RegisterOutputType(ApiKeyOutput{})
pulumi.RegisterOutputType(ApiKeyArrayOutput{})
pulumi.RegisterOutputType(ApiKeyMapOutput{})
}