forked from pulumi/pulumi-metabase
-
Notifications
You must be signed in to change notification settings - Fork 0
/
schema.yaml
320 lines (293 loc) · 9.27 KB
/
schema.yaml
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
# yaml-language-server: $schema=https://raw.githubusercontent.com/pulumi/pulumi/master/pkg/codegen/schema/pulumi.json
---
name: metabase2
types:
metabase2:index:Networking:
description: The options for networking.
type: object
properties:
ecsSubnetIds:
description: The subnets to use for the Fargate task.
type: array
items:
type: string
dbSubnetIds:
description: The subnets to use for the RDS instance.
type: array
items:
type: string
lbSubnetIds:
description: The subnets to use for the load balancer.
type: array
items:
type: string
metabase2:index:CustomDomain:
description: Options for setting a custom domain.
type: object
properties:
hostedZoneName:
type: string
domainName:
type: string
resources:
metabase2:index:Metabase2:
description: |
This resources provisions a container running Metabase on AWS ECS Fargate. By default
the resource will run the service in the AWS Account's Default VPC unless a VPC is defined. This
resource will also deploy the `latest` version of Metabase unless a version is supplied.
You can provide specific subnets to host the Load Balancer, Database, and ECS Service, as well
as provide a custom domain name for the service.
{{% examples %}}
## Example Usage
{{% example %}}
### Default
```typescript
import * as pulumi from "@pulumi/pulumi";
import * as metabase from "@pulumi/metabase";
const metabaseService = new metabase.Metabase("metabaseService", {});
export const url = metabaseService.dnsName;
```
```python
import pulumi
import pulumi_metabase as metabase
metabase_service = metabase.Metabase("metabaseService")
pulumi.export("url", metabase_service.dns_name)
```
```go
package main
import (
"github.com/pulumi/pulumi-metabase/sdk/go/metabase"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
metabaseService, err := metabase.NewMetabase(ctx, "metabaseService", nil)
if err != nil {
return err
}
ctx.Export("url", metabaseService.DnsName)
return nil
})
}
```
```csharp
using Pulumi;
using Metabase = Pulumi.Metabase;
class MyStack : Stack
{
public MyStack()
{
var metabaseService = new Metabase.Metabase("metabaseService", new Metabase.MetabaseArgs
{
});
this.Url = metabaseService.DnsName;
}
[Output("url")]
public Output<string> Url { get; set; }
}
```
```yaml
name: metabase-yaml
runtime: yaml
resources:
metabaseService:
type: "metabase2:index:Metabase"
outputs:
url: ${metabaseService.dnsName}
```
{{ /example }}
{{% example %}}
### Custom Domain & Networking
```typescript
import * as pulumi from "@pulumi/pulumi";
import * as metabase from "@pulumi/metabase";
const metabaseService = new metabase.Metabase("metabaseService", {
vpcId: "vpc-123",
networking: {
ecsSubnetIds: [
"subnet-123",
"subnet-456",
],
dbSubnetIds: [
"subnet-789",
"subnet-abc",
],
lbSubnetIds: [
"subnet-def",
"subnet-ghi",
],
},
domain: {
hostedZoneName: "example.com",
domainName: "metabase.example.com",
},
});
export const url = metabaseService.dnsName;
```
```python
import pulumi
import pulumi_metabase as metabase
metabase_service = metabase.Metabase("metabaseService",
vpc_id="vpc-123",
networking=metabase.NetworkingArgs(
ecs_subnet_ids=[
"subnet-123",
"subnet-456",
],
db_subnet_ids=[
"subnet-789",
"subnet-abc",
],
lb_subnet_ids=[
"subnet-def",
"subnet-ghi",
],
),
domain=metabase.CustomDomainArgs(
hosted_zone_name="example.com",
domain_name="metabase.example.com",
))
pulumi.export("url", metabase_service.dns_name)
```
```go
package main
import (
"github.com/pulumi/pulumi-metabase/sdk/go/metabase"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
metabaseService, err := metabase.NewMetabase(ctx, "metabaseService", &metabase.MetabaseArgs{
VpcId: pulumi.String("vpc-123"),
Networking: &metabase.NetworkingArgs{
EcsSubnetIds: pulumi.StringArray{
pulumi.String("subnet-123"),
pulumi.String("subnet-456"),
},
DbSubnetIds: pulumi.StringArray{
pulumi.String("subnet-789"),
pulumi.String("subnet-abc"),
},
LbSubnetIds: pulumi.StringArray{
pulumi.String("subnet-def"),
pulumi.String("subnet-ghi"),
},
},
Domain: &metabase.CustomDomainArgs{
HostedZoneName: pulumi.String("example.com"),
DomainName: pulumi.String("metabase.example.com"),
},
})
if err != nil {
return err
}
ctx.Export("url", metabaseService.DnsName)
return nil
})
}
```
```csharp
using Pulumi;
using Metabase = Pulumi.Metabase;
class MyStack : Stack
{
public MyStack()
{
var metabaseService = new Metabase.Metabase("metabaseService", new Metabase.MetabaseArgs
{
VpcId = "vpc-123",
Networking = new Metabase.Inputs.NetworkingArgs
{
EcsSubnetIds =
{
"subnet-123",
"subnet-456",
},
DbSubnetIds =
{
"subnet-789",
"subnet-abc",
},
LbSubnetIds =
{
"subnet-def",
"subnet-ghi",
},
},
Domain = new Metabase.Inputs.CustomDomainArgs
{
HostedZoneName = "example.com",
DomainName = "metabase.example.com",
},
});
this.Url = metabaseService.DnsName;
}
[Output("url")]
public Output<string> Url { get; set; }
}
```
```yaml
name: metabase-yaml
runtime: yaml
resources:
metabaseService:
type: "metabase2:index:Metabase"
properties:
vpcId: "vpc-123"
networking:
ecsSubnetIds: [ "subnet-123", "subnet-456" ]
dbSubnetIds: [ "subnet-789", "subnet-abc" ]
lbSubnetIds: [ "subnet-def", "subnet-ghi" ]
domain:
hostedZoneName: "example.com"
domainName: "metabase.example.com"
outputs:
url: ${metabaseService.dnsName}
```
{{ /example }}
{{% examples %}}
isComponent: true
inputProperties:
vpcId:
type: string
description: The VPC to use for the Metabase service. If left blank then the default VPC will be used.
networking:
description: Optionally provide specific subnet IDs to run the different resources of Metabase.
$ref: "#/types/metabase2:index:Networking"
domain:
description: Optionally provide a hosted zone and domain name for the Metabase service.
$ref: "#/types/metabase2:index:CustomDomain"
metabaseVersion:
description: The version of Metabase to run - used as a tag on the `metabase/metabase` Dockerhub image.
type: string
requiredInputs: []
properties:
dnsName:
type: string
description: The DNS name for the Metabase instance.
securityGroupId:
type: string
description: The security group id for the Metabase instance.
required:
- dnsName
- securityGroupId
language:
csharp:
packageReferences:
Pulumi: 3.*
Pulumi.Aws: 5.*
Pulumi.Random: 4.*
go:
generateResourceContainerTypes: true
importBasePath: github.com/pulumi/pulumi-metabase/sdk/go/metabase
nodejs:
dependencies:
"@pulumi/aws": "^5.0.0"
"@pulumi/random": "^4.0.0"
devDependencies:
typescript: "^3.7.0"
python:
requires:
pulumi: ">=3.0.0,<4.0.0"
pulumi-aws: ">=5.0.0,<6.0.0"
pulumi-random: ">=4.0.0,<5.0.0"