/
getVolume.go
211 lines (187 loc) · 6.93 KB
/
getVolume.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
// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package digitalocean
import (
"context"
"reflect"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
// Get information on a volume for use in other resources. This data source provides
// all of the volumes properties as configured on your DigitalOcean account. This is
// useful if the volume in question is not managed by the provider or you need to utilize
// any of the volumes data.
//
// An error is triggered if the provided volume name does not exist.
//
// ## Example Usage
//
// Get the volume:
//
// ```go
// package main
//
// import (
// "github.com/pulumi/pulumi-digitalocean/sdk/v4/go/digitalocean"
// "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
// )
//
// func main() {
// pulumi.Run(func(ctx *pulumi.Context) error {
// _, err := digitalocean.LookupVolume(ctx, &GetVolumeArgs{
// Name: "app-data",
// Region: pulumi.StringRef("nyc3"),
// }, nil)
// if err != nil {
// return err
// }
// return nil
// })
// }
// ```
//
// Reuse the data about a volume to attach it to a Droplet:
//
// ```go
// package main
//
// import (
// "github.com/pulumi/pulumi-digitalocean/sdk/v4/go/digitalocean"
// "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
// )
//
// func main() {
// pulumi.Run(func(ctx *pulumi.Context) error {
// exampleVolume, err := digitalocean.LookupVolume(ctx, &GetVolumeArgs{
// Name: "app-data",
// Region: pulumi.StringRef("nyc3"),
// }, nil)
// if err != nil {
// return err
// }
// exampleDroplet, err := digitalocean.NewDroplet(ctx, "exampleDroplet", &digitalocean.DropletArgs{
// Size: pulumi.String("s-1vcpu-1gb"),
// Image: pulumi.String("ubuntu-18-04-x64"),
// Region: pulumi.String("nyc3"),
// })
// if err != nil {
// return err
// }
// _, err = digitalocean.NewVolumeAttachment(ctx, "foobar", &digitalocean.VolumeAttachmentArgs{
// DropletId: exampleDroplet.ID(),
// VolumeId: pulumi.String(exampleVolume.Id),
// })
// if err != nil {
// return err
// }
// return nil
// })
// }
// ```
func LookupVolume(ctx *pulumi.Context, args *LookupVolumeArgs, opts ...pulumi.InvokeOption) (*LookupVolumeResult, error) {
var rv LookupVolumeResult
err := ctx.Invoke("digitalocean:index/getVolume:getVolume", args, &rv, opts...)
if err != nil {
return nil, err
}
return &rv, nil
}
// A collection of arguments for invoking getVolume.
type LookupVolumeArgs struct {
// Text describing a block storage volume.
Description *string `pulumi:"description"`
// The name of block storage volume.
Name string `pulumi:"name"`
// The region the block storage volume is provisioned in.
Region *string `pulumi:"region"`
}
// A collection of values returned by getVolume.
type LookupVolumeResult struct {
// Text describing a block storage volume.
Description *string `pulumi:"description"`
// A list of associated Droplet ids.
DropletIds []int `pulumi:"dropletIds"`
// Filesystem label currently in-use on the block storage volume.
FilesystemLabel string `pulumi:"filesystemLabel"`
// Filesystem type currently in-use on the block storage volume.
FilesystemType string `pulumi:"filesystemType"`
// The provider-assigned unique ID for this managed resource.
Id string `pulumi:"id"`
Name string `pulumi:"name"`
Region *string `pulumi:"region"`
// The size of the block storage volume in GiB.
Size int `pulumi:"size"`
// A list of the tags associated to the Volume.
Tags []string `pulumi:"tags"`
Urn string `pulumi:"urn"`
}
func LookupVolumeOutput(ctx *pulumi.Context, args LookupVolumeOutputArgs, opts ...pulumi.InvokeOption) LookupVolumeResultOutput {
return pulumi.ToOutputWithContext(context.Background(), args).
ApplyT(func(v interface{}) (LookupVolumeResult, error) {
args := v.(LookupVolumeArgs)
r, err := LookupVolume(ctx, &args, opts...)
return *r, err
}).(LookupVolumeResultOutput)
}
// A collection of arguments for invoking getVolume.
type LookupVolumeOutputArgs struct {
// Text describing a block storage volume.
Description pulumi.StringPtrInput `pulumi:"description"`
// The name of block storage volume.
Name pulumi.StringInput `pulumi:"name"`
// The region the block storage volume is provisioned in.
Region pulumi.StringPtrInput `pulumi:"region"`
}
func (LookupVolumeOutputArgs) ElementType() reflect.Type {
return reflect.TypeOf((*LookupVolumeArgs)(nil)).Elem()
}
// A collection of values returned by getVolume.
type LookupVolumeResultOutput struct{ *pulumi.OutputState }
func (LookupVolumeResultOutput) ElementType() reflect.Type {
return reflect.TypeOf((*LookupVolumeResult)(nil)).Elem()
}
func (o LookupVolumeResultOutput) ToLookupVolumeResultOutput() LookupVolumeResultOutput {
return o
}
func (o LookupVolumeResultOutput) ToLookupVolumeResultOutputWithContext(ctx context.Context) LookupVolumeResultOutput {
return o
}
// Text describing a block storage volume.
func (o LookupVolumeResultOutput) Description() pulumi.StringPtrOutput {
return o.ApplyT(func(v LookupVolumeResult) *string { return v.Description }).(pulumi.StringPtrOutput)
}
// A list of associated Droplet ids.
func (o LookupVolumeResultOutput) DropletIds() pulumi.IntArrayOutput {
return o.ApplyT(func(v LookupVolumeResult) []int { return v.DropletIds }).(pulumi.IntArrayOutput)
}
// Filesystem label currently in-use on the block storage volume.
func (o LookupVolumeResultOutput) FilesystemLabel() pulumi.StringOutput {
return o.ApplyT(func(v LookupVolumeResult) string { return v.FilesystemLabel }).(pulumi.StringOutput)
}
// Filesystem type currently in-use on the block storage volume.
func (o LookupVolumeResultOutput) FilesystemType() pulumi.StringOutput {
return o.ApplyT(func(v LookupVolumeResult) string { return v.FilesystemType }).(pulumi.StringOutput)
}
// The provider-assigned unique ID for this managed resource.
func (o LookupVolumeResultOutput) Id() pulumi.StringOutput {
return o.ApplyT(func(v LookupVolumeResult) string { return v.Id }).(pulumi.StringOutput)
}
func (o LookupVolumeResultOutput) Name() pulumi.StringOutput {
return o.ApplyT(func(v LookupVolumeResult) string { return v.Name }).(pulumi.StringOutput)
}
func (o LookupVolumeResultOutput) Region() pulumi.StringPtrOutput {
return o.ApplyT(func(v LookupVolumeResult) *string { return v.Region }).(pulumi.StringPtrOutput)
}
// The size of the block storage volume in GiB.
func (o LookupVolumeResultOutput) Size() pulumi.IntOutput {
return o.ApplyT(func(v LookupVolumeResult) int { return v.Size }).(pulumi.IntOutput)
}
// A list of the tags associated to the Volume.
func (o LookupVolumeResultOutput) Tags() pulumi.StringArrayOutput {
return o.ApplyT(func(v LookupVolumeResult) []string { return v.Tags }).(pulumi.StringArrayOutput)
}
func (o LookupVolumeResultOutput) Urn() pulumi.StringOutput {
return o.ApplyT(func(v LookupVolumeResult) string { return v.Urn }).(pulumi.StringOutput)
}
func init() {
pulumi.RegisterOutputType(LookupVolumeResultOutput{})
}