Snowflake v0.61.1, Nov 14 24

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

snowflake.ObjectParameter

Explore with Pulumi AI

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

Import

$ pulumi import snowflake:index/objectParameter:ObjectParameter s <key>❄️<object_type>❄️<object_identifier>

Create ObjectParameter Resource

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

Constructor syntax

new ObjectParameter(name: string, args: ObjectParameterArgs, opts?: CustomResourceOptions);

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

@overload
def ObjectParameter(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    key: Optional[str] = None,
                    value: Optional[str] = None,
                    object_identifiers: Optional[Sequence[ObjectParameterObjectIdentifierArgs]] = None,
                    object_type: Optional[str] = None,
                    on_account: Optional[bool] = None)

func NewObjectParameter(ctx *Context, name string, args ObjectParameterArgs, opts ...ResourceOption) (*ObjectParameter, error)

public ObjectParameter(string name, ObjectParameterArgs args, CustomResourceOptions? opts = null)

public ObjectParameter(String name, ObjectParameterArgs args)
public ObjectParameter(String name, ObjectParameterArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args ObjectParameterArgs: 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 objectParameterResource = new Snowflake.ObjectParameter("objectParameterResource", new()
{
    Key = "string",
    Value = "string",
    ObjectIdentifiers = new[]
    {
        new Snowflake.Inputs.ObjectParameterObjectIdentifierArgs
        {
            Name = "string",
            Database = "string",
            Schema = "string",
        },
    },
    ObjectType = "string",
    OnAccount = false,
});

example, err := snowflake.NewObjectParameter(ctx, "objectParameterResource", &snowflake.ObjectParameterArgs{
	Key:   pulumi.String("string"),
	Value: pulumi.String("string"),
	ObjectIdentifiers: snowflake.ObjectParameterObjectIdentifierArray{
		&snowflake.ObjectParameterObjectIdentifierArgs{
			Name:     pulumi.String("string"),
			Database: pulumi.String("string"),
			Schema:   pulumi.String("string"),
		},
	},
	ObjectType: pulumi.String("string"),
	OnAccount:  pulumi.Bool(false),
})

var objectParameterResource = new ObjectParameter("objectParameterResource", ObjectParameterArgs.builder()
    .key("string")
    .value("string")
    .objectIdentifiers(ObjectParameterObjectIdentifierArgs.builder()
        .name("string")
        .database("string")
        .schema("string")
        .build())
    .objectType("string")
    .onAccount(false)
    .build());

object_parameter_resource = snowflake.ObjectParameter("objectParameterResource",
    key="string",
    value="string",
    object_identifiers=[{
        "name": "string",
        "database": "string",
        "schema": "string",
    }],
    object_type="string",
    on_account=False)

const objectParameterResource = new snowflake.ObjectParameter("objectParameterResource", {
    key: "string",
    value: "string",
    objectIdentifiers: [{
        name: "string",
        database: "string",
        schema: "string",
    }],
    objectType: "string",
    onAccount: false,
});

type: snowflake:ObjectParameter
properties:
    key: string
    objectIdentifiers:
        - database: string
          name: string
          schema: string
    objectType: string
    onAccount: false
    value: string

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

Key string: Name of object parameter. Valid values are those in object parameters.
Value string: Value of object parameter, as a string. Constraints are the same as those for the parameters in Snowflake documentation.
ObjectIdentifiers List<ObjectParameterObjectIdentifier>: Specifies the object identifier for the object parameter. If no value is provided, then the resource will default to setting the object parameter at account level.
ObjectType string: Type of object to which the parameter applies. Valid values are those in object types. If no value is provided, then the resource will default to setting the object parameter at account level.
OnAccount bool: If true, the object parameter will be set on the account level.

Key string: Name of object parameter. Valid values are those in object parameters.
Value string: Value of object parameter, as a string. Constraints are the same as those for the parameters in Snowflake documentation.
ObjectIdentifiers []ObjectParameterObjectIdentifierArgs: Specifies the object identifier for the object parameter. If no value is provided, then the resource will default to setting the object parameter at account level.
ObjectType string: Type of object to which the parameter applies. Valid values are those in object types. If no value is provided, then the resource will default to setting the object parameter at account level.
OnAccount bool: If true, the object parameter will be set on the account level.

key String: Name of object parameter. Valid values are those in object parameters.
value String: Value of object parameter, as a string. Constraints are the same as those for the parameters in Snowflake documentation.
objectIdentifiers List<ObjectParameterObjectIdentifier>: Specifies the object identifier for the object parameter. If no value is provided, then the resource will default to setting the object parameter at account level.
objectType String: Type of object to which the parameter applies. Valid values are those in object types. If no value is provided, then the resource will default to setting the object parameter at account level.
onAccount Boolean: If true, the object parameter will be set on the account level.

key string: Name of object parameter. Valid values are those in object parameters.
value string: Value of object parameter, as a string. Constraints are the same as those for the parameters in Snowflake documentation.
objectIdentifiers ObjectParameterObjectIdentifier[]: Specifies the object identifier for the object parameter. If no value is provided, then the resource will default to setting the object parameter at account level.
objectType string: Type of object to which the parameter applies. Valid values are those in object types. If no value is provided, then the resource will default to setting the object parameter at account level.
onAccount boolean: If true, the object parameter will be set on the account level.

key str: Name of object parameter. Valid values are those in object parameters.
value str: Value of object parameter, as a string. Constraints are the same as those for the parameters in Snowflake documentation.
object_identifiers Sequence[ObjectParameterObjectIdentifierArgs]: Specifies the object identifier for the object parameter. If no value is provided, then the resource will default to setting the object parameter at account level.
object_type str: Type of object to which the parameter applies. Valid values are those in object types. If no value is provided, then the resource will default to setting the object parameter at account level.
on_account bool: If true, the object parameter will be set on the account level.

key String: Name of object parameter. Valid values are those in object parameters.
value String: Value of object parameter, as a string. Constraints are the same as those for the parameters in Snowflake documentation.
objectIdentifiers List<Property Map>: Specifies the object identifier for the object parameter. If no value is provided, then the resource will default to setting the object parameter at account level.
objectType String: Type of object to which the parameter applies. Valid values are those in object types. If no value is provided, then the resource will default to setting the object parameter at account level.
onAccount Boolean: If true, the object parameter will be set on the account level.

Outputs

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

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        key: Optional[str] = None,
        object_identifiers: Optional[Sequence[ObjectParameterObjectIdentifierArgs]] = None,
        object_type: Optional[str] = None,
        on_account: Optional[bool] = None,
        value: Optional[str] = None) -> ObjectParameter

func GetObjectParameter(ctx *Context, name string, id IDInput, state *ObjectParameterState, opts ...ResourceOption) (*ObjectParameter, error)

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

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

Key string: Name of object parameter. Valid values are those in object parameters.
ObjectIdentifiers List<ObjectParameterObjectIdentifier>: Specifies the object identifier for the object parameter. If no value is provided, then the resource will default to setting the object parameter at account level.
ObjectType string: Type of object to which the parameter applies. Valid values are those in object types. If no value is provided, then the resource will default to setting the object parameter at account level.
OnAccount bool: If true, the object parameter will be set on the account level.
Value string: Value of object parameter, as a string. Constraints are the same as those for the parameters in Snowflake documentation.

Key string: Name of object parameter. Valid values are those in object parameters.
ObjectIdentifiers []ObjectParameterObjectIdentifierArgs: Specifies the object identifier for the object parameter. If no value is provided, then the resource will default to setting the object parameter at account level.
ObjectType string: Type of object to which the parameter applies. Valid values are those in object types. If no value is provided, then the resource will default to setting the object parameter at account level.
OnAccount bool: If true, the object parameter will be set on the account level.
Value string: Value of object parameter, as a string. Constraints are the same as those for the parameters in Snowflake documentation.

key String: Name of object parameter. Valid values are those in object parameters.
objectIdentifiers List<ObjectParameterObjectIdentifier>: Specifies the object identifier for the object parameter. If no value is provided, then the resource will default to setting the object parameter at account level.
objectType String: Type of object to which the parameter applies. Valid values are those in object types. If no value is provided, then the resource will default to setting the object parameter at account level.
onAccount Boolean: If true, the object parameter will be set on the account level.
value String: Value of object parameter, as a string. Constraints are the same as those for the parameters in Snowflake documentation.

key string: Name of object parameter. Valid values are those in object parameters.
objectIdentifiers ObjectParameterObjectIdentifier[]: Specifies the object identifier for the object parameter. If no value is provided, then the resource will default to setting the object parameter at account level.
objectType string: Type of object to which the parameter applies. Valid values are those in object types. If no value is provided, then the resource will default to setting the object parameter at account level.
onAccount boolean: If true, the object parameter will be set on the account level.
value string: Value of object parameter, as a string. Constraints are the same as those for the parameters in Snowflake documentation.

key str: Name of object parameter. Valid values are those in object parameters.
object_identifiers Sequence[ObjectParameterObjectIdentifierArgs]: Specifies the object identifier for the object parameter. If no value is provided, then the resource will default to setting the object parameter at account level.
object_type str: Type of object to which the parameter applies. Valid values are those in object types. If no value is provided, then the resource will default to setting the object parameter at account level.
on_account bool: If true, the object parameter will be set on the account level.
value str: Value of object parameter, as a string. Constraints are the same as those for the parameters in Snowflake documentation.

key String: Name of object parameter. Valid values are those in object parameters.
objectIdentifiers List<Property Map>: Specifies the object identifier for the object parameter. If no value is provided, then the resource will default to setting the object parameter at account level.
objectType String: Type of object to which the parameter applies. Valid values are those in object types. If no value is provided, then the resource will default to setting the object parameter at account level.
onAccount Boolean: If true, the object parameter will be set on the account level.
value String: Value of object parameter, as a string. Constraints are the same as those for the parameters in Snowflake documentation.

Supporting Types

ObjectParameterObjectIdentifier, ObjectParameterObjectIdentifierArgs

Name string: Name of the object to set the parameter for.
Database string: Name of the database that the object was created in.
Schema string: Name of the schema that the object was created in.

Name string: Name of the object to set the parameter for.
Database string: Name of the database that the object was created in.
Schema string: Name of the schema that the object was created in.

name String: Name of the object to set the parameter for.
database String: Name of the database that the object was created in.
schema String: Name of the schema that the object was created in.

name string: Name of the object to set the parameter for.
database string: Name of the database that the object was created in.
schema string: Name of the schema that the object was created in.

name str: Name of the object to set the parameter for.
database str: Name of the database that the object was created in.
schema str: Name of the schema that the object was created in.

name String: Name of the object to set the parameter for.
database String: Name of the database that the object was created in.
schema String: Name of the schema that the object was created in.

Package Details

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

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

pulumi/pulumi-snowflake

snowflake.ObjectParameter

On this page

On this page

Import

Create ObjectParameter Resource

Constructor syntax

Parameters

Constructor example

ObjectParameter Resource Properties

Inputs

Outputs

Look up Existing ObjectParameter Resource

Supporting Types

ObjectParameterObjectIdentifier, ObjectParameterObjectIdentifierArgs

Package Details

On this page

On this page