Snowflake v0.61.1, Nov 14 24

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

snowflake.Share

Explore with Pulumi AI

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

Import

$ pulumi import snowflake:index/share:Share example name

Create Share Resource

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

Constructor syntax

new Share(name: string, args?: ShareArgs, opts?: CustomResourceOptions);

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

@overload
def Share(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          accounts: Optional[Sequence[str]] = None,
          comment: Optional[str] = None,
          name: Optional[str] = None)

func NewShare(ctx *Context, name string, args *ShareArgs, opts ...ResourceOption) (*Share, error)

public Share(string name, ShareArgs? args = null, CustomResourceOptions? opts = null)

public Share(String name, ShareArgs args)
public Share(String name, ShareArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args ShareArgs: 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 shareResource = new Snowflake.Share("shareResource", new()
{
    Accounts = new[]
    {
        "string",
    },
    Comment = "string",
    Name = "string",
});

example, err := snowflake.NewShare(ctx, "shareResource", &snowflake.ShareArgs{
	Accounts: pulumi.StringArray{
		pulumi.String("string"),
	},
	Comment: pulumi.String("string"),
	Name:    pulumi.String("string"),
})

var shareResource = new Share("shareResource", ShareArgs.builder()
    .accounts("string")
    .comment("string")
    .name("string")
    .build());

share_resource = snowflake.Share("shareResource",
    accounts=["string"],
    comment="string",
    name="string")

const shareResource = new snowflake.Share("shareResource", {
    accounts: ["string"],
    comment: "string",
    name: "string",
});

type: snowflake:Share
properties:
    accounts:
        - string
    comment: string
    name: string

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

Accounts List<string>: A list of accounts to be added to the share. Values should not be the account locator, but in the form of 'organizationname.accountname
Comment string: Specifies a comment for the managed account.
Name string: Specifies the identifier for the share; must be unique for the account in which the share is created.

Accounts []string: A list of accounts to be added to the share. Values should not be the account locator, but in the form of 'organizationname.accountname
Comment string: Specifies a comment for the managed account.
Name string: Specifies the identifier for the share; must be unique for the account in which the share is created.

accounts List<String>: A list of accounts to be added to the share. Values should not be the account locator, but in the form of 'organizationname.accountname
comment String: Specifies a comment for the managed account.
name String: Specifies the identifier for the share; must be unique for the account in which the share is created.

accounts string[]: A list of accounts to be added to the share. Values should not be the account locator, but in the form of 'organizationname.accountname
comment string: Specifies a comment for the managed account.
name string: Specifies the identifier for the share; must be unique for the account in which the share is created.

accounts Sequence[str]: A list of accounts to be added to the share. Values should not be the account locator, but in the form of 'organizationname.accountname
comment str: Specifies a comment for the managed account.
name str: Specifies the identifier for the share; must be unique for the account in which the share is created.

accounts List<String>: A list of accounts to be added to the share. Values should not be the account locator, but in the form of 'organizationname.accountname
comment String: Specifies a comment for the managed account.
name String: Specifies the identifier for the share; must be unique for the account in which the share is created.

Outputs

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

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.

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.

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.

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.

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.

Look up Existing Share Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        accounts: Optional[Sequence[str]] = None,
        comment: Optional[str] = None,
        fully_qualified_name: Optional[str] = None,
        name: Optional[str] = None) -> Share

func GetShare(ctx *Context, name string, id IDInput, state *ShareState, opts ...ResourceOption) (*Share, error)

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

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

Accounts List<string>: A list of accounts to be added to the share. Values should not be the account locator, but in the form of 'organizationname.accountname
Comment string: Specifies a comment for the managed account.
FullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
Name string: Specifies the identifier for the share; must be unique for the account in which the share is created.

Accounts []string: A list of accounts to be added to the share. Values should not be the account locator, but in the form of 'organizationname.accountname
Comment string: Specifies a comment for the managed account.
FullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
Name string: Specifies the identifier for the share; must be unique for the account in which the share is created.

accounts List<String>: A list of accounts to be added to the share. Values should not be the account locator, but in the form of 'organizationname.accountname
comment String: Specifies a comment for the managed account.
fullyQualifiedName String: Fully qualified name of the resource. For more information, see object name resolution.
name String: Specifies the identifier for the share; must be unique for the account in which the share is created.

accounts string[]: A list of accounts to be added to the share. Values should not be the account locator, but in the form of 'organizationname.accountname
comment string: Specifies a comment for the managed account.
fullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
name string: Specifies the identifier for the share; must be unique for the account in which the share is created.

accounts Sequence[str]: A list of accounts to be added to the share. Values should not be the account locator, but in the form of 'organizationname.accountname
comment str: Specifies a comment for the managed account.
fully_qualified_name str: Fully qualified name of the resource. For more information, see object name resolution.
name str: Specifies the identifier for the share; must be unique for the account in which the share is created.

accounts List<String>: A list of accounts to be added to the share. Values should not be the account locator, but in the form of 'organizationname.accountname
comment String: Specifies a comment for the managed account.
fullyQualifiedName String: Fully qualified name of the resource. For more information, see object name resolution.
name String: Specifies the identifier for the share; must be unique for the account in which the share is created.

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.Share

On this page

On this page

Import

Create Share Resource

Constructor syntax

Parameters

Constructor example

Share Resource Properties

Inputs

Outputs

Look up Existing Share Resource

Package Details

On this page

On this page