Docs Packages
  1. Packages
  2. Snowflake
  3. API Docs
  4. Role
Snowflake v0.55.0 published on Friday, Jun 7, 2024 by Pulumi
pulumi/pulumi-snowflake

snowflake.Role

Explore with Pulumi AI

snowflake logo
Snowflake v0.55.0 published on Friday, Jun 7, 2024 by Pulumi
pulumi/pulumi-snowflake

    Example Usage

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

const role = new snowflake.Role("role", {
    name: "role1",
    comment: "A role.",
});

    import pulumi
import pulumi_snowflake as snowflake

role = snowflake.Role("role",
    name="role1",
    comment="A role.")

    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.NewRole(ctx, "role", &snowflake.RoleArgs{
			Name:    pulumi.String("role1"),
			Comment: pulumi.String("A 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(() => 
{
    var role = new Snowflake.Role("role", new()
    {
        Name = "role1",
        Comment = "A role.",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.snowflake.Role;
import com.pulumi.snowflake.RoleArgs;
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) {
        var role = new Role("role", RoleArgs.builder()
            .name("role1")
            .comment("A role.")
            .build());

    }
}

    resources:
  role:
    type: snowflake:Role
    properties:
      name: role1
      comment: A role.

    Create Role Resource

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

    Constructor syntax

    new Role(name: string, args?: RoleArgs, opts?: CustomResourceOptions);
    @overload
def Role(resource_name: str,
         args: Optional[RoleArgs] = None,
         opts: Optional[ResourceOptions] = None)

@overload
def Role(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         comment: Optional[str] = None,
         name: Optional[str] = None,
         tags: Optional[Sequence[RoleTagArgs]] = None)
    func NewRole(ctx *Context, name string, args *RoleArgs, opts ...ResourceOption) (*Role, error)
    public Role(string name, RoleArgs? args = null, CustomResourceOptions? opts = null)
    public Role(String name, RoleArgs args)
public Role(String name, RoleArgs args, CustomResourceOptions options)

    type: snowflake:Role
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 RoleArgs
    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 RoleArgs
    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 RoleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RoleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RoleArgs
    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 roleResource = new Snowflake.Role("roleResource", new()
{
    Comment = "string",
    Name = "string",
});

    example, err := snowflake.NewRole(ctx, "roleResource", &snowflake.RoleArgs{
	Comment: pulumi.String("string"),
	Name:    pulumi.String("string"),
})

    var roleResource = new Role("roleResource", RoleArgs.builder()
    .comment("string")
    .name("string")
    .build());

    role_resource = snowflake.Role("roleResource",
    comment="string",
    name="string")

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

    type: snowflake:Role
properties:
    comment: string
    name: string

    Role 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 Role resource accepts the following input properties:

    Comment string
    Name string
    Tags List<RoleTag>
    Definitions of a tag to associate with the resource.

    Deprecated: Use the 'snowflake_tag_association' resource instead.

    Comment string
    Name string
    Tags []RoleTagArgs
    Definitions of a tag to associate with the resource.

    Deprecated: Use the 'snowflake_tag_association' resource instead.

    comment String
    name String
    tags List<RoleTag>
    Definitions of a tag to associate with the resource.

    Deprecated: Use the 'snowflake_tag_association' resource instead.

    comment string
    name string
    tags RoleTag[]
    Definitions of a tag to associate with the resource.

    Deprecated: Use the 'snowflake_tag_association' resource instead.

    comment str
    name str
    tags Sequence[RoleTagArgs]
    Definitions of a tag to associate with the resource.

    Deprecated: Use the 'snowflake_tag_association' resource instead.

    comment String
    name String
    tags List<Property Map>
    Definitions of a tag to associate with the resource.

    Deprecated: Use the 'snowflake_tag_association' resource instead.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Role 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 Role Resource

    Get an existing Role 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?: RoleState, opts?: CustomResourceOptions): Role
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comment: Optional[str] = None,
        name: Optional[str] = None,
        tags: Optional[Sequence[RoleTagArgs]] = None) -> Role
    func GetRole(ctx *Context, name string, id IDInput, state *RoleState, opts ...ResourceOption) (*Role, error)
    public static Role Get(string name, Input<string> id, RoleState? state, CustomResourceOptions? opts = null)
    public static Role get(String name, Output<String> id, RoleState 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:
    Comment string
    Name string
    Tags List<RoleTag>
    Definitions of a tag to associate with the resource.

    Deprecated: Use the 'snowflake_tag_association' resource instead.

    Comment string
    Name string
    Tags []RoleTagArgs
    Definitions of a tag to associate with the resource.

    Deprecated: Use the 'snowflake_tag_association' resource instead.

    comment String
    name String
    tags List<RoleTag>
    Definitions of a tag to associate with the resource.

    Deprecated: Use the 'snowflake_tag_association' resource instead.

    comment string
    name string
    tags RoleTag[]
    Definitions of a tag to associate with the resource.

    Deprecated: Use the 'snowflake_tag_association' resource instead.

    comment str
    name str
    tags Sequence[RoleTagArgs]
    Definitions of a tag to associate with the resource.

    Deprecated: Use the 'snowflake_tag_association' resource instead.

    comment String
    name String
    tags List<Property Map>
    Definitions of a tag to associate with the resource.

    Deprecated: Use the 'snowflake_tag_association' resource instead.

    Supporting Types

    RoleTag, RoleTagArgs

    Name string
    Tag name, e.g. department.
    Value string
    Tag value, e.g. marketing_info.
    Database string
    Name of the database that the tag was created in.
    Schema string
    Name of the schema that the tag was created in.
    Name string
    Tag name, e.g. department.
    Value string
    Tag value, e.g. marketing_info.
    Database string
    Name of the database that the tag was created in.
    Schema string
    Name of the schema that the tag was created in.
    name String
    Tag name, e.g. department.
    value String
    Tag value, e.g. marketing_info.
    database String
    Name of the database that the tag was created in.
    schema String
    Name of the schema that the tag was created in.
    name string
    Tag name, e.g. department.
    value string
    Tag value, e.g. marketing_info.
    database string
    Name of the database that the tag was created in.
    schema string
    Name of the schema that the tag was created in.
    name str
    Tag name, e.g. department.
    value str
    Tag value, e.g. marketing_info.
    database str
    Name of the database that the tag was created in.
    schema str
    Name of the schema that the tag was created in.
    name String
    Tag name, e.g. department.
    value String
    Tag value, e.g. marketing_info.
    database String
    Name of the database that the tag was created in.
    schema String
    Name of the schema that the tag was created in.

    Import

    $ pulumi import snowflake:index/role:Role example roleName

    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.
    snowflake logo
    Snowflake v0.55.0 published on Friday, Jun 7, 2024 by Pulumi
    pulumi/pulumi-snowflake