Skip to content

Latest commit

 

History

History
1348 lines (844 loc) · 54.6 KB

procedureGrant.go.md

File metadata and controls

1348 lines (844 loc) · 54.6 KB
Raw

procedureGrant Submodule

Constructs

ProcedureGrant

Represents a {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/procedure_grant snowflake_procedure_grant}.

Initializers 

import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v11/proceduregrant"

proceduregrant.NewProcedureGrant(scope Construct, id *string, config ProcedureGrantConfig) ProcedureGrant
Name Type Description
scope github.com/aws/constructs-go/constructs/v10.Construct The scope in which to define this construct.
id *string The scoped construct ID.
config ProcedureGrantConfig No description.
scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.

idRequired
  • Type: *string

The scoped construct ID.

Must be unique amongst siblings in the same scope

configRequired

Methods

Name Description
ToString Returns a string representation of this construct.
AddOverride No description.
OverrideLogicalId Overrides the auto-generated logical ID with a specific ID.
ResetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform No description.
ToMetadata No description.
ToTerraform Adds this resource to the terraform JSON output.
AddMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
HasResourceMove No description.
ImportFrom No description.
InterpolationForAttribute No description.
MoveFromId Move the resource corresponding to "id" to this resource.
MoveTo Moves this resource to the target resource given by moveTarget.
MoveToId Moves this resource to the resource corresponding to "id".
ResetArgumentDataTypes No description.
ResetEnableMultipleGrants No description.
ResetId No description.
ResetOnAll No description.
ResetOnFuture No description.
ResetPrivilege No description.
ResetProcedureName No description.
ResetRevertOwnershipToRoleName No description.
ResetSchemaName No description.
ResetShares No description.
ResetWithGrantOption No description.
ToString 
func ToString() *string

Returns a string representation of this construct.

AddOverride 
func AddOverride(path *string, value interface{})
pathRequired
  • Type: *string
valueRequired
  • Type: interface{}
OverrideLogicalId 
func OverrideLogicalId(newLogicalId *string)

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired
  • Type: *string

The new logical ID to use for this stack element.

ResetOverrideLogicalId 
func ResetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

ToHclTerraform 
func ToHclTerraform() interface{}
ToMetadata 
func ToMetadata() interface{}
ToTerraform 
func ToTerraform() interface{}

Adds this resource to the terraform JSON output.

AddMoveTarget 
func AddMoveTarget(moveTarget *string)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTargetRequired
  • Type: *string

The string move target that will correspond to this resource.

GetAnyMapAttribute 
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
terraformAttributeRequired
  • Type: *string
GetBooleanAttribute 
func GetBooleanAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string
GetBooleanMapAttribute 
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
terraformAttributeRequired
  • Type: *string
GetListAttribute 
func GetListAttribute(terraformAttribute *string) *[]*string
terraformAttributeRequired
  • Type: *string
GetNumberAttribute 
func GetNumberAttribute(terraformAttribute *string) *f64
terraformAttributeRequired
  • Type: *string
GetNumberListAttribute 
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
terraformAttributeRequired
  • Type: *string
GetNumberMapAttribute 
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
terraformAttributeRequired
  • Type: *string
GetStringAttribute 
func GetStringAttribute(terraformAttribute *string) *string
terraformAttributeRequired
  • Type: *string
GetStringMapAttribute 
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
terraformAttributeRequired
  • Type: *string
HasResourceMove 
func HasResourceMove() interface{}
ImportFrom 
func ImportFrom(id *string, provider TerraformProvider)
idRequired
  • Type: *string
providerOptional
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
InterpolationForAttribute 
func InterpolationForAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string
MoveFromId 
func MoveFromId(id *string)

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: *string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

MoveTo 
func MoveTo(moveTarget *string, index interface{})

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: *string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

indexOptional
  • Type: interface{}

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

MoveToId 
func MoveToId(id *string)

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: *string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

ResetArgumentDataTypes 
func ResetArgumentDataTypes()
ResetEnableMultipleGrants 
func ResetEnableMultipleGrants()
ResetId 
func ResetId()
ResetOnAll 
func ResetOnAll()
ResetOnFuture 
func ResetOnFuture()
ResetPrivilege 
func ResetPrivilege()
ResetProcedureName 
func ResetProcedureName()
ResetRevertOwnershipToRoleName 
func ResetRevertOwnershipToRoleName()
ResetSchemaName 
func ResetSchemaName()
ResetShares 
func ResetShares()
ResetWithGrantOption 
func ResetWithGrantOption()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformResource No description.
GenerateConfigForImport Generates CDKTF code for importing a ProcedureGrant resource upon running "cdktf plan ".
IsConstruct 
import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v11/proceduregrant"

proceduregrant.ProcedureGrant_IsConstruct(x interface{}) *bool

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: interface{}

Any object.

IsTerraformElement 
import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v11/proceduregrant"

proceduregrant.ProcedureGrant_IsTerraformElement(x interface{}) *bool
xRequired
  • Type: interface{}
IsTerraformResource 
import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v11/proceduregrant"

proceduregrant.ProcedureGrant_IsTerraformResource(x interface{}) *bool
xRequired
  • Type: interface{}
GenerateConfigForImport 
import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v11/proceduregrant"

proceduregrant.ProcedureGrant_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

Generates CDKTF code for importing a ProcedureGrant resource upon running "cdktf plan ".

scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: *string

The construct id used in the generated config for the ProcedureGrant to import.

importFromIdRequired
  • Type: *string

The id of the existing ProcedureGrant that should be imported.

Refer to the {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/procedure_grant#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

? Optional instance of the provider where the ProcedureGrant to import is found.

Properties

Name Type Description
Node github.com/aws/constructs-go/constructs/v10.Node The tree node.
CdktfStack github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack No description.
Fqn *string No description.
FriendlyUniqueId *string No description.
TerraformMetaArguments *map[string]interface{} No description.
TerraformResourceType *string No description.
TerraformGeneratorMetadata github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata No description.
Connection interface{} No description.
Count interface{} No description.
DependsOn *[]*string No description.
ForEach github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator No description.
Lifecycle github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle No description.
Provider github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider No description.
Provisioners *[]interface{} No description.
ArgumentDataTypesInput *[]*string No description.
DatabaseNameInput *string No description.
EnableMultipleGrantsInput interface{} No description.
IdInput *string No description.
OnAllInput interface{} No description.
OnFutureInput interface{} No description.
PrivilegeInput *string No description.
ProcedureNameInput *string No description.
RevertOwnershipToRoleNameInput *string No description.
RolesInput *[]*string No description.
SchemaNameInput *string No description.
SharesInput *[]*string No description.
WithGrantOptionInput interface{} No description.
ArgumentDataTypes *[]*string No description.
DatabaseName *string No description.
EnableMultipleGrants interface{} No description.
Id *string No description.
OnAll interface{} No description.
OnFuture interface{} No description.
Privilege *string No description.
ProcedureName *string No description.
RevertOwnershipToRoleName *string No description.
Roles *[]*string No description.
SchemaName *string No description.
Shares *[]*string No description.
WithGrantOption interface{} No description.
NodeRequired 
func Node() Node
  • Type: github.com/aws/constructs-go/constructs/v10.Node

The tree node.

CdktfStackRequired 
func CdktfStack() TerraformStack
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack
FqnRequired 
func Fqn() *string
  • Type: *string
FriendlyUniqueIdRequired 
func FriendlyUniqueId() *string
  • Type: *string
TerraformMetaArgumentsRequired 
func TerraformMetaArguments() *map[string]interface{}
  • Type: *map[string]interface{}
TerraformResourceTypeRequired 
func TerraformResourceType() *string
  • Type: *string
TerraformGeneratorMetadataOptional 
func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata
ConnectionOptional 
func Connection() interface{}
  • Type: interface{}
CountOptional 
func Count() interface{}
  • Type: interface{}
DependsOnOptional 
func DependsOn() *[]*string
  • Type: *[]*string
ForEachOptional 
func ForEach() ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator
LifecycleOptional 
func Lifecycle() TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle
ProviderOptional 
func Provider() TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
ProvisionersOptional 
func Provisioners() *[]interface{}
  • Type: *[]interface{}
ArgumentDataTypesInputOptional 
func ArgumentDataTypesInput() *[]*string
  • Type: *[]*string
DatabaseNameInputOptional 
func DatabaseNameInput() *string
  • Type: *string
EnableMultipleGrantsInputOptional 
func EnableMultipleGrantsInput() interface{}
  • Type: interface{}
IdInputOptional 
func IdInput() *string
  • Type: *string
OnAllInputOptional 
func OnAllInput() interface{}
  • Type: interface{}
OnFutureInputOptional 
func OnFutureInput() interface{}
  • Type: interface{}
PrivilegeInputOptional 
func PrivilegeInput() *string
  • Type: *string
ProcedureNameInputOptional 
func ProcedureNameInput() *string
  • Type: *string
RevertOwnershipToRoleNameInputOptional 
func RevertOwnershipToRoleNameInput() *string
  • Type: *string
RolesInputOptional 
func RolesInput() *[]*string
  • Type: *[]*string
SchemaNameInputOptional 
func SchemaNameInput() *string
  • Type: *string
SharesInputOptional 
func SharesInput() *[]*string
  • Type: *[]*string
WithGrantOptionInputOptional 
func WithGrantOptionInput() interface{}
  • Type: interface{}
ArgumentDataTypesRequired 
func ArgumentDataTypes() *[]*string
  • Type: *[]*string
DatabaseNameRequired 
func DatabaseName() *string
  • Type: *string
EnableMultipleGrantsRequired 
func EnableMultipleGrants() interface{}
  • Type: interface{}
IdRequired 
func Id() *string
  • Type: *string
OnAllRequired 
func OnAll() interface{}
  • Type: interface{}
OnFutureRequired 
func OnFuture() interface{}
  • Type: interface{}
PrivilegeRequired 
func Privilege() *string
  • Type: *string
ProcedureNameRequired 
func ProcedureName() *string
  • Type: *string
RevertOwnershipToRoleNameRequired 
func RevertOwnershipToRoleName() *string
  • Type: *string
RolesRequired 
func Roles() *[]*string
  • Type: *[]*string
SchemaNameRequired 
func SchemaName() *string
  • Type: *string
SharesRequired 
func Shares() *[]*string
  • Type: *[]*string
WithGrantOptionRequired 
func WithGrantOption() interface{}
  • Type: interface{}

Constants

Name Type Description
TfResourceType *string No description.
TfResourceTypeRequired 
func TfResourceType() *string
  • Type: *string

Structs

ProcedureGrantConfig

Initializer 

import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v11/proceduregrant"

&proceduregrant.ProcedureGrantConfig {
	Connection: interface{},
	Count: interface{},
	DependsOn: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable,
	ForEach: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator,
	Lifecycle: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle,
	Provider: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider,
	Provisioners: *[]interface{},
	DatabaseName: *string,
	Roles: *[]*string,
	ArgumentDataTypes: *[]*string,
	EnableMultipleGrants: interface{},
	Id: *string,
	OnAll: interface{},
	OnFuture: interface{},
	Privilege: *string,
	ProcedureName: *string,
	RevertOwnershipToRoleName: *string,
	SchemaName: *string,
	Shares: *[]*string,
	WithGrantOption: interface{},
}

Properties

Name Type Description
Connection interface{} No description.
Count interface{} No description.
DependsOn *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable No description.
ForEach github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator No description.
Lifecycle github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle No description.
Provider github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider No description.
Provisioners *[]interface{} No description.
DatabaseName *string The name of the database containing the current or future procedures on which to grant privileges.
Roles *[]*string Grants privilege to these roles.
ArgumentDataTypes *[]*string List of the argument data types for the procedure (must be present if procedure has arguments and procedure_name is present).
EnableMultipleGrants interface{} When this is set to true, multiple grants of the same type can be created.
Id *string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/procedure_grant#id ProcedureGrant#id}.
OnAll interface{} When this is set to true and a schema_name is provided, apply this grant on all procedures in the given schema.
OnFuture interface{} When this is set to true and a schema_name is provided, apply this grant on all future procedures in the given schema.
Privilege *string The privilege to grant on the current or future procedure. To grant all privileges, use the value ALL PRIVILEGES.
ProcedureName *string The name of the procedure on which to grant privileges immediately (only valid if on_future is false).
RevertOwnershipToRoleName *string The name of the role to revert ownership to on destroy.
SchemaName *string The name of the schema containing the current or future procedures on which to grant privileges.
Shares *[]*string Grants privilege to these shares (only valid if on_future is false).
WithGrantOption interface{} When this is set to true, allows the recipient role to grant the privileges to other roles.
ConnectionOptional 
Connection interface{}
  • Type: interface{}
CountOptional 
Count interface{}
  • Type: interface{}
DependsOnOptional 
DependsOn *[]ITerraformDependable
  • Type: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable
ForEachOptional 
ForEach ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator
LifecycleOptional 
Lifecycle TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle
ProviderOptional 
Provider TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
ProvisionersOptional 
Provisioners *[]interface{}
  • Type: *[]interface{}
DatabaseNameRequired 
DatabaseName *string
  • Type: *string

The name of the database containing the current or future procedures on which to grant privileges.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/procedure_grant#database_name ProcedureGrant#database_name}

RolesRequired 
Roles *[]*string
  • Type: *[]*string

Grants privilege to these roles.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/procedure_grant#roles ProcedureGrant#roles}

ArgumentDataTypesOptional 
ArgumentDataTypes *[]*string
  • Type: *[]*string

List of the argument data types for the procedure (must be present if procedure has arguments and procedure_name is present).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/procedure_grant#argument_data_types ProcedureGrant#argument_data_types}

EnableMultipleGrantsOptional 
EnableMultipleGrants interface{}
  • Type: interface{}

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/procedure_grant#enable_multiple_grants ProcedureGrant#enable_multiple_grants}

IdOptional 
Id *string
  • Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/procedure_grant#id ProcedureGrant#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

OnAllOptional 
OnAll interface{}
  • Type: interface{}

When this is set to true and a schema_name is provided, apply this grant on all procedures in the given schema.

When this is true and no schema_name is provided apply this grant on all procedures in the given database. The procedure_name and shares fields must be unset in order to use on_all. Cannot be used together with on_future.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/procedure_grant#on_all ProcedureGrant#on_all}

OnFutureOptional 
OnFuture interface{}
  • Type: interface{}

When this is set to true and a schema_name is provided, apply this grant on all future procedures in the given schema.

When this is true and no schema_name is provided apply this grant on all future procedures in the given database. The procedure_name and shares fields must be unset in order to use on_future. Cannot be used together with on_all.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/procedure_grant#on_future ProcedureGrant#on_future}

PrivilegeOptional 
Privilege *string
  • Type: *string

The privilege to grant on the current or future procedure. To grant all privileges, use the value ALL PRIVILEGES.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/procedure_grant#privilege ProcedureGrant#privilege}

ProcedureNameOptional 
ProcedureName *string
  • Type: *string

The name of the procedure on which to grant privileges immediately (only valid if on_future is false).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/procedure_grant#procedure_name ProcedureGrant#procedure_name}

RevertOwnershipToRoleNameOptional 
RevertOwnershipToRoleName *string
  • Type: *string

The name of the role to revert ownership to on destroy.

Has no effect unless privilege is set to OWNERSHIP

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/procedure_grant#revert_ownership_to_role_name ProcedureGrant#revert_ownership_to_role_name}

SchemaNameOptional 
SchemaName *string
  • Type: *string

The name of the schema containing the current or future procedures on which to grant privileges.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/procedure_grant#schema_name ProcedureGrant#schema_name}

SharesOptional 
Shares *[]*string
  • Type: *[]*string

Grants privilege to these shares (only valid if on_future is false).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/procedure_grant#shares ProcedureGrant#shares}

WithGrantOptionOptional 
WithGrantOption interface{}
  • Type: interface{}

When this is set to true, allows the recipient role to grant the privileges to other roles.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/procedure_grant#with_grant_option ProcedureGrant#with_grant_option}