Snowflake v0.61.1, Nov 14 24

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

snowflake.Streamlit

Explore with Pulumi AI

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

pulumi/pulumi-snowflake

Import

format is <database_name>.<schema_name>.<streamlit_name>

$ pulumi import snowflake:index/streamlit:Streamlit example '"<database_name>"."<schema_name>"."<streamlit_name>"'

Create Streamlit Resource

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

Constructor syntax

new Streamlit(name: string, args: StreamlitArgs, opts?: CustomResourceOptions);

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

@overload
def Streamlit(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              database: Optional[str] = None,
              main_file: Optional[str] = None,
              schema: Optional[str] = None,
              stage: Optional[str] = None,
              comment: Optional[str] = None,
              directory_location: Optional[str] = None,
              external_access_integrations: Optional[Sequence[str]] = None,
              name: Optional[str] = None,
              query_warehouse: Optional[str] = None,
              title: Optional[str] = None)

func NewStreamlit(ctx *Context, name string, args StreamlitArgs, opts ...ResourceOption) (*Streamlit, error)

public Streamlit(string name, StreamlitArgs args, CustomResourceOptions? opts = null)

public Streamlit(String name, StreamlitArgs args)
public Streamlit(String name, StreamlitArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args StreamlitArgs: 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 streamlitResource = new Snowflake.Streamlit("streamlitResource", new()
{
    Database = "string",
    MainFile = "string",
    Schema = "string",
    Stage = "string",
    Comment = "string",
    DirectoryLocation = "string",
    ExternalAccessIntegrations = new[]
    {
        "string",
    },
    Name = "string",
    QueryWarehouse = "string",
    Title = "string",
});

example, err := snowflake.NewStreamlit(ctx, "streamlitResource", &snowflake.StreamlitArgs{
	Database:          pulumi.String("string"),
	MainFile:          pulumi.String("string"),
	Schema:            pulumi.String("string"),
	Stage:             pulumi.String("string"),
	Comment:           pulumi.String("string"),
	DirectoryLocation: pulumi.String("string"),
	ExternalAccessIntegrations: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name:           pulumi.String("string"),
	QueryWarehouse: pulumi.String("string"),
	Title:          pulumi.String("string"),
})

var streamlitResource = new Streamlit("streamlitResource", StreamlitArgs.builder()
    .database("string")
    .mainFile("string")
    .schema("string")
    .stage("string")
    .comment("string")
    .directoryLocation("string")
    .externalAccessIntegrations("string")
    .name("string")
    .queryWarehouse("string")
    .title("string")
    .build());

streamlit_resource = snowflake.Streamlit("streamlitResource",
    database="string",
    main_file="string",
    schema="string",
    stage="string",
    comment="string",
    directory_location="string",
    external_access_integrations=["string"],
    name="string",
    query_warehouse="string",
    title="string")

const streamlitResource = new snowflake.Streamlit("streamlitResource", {
    database: "string",
    mainFile: "string",
    schema: "string",
    stage: "string",
    comment: "string",
    directoryLocation: "string",
    externalAccessIntegrations: ["string"],
    name: "string",
    queryWarehouse: "string",
    title: "string",
});

type: snowflake:Streamlit
properties:
    comment: string
    database: string
    directoryLocation: string
    externalAccessIntegrations:
        - string
    mainFile: string
    name: string
    queryWarehouse: string
    schema: string
    stage: string
    title: string

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

Database string: The database in which to create the streamlit
MainFile string: Specifies the filename of the Streamlit Python application. This filename is relative to the value of root_location
Schema string: The schema in which to create the streamlit.
Stage string: The stage in which streamlit files are located.
Comment string: Specifies a comment for the streamlit.
DirectoryLocation string: Specifies the full path to the named stage containing the Streamlit Python files, media files, and the environment.yml file.
ExternalAccessIntegrations List<string>: External access integrations connected to the Streamlit.
Name string: String that specifies the identifier (i.e. name) for the streamlit; must be unique in your account.
QueryWarehouse string: Specifies the warehouse where SQL queries issued by the Streamlit application are run.
Title string: Specifies a title for the Streamlit app to display in Snowsight.

Database string: The database in which to create the streamlit
MainFile string: Specifies the filename of the Streamlit Python application. This filename is relative to the value of root_location
Schema string: The schema in which to create the streamlit.
Stage string: The stage in which streamlit files are located.
Comment string: Specifies a comment for the streamlit.
DirectoryLocation string: Specifies the full path to the named stage containing the Streamlit Python files, media files, and the environment.yml file.
ExternalAccessIntegrations []string: External access integrations connected to the Streamlit.
Name string: String that specifies the identifier (i.e. name) for the streamlit; must be unique in your account.
QueryWarehouse string: Specifies the warehouse where SQL queries issued by the Streamlit application are run.
Title string: Specifies a title for the Streamlit app to display in Snowsight.

database String: The database in which to create the streamlit
mainFile String: Specifies the filename of the Streamlit Python application. This filename is relative to the value of root_location
schema String: The schema in which to create the streamlit.
stage String: The stage in which streamlit files are located.
comment String: Specifies a comment for the streamlit.
directoryLocation String: Specifies the full path to the named stage containing the Streamlit Python files, media files, and the environment.yml file.
externalAccessIntegrations List<String>: External access integrations connected to the Streamlit.
name String: String that specifies the identifier (i.e. name) for the streamlit; must be unique in your account.
queryWarehouse String: Specifies the warehouse where SQL queries issued by the Streamlit application are run.
title String: Specifies a title for the Streamlit app to display in Snowsight.

database string: The database in which to create the streamlit
mainFile string: Specifies the filename of the Streamlit Python application. This filename is relative to the value of root_location
schema string: The schema in which to create the streamlit.
stage string: The stage in which streamlit files are located.
comment string: Specifies a comment for the streamlit.
directoryLocation string: Specifies the full path to the named stage containing the Streamlit Python files, media files, and the environment.yml file.
externalAccessIntegrations string[]: External access integrations connected to the Streamlit.
name string: String that specifies the identifier (i.e. name) for the streamlit; must be unique in your account.
queryWarehouse string: Specifies the warehouse where SQL queries issued by the Streamlit application are run.
title string: Specifies a title for the Streamlit app to display in Snowsight.

database str: The database in which to create the streamlit
main_file str: Specifies the filename of the Streamlit Python application. This filename is relative to the value of root_location
schema str: The schema in which to create the streamlit.
stage str: The stage in which streamlit files are located.
comment str: Specifies a comment for the streamlit.
directory_location str: Specifies the full path to the named stage containing the Streamlit Python files, media files, and the environment.yml file.
external_access_integrations Sequence[str]: External access integrations connected to the Streamlit.
name str: String that specifies the identifier (i.e. name) for the streamlit; must be unique in your account.
query_warehouse str: Specifies the warehouse where SQL queries issued by the Streamlit application are run.
title str: Specifies a title for the Streamlit app to display in Snowsight.

database String: The database in which to create the streamlit
mainFile String: Specifies the filename of the Streamlit Python application. This filename is relative to the value of root_location
schema String: The schema in which to create the streamlit.
stage String: The stage in which streamlit files are located.
comment String: Specifies a comment for the streamlit.
directoryLocation String: Specifies the full path to the named stage containing the Streamlit Python files, media files, and the environment.yml file.
externalAccessIntegrations List<String>: External access integrations connected to the Streamlit.
name String: String that specifies the identifier (i.e. name) for the streamlit; must be unique in your account.
queryWarehouse String: Specifies the warehouse where SQL queries issued by the Streamlit application are run.
title String: Specifies a title for the Streamlit app to display in Snowsight.

Outputs

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

DescribeOutputs List<StreamlitDescribeOutput>: Outputs the result of DESCRIBE STREAMLIT for the given streamlit.
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<StreamlitShowOutput>: Outputs the result of SHOW STREAMLIT for the given streamlit.

DescribeOutputs []StreamlitDescribeOutput: Outputs the result of DESCRIBE STREAMLIT for the given streamlit.
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 []StreamlitShowOutput: Outputs the result of SHOW STREAMLIT for the given streamlit.

describeOutputs List<StreamlitDescribeOutput>: Outputs the result of DESCRIBE STREAMLIT for the given streamlit.
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<StreamlitShowOutput>: Outputs the result of SHOW STREAMLIT for the given streamlit.

describeOutputs StreamlitDescribeOutput[]: Outputs the result of DESCRIBE STREAMLIT for the given streamlit.
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 StreamlitShowOutput[]: Outputs the result of SHOW STREAMLIT for the given streamlit.

describe_outputs Sequence[StreamlitDescribeOutput]: Outputs the result of DESCRIBE STREAMLIT for the given streamlit.
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[StreamlitShowOutput]: Outputs the result of SHOW STREAMLIT for the given streamlit.

describeOutputs List<Property Map>: Outputs the result of DESCRIBE STREAMLIT for the given streamlit.
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 STREAMLIT for the given streamlit.

Look up Existing Streamlit Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comment: Optional[str] = None,
        database: Optional[str] = None,
        describe_outputs: Optional[Sequence[StreamlitDescribeOutputArgs]] = None,
        directory_location: Optional[str] = None,
        external_access_integrations: Optional[Sequence[str]] = None,
        fully_qualified_name: Optional[str] = None,
        main_file: Optional[str] = None,
        name: Optional[str] = None,
        query_warehouse: Optional[str] = None,
        schema: Optional[str] = None,
        show_outputs: Optional[Sequence[StreamlitShowOutputArgs]] = None,
        stage: Optional[str] = None,
        title: Optional[str] = None) -> Streamlit

func GetStreamlit(ctx *Context, name string, id IDInput, state *StreamlitState, opts ...ResourceOption) (*Streamlit, error)

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

public static Streamlit get(String name, Output<String> id, StreamlitState 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: Specifies a comment for the streamlit.
Database string: The database in which to create the streamlit
DescribeOutputs List<StreamlitDescribeOutput>: Outputs the result of DESCRIBE STREAMLIT for the given streamlit.
DirectoryLocation string: Specifies the full path to the named stage containing the Streamlit Python files, media files, and the environment.yml file.
ExternalAccessIntegrations List<string>: External access integrations connected to the Streamlit.
FullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
MainFile string: Specifies the filename of the Streamlit Python application. This filename is relative to the value of root_location
Name string: String that specifies the identifier (i.e. name) for the streamlit; must be unique in your account.
QueryWarehouse string: Specifies the warehouse where SQL queries issued by the Streamlit application are run.
Schema string: The schema in which to create the streamlit.
ShowOutputs List<StreamlitShowOutput>: Outputs the result of SHOW STREAMLIT for the given streamlit.
Stage string: The stage in which streamlit files are located.
Title string: Specifies a title for the Streamlit app to display in Snowsight.

Comment string: Specifies a comment for the streamlit.
Database string: The database in which to create the streamlit
DescribeOutputs []StreamlitDescribeOutputArgs: Outputs the result of DESCRIBE STREAMLIT for the given streamlit.
DirectoryLocation string: Specifies the full path to the named stage containing the Streamlit Python files, media files, and the environment.yml file.
ExternalAccessIntegrations []string: External access integrations connected to the Streamlit.
FullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
MainFile string: Specifies the filename of the Streamlit Python application. This filename is relative to the value of root_location
Name string: String that specifies the identifier (i.e. name) for the streamlit; must be unique in your account.
QueryWarehouse string: Specifies the warehouse where SQL queries issued by the Streamlit application are run.
Schema string: The schema in which to create the streamlit.
ShowOutputs []StreamlitShowOutputArgs: Outputs the result of SHOW STREAMLIT for the given streamlit.
Stage string: The stage in which streamlit files are located.
Title string: Specifies a title for the Streamlit app to display in Snowsight.

comment String: Specifies a comment for the streamlit.
database String: The database in which to create the streamlit
describeOutputs List<StreamlitDescribeOutput>: Outputs the result of DESCRIBE STREAMLIT for the given streamlit.
directoryLocation String: Specifies the full path to the named stage containing the Streamlit Python files, media files, and the environment.yml file.
externalAccessIntegrations List<String>: External access integrations connected to the Streamlit.
fullyQualifiedName String: Fully qualified name of the resource. For more information, see object name resolution.
mainFile String: Specifies the filename of the Streamlit Python application. This filename is relative to the value of root_location
name String: String that specifies the identifier (i.e. name) for the streamlit; must be unique in your account.
queryWarehouse String: Specifies the warehouse where SQL queries issued by the Streamlit application are run.
schema String: The schema in which to create the streamlit.
showOutputs List<StreamlitShowOutput>: Outputs the result of SHOW STREAMLIT for the given streamlit.
stage String: The stage in which streamlit files are located.
title String: Specifies a title for the Streamlit app to display in Snowsight.

comment string: Specifies a comment for the streamlit.
database string: The database in which to create the streamlit
describeOutputs StreamlitDescribeOutput[]: Outputs the result of DESCRIBE STREAMLIT for the given streamlit.
directoryLocation string: Specifies the full path to the named stage containing the Streamlit Python files, media files, and the environment.yml file.
externalAccessIntegrations string[]: External access integrations connected to the Streamlit.
fullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
mainFile string: Specifies the filename of the Streamlit Python application. This filename is relative to the value of root_location
name string: String that specifies the identifier (i.e. name) for the streamlit; must be unique in your account.
queryWarehouse string: Specifies the warehouse where SQL queries issued by the Streamlit application are run.
schema string: The schema in which to create the streamlit.
showOutputs StreamlitShowOutput[]: Outputs the result of SHOW STREAMLIT for the given streamlit.
stage string: The stage in which streamlit files are located.
title string: Specifies a title for the Streamlit app to display in Snowsight.

comment str: Specifies a comment for the streamlit.
database str: The database in which to create the streamlit
describe_outputs Sequence[StreamlitDescribeOutputArgs]: Outputs the result of DESCRIBE STREAMLIT for the given streamlit.
directory_location str: Specifies the full path to the named stage containing the Streamlit Python files, media files, and the environment.yml file.
external_access_integrations Sequence[str]: External access integrations connected to the Streamlit.
fully_qualified_name str: Fully qualified name of the resource. For more information, see object name resolution.
main_file str: Specifies the filename of the Streamlit Python application. This filename is relative to the value of root_location
name str: String that specifies the identifier (i.e. name) for the streamlit; must be unique in your account.
query_warehouse str: Specifies the warehouse where SQL queries issued by the Streamlit application are run.
schema str: The schema in which to create the streamlit.
show_outputs Sequence[StreamlitShowOutputArgs]: Outputs the result of SHOW STREAMLIT for the given streamlit.
stage str: The stage in which streamlit files are located.
title str: Specifies a title for the Streamlit app to display in Snowsight.

comment String: Specifies a comment for the streamlit.
database String: The database in which to create the streamlit
describeOutputs List<Property Map>: Outputs the result of DESCRIBE STREAMLIT for the given streamlit.
directoryLocation String: Specifies the full path to the named stage containing the Streamlit Python files, media files, and the environment.yml file.
externalAccessIntegrations List<String>: External access integrations connected to the Streamlit.
fullyQualifiedName String: Fully qualified name of the resource. For more information, see object name resolution.
mainFile String: Specifies the filename of the Streamlit Python application. This filename is relative to the value of root_location
name String: String that specifies the identifier (i.e. name) for the streamlit; must be unique in your account.
queryWarehouse String: Specifies the warehouse where SQL queries issued by the Streamlit application are run.
schema String: The schema in which to create the streamlit.
showOutputs List<Property Map>: Outputs the result of SHOW STREAMLIT for the given streamlit.
stage String: The stage in which streamlit files are located.
title String: Specifies a title for the Streamlit app to display in Snowsight.