AccountRole

Snowflake v2.13.0, Feb 26 26

Viewing docs for Snowflake v2.13.0
published on Thursday, Feb 26, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-snowflake

Viewing docs for Snowflake v2.13.0
published on Thursday, Feb 26, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-snowflake

Note Users cannot execute a DROP ROLE command that drops the current primary role. An attempt to drop this role returns the following error: Cannot drop role '<role_name>' because it is the current role for user '<username>'. This means that before deleting the resource, make sure that you do not attempt to drop the current primary role. See Usage notes for more details.

The resource is used for role management, where roles can be assigned privileges and, in turn, granted to users and other roles. When granted to roles they can create hierarchies of privilege structures. For more details, refer to the official documentation.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as snowflake from "@pulumi/snowflake";

//# Minimal
const minimal = new snowflake.AccountRole("minimal", {name: "role_name"});
//# Complete (with every optional set)
const complete = new snowflake.AccountRole("complete", {
    name: "role_name",
    comment: "my account role",
});

import pulumi
import pulumi_snowflake as snowflake

## Minimal
minimal = snowflake.AccountRole("minimal", name="role_name")
## Complete (with every optional set)
complete = snowflake.AccountRole("complete",
    name="role_name",
    comment="my account role")

package main

import (
	"github.com/pulumi/pulumi-snowflake/sdk/v2/go/snowflake"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// # Minimal
		_, err := snowflake.NewAccountRole(ctx, "minimal", &snowflake.AccountRoleArgs{
			Name: pulumi.String("role_name"),
		})
		if err != nil {
			return err
		}
		// # Complete (with every optional set)
		_, err = snowflake.NewAccountRole(ctx, "complete", &snowflake.AccountRoleArgs{
			Name:    pulumi.String("role_name"),
			Comment: pulumi.String("my account role"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Snowflake = Pulumi.Snowflake;

return await Deployment.RunAsync(() => 
{
    //# Minimal
    var minimal = new Snowflake.AccountRole("minimal", new()
    {
        Name = "role_name",
    });

    //# Complete (with every optional set)
    var complete = new Snowflake.AccountRole("complete", new()
    {
        Name = "role_name",
        Comment = "my account role",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.snowflake.AccountRole;
import com.pulumi.snowflake.AccountRoleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        //# Minimal
        var minimal = new AccountRole("minimal", AccountRoleArgs.builder()
            .name("role_name")
            .build());

        //# Complete (with every optional set)
        var complete = new AccountRole("complete", AccountRoleArgs.builder()
            .name("role_name")
            .comment("my account role")
            .build());

    }
}

resources:
  ## Minimal
  minimal:
    type: snowflake:AccountRole
    properties:
      name: role_name
  ## Complete (with every optional set)
  complete:
    type: snowflake:AccountRole
    properties:
      name: role_name
      comment: my account role

Note Instead of using fully_qualified_name, you can reference objects managed outside Terraform by constructing a correct ID, consult identifiers guide.

Note If a field has a default value, it is shown next to the type in the schema.

Create AccountRole Resource

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

Constructor syntax

new AccountRole(name: string, args?: AccountRoleArgs, opts?: CustomResourceOptions);

@overload
def AccountRole(resource_name: str,
                args: Optional[AccountRoleArgs] = None,
                opts: Optional[ResourceOptions] = None)

@overload
def AccountRole(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                comment: Optional[str] = None,
                name: Optional[str] = None)

func NewAccountRole(ctx *Context, name string, args *AccountRoleArgs, opts ...ResourceOption) (*AccountRole, error)

public AccountRole(string name, AccountRoleArgs? args = null, CustomResourceOptions? opts = null)

public AccountRole(String name, AccountRoleArgs args)
public AccountRole(String name, AccountRoleArgs args, CustomResourceOptions options)

type: snowflake:AccountRole
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 AccountRoleArgs: 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 AccountRoleArgs: 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 AccountRoleArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AccountRoleArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args AccountRoleArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

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

var accountRoleResource = new Snowflake.AccountRole("accountRoleResource", new()
{
    Comment = "string",
    Name = "string",
});

example, err := snowflake.NewAccountRole(ctx, "accountRoleResource", &snowflake.AccountRoleArgs{
	Comment: pulumi.String("string"),
	Name:    pulumi.String("string"),
})

var accountRoleResource = new AccountRole("accountRoleResource", AccountRoleArgs.builder()
    .comment("string")
    .name("string")
    .build());

account_role_resource = snowflake.AccountRole("accountRoleResource",
    comment="string",
    name="string")

const accountRoleResource = new snowflake.AccountRole("accountRoleResource", {
    comment: "string",
    name: "string",
});

type: snowflake:AccountRole
properties:
    comment: string
    name: string

AccountRole Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The AccountRole resource accepts the following input properties:

Comment string
Name string: Identifier for the role; must be unique for your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".

Comment string
Name string: Identifier for the role; must be unique for your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".

comment String
name String: Identifier for the role; must be unique for your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".

comment string
name string: Identifier for the role; must be unique for your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".

comment str
name str: Identifier for the role; must be unique for your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".

comment String
name String: Identifier for the role; must be unique for your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".

Outputs

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

FullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
Id string: The provider-assigned unique ID for this managed resource.
ShowOutputs List<AccountRoleShowOutput>: Outputs the result of SHOW ROLES for the given role.

FullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
Id string: The provider-assigned unique ID for this managed resource.
ShowOutputs []AccountRoleShowOutput: Outputs the result of SHOW ROLES for the given role.

fullyQualifiedName String: Fully qualified name of the resource. For more information, see object name resolution.
id String: The provider-assigned unique ID for this managed resource.
showOutputs List<AccountRoleShowOutput>: Outputs the result of SHOW ROLES for the given role.

fullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
id string: The provider-assigned unique ID for this managed resource.
showOutputs AccountRoleShowOutput[]: Outputs the result of SHOW ROLES for the given role.

fully_qualified_name str: Fully qualified name of the resource. For more information, see object name resolution.
id str: The provider-assigned unique ID for this managed resource.
show_outputs Sequence[AccountRoleShowOutput]: Outputs the result of SHOW ROLES for the given role.

fullyQualifiedName String: Fully qualified name of the resource. For more information, see object name resolution.
id String: The provider-assigned unique ID for this managed resource.
showOutputs List<Property Map>: Outputs the result of SHOW ROLES for the given role.

Look up Existing AccountRole Resource

Get an existing AccountRole 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?: AccountRoleState, opts?: CustomResourceOptions): AccountRole

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comment: Optional[str] = None,
        fully_qualified_name: Optional[str] = None,
        name: Optional[str] = None,
        show_outputs: Optional[Sequence[AccountRoleShowOutputArgs]] = None) -> AccountRole

func GetAccountRole(ctx *Context, name string, id IDInput, state *AccountRoleState, opts ...ResourceOption) (*AccountRole, error)

public static AccountRole Get(string name, Input<string> id, AccountRoleState? state, CustomResourceOptions? opts = null)

public static AccountRole get(String name, Output<String> id, AccountRoleState state, CustomResourceOptions options)

resources:  _:    type: snowflake:AccountRole    get:      id: ${id}

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:

Comment string
FullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
Name string: Identifier for the role; must be unique for your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
ShowOutputs List<AccountRoleShowOutput>: Outputs the result of SHOW ROLES for the given role.

Comment string
FullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
Name string: Identifier for the role; must be unique for your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
ShowOutputs []AccountRoleShowOutputArgs: Outputs the result of SHOW ROLES for the given role.

comment String
fullyQualifiedName String: Fully qualified name of the resource. For more information, see object name resolution.
name String: Identifier for the role; must be unique for your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
showOutputs List<AccountRoleShowOutput>: Outputs the result of SHOW ROLES for the given role.

comment string
fullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
name string: Identifier for the role; must be unique for your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
showOutputs AccountRoleShowOutput[]: Outputs the result of SHOW ROLES for the given role.

comment str
fully_qualified_name str: Fully qualified name of the resource. For more information, see object name resolution.
name str: Identifier for the role; must be unique for your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
show_outputs Sequence[AccountRoleShowOutputArgs]: Outputs the result of SHOW ROLES for the given role.

comment String
fullyQualifiedName String: Fully qualified name of the resource. For more information, see object name resolution.
name String: Identifier for the role; must be unique for your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
showOutputs List<Property Map>: Outputs the result of SHOW ROLES for the given role.

Supporting Types

AccountRoleShowOutput, AccountRoleShowOutputArgs

AssignedToUsers int
Comment string
CreatedOn string
GrantedRoles int
GrantedToRoles int
IsCurrent bool
IsDefault bool
IsInherited bool
Name string
Owner string

AssignedToUsers int
Comment string
CreatedOn string
GrantedRoles int
GrantedToRoles int
IsCurrent bool
IsDefault bool
IsInherited bool
Name string
Owner string

assignedToUsers Integer
comment String
createdOn String
grantedRoles Integer
grantedToRoles Integer
isCurrent Boolean
isDefault Boolean
isInherited Boolean
name String
owner String

assignedToUsers number
comment string
createdOn string
grantedRoles number
grantedToRoles number
isCurrent boolean
isDefault boolean
isInherited boolean
name string
owner string

assigned_to_users int
comment str
created_on str
granted_roles int
granted_to_roles int
is_current bool
is_default bool
is_inherited bool
name str
owner str

assignedToUsers Number
comment String
createdOn String
grantedRoles Number
grantedToRoles Number
isCurrent Boolean
isDefault Boolean
isInherited Boolean
name String
owner String

Import

$ pulumi import snowflake:index/accountRole:AccountRole example '"<account_role_name>"'

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: Snowflake pulumi/pulumi-snowflake
License: Apache-2.0
Notes: This Pulumi package is based on the snowflake Terraform Provider.

Viewing docs for Snowflake v2.13.0
published on Thursday, Feb 26, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-snowflake

snowflake.AccountRole

On this page

On this page

Example Usage

Create AccountRole Resource

Constructor syntax

Parameters

Constructor example

AccountRole Resource Properties

Inputs

Outputs

Look up Existing AccountRole Resource

Supporting Types

AccountRoleShowOutput, AccountRoleShowOutputArgs

Import

Package Details

On this page

On this page