functionGrant.go

// *** 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 snowflake

import (
	"context"
	"reflect"

	"github.com/pkg/errors"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

// ## Example Usage
//
// ```go
// package main
//
// import (
// 	"github.com/pulumi/pulumi-snowflake/sdk/go/snowflake"
// 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
// )
//
// func main() {
// 	pulumi.Run(func(ctx *pulumi.Context) error {
// 		_, err := snowflake.NewFunctionGrant(ctx, "grant", &snowflake.FunctionGrantArgs{
// 			DatabaseName: pulumi.String("db"),
// 			SchemaName:   pulumi.String("schema"),
// 			FunctionName: pulumi.String("function"),
// 			Arguments: FunctionGrantArgumentArray{
// 				&FunctionGrantArgumentArgs{
// 					Name: pulumi.String("a"),
// 					Type: pulumi.String("array"),
// 				},
// 				&FunctionGrantArgumentArgs{
// 					Name: pulumi.String("b"),
// 					Type: pulumi.String("string"),
// 				},
// 			},
// 			ReturnType: pulumi.String("string"),
// 			Privilege:  pulumi.String("USAGE"),
// 			Roles: pulumi.StringArray{
// 				pulumi.String("role1"),
// 				pulumi.String("role2"),
// 			},
// 			Shares: pulumi.StringArray{
// 				pulumi.String("share1"),
// 				pulumi.String("share2"),
// 			},
// 			OnFuture:        pulumi.Bool(false),
// 			WithGrantOption: pulumi.Bool(false),
// 		})
// 		if err != nil {
// 			return err
// 		}
// 		return nil
// 	})
// }
// ```
//
// ## Import
//
// # format is database name | schema name | function signature | privilege | true/false for with_grant_option
//
// ```sh
//  $ pulumi import snowflake:index/functionGrant:FunctionGrant example 'dbName|schemaName|functionName(ARG1 ARG1TYPE, ARG2 ARG2TYPE):RETURNTYPE|USAGE|false'
// ```
type FunctionGrant struct {
	pulumi.CustomResourceState

	// List of the arguments for the function (must be present if function has arguments and functionName is present)
	Arguments FunctionGrantArgumentArrayOutput `pulumi:"arguments"`
	// The name of the database containing the current or future functions on which to grant privileges.
	DatabaseName pulumi.StringOutput `pulumi:"databaseName"`
	// When this is set to true, multiple grants of the same type can be created. This will cause Terraform to not revoke
	// grants applied to roles and objects outside Terraform.
	EnableMultipleGrants pulumi.BoolPtrOutput `pulumi:"enableMultipleGrants"`
	// The name of the function on which to grant privileges immediately (only valid if onFuture is false).
	FunctionName pulumi.StringPtrOutput `pulumi:"functionName"`
	// When this is set to true and a schema*name is provided, apply this grant on all future functions in the given schema. When this is true and no schema*name is provided apply this grant on all future functions in the given database. The function*name, arguments, return*type, and shares fields must be unset in order to use on_future.
	OnFuture pulumi.BoolPtrOutput `pulumi:"onFuture"`
	// The privilege to grant on the current or future function. Must be one of `USAGE` or `OWNERSHIP`.
	Privilege pulumi.StringPtrOutput `pulumi:"privilege"`
	// The return type of the function (must be present if functionName is present)
	ReturnType pulumi.StringPtrOutput `pulumi:"returnType"`
	// Grants privilege to these roles.
	Roles pulumi.StringArrayOutput `pulumi:"roles"`
	// The name of the schema containing the current or future functions on which to grant privileges.
	SchemaName pulumi.StringOutput `pulumi:"schemaName"`
	// Grants privilege to these shares (only valid if onFuture is false).
	Shares pulumi.StringArrayOutput `pulumi:"shares"`
	// When this is set to true, allows the recipient role to grant the privileges to other roles.
	WithGrantOption pulumi.BoolPtrOutput `pulumi:"withGrantOption"`
}

// NewFunctionGrant registers a new resource with the given unique name, arguments, and options.
func NewFunctionGrant(ctx *pulumi.Context,
	name string, args *FunctionGrantArgs, opts ...pulumi.ResourceOption) (*FunctionGrant, error) {
	if args == nil {
		return nil, errors.New("missing one or more required arguments")
	}

	if args.DatabaseName == nil {
		return nil, errors.New("invalid value for required argument 'DatabaseName'")
	}
	if args.SchemaName == nil {
		return nil, errors.New("invalid value for required argument 'SchemaName'")
	}
	var resource FunctionGrant
	err := ctx.RegisterResource("snowflake:index/functionGrant:FunctionGrant", name, args, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// GetFunctionGrant gets an existing FunctionGrant 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 GetFunctionGrant(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *FunctionGrantState, opts ...pulumi.ResourceOption) (*FunctionGrant, error) {
	var resource FunctionGrant
	err := ctx.ReadResource("snowflake:index/functionGrant:FunctionGrant", name, id, state, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// Input properties used for looking up and filtering FunctionGrant resources.
type functionGrantState struct {
	// List of the arguments for the function (must be present if function has arguments and functionName is present)
	Arguments []FunctionGrantArgument `pulumi:"arguments"`
	// The name of the database containing the current or future functions on which to grant privileges.
	DatabaseName *string `pulumi:"databaseName"`
	// When this is set to true, multiple grants of the same type can be created. This will cause Terraform to not revoke
	// grants applied to roles and objects outside Terraform.
	EnableMultipleGrants *bool `pulumi:"enableMultipleGrants"`
	// The name of the function on which to grant privileges immediately (only valid if onFuture is false).
	FunctionName *string `pulumi:"functionName"`
	// When this is set to true and a schema*name is provided, apply this grant on all future functions in the given schema. When this is true and no schema*name is provided apply this grant on all future functions in the given database. The function*name, arguments, return*type, and shares fields must be unset in order to use on_future.
	OnFuture *bool `pulumi:"onFuture"`
	// The privilege to grant on the current or future function. Must be one of `USAGE` or `OWNERSHIP`.
	Privilege *string `pulumi:"privilege"`
	// The return type of the function (must be present if functionName is present)
	ReturnType *string `pulumi:"returnType"`
	// Grants privilege to these roles.
	Roles []string `pulumi:"roles"`
	// The name of the schema containing the current or future functions on which to grant privileges.
	SchemaName *string `pulumi:"schemaName"`
	// Grants privilege to these shares (only valid if onFuture is false).
	Shares []string `pulumi:"shares"`
	// When this is set to true, allows the recipient role to grant the privileges to other roles.
	WithGrantOption *bool `pulumi:"withGrantOption"`
}

type FunctionGrantState struct {
	// List of the arguments for the function (must be present if function has arguments and functionName is present)
	Arguments FunctionGrantArgumentArrayInput
	// The name of the database containing the current or future functions on which to grant privileges.
	DatabaseName pulumi.StringPtrInput
	// When this is set to true, multiple grants of the same type can be created. This will cause Terraform to not revoke
	// grants applied to roles and objects outside Terraform.
	EnableMultipleGrants pulumi.BoolPtrInput
	// The name of the function on which to grant privileges immediately (only valid if onFuture is false).
	FunctionName pulumi.StringPtrInput
	// When this is set to true and a schema*name is provided, apply this grant on all future functions in the given schema. When this is true and no schema*name is provided apply this grant on all future functions in the given database. The function*name, arguments, return*type, and shares fields must be unset in order to use on_future.
	OnFuture pulumi.BoolPtrInput
	// The privilege to grant on the current or future function. Must be one of `USAGE` or `OWNERSHIP`.
	Privilege pulumi.StringPtrInput
	// The return type of the function (must be present if functionName is present)
	ReturnType pulumi.StringPtrInput
	// Grants privilege to these roles.
	Roles pulumi.StringArrayInput
	// The name of the schema containing the current or future functions on which to grant privileges.
	SchemaName pulumi.StringPtrInput
	// Grants privilege to these shares (only valid if onFuture is false).
	Shares pulumi.StringArrayInput
	// When this is set to true, allows the recipient role to grant the privileges to other roles.
	WithGrantOption pulumi.BoolPtrInput
}

func (FunctionGrantState) ElementType() reflect.Type {
	return reflect.TypeOf((*functionGrantState)(nil)).Elem()
}

type functionGrantArgs struct {
	// List of the arguments for the function (must be present if function has arguments and functionName is present)
	Arguments []FunctionGrantArgument `pulumi:"arguments"`
	// The name of the database containing the current or future functions on which to grant privileges.
	DatabaseName string `pulumi:"databaseName"`
	// When this is set to true, multiple grants of the same type can be created. This will cause Terraform to not revoke
	// grants applied to roles and objects outside Terraform.
	EnableMultipleGrants *bool `pulumi:"enableMultipleGrants"`
	// The name of the function on which to grant privileges immediately (only valid if onFuture is false).
	FunctionName *string `pulumi:"functionName"`
	// When this is set to true and a schema*name is provided, apply this grant on all future functions in the given schema. When this is true and no schema*name is provided apply this grant on all future functions in the given database. The function*name, arguments, return*type, and shares fields must be unset in order to use on_future.
	OnFuture *bool `pulumi:"onFuture"`
	// The privilege to grant on the current or future function. Must be one of `USAGE` or `OWNERSHIP`.
	Privilege *string `pulumi:"privilege"`
	// The return type of the function (must be present if functionName is present)
	ReturnType *string `pulumi:"returnType"`
	// Grants privilege to these roles.
	Roles []string `pulumi:"roles"`
	// The name of the schema containing the current or future functions on which to grant privileges.
	SchemaName string `pulumi:"schemaName"`
	// Grants privilege to these shares (only valid if onFuture is false).
	Shares []string `pulumi:"shares"`
	// When this is set to true, allows the recipient role to grant the privileges to other roles.
	WithGrantOption *bool `pulumi:"withGrantOption"`
}

// The set of arguments for constructing a FunctionGrant resource.
type FunctionGrantArgs struct {
	// List of the arguments for the function (must be present if function has arguments and functionName is present)
	Arguments FunctionGrantArgumentArrayInput
	// The name of the database containing the current or future functions on which to grant privileges.
	DatabaseName pulumi.StringInput
	// When this is set to true, multiple grants of the same type can be created. This will cause Terraform to not revoke
	// grants applied to roles and objects outside Terraform.
	EnableMultipleGrants pulumi.BoolPtrInput
	// The name of the function on which to grant privileges immediately (only valid if onFuture is false).
	FunctionName pulumi.StringPtrInput
	// When this is set to true and a schema*name is provided, apply this grant on all future functions in the given schema. When this is true and no schema*name is provided apply this grant on all future functions in the given database. The function*name, arguments, return*type, and shares fields must be unset in order to use on_future.
	OnFuture pulumi.BoolPtrInput
	// The privilege to grant on the current or future function. Must be one of `USAGE` or `OWNERSHIP`.
	Privilege pulumi.StringPtrInput
	// The return type of the function (must be present if functionName is present)
	ReturnType pulumi.StringPtrInput
	// Grants privilege to these roles.
	Roles pulumi.StringArrayInput
	// The name of the schema containing the current or future functions on which to grant privileges.
	SchemaName pulumi.StringInput
	// Grants privilege to these shares (only valid if onFuture is false).
	Shares pulumi.StringArrayInput
	// When this is set to true, allows the recipient role to grant the privileges to other roles.
	WithGrantOption pulumi.BoolPtrInput
}

func (FunctionGrantArgs) ElementType() reflect.Type {
	return reflect.TypeOf((*functionGrantArgs)(nil)).Elem()
}

type FunctionGrantInput interface {
	pulumi.Input

	ToFunctionGrantOutput() FunctionGrantOutput
	ToFunctionGrantOutputWithContext(ctx context.Context) FunctionGrantOutput
}

func (*FunctionGrant) ElementType() reflect.Type {
	return reflect.TypeOf((**FunctionGrant)(nil)).Elem()
}

func (i *FunctionGrant) ToFunctionGrantOutput() FunctionGrantOutput {
	return i.ToFunctionGrantOutputWithContext(context.Background())
}

func (i *FunctionGrant) ToFunctionGrantOutputWithContext(ctx context.Context) FunctionGrantOutput {
	return pulumi.ToOutputWithContext(ctx, i).(FunctionGrantOutput)
}

// FunctionGrantArrayInput is an input type that accepts FunctionGrantArray and FunctionGrantArrayOutput values.
// You can construct a concrete instance of `FunctionGrantArrayInput` via:
//
//          FunctionGrantArray{ FunctionGrantArgs{...} }
type FunctionGrantArrayInput interface {
	pulumi.Input

	ToFunctionGrantArrayOutput() FunctionGrantArrayOutput
	ToFunctionGrantArrayOutputWithContext(context.Context) FunctionGrantArrayOutput
}

type FunctionGrantArray []FunctionGrantInput

func (FunctionGrantArray) ElementType() reflect.Type {
	return reflect.TypeOf((*[]*FunctionGrant)(nil)).Elem()
}

func (i FunctionGrantArray) ToFunctionGrantArrayOutput() FunctionGrantArrayOutput {
	return i.ToFunctionGrantArrayOutputWithContext(context.Background())
}

func (i FunctionGrantArray) ToFunctionGrantArrayOutputWithContext(ctx context.Context) FunctionGrantArrayOutput {
	return pulumi.ToOutputWithContext(ctx, i).(FunctionGrantArrayOutput)
}

// FunctionGrantMapInput is an input type that accepts FunctionGrantMap and FunctionGrantMapOutput values.
// You can construct a concrete instance of `FunctionGrantMapInput` via:
//
//          FunctionGrantMap{ "key": FunctionGrantArgs{...} }
type FunctionGrantMapInput interface {
	pulumi.Input

	ToFunctionGrantMapOutput() FunctionGrantMapOutput
	ToFunctionGrantMapOutputWithContext(context.Context) FunctionGrantMapOutput
}

type FunctionGrantMap map[string]FunctionGrantInput

func (FunctionGrantMap) ElementType() reflect.Type {
	return reflect.TypeOf((*map[string]*FunctionGrant)(nil)).Elem()
}

func (i FunctionGrantMap) ToFunctionGrantMapOutput() FunctionGrantMapOutput {
	return i.ToFunctionGrantMapOutputWithContext(context.Background())
}

func (i FunctionGrantMap) ToFunctionGrantMapOutputWithContext(ctx context.Context) FunctionGrantMapOutput {
	return pulumi.ToOutputWithContext(ctx, i).(FunctionGrantMapOutput)
}

type FunctionGrantOutput struct{ *pulumi.OutputState }

func (FunctionGrantOutput) ElementType() reflect.Type {
	return reflect.TypeOf((**FunctionGrant)(nil)).Elem()
}

func (o FunctionGrantOutput) ToFunctionGrantOutput() FunctionGrantOutput {
	return o
}

func (o FunctionGrantOutput) ToFunctionGrantOutputWithContext(ctx context.Context) FunctionGrantOutput {
	return o
}

type FunctionGrantArrayOutput struct{ *pulumi.OutputState }

func (FunctionGrantArrayOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*[]*FunctionGrant)(nil)).Elem()
}

func (o FunctionGrantArrayOutput) ToFunctionGrantArrayOutput() FunctionGrantArrayOutput {
	return o
}

func (o FunctionGrantArrayOutput) ToFunctionGrantArrayOutputWithContext(ctx context.Context) FunctionGrantArrayOutput {
	return o
}

func (o FunctionGrantArrayOutput) Index(i pulumi.IntInput) FunctionGrantOutput {
	return pulumi.All(o, i).ApplyT(func(vs []interface{}) *FunctionGrant {
		return vs[0].([]*FunctionGrant)[vs[1].(int)]
	}).(FunctionGrantOutput)
}

type FunctionGrantMapOutput struct{ *pulumi.OutputState }

func (FunctionGrantMapOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*map[string]*FunctionGrant)(nil)).Elem()
}

func (o FunctionGrantMapOutput) ToFunctionGrantMapOutput() FunctionGrantMapOutput {
	return o
}

func (o FunctionGrantMapOutput) ToFunctionGrantMapOutputWithContext(ctx context.Context) FunctionGrantMapOutput {
	return o
}

func (o FunctionGrantMapOutput) MapIndex(k pulumi.StringInput) FunctionGrantOutput {
	return pulumi.All(o, k).ApplyT(func(vs []interface{}) *FunctionGrant {
		return vs[0].(map[string]*FunctionGrant)[vs[1].(string)]
	}).(FunctionGrantOutput)
}

func init() {
	pulumi.RegisterInputType(reflect.TypeOf((*FunctionGrantInput)(nil)).Elem(), &FunctionGrant{})
	pulumi.RegisterInputType(reflect.TypeOf((*FunctionGrantArrayInput)(nil)).Elem(), FunctionGrantArray{})
	pulumi.RegisterInputType(reflect.TypeOf((*FunctionGrantMapInput)(nil)).Elem(), FunctionGrantMap{})
	pulumi.RegisterOutputType(FunctionGrantOutput{})
	pulumi.RegisterOutputType(FunctionGrantArrayOutput{})
	pulumi.RegisterOutputType(FunctionGrantMapOutput{})
}