/
snapshot.go
370 lines (315 loc) · 14.4 KB
/
snapshot.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
// 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 memorydb
import (
"context"
"reflect"
"errors"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/internal"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
// Provides a MemoryDB Snapshot.
//
// More information about snapshot and restore can be found in the [MemoryDB User Guide](https://docs.aws.amazon.com/memorydb/latest/devguide/snapshots.html).
//
// ## Example Usage
//
// <!--Start PulumiCodeChooser -->
// ```go
// package main
//
// import (
//
// "github.com/pulumi/pulumi-aws/sdk/v6/go/aws/memorydb"
// "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
//
// )
//
// func main() {
// pulumi.Run(func(ctx *pulumi.Context) error {
// _, err := memorydb.NewSnapshot(ctx, "example", &memorydb.SnapshotArgs{
// ClusterName: pulumi.Any(exampleAwsMemorydbCluster.Name),
// Name: pulumi.String("my-snapshot"),
// })
// if err != nil {
// return err
// }
// return nil
// })
// }
//
// ```
// <!--End PulumiCodeChooser -->
//
// ## Import
//
// Using `pulumi import`, import a snapshot using the `name`. For example:
//
// ```sh
// $ pulumi import aws:memorydb/snapshot:Snapshot example my-snapshot
// ```
type Snapshot struct {
pulumi.CustomResourceState
// The ARN of the snapshot.
Arn pulumi.StringOutput `pulumi:"arn"`
// The configuration of the cluster from which the snapshot was taken.
ClusterConfigurations SnapshotClusterConfigurationArrayOutput `pulumi:"clusterConfigurations"`
// Name of the MemoryDB cluster to take a snapshot of.
ClusterName pulumi.StringOutput `pulumi:"clusterName"`
// ARN of the KMS key used to encrypt the snapshot at rest.
KmsKeyArn pulumi.StringPtrOutput `pulumi:"kmsKeyArn"`
// Name of the snapshot. If omitted, the provider will assign a random, unique name. Conflicts with `namePrefix`.
Name pulumi.StringOutput `pulumi:"name"`
// Creates a unique name beginning with the specified prefix. Conflicts with `name`.
NamePrefix pulumi.StringOutput `pulumi:"namePrefix"`
// Indicates whether the snapshot is from an automatic backup (`automated`) or was created manually (`manual`).
Source pulumi.StringOutput `pulumi:"source"`
// A map of tags to assign to the resource. 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"`
// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
//
// Deprecated: Please use `tags` instead.
TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"`
}
// NewSnapshot registers a new resource with the given unique name, arguments, and options.
func NewSnapshot(ctx *pulumi.Context,
name string, args *SnapshotArgs, opts ...pulumi.ResourceOption) (*Snapshot, error) {
if args == nil {
return nil, errors.New("missing one or more required arguments")
}
if args.ClusterName == nil {
return nil, errors.New("invalid value for required argument 'ClusterName'")
}
opts = internal.PkgResourceDefaultOpts(opts)
var resource Snapshot
err := ctx.RegisterResource("aws:memorydb/snapshot:Snapshot", name, args, &resource, opts...)
if err != nil {
return nil, err
}
return &resource, nil
}
// GetSnapshot gets an existing Snapshot 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 GetSnapshot(ctx *pulumi.Context,
name string, id pulumi.IDInput, state *SnapshotState, opts ...pulumi.ResourceOption) (*Snapshot, error) {
var resource Snapshot
err := ctx.ReadResource("aws:memorydb/snapshot:Snapshot", name, id, state, &resource, opts...)
if err != nil {
return nil, err
}
return &resource, nil
}
// Input properties used for looking up and filtering Snapshot resources.
type snapshotState struct {
// The ARN of the snapshot.
Arn *string `pulumi:"arn"`
// The configuration of the cluster from which the snapshot was taken.
ClusterConfigurations []SnapshotClusterConfiguration `pulumi:"clusterConfigurations"`
// Name of the MemoryDB cluster to take a snapshot of.
ClusterName *string `pulumi:"clusterName"`
// ARN of the KMS key used to encrypt the snapshot at rest.
KmsKeyArn *string `pulumi:"kmsKeyArn"`
// Name of the snapshot. If omitted, the provider will assign a random, unique name. Conflicts with `namePrefix`.
Name *string `pulumi:"name"`
// Creates a unique name beginning with the specified prefix. Conflicts with `name`.
NamePrefix *string `pulumi:"namePrefix"`
// Indicates whether the snapshot is from an automatic backup (`automated`) or was created manually (`manual`).
Source *string `pulumi:"source"`
// A map of tags to assign to the resource. 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"`
// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
//
// Deprecated: Please use `tags` instead.
TagsAll map[string]string `pulumi:"tagsAll"`
}
type SnapshotState struct {
// The ARN of the snapshot.
Arn pulumi.StringPtrInput
// The configuration of the cluster from which the snapshot was taken.
ClusterConfigurations SnapshotClusterConfigurationArrayInput
// Name of the MemoryDB cluster to take a snapshot of.
ClusterName pulumi.StringPtrInput
// ARN of the KMS key used to encrypt the snapshot at rest.
KmsKeyArn pulumi.StringPtrInput
// Name of the snapshot. If omitted, the provider will assign a random, unique name. Conflicts with `namePrefix`.
Name pulumi.StringPtrInput
// Creates a unique name beginning with the specified prefix. Conflicts with `name`.
NamePrefix pulumi.StringPtrInput
// Indicates whether the snapshot is from an automatic backup (`automated`) or was created manually (`manual`).
Source pulumi.StringPtrInput
// A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Tags pulumi.StringMapInput
// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
//
// Deprecated: Please use `tags` instead.
TagsAll pulumi.StringMapInput
}
func (SnapshotState) ElementType() reflect.Type {
return reflect.TypeOf((*snapshotState)(nil)).Elem()
}
type snapshotArgs struct {
// Name of the MemoryDB cluster to take a snapshot of.
ClusterName string `pulumi:"clusterName"`
// ARN of the KMS key used to encrypt the snapshot at rest.
KmsKeyArn *string `pulumi:"kmsKeyArn"`
// Name of the snapshot. If omitted, the provider will assign a random, unique name. Conflicts with `namePrefix`.
Name *string `pulumi:"name"`
// Creates a unique name beginning with the specified prefix. Conflicts with `name`.
NamePrefix *string `pulumi:"namePrefix"`
// A map of tags to assign to the resource. 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"`
}
// The set of arguments for constructing a Snapshot resource.
type SnapshotArgs struct {
// Name of the MemoryDB cluster to take a snapshot of.
ClusterName pulumi.StringInput
// ARN of the KMS key used to encrypt the snapshot at rest.
KmsKeyArn pulumi.StringPtrInput
// Name of the snapshot. If omitted, the provider will assign a random, unique name. Conflicts with `namePrefix`.
Name pulumi.StringPtrInput
// Creates a unique name beginning with the specified prefix. Conflicts with `name`.
NamePrefix pulumi.StringPtrInput
// A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Tags pulumi.StringMapInput
}
func (SnapshotArgs) ElementType() reflect.Type {
return reflect.TypeOf((*snapshotArgs)(nil)).Elem()
}
type SnapshotInput interface {
pulumi.Input
ToSnapshotOutput() SnapshotOutput
ToSnapshotOutputWithContext(ctx context.Context) SnapshotOutput
}
func (*Snapshot) ElementType() reflect.Type {
return reflect.TypeOf((**Snapshot)(nil)).Elem()
}
func (i *Snapshot) ToSnapshotOutput() SnapshotOutput {
return i.ToSnapshotOutputWithContext(context.Background())
}
func (i *Snapshot) ToSnapshotOutputWithContext(ctx context.Context) SnapshotOutput {
return pulumi.ToOutputWithContext(ctx, i).(SnapshotOutput)
}
// SnapshotArrayInput is an input type that accepts SnapshotArray and SnapshotArrayOutput values.
// You can construct a concrete instance of `SnapshotArrayInput` via:
//
// SnapshotArray{ SnapshotArgs{...} }
type SnapshotArrayInput interface {
pulumi.Input
ToSnapshotArrayOutput() SnapshotArrayOutput
ToSnapshotArrayOutputWithContext(context.Context) SnapshotArrayOutput
}
type SnapshotArray []SnapshotInput
func (SnapshotArray) ElementType() reflect.Type {
return reflect.TypeOf((*[]*Snapshot)(nil)).Elem()
}
func (i SnapshotArray) ToSnapshotArrayOutput() SnapshotArrayOutput {
return i.ToSnapshotArrayOutputWithContext(context.Background())
}
func (i SnapshotArray) ToSnapshotArrayOutputWithContext(ctx context.Context) SnapshotArrayOutput {
return pulumi.ToOutputWithContext(ctx, i).(SnapshotArrayOutput)
}
// SnapshotMapInput is an input type that accepts SnapshotMap and SnapshotMapOutput values.
// You can construct a concrete instance of `SnapshotMapInput` via:
//
// SnapshotMap{ "key": SnapshotArgs{...} }
type SnapshotMapInput interface {
pulumi.Input
ToSnapshotMapOutput() SnapshotMapOutput
ToSnapshotMapOutputWithContext(context.Context) SnapshotMapOutput
}
type SnapshotMap map[string]SnapshotInput
func (SnapshotMap) ElementType() reflect.Type {
return reflect.TypeOf((*map[string]*Snapshot)(nil)).Elem()
}
func (i SnapshotMap) ToSnapshotMapOutput() SnapshotMapOutput {
return i.ToSnapshotMapOutputWithContext(context.Background())
}
func (i SnapshotMap) ToSnapshotMapOutputWithContext(ctx context.Context) SnapshotMapOutput {
return pulumi.ToOutputWithContext(ctx, i).(SnapshotMapOutput)
}
type SnapshotOutput struct{ *pulumi.OutputState }
func (SnapshotOutput) ElementType() reflect.Type {
return reflect.TypeOf((**Snapshot)(nil)).Elem()
}
func (o SnapshotOutput) ToSnapshotOutput() SnapshotOutput {
return o
}
func (o SnapshotOutput) ToSnapshotOutputWithContext(ctx context.Context) SnapshotOutput {
return o
}
// The ARN of the snapshot.
func (o SnapshotOutput) Arn() pulumi.StringOutput {
return o.ApplyT(func(v *Snapshot) pulumi.StringOutput { return v.Arn }).(pulumi.StringOutput)
}
// The configuration of the cluster from which the snapshot was taken.
func (o SnapshotOutput) ClusterConfigurations() SnapshotClusterConfigurationArrayOutput {
return o.ApplyT(func(v *Snapshot) SnapshotClusterConfigurationArrayOutput { return v.ClusterConfigurations }).(SnapshotClusterConfigurationArrayOutput)
}
// Name of the MemoryDB cluster to take a snapshot of.
func (o SnapshotOutput) ClusterName() pulumi.StringOutput {
return o.ApplyT(func(v *Snapshot) pulumi.StringOutput { return v.ClusterName }).(pulumi.StringOutput)
}
// ARN of the KMS key used to encrypt the snapshot at rest.
func (o SnapshotOutput) KmsKeyArn() pulumi.StringPtrOutput {
return o.ApplyT(func(v *Snapshot) pulumi.StringPtrOutput { return v.KmsKeyArn }).(pulumi.StringPtrOutput)
}
// Name of the snapshot. If omitted, the provider will assign a random, unique name. Conflicts with `namePrefix`.
func (o SnapshotOutput) Name() pulumi.StringOutput {
return o.ApplyT(func(v *Snapshot) pulumi.StringOutput { return v.Name }).(pulumi.StringOutput)
}
// Creates a unique name beginning with the specified prefix. Conflicts with `name`.
func (o SnapshotOutput) NamePrefix() pulumi.StringOutput {
return o.ApplyT(func(v *Snapshot) pulumi.StringOutput { return v.NamePrefix }).(pulumi.StringOutput)
}
// Indicates whether the snapshot is from an automatic backup (`automated`) or was created manually (`manual`).
func (o SnapshotOutput) Source() pulumi.StringOutput {
return o.ApplyT(func(v *Snapshot) pulumi.StringOutput { return v.Source }).(pulumi.StringOutput)
}
// A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
func (o SnapshotOutput) Tags() pulumi.StringMapOutput {
return o.ApplyT(func(v *Snapshot) pulumi.StringMapOutput { return v.Tags }).(pulumi.StringMapOutput)
}
// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
//
// Deprecated: Please use `tags` instead.
func (o SnapshotOutput) TagsAll() pulumi.StringMapOutput {
return o.ApplyT(func(v *Snapshot) pulumi.StringMapOutput { return v.TagsAll }).(pulumi.StringMapOutput)
}
type SnapshotArrayOutput struct{ *pulumi.OutputState }
func (SnapshotArrayOutput) ElementType() reflect.Type {
return reflect.TypeOf((*[]*Snapshot)(nil)).Elem()
}
func (o SnapshotArrayOutput) ToSnapshotArrayOutput() SnapshotArrayOutput {
return o
}
func (o SnapshotArrayOutput) ToSnapshotArrayOutputWithContext(ctx context.Context) SnapshotArrayOutput {
return o
}
func (o SnapshotArrayOutput) Index(i pulumi.IntInput) SnapshotOutput {
return pulumi.All(o, i).ApplyT(func(vs []interface{}) *Snapshot {
return vs[0].([]*Snapshot)[vs[1].(int)]
}).(SnapshotOutput)
}
type SnapshotMapOutput struct{ *pulumi.OutputState }
func (SnapshotMapOutput) ElementType() reflect.Type {
return reflect.TypeOf((*map[string]*Snapshot)(nil)).Elem()
}
func (o SnapshotMapOutput) ToSnapshotMapOutput() SnapshotMapOutput {
return o
}
func (o SnapshotMapOutput) ToSnapshotMapOutputWithContext(ctx context.Context) SnapshotMapOutput {
return o
}
func (o SnapshotMapOutput) MapIndex(k pulumi.StringInput) SnapshotOutput {
return pulumi.All(o, k).ApplyT(func(vs []interface{}) *Snapshot {
return vs[0].(map[string]*Snapshot)[vs[1].(string)]
}).(SnapshotOutput)
}
func init() {
pulumi.RegisterInputType(reflect.TypeOf((*SnapshotInput)(nil)).Elem(), &Snapshot{})
pulumi.RegisterInputType(reflect.TypeOf((*SnapshotArrayInput)(nil)).Elem(), SnapshotArray{})
pulumi.RegisterInputType(reflect.TypeOf((*SnapshotMapInput)(nil)).Elem(), SnapshotMap{})
pulumi.RegisterOutputType(SnapshotOutput{})
pulumi.RegisterOutputType(SnapshotArrayOutput{})
pulumi.RegisterOutputType(SnapshotMapOutput{})
}