1. Packages
  2. Snowflake
  3. API Docs
  4. FailoverGroupGrant
Snowflake v0.51.0 published on Wednesday, Apr 10, 2024 by Pulumi

snowflake.FailoverGroupGrant

Explore with Pulumi AI

snowflake logo
Snowflake v0.51.0 published on Wednesday, Apr 10, 2024 by Pulumi

    Deprecation This resource is deprecated and will be removed in a future major version release. Please use snowflake.GrantPrivilegesToAccountRole instead.

    Create FailoverGroupGrant Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new FailoverGroupGrant(name: string, args: FailoverGroupGrantArgs, opts?: CustomResourceOptions);
    @overload
    def FailoverGroupGrant(resource_name: str,
                           args: FailoverGroupGrantArgs,
                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def FailoverGroupGrant(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           roles: Optional[Sequence[str]] = None,
                           enable_multiple_grants: Optional[bool] = None,
                           failover_group_name: Optional[str] = None,
                           privilege: Optional[str] = None,
                           revert_ownership_to_role_name: Optional[str] = None,
                           with_grant_option: Optional[bool] = None)
    func NewFailoverGroupGrant(ctx *Context, name string, args FailoverGroupGrantArgs, opts ...ResourceOption) (*FailoverGroupGrant, error)
    public FailoverGroupGrant(string name, FailoverGroupGrantArgs args, CustomResourceOptions? opts = null)
    public FailoverGroupGrant(String name, FailoverGroupGrantArgs args)
    public FailoverGroupGrant(String name, FailoverGroupGrantArgs args, CustomResourceOptions options)
    
    type: snowflake:FailoverGroupGrant
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args FailoverGroupGrantArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args FailoverGroupGrantArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args FailoverGroupGrantArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FailoverGroupGrantArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FailoverGroupGrantArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var failoverGroupGrantResource = new Snowflake.FailoverGroupGrant("failoverGroupGrantResource", new()
    {
        Roles = new[]
        {
            "string",
        },
        EnableMultipleGrants = false,
        FailoverGroupName = "string",
        Privilege = "string",
        RevertOwnershipToRoleName = "string",
        WithGrantOption = false,
    });
    
    example, err := snowflake.NewFailoverGroupGrant(ctx, "failoverGroupGrantResource", &snowflake.FailoverGroupGrantArgs{
    	Roles: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	EnableMultipleGrants:      pulumi.Bool(false),
    	FailoverGroupName:         pulumi.String("string"),
    	Privilege:                 pulumi.String("string"),
    	RevertOwnershipToRoleName: pulumi.String("string"),
    	WithGrantOption:           pulumi.Bool(false),
    })
    
    var failoverGroupGrantResource = new FailoverGroupGrant("failoverGroupGrantResource", FailoverGroupGrantArgs.builder()        
        .roles("string")
        .enableMultipleGrants(false)
        .failoverGroupName("string")
        .privilege("string")
        .revertOwnershipToRoleName("string")
        .withGrantOption(false)
        .build());
    
    failover_group_grant_resource = snowflake.FailoverGroupGrant("failoverGroupGrantResource",
        roles=["string"],
        enable_multiple_grants=False,
        failover_group_name="string",
        privilege="string",
        revert_ownership_to_role_name="string",
        with_grant_option=False)
    
    const failoverGroupGrantResource = new snowflake.FailoverGroupGrant("failoverGroupGrantResource", {
        roles: ["string"],
        enableMultipleGrants: false,
        failoverGroupName: "string",
        privilege: "string",
        revertOwnershipToRoleName: "string",
        withGrantOption: false,
    });
    
    type: snowflake:FailoverGroupGrant
    properties:
        enableMultipleGrants: false
        failoverGroupName: string
        privilege: string
        revertOwnershipToRoleName: string
        roles:
            - string
        withGrantOption: false
    

    FailoverGroupGrant Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The FailoverGroupGrant resource accepts the following input properties:

    Roles List<string>
    Grants privilege to these roles.
    EnableMultipleGrants bool
    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.
    FailoverGroupName string
    The name of the failover group on which to grant privileges.
    Privilege string
    The privilege to grant on the failover group. To grant all privileges, use the value ALL PRIVILEGES
    RevertOwnershipToRoleName string
    The name of the role to revert ownership to on destroy. Has no effect unless privilege is set to OWNERSHIP
    WithGrantOption bool
    When this is set to true, allows the recipient role to grant the privileges to other roles.
    Roles []string
    Grants privilege to these roles.
    EnableMultipleGrants bool
    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.
    FailoverGroupName string
    The name of the failover group on which to grant privileges.
    Privilege string
    The privilege to grant on the failover group. To grant all privileges, use the value ALL PRIVILEGES
    RevertOwnershipToRoleName string
    The name of the role to revert ownership to on destroy. Has no effect unless privilege is set to OWNERSHIP
    WithGrantOption bool
    When this is set to true, allows the recipient role to grant the privileges to other roles.
    roles List<String>
    Grants privilege to these roles.
    enableMultipleGrants Boolean
    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.
    failoverGroupName String
    The name of the failover group on which to grant privileges.
    privilege String
    The privilege to grant on the failover group. To grant all privileges, use the value ALL PRIVILEGES
    revertOwnershipToRoleName String
    The name of the role to revert ownership to on destroy. Has no effect unless privilege is set to OWNERSHIP
    withGrantOption Boolean
    When this is set to true, allows the recipient role to grant the privileges to other roles.
    roles string[]
    Grants privilege to these roles.
    enableMultipleGrants boolean
    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.
    failoverGroupName string
    The name of the failover group on which to grant privileges.
    privilege string
    The privilege to grant on the failover group. To grant all privileges, use the value ALL PRIVILEGES
    revertOwnershipToRoleName string
    The name of the role to revert ownership to on destroy. Has no effect unless privilege is set to OWNERSHIP
    withGrantOption boolean
    When this is set to true, allows the recipient role to grant the privileges to other roles.
    roles Sequence[str]
    Grants privilege to these roles.
    enable_multiple_grants bool
    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.
    failover_group_name str
    The name of the failover group on which to grant privileges.
    privilege str
    The privilege to grant on the failover group. To grant all privileges, use the value ALL PRIVILEGES
    revert_ownership_to_role_name str
    The name of the role to revert ownership to on destroy. Has no effect unless privilege is set to OWNERSHIP
    with_grant_option bool
    When this is set to true, allows the recipient role to grant the privileges to other roles.
    roles List<String>
    Grants privilege to these roles.
    enableMultipleGrants Boolean
    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.
    failoverGroupName String
    The name of the failover group on which to grant privileges.
    privilege String
    The privilege to grant on the failover group. To grant all privileges, use the value ALL PRIVILEGES
    revertOwnershipToRoleName String
    The name of the role to revert ownership to on destroy. Has no effect unless privilege is set to OWNERSHIP
    withGrantOption Boolean
    When this is set to true, allows the recipient role to grant the privileges to other roles.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the FailoverGroupGrant resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing FailoverGroupGrant Resource

    Get an existing FailoverGroupGrant resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: FailoverGroupGrantState, opts?: CustomResourceOptions): FailoverGroupGrant
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            enable_multiple_grants: Optional[bool] = None,
            failover_group_name: Optional[str] = None,
            privilege: Optional[str] = None,
            revert_ownership_to_role_name: Optional[str] = None,
            roles: Optional[Sequence[str]] = None,
            with_grant_option: Optional[bool] = None) -> FailoverGroupGrant
    func GetFailoverGroupGrant(ctx *Context, name string, id IDInput, state *FailoverGroupGrantState, opts ...ResourceOption) (*FailoverGroupGrant, error)
    public static FailoverGroupGrant Get(string name, Input<string> id, FailoverGroupGrantState? state, CustomResourceOptions? opts = null)
    public static FailoverGroupGrant get(String name, Output<String> id, FailoverGroupGrantState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    EnableMultipleGrants bool
    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.
    FailoverGroupName string
    The name of the failover group on which to grant privileges.
    Privilege string
    The privilege to grant on the failover group. To grant all privileges, use the value ALL PRIVILEGES
    RevertOwnershipToRoleName string
    The name of the role to revert ownership to on destroy. Has no effect unless privilege is set to OWNERSHIP
    Roles List<string>
    Grants privilege to these roles.
    WithGrantOption bool
    When this is set to true, allows the recipient role to grant the privileges to other roles.
    EnableMultipleGrants bool
    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.
    FailoverGroupName string
    The name of the failover group on which to grant privileges.
    Privilege string
    The privilege to grant on the failover group. To grant all privileges, use the value ALL PRIVILEGES
    RevertOwnershipToRoleName string
    The name of the role to revert ownership to on destroy. Has no effect unless privilege is set to OWNERSHIP
    Roles []string
    Grants privilege to these roles.
    WithGrantOption bool
    When this is set to true, allows the recipient role to grant the privileges to other roles.
    enableMultipleGrants Boolean
    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.
    failoverGroupName String
    The name of the failover group on which to grant privileges.
    privilege String
    The privilege to grant on the failover group. To grant all privileges, use the value ALL PRIVILEGES
    revertOwnershipToRoleName String
    The name of the role to revert ownership to on destroy. Has no effect unless privilege is set to OWNERSHIP
    roles List<String>
    Grants privilege to these roles.
    withGrantOption Boolean
    When this is set to true, allows the recipient role to grant the privileges to other roles.
    enableMultipleGrants boolean
    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.
    failoverGroupName string
    The name of the failover group on which to grant privileges.
    privilege string
    The privilege to grant on the failover group. To grant all privileges, use the value ALL PRIVILEGES
    revertOwnershipToRoleName string
    The name of the role to revert ownership to on destroy. Has no effect unless privilege is set to OWNERSHIP
    roles string[]
    Grants privilege to these roles.
    withGrantOption boolean
    When this is set to true, allows the recipient role to grant the privileges to other roles.
    enable_multiple_grants bool
    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.
    failover_group_name str
    The name of the failover group on which to grant privileges.
    privilege str
    The privilege to grant on the failover group. To grant all privileges, use the value ALL PRIVILEGES
    revert_ownership_to_role_name str
    The name of the role to revert ownership to on destroy. Has no effect unless privilege is set to OWNERSHIP
    roles Sequence[str]
    Grants privilege to these roles.
    with_grant_option bool
    When this is set to true, allows the recipient role to grant the privileges to other roles.
    enableMultipleGrants Boolean
    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.
    failoverGroupName String
    The name of the failover group on which to grant privileges.
    privilege String
    The privilege to grant on the failover group. To grant all privileges, use the value ALL PRIVILEGES
    revertOwnershipToRoleName String
    The name of the role to revert ownership to on destroy. Has no effect unless privilege is set to OWNERSHIP
    roles List<String>
    Grants privilege to these roles.
    withGrantOption Boolean
    When this is set to true, allows the recipient role to grant the privileges to other roles.

    Package Details

    Repository
    Snowflake pulumi/pulumi-snowflake
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the snowflake Terraform Provider.
    snowflake logo
    Snowflake v0.51.0 published on Wednesday, Apr 10, 2024 by Pulumi