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

snowflake.DatabaseRole

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 dbRole = new snowflake.DatabaseRole("db_role", {
    database: "database",
    name: "role_1",
    comment: "my db role",
});

    import pulumi
import pulumi_snowflake as snowflake

db_role = snowflake.DatabaseRole("db_role",
    database="database",
    name="role_1",
    comment="my db 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.NewDatabaseRole(ctx, "db_role", &snowflake.DatabaseRoleArgs{
			Database: pulumi.String("database"),
			Name:     pulumi.String("role_1"),
			Comment:  pulumi.String("my db 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 dbRole = new Snowflake.DatabaseRole("db_role", new()
    {
        Database = "database",
        Name = "role_1",
        Comment = "my db role",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.snowflake.DatabaseRole;
import com.pulumi.snowflake.DatabaseRoleArgs;
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 dbRole = new DatabaseRole("dbRole", DatabaseRoleArgs.builder()
            .database("database")
            .name("role_1")
            .comment("my db role")
            .build());

    }
}

    resources:
  dbRole:
    type: snowflake:DatabaseRole
    name: db_role
    properties:
      database: database
      name: role_1
      comment: my db role

    Create DatabaseRole Resource

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

    Constructor syntax

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

@overload
def DatabaseRole(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 database: Optional[str] = None,
                 comment: Optional[str] = None,
                 name: Optional[str] = None)
    func NewDatabaseRole(ctx *Context, name string, args DatabaseRoleArgs, opts ...ResourceOption) (*DatabaseRole, error)
    public DatabaseRole(string name, DatabaseRoleArgs args, CustomResourceOptions? opts = null)
    public DatabaseRole(String name, DatabaseRoleArgs args)
public DatabaseRole(String name, DatabaseRoleArgs args, CustomResourceOptions options)

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

    example, err := snowflake.NewDatabaseRole(ctx, "databaseRoleResource", &snowflake.DatabaseRoleArgs{
	Database: pulumi.String("string"),
	Comment:  pulumi.String("string"),
	Name:     pulumi.String("string"),
})

    var databaseRoleResource = new DatabaseRole("databaseRoleResource", DatabaseRoleArgs.builder()
    .database("string")
    .comment("string")
    .name("string")
    .build());

    database_role_resource = snowflake.DatabaseRole("databaseRoleResource",
    database="string",
    comment="string",
    name="string")

    const databaseRoleResource = new snowflake.DatabaseRole("databaseRoleResource", {
    database: "string",
    comment: "string",
    name: "string",
});

    type: snowflake:DatabaseRole
properties:
    comment: string
    database: string
    name: string

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

    Database string
    The database in which to create the database role.
    Comment string
    Specifies a comment for the database role.
    Name string
    Specifies the identifier for the database role.
    Database string
    The database in which to create the database role.
    Comment string
    Specifies a comment for the database role.
    Name string
    Specifies the identifier for the database role.
    database String
    The database in which to create the database role.
    comment String
    Specifies a comment for the database role.
    name String
    Specifies the identifier for the database role.
    database string
    The database in which to create the database role.
    comment string
    Specifies a comment for the database role.
    name string
    Specifies the identifier for the database role.
    database str
    The database in which to create the database role.
    comment str
    Specifies a comment for the database role.
    name str
    Specifies the identifier for the database role.
    database String
    The database in which to create the database role.
    comment String
    Specifies a comment for the database role.
    name String
    Specifies the identifier for the database role.

    Outputs

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

    Get an existing DatabaseRole 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?: DatabaseRoleState, opts?: CustomResourceOptions): DatabaseRole
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comment: Optional[str] = None,
        database: Optional[str] = None,
        name: Optional[str] = None) -> DatabaseRole
    func GetDatabaseRole(ctx *Context, name string, id IDInput, state *DatabaseRoleState, opts ...ResourceOption) (*DatabaseRole, error)
    public static DatabaseRole Get(string name, Input<string> id, DatabaseRoleState? state, CustomResourceOptions? opts = null)
    public static DatabaseRole get(String name, Output<String> id, DatabaseRoleState 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
    Specifies a comment for the database role.
    Database string
    The database in which to create the database role.
    Name string
    Specifies the identifier for the database role.
    Comment string
    Specifies a comment for the database role.
    Database string
    The database in which to create the database role.
    Name string
    Specifies the identifier for the database role.
    comment String
    Specifies a comment for the database role.
    database String
    The database in which to create the database role.
    name String
    Specifies the identifier for the database role.
    comment string
    Specifies a comment for the database role.
    database string
    The database in which to create the database role.
    name string
    Specifies the identifier for the database role.
    comment str
    Specifies a comment for the database role.
    database str
    The database in which to create the database role.
    name str
    Specifies the identifier for the database role.
    comment String
    Specifies a comment for the database role.
    database String
    The database in which to create the database role.
    name String
    Specifies the identifier for the database role.

    Import

    $ pulumi import snowflake:index/databaseRole:DatabaseRole example 'dbName|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