1. Packages
  2. Snowflake
  3. API Docs
  4. Share
Snowflake v0.50.2 published on Friday, Mar 8, 2024 by Pulumi

snowflake.Share

Explore with Pulumi AI

snowflake logo
Snowflake v0.50.2 published on Friday, Mar 8, 2024 by Pulumi

    Import

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

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Snowflake = Pulumi.Snowflake;
    
    return await Deployment.RunAsync(() => 
    {
        var test = new Snowflake.Share("test", new()
        {
            Comment = "cool comment",
            Accounts = new[]
            {
                "organizationName.accountName",
            },
        });
    
        var example = new Snowflake.Database("example", new()
        {
        }, new CustomResourceOptions
        {
            DependsOn = new[]
            {
                test,
            },
        });
    
    });
    
    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 {
    		test, err := snowflake.NewShare(ctx, "test", &snowflake.ShareArgs{
    			Comment: pulumi.String("cool comment"),
    			Accounts: pulumi.StringArray{
    				pulumi.String("organizationName.accountName"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = snowflake.NewDatabase(ctx, "example", nil, pulumi.DependsOn([]pulumi.Resource{
    			test,
    		}))
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.snowflake.Share;
    import com.pulumi.snowflake.ShareArgs;
    import com.pulumi.snowflake.Database;
    import com.pulumi.snowflake.DatabaseArgs;
    import com.pulumi.resources.CustomResourceOptions;
    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 test = new Share("test", ShareArgs.builder()        
                .comment("cool comment")
                .accounts("organizationName.accountName")
                .build());
    
            var example = new Database("example", DatabaseArgs.Empty, CustomResourceOptions.builder()
                .dependsOn(test)
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_snowflake as snowflake
    
    test = snowflake.Share("test",
        comment="cool comment",
        accounts=["organizationName.accountName"])
    example = snowflake.Database("example", opts=pulumi.ResourceOptions(depends_on=[test]))
    
    import * as pulumi from "@pulumi/pulumi";
    import * as snowflake from "@pulumi/snowflake";
    
    const test = new snowflake.Share("test", {
        comment: "cool comment",
        accounts: ["organizationName.accountName"],
    });
    const example = new snowflake.Database("example", {}, {
        dependsOn: [test],
    });
    
    resources:
      test:
        type: snowflake:Share
        properties:
          comment: cool comment
          accounts:
            - organizationName.accountName
      example:
        type: snowflake:Database
        options:
          dependson:
            - ${test}
    

    Create Share Resource

    new Share(name: string, args?: ShareArgs, opts?: CustomResourceOptions);
    @overload
    def Share(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              accounts: Optional[Sequence[str]] = None,
              comment: Optional[str] = None,
              name: Optional[str] = None)
    @overload
    def Share(resource_name: str,
              args: Optional[ShareArgs] = None,
              opts: Optional[ResourceOptions] = 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.
    
    
    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.

    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

    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:

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

    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.50.2 published on Friday, Mar 8, 2024 by Pulumi