Snowflake v0.61.1, Nov 14 24

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

snowflake.RowAccessPolicy

Explore with Pulumi AI

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

Import

$ pulumi import snowflake:index/rowAccessPolicy:RowAccessPolicy example '"<database_name>"."<schema_name>"."<row_access_policy_name>"'

Create RowAccessPolicy Resource

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

Constructor syntax

new RowAccessPolicy(name: string, args: RowAccessPolicyArgs, opts?: CustomResourceOptions);

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

@overload
def RowAccessPolicy(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    arguments: Optional[Sequence[RowAccessPolicyArgumentArgs]] = None,
                    body: Optional[str] = None,
                    database: Optional[str] = None,
                    schema: Optional[str] = None,
                    comment: Optional[str] = None,
                    name: Optional[str] = None)

func NewRowAccessPolicy(ctx *Context, name string, args RowAccessPolicyArgs, opts ...ResourceOption) (*RowAccessPolicy, error)

public RowAccessPolicy(string name, RowAccessPolicyArgs args, CustomResourceOptions? opts = null)

public RowAccessPolicy(String name, RowAccessPolicyArgs args)
public RowAccessPolicy(String name, RowAccessPolicyArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args RowAccessPolicyArgs: 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 rowAccessPolicyResource = new Snowflake.RowAccessPolicy("rowAccessPolicyResource", new()
{
    Arguments = new[]
    {
        new Snowflake.Inputs.RowAccessPolicyArgumentArgs
        {
            Name = "string",
            Type = "string",
        },
    },
    Body = "string",
    Database = "string",
    Schema = "string",
    Comment = "string",
    Name = "string",
});

example, err := snowflake.NewRowAccessPolicy(ctx, "rowAccessPolicyResource", &snowflake.RowAccessPolicyArgs{
	Arguments: snowflake.RowAccessPolicyArgumentArray{
		&snowflake.RowAccessPolicyArgumentArgs{
			Name: pulumi.String("string"),
			Type: pulumi.String("string"),
		},
	},
	Body:     pulumi.String("string"),
	Database: pulumi.String("string"),
	Schema:   pulumi.String("string"),
	Comment:  pulumi.String("string"),
	Name:     pulumi.String("string"),
})

var rowAccessPolicyResource = new RowAccessPolicy("rowAccessPolicyResource", RowAccessPolicyArgs.builder()
    .arguments(RowAccessPolicyArgumentArgs.builder()
        .name("string")
        .type("string")
        .build())
    .body("string")
    .database("string")
    .schema("string")
    .comment("string")
    .name("string")
    .build());

row_access_policy_resource = snowflake.RowAccessPolicy("rowAccessPolicyResource",
    arguments=[{
        "name": "string",
        "type": "string",
    }],
    body="string",
    database="string",
    schema="string",
    comment="string",
    name="string")

const rowAccessPolicyResource = new snowflake.RowAccessPolicy("rowAccessPolicyResource", {
    arguments: [{
        name: "string",
        type: "string",
    }],
    body: "string",
    database: "string",
    schema: "string",
    comment: "string",
    name: "string",
});

type: snowflake:RowAccessPolicy
properties:
    arguments:
        - name: string
          type: string
    body: string
    comment: string
    database: string
    name: string
    schema: string

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

Arguments List<RowAccessPolicyArgument>: List of the arguments for the row access policy. A signature specifies a set of attributes that must be considered to determine whether the row is accessible. The attribute values come from the database object (e.g. table or view) to be protected by the row access policy. If any argument name or type is changed, the resource is recreated.
Body string: Specifies the SQL expression. The expression can be any boolean-valued SQL expression. To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
Database string: The database in which to create the row access policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
Schema string: The schema in which to create the row access policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
Comment string: Specifies a comment for the row access policy.
Name string: Specifies the identifier for the row access policy; must be unique for the database and schema in which the row access policy is created. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "

Arguments []RowAccessPolicyArgumentArgs: List of the arguments for the row access policy. A signature specifies a set of attributes that must be considered to determine whether the row is accessible. The attribute values come from the database object (e.g. table or view) to be protected by the row access policy. If any argument name or type is changed, the resource is recreated.
Body string: Specifies the SQL expression. The expression can be any boolean-valued SQL expression. To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
Database string: The database in which to create the row access policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
Schema string: The schema in which to create the row access policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
Comment string: Specifies a comment for the row access policy.
Name string: Specifies the identifier for the row access policy; must be unique for the database and schema in which the row access policy is created. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "

arguments List<RowAccessPolicyArgument>: List of the arguments for the row access policy. A signature specifies a set of attributes that must be considered to determine whether the row is accessible. The attribute values come from the database object (e.g. table or view) to be protected by the row access policy. If any argument name or type is changed, the resource is recreated.
body String: Specifies the SQL expression. The expression can be any boolean-valued SQL expression. To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
database String: The database in which to create the row access policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
schema String: The schema in which to create the row access policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
comment String: Specifies a comment for the row access policy.
name String: Specifies the identifier for the row access policy; must be unique for the database and schema in which the row access policy is created. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "

arguments RowAccessPolicyArgument[]: List of the arguments for the row access policy. A signature specifies a set of attributes that must be considered to determine whether the row is accessible. The attribute values come from the database object (e.g. table or view) to be protected by the row access policy. If any argument name or type is changed, the resource is recreated.
body string: Specifies the SQL expression. The expression can be any boolean-valued SQL expression. To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
database string: The database in which to create the row access policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
schema string: The schema in which to create the row access policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
comment string: Specifies a comment for the row access policy.
name string: Specifies the identifier for the row access policy; must be unique for the database and schema in which the row access policy is created. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "

arguments Sequence[RowAccessPolicyArgumentArgs]: List of the arguments for the row access policy. A signature specifies a set of attributes that must be considered to determine whether the row is accessible. The attribute values come from the database object (e.g. table or view) to be protected by the row access policy. If any argument name or type is changed, the resource is recreated.
body str: Specifies the SQL expression. The expression can be any boolean-valued SQL expression. To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
database str: The database in which to create the row access policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
schema str: The schema in which to create the row access policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
comment str: Specifies a comment for the row access policy.
name str: Specifies the identifier for the row access policy; must be unique for the database and schema in which the row access policy is created. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "

arguments List<Property Map>: List of the arguments for the row access policy. A signature specifies a set of attributes that must be considered to determine whether the row is accessible. The attribute values come from the database object (e.g. table or view) to be protected by the row access policy. If any argument name or type is changed, the resource is recreated.
body String: Specifies the SQL expression. The expression can be any boolean-valued SQL expression. To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
database String: The database in which to create the row access policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
schema String: The schema in which to create the row access policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
comment String: Specifies a comment for the row access policy.
name String: Specifies the identifier for the row access policy; must be unique for the database and schema in which the row access policy is created. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "

Outputs

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

DescribeOutputs List<RowAccessPolicyDescribeOutput>: Outputs the result of DESCRIBE ROW ACCESS POLICY for the given row access policy.
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<RowAccessPolicyShowOutput>: Outputs the result of SHOW ROW ACCESS POLICIES for the given row access policy.

DescribeOutputs []RowAccessPolicyDescribeOutput: Outputs the result of DESCRIBE ROW ACCESS POLICY for the given row access policy.
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 []RowAccessPolicyShowOutput: Outputs the result of SHOW ROW ACCESS POLICIES for the given row access policy.

describeOutputs List<RowAccessPolicyDescribeOutput>: Outputs the result of DESCRIBE ROW ACCESS POLICY for the given row access policy.
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<RowAccessPolicyShowOutput>: Outputs the result of SHOW ROW ACCESS POLICIES for the given row access policy.

describeOutputs RowAccessPolicyDescribeOutput[]: Outputs the result of DESCRIBE ROW ACCESS POLICY for the given row access policy.
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 RowAccessPolicyShowOutput[]: Outputs the result of SHOW ROW ACCESS POLICIES for the given row access policy.

describe_outputs Sequence[RowAccessPolicyDescribeOutput]: Outputs the result of DESCRIBE ROW ACCESS POLICY for the given row access policy.
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[RowAccessPolicyShowOutput]: Outputs the result of SHOW ROW ACCESS POLICIES for the given row access policy.

describeOutputs List<Property Map>: Outputs the result of DESCRIBE ROW ACCESS POLICY for the given row access policy.
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 ROW ACCESS POLICIES for the given row access policy.

Look up Existing RowAccessPolicy Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arguments: Optional[Sequence[RowAccessPolicyArgumentArgs]] = None,
        body: Optional[str] = None,
        comment: Optional[str] = None,
        database: Optional[str] = None,
        describe_outputs: Optional[Sequence[RowAccessPolicyDescribeOutputArgs]] = None,
        fully_qualified_name: Optional[str] = None,
        name: Optional[str] = None,
        schema: Optional[str] = None,
        show_outputs: Optional[Sequence[RowAccessPolicyShowOutputArgs]] = None) -> RowAccessPolicy

func GetRowAccessPolicy(ctx *Context, name string, id IDInput, state *RowAccessPolicyState, opts ...ResourceOption) (*RowAccessPolicy, error)

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

public static RowAccessPolicy get(String name, Output<String> id, RowAccessPolicyState 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:

Arguments List<RowAccessPolicyArgument>: List of the arguments for the row access policy. A signature specifies a set of attributes that must be considered to determine whether the row is accessible. The attribute values come from the database object (e.g. table or view) to be protected by the row access policy. If any argument name or type is changed, the resource is recreated.
Body string: Specifies the SQL expression. The expression can be any boolean-valued SQL expression. To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
Comment string: Specifies a comment for the row access policy.
Database string: The database in which to create the row access policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
DescribeOutputs List<RowAccessPolicyDescribeOutput>: Outputs the result of DESCRIBE ROW ACCESS POLICY for the given row access policy.
FullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
Name string: Specifies the identifier for the row access policy; must be unique for the database and schema in which the row access policy is created. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
Schema string: The schema in which to create the row access policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
ShowOutputs List<RowAccessPolicyShowOutput>: Outputs the result of SHOW ROW ACCESS POLICIES for the given row access policy.

Arguments []RowAccessPolicyArgumentArgs: List of the arguments for the row access policy. A signature specifies a set of attributes that must be considered to determine whether the row is accessible. The attribute values come from the database object (e.g. table or view) to be protected by the row access policy. If any argument name or type is changed, the resource is recreated.
Body string: Specifies the SQL expression. The expression can be any boolean-valued SQL expression. To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
Comment string: Specifies a comment for the row access policy.
Database string: The database in which to create the row access policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
DescribeOutputs []RowAccessPolicyDescribeOutputArgs: Outputs the result of DESCRIBE ROW ACCESS POLICY for the given row access policy.
FullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
Name string: Specifies the identifier for the row access policy; must be unique for the database and schema in which the row access policy is created. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
Schema string: The schema in which to create the row access policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
ShowOutputs []RowAccessPolicyShowOutputArgs: Outputs the result of SHOW ROW ACCESS POLICIES for the given row access policy.

arguments List<RowAccessPolicyArgument>: List of the arguments for the row access policy. A signature specifies a set of attributes that must be considered to determine whether the row is accessible. The attribute values come from the database object (e.g. table or view) to be protected by the row access policy. If any argument name or type is changed, the resource is recreated.
body String: Specifies the SQL expression. The expression can be any boolean-valued SQL expression. To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
comment String: Specifies a comment for the row access policy.
database String: The database in which to create the row access policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
describeOutputs List<RowAccessPolicyDescribeOutput>: Outputs the result of DESCRIBE ROW ACCESS POLICY for the given row access policy.
fullyQualifiedName String: Fully qualified name of the resource. For more information, see object name resolution.
name String: Specifies the identifier for the row access policy; must be unique for the database and schema in which the row access policy is created. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
schema String: The schema in which to create the row access policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
showOutputs List<RowAccessPolicyShowOutput>: Outputs the result of SHOW ROW ACCESS POLICIES for the given row access policy.

arguments RowAccessPolicyArgument[]: List of the arguments for the row access policy. A signature specifies a set of attributes that must be considered to determine whether the row is accessible. The attribute values come from the database object (e.g. table or view) to be protected by the row access policy. If any argument name or type is changed, the resource is recreated.
body string: Specifies the SQL expression. The expression can be any boolean-valued SQL expression. To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
comment string: Specifies a comment for the row access policy.
database string: The database in which to create the row access policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
describeOutputs RowAccessPolicyDescribeOutput[]: Outputs the result of DESCRIBE ROW ACCESS POLICY for the given row access policy.
fullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
name string: Specifies the identifier for the row access policy; must be unique for the database and schema in which the row access policy is created. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
schema string: The schema in which to create the row access policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
showOutputs RowAccessPolicyShowOutput[]: Outputs the result of SHOW ROW ACCESS POLICIES for the given row access policy.

arguments Sequence[RowAccessPolicyArgumentArgs]: List of the arguments for the row access policy. A signature specifies a set of attributes that must be considered to determine whether the row is accessible. The attribute values come from the database object (e.g. table or view) to be protected by the row access policy. If any argument name or type is changed, the resource is recreated.
body str: Specifies the SQL expression. The expression can be any boolean-valued SQL expression. To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
comment str: Specifies a comment for the row access policy.
database str: The database in which to create the row access policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
describe_outputs Sequence[RowAccessPolicyDescribeOutputArgs]: Outputs the result of DESCRIBE ROW ACCESS POLICY for the given row access policy.
fully_qualified_name str: Fully qualified name of the resource. For more information, see object name resolution.
name str: Specifies the identifier for the row access policy; must be unique for the database and schema in which the row access policy is created. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
schema str: The schema in which to create the row access policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
show_outputs Sequence[RowAccessPolicyShowOutputArgs]: Outputs the result of SHOW ROW ACCESS POLICIES for the given row access policy.

arguments List<Property Map>: List of the arguments for the row access policy. A signature specifies a set of attributes that must be considered to determine whether the row is accessible. The attribute values come from the database object (e.g. table or view) to be protected by the row access policy. If any argument name or type is changed, the resource is recreated.
body String: Specifies the SQL expression. The expression can be any boolean-valued SQL expression. To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
comment String: Specifies a comment for the row access policy.
database String: The database in which to create the row access policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
describeOutputs List<Property Map>: Outputs the result of DESCRIBE ROW ACCESS POLICY for the given row access policy.
fullyQualifiedName String: Fully qualified name of the resource. For more information, see object name resolution.
name String: Specifies the identifier for the row access policy; must be unique for the database and schema in which the row access policy is created. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
schema String: The schema in which to create the row access policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
showOutputs List<Property Map>: Outputs the result of SHOW ROW ACCESS POLICIES for the given row access policy.

Supporting Types

RowAccessPolicyArgument, RowAccessPolicyArgumentArgs

Name string: The argument name
Type string: The argument type. VECTOR data types are not yet supported. For more information about data types, check Snowflake docs.

Name string: The argument name
Type string: The argument type. VECTOR data types are not yet supported. For more information about data types, check Snowflake docs.

name String: The argument name
type String: The argument type. VECTOR data types are not yet supported. For more information about data types, check Snowflake docs.

name string: The argument name
type string: The argument type. VECTOR data types are not yet supported. For more information about data types, check Snowflake docs.

name str: The argument name
type str: The argument type. VECTOR data types are not yet supported. For more information about data types, check Snowflake docs.

name String: The argument name
type String: The argument type. VECTOR data types are not yet supported. For more information about data types, check Snowflake docs.