Snowflake v0.61.1, Nov 14 24

Snowflake v0.61.1 published on Thursday, Nov 14, 2024 by Pulumi

snowflake.Role

Explore with Pulumi AI

Snowflake v0.61.1 published on Thursday, Nov 14, 2024 by Pulumi

Import

$ pulumi import snowflake:index/role:Role example "name"

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)

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

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

The Role 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 Role 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<RoleShowOutput>: 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 []RoleShowOutput: 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<RoleShowOutput>: 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 RoleShowOutput[]: 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[RoleShowOutput]: 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 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,
        fully_qualified_name: Optional[str] = None,
        name: Optional[str] = None,
        show_outputs: Optional[Sequence[RoleShowOutputArgs]] = 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
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<RoleShowOutput>: 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 []RoleShowOutputArgs: 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<RoleShowOutput>: 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 RoleShowOutput[]: 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[RoleShowOutputArgs]: 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.