/
getPermissions.go
283 lines (257 loc) · 11.7 KB
/
getPermissions.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
// 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 lakeformation
import (
"context"
"reflect"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
// Get permissions for a principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3. Permissions are granted to a principal, in a Data Catalog, relative to a Lake Formation resource, which includes the Data Catalog, databases, tables, LF-tags, and LF-tag policies. For more information, see [Security and Access Control to Metadata and Data in Lake Formation](https://docs.aws.amazon.com/lake-formation/latest/dg/security-data-access.html).
//
// > **NOTE:** This data source deals with explicitly granted permissions. Lake Formation grants implicit permissions to data lake administrators, database creators, and table creators. For more information, see [Implicit Lake Formation Permissions](https://docs.aws.amazon.com/lake-formation/latest/dg/implicit-permissions.html).
//
// ## Example Usage
// ### Permissions For A Lake Formation S3 Resource
//
// ```go
// package main
//
// import (
//
// "github.com/pulumi/pulumi-aws/sdk/v5/go/aws/lakeformation"
// "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
//
// )
//
// func main() {
// pulumi.Run(func(ctx *pulumi.Context) error {
// _, err := lakeformation.LookupPermissions(ctx, &lakeformation.LookupPermissionsArgs{
// Principal: aws_iam_role.Workflow_role.Arn,
// DataLocation: lakeformation.GetPermissionsDataLocation{
// Arn: aws_lakeformation_resource.Test.Arn,
// },
// }, nil)
// if err != nil {
// return err
// }
// return nil
// })
// }
//
// ```
// ### Permissions For A Glue Catalog Database
//
// ```go
// package main
//
// import (
//
// "github.com/pulumi/pulumi-aws/sdk/v5/go/aws/lakeformation"
// "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
//
// )
//
// func main() {
// pulumi.Run(func(ctx *pulumi.Context) error {
// _, err := lakeformation.LookupPermissions(ctx, &lakeformation.LookupPermissionsArgs{
// Principal: aws_iam_role.Workflow_role.Arn,
// Database: lakeformation.GetPermissionsDatabase{
// Name: aws_glue_catalog_database.Test.Name,
// CatalogId: "110376042874",
// },
// }, nil)
// if err != nil {
// return err
// }
// return nil
// })
// }
//
// ```
// ### Permissions For Tag-Based Access Control
//
// ```go
// package main
//
// import (
//
// "github.com/pulumi/pulumi-aws/sdk/v5/go/aws/lakeformation"
// "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
//
// )
//
// func main() {
// pulumi.Run(func(ctx *pulumi.Context) error {
// _, err := lakeformation.LookupPermissions(ctx, &lakeformation.LookupPermissionsArgs{
// Principal: aws_iam_role.Workflow_role.Arn,
// LfTagPolicy: lakeformation.GetPermissionsLfTagPolicy{
// ResourceType: "DATABASE",
// Expressions: []lakeformation.GetPermissionsLfTagPolicyExpression{
// {
// Key: "Team",
// Values: []string{
// "Sales",
// },
// },
// {
// Key: "Environment",
// Values: []string{
// "Dev",
// "Production",
// },
// },
// },
// },
// }, nil)
// if err != nil {
// return err
// }
// return nil
// })
// }
//
// ```
func LookupPermissions(ctx *pulumi.Context, args *LookupPermissionsArgs, opts ...pulumi.InvokeOption) (*LookupPermissionsResult, error) {
var rv LookupPermissionsResult
err := ctx.Invoke("aws:lakeformation/getPermissions:getPermissions", args, &rv, opts...)
if err != nil {
return nil, err
}
return &rv, nil
}
// A collection of arguments for invoking getPermissions.
type LookupPermissionsArgs struct {
// Identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
CatalogId *string `pulumi:"catalogId"`
// Whether the permissions are to be granted for the Data Catalog. Defaults to `false`.
CatalogResource *bool `pulumi:"catalogResource"`
// Configuration block for a data location resource. Detailed below.
DataLocation *GetPermissionsDataLocation `pulumi:"dataLocation"`
// Configuration block for a database resource. Detailed below.
Database *GetPermissionsDatabase `pulumi:"database"`
// Configuration block for an LF-tag resource. Detailed below.
LfTag *GetPermissionsLfTag `pulumi:"lfTag"`
// Configuration block for an LF-tag policy resource. Detailed below.
LfTagPolicy *GetPermissionsLfTagPolicy `pulumi:"lfTagPolicy"`
// Principal to be granted the permissions on the resource. Supported principals are IAM users or IAM roles.
//
// One of the following is required:
Principal string `pulumi:"principal"`
// Configuration block for a table resource. Detailed below.
Table *GetPermissionsTable `pulumi:"table"`
// Configuration block for a table with columns resource. Detailed below.
//
// The following arguments are optional:
TableWithColumns *GetPermissionsTableWithColumns `pulumi:"tableWithColumns"`
}
// A collection of values returned by getPermissions.
type LookupPermissionsResult struct {
CatalogId *string `pulumi:"catalogId"`
CatalogResource *bool `pulumi:"catalogResource"`
DataLocation GetPermissionsDataLocation `pulumi:"dataLocation"`
Database GetPermissionsDatabase `pulumi:"database"`
// The provider-assigned unique ID for this managed resource.
Id string `pulumi:"id"`
LfTag GetPermissionsLfTag `pulumi:"lfTag"`
LfTagPolicy GetPermissionsLfTagPolicy `pulumi:"lfTagPolicy"`
// List of permissions granted to the principal. For details on permissions, see [Lake Formation Permissions Reference](https://docs.aws.amazon.com/lake-formation/latest/dg/lf-permissions-reference.html).
Permissions []string `pulumi:"permissions"`
// Subset of `permissions` which the principal can pass.
PermissionsWithGrantOptions []string `pulumi:"permissionsWithGrantOptions"`
Principal string `pulumi:"principal"`
Table GetPermissionsTable `pulumi:"table"`
TableWithColumns GetPermissionsTableWithColumns `pulumi:"tableWithColumns"`
}
func LookupPermissionsOutput(ctx *pulumi.Context, args LookupPermissionsOutputArgs, opts ...pulumi.InvokeOption) LookupPermissionsResultOutput {
return pulumi.ToOutputWithContext(context.Background(), args).
ApplyT(func(v interface{}) (LookupPermissionsResult, error) {
args := v.(LookupPermissionsArgs)
r, err := LookupPermissions(ctx, &args, opts...)
var s LookupPermissionsResult
if r != nil {
s = *r
}
return s, err
}).(LookupPermissionsResultOutput)
}
// A collection of arguments for invoking getPermissions.
type LookupPermissionsOutputArgs struct {
// Identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
CatalogId pulumi.StringPtrInput `pulumi:"catalogId"`
// Whether the permissions are to be granted for the Data Catalog. Defaults to `false`.
CatalogResource pulumi.BoolPtrInput `pulumi:"catalogResource"`
// Configuration block for a data location resource. Detailed below.
DataLocation GetPermissionsDataLocationPtrInput `pulumi:"dataLocation"`
// Configuration block for a database resource. Detailed below.
Database GetPermissionsDatabasePtrInput `pulumi:"database"`
// Configuration block for an LF-tag resource. Detailed below.
LfTag GetPermissionsLfTagPtrInput `pulumi:"lfTag"`
// Configuration block for an LF-tag policy resource. Detailed below.
LfTagPolicy GetPermissionsLfTagPolicyPtrInput `pulumi:"lfTagPolicy"`
// Principal to be granted the permissions on the resource. Supported principals are IAM users or IAM roles.
//
// One of the following is required:
Principal pulumi.StringInput `pulumi:"principal"`
// Configuration block for a table resource. Detailed below.
Table GetPermissionsTablePtrInput `pulumi:"table"`
// Configuration block for a table with columns resource. Detailed below.
//
// The following arguments are optional:
TableWithColumns GetPermissionsTableWithColumnsPtrInput `pulumi:"tableWithColumns"`
}
func (LookupPermissionsOutputArgs) ElementType() reflect.Type {
return reflect.TypeOf((*LookupPermissionsArgs)(nil)).Elem()
}
// A collection of values returned by getPermissions.
type LookupPermissionsResultOutput struct{ *pulumi.OutputState }
func (LookupPermissionsResultOutput) ElementType() reflect.Type {
return reflect.TypeOf((*LookupPermissionsResult)(nil)).Elem()
}
func (o LookupPermissionsResultOutput) ToLookupPermissionsResultOutput() LookupPermissionsResultOutput {
return o
}
func (o LookupPermissionsResultOutput) ToLookupPermissionsResultOutputWithContext(ctx context.Context) LookupPermissionsResultOutput {
return o
}
func (o LookupPermissionsResultOutput) CatalogId() pulumi.StringPtrOutput {
return o.ApplyT(func(v LookupPermissionsResult) *string { return v.CatalogId }).(pulumi.StringPtrOutput)
}
func (o LookupPermissionsResultOutput) CatalogResource() pulumi.BoolPtrOutput {
return o.ApplyT(func(v LookupPermissionsResult) *bool { return v.CatalogResource }).(pulumi.BoolPtrOutput)
}
func (o LookupPermissionsResultOutput) DataLocation() GetPermissionsDataLocationOutput {
return o.ApplyT(func(v LookupPermissionsResult) GetPermissionsDataLocation { return v.DataLocation }).(GetPermissionsDataLocationOutput)
}
func (o LookupPermissionsResultOutput) Database() GetPermissionsDatabaseOutput {
return o.ApplyT(func(v LookupPermissionsResult) GetPermissionsDatabase { return v.Database }).(GetPermissionsDatabaseOutput)
}
// The provider-assigned unique ID for this managed resource.
func (o LookupPermissionsResultOutput) Id() pulumi.StringOutput {
return o.ApplyT(func(v LookupPermissionsResult) string { return v.Id }).(pulumi.StringOutput)
}
func (o LookupPermissionsResultOutput) LfTag() GetPermissionsLfTagOutput {
return o.ApplyT(func(v LookupPermissionsResult) GetPermissionsLfTag { return v.LfTag }).(GetPermissionsLfTagOutput)
}
func (o LookupPermissionsResultOutput) LfTagPolicy() GetPermissionsLfTagPolicyOutput {
return o.ApplyT(func(v LookupPermissionsResult) GetPermissionsLfTagPolicy { return v.LfTagPolicy }).(GetPermissionsLfTagPolicyOutput)
}
// List of permissions granted to the principal. For details on permissions, see [Lake Formation Permissions Reference](https://docs.aws.amazon.com/lake-formation/latest/dg/lf-permissions-reference.html).
func (o LookupPermissionsResultOutput) Permissions() pulumi.StringArrayOutput {
return o.ApplyT(func(v LookupPermissionsResult) []string { return v.Permissions }).(pulumi.StringArrayOutput)
}
// Subset of `permissions` which the principal can pass.
func (o LookupPermissionsResultOutput) PermissionsWithGrantOptions() pulumi.StringArrayOutput {
return o.ApplyT(func(v LookupPermissionsResult) []string { return v.PermissionsWithGrantOptions }).(pulumi.StringArrayOutput)
}
func (o LookupPermissionsResultOutput) Principal() pulumi.StringOutput {
return o.ApplyT(func(v LookupPermissionsResult) string { return v.Principal }).(pulumi.StringOutput)
}
func (o LookupPermissionsResultOutput) Table() GetPermissionsTableOutput {
return o.ApplyT(func(v LookupPermissionsResult) GetPermissionsTable { return v.Table }).(GetPermissionsTableOutput)
}
func (o LookupPermissionsResultOutput) TableWithColumns() GetPermissionsTableWithColumnsOutput {
return o.ApplyT(func(v LookupPermissionsResult) GetPermissionsTableWithColumns { return v.TableWithColumns }).(GetPermissionsTableWithColumnsOutput)
}
func init() {
pulumi.RegisterOutputType(LookupPermissionsResultOutput{})
}