Snowflake v2.4.0, Aug 8 25

Snowflake v2.4.0 published on Friday, Aug 8, 2025 by Pulumi

snowflake.Listing

Explore with Pulumi AI

Snowflake v2.4.0 published on Friday, Aug 8, 2025 by Pulumi

Import

$ pulumi import snowflake:index/listing:Listing example '"<listing_name>"'

Create Listing Resource

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

Constructor syntax

new Listing(name: string, args: ListingArgs, opts?: CustomResourceOptions);

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

@overload
def Listing(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            manifest: Optional[ListingManifestArgs] = None,
            application_package: Optional[str] = None,
            comment: Optional[str] = None,
            name: Optional[str] = None,
            publish: Optional[str] = None,
            share: Optional[str] = None)

func NewListing(ctx *Context, name string, args ListingArgs, opts ...ResourceOption) (*Listing, error)

public Listing(string name, ListingArgs args, CustomResourceOptions? opts = null)

public Listing(String name, ListingArgs args)
public Listing(String name, ListingArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args ListingArgs: 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 listingResource = new Snowflake.Listing("listingResource", new()
{
    Manifest = new Snowflake.Inputs.ListingManifestArgs
    {
        FromStage = new Snowflake.Inputs.ListingManifestFromStageArgs
        {
            Stage = "string",
            Location = "string",
            VersionComment = "string",
            VersionName = "string",
        },
        FromString = "string",
    },
    ApplicationPackage = "string",
    Comment = "string",
    Name = "string",
    Publish = "string",
    Share = "string",
});

example, err := snowflake.NewListing(ctx, "listingResource", &snowflake.ListingArgs{
	Manifest: &snowflake.ListingManifestArgs{
		FromStage: &snowflake.ListingManifestFromStageArgs{
			Stage:          pulumi.String("string"),
			Location:       pulumi.String("string"),
			VersionComment: pulumi.String("string"),
			VersionName:    pulumi.String("string"),
		},
		FromString: pulumi.String("string"),
	},
	ApplicationPackage: pulumi.String("string"),
	Comment:            pulumi.String("string"),
	Name:               pulumi.String("string"),
	Publish:            pulumi.String("string"),
	Share:              pulumi.String("string"),
})

var listingResource = new Listing("listingResource", ListingArgs.builder()
    .manifest(ListingManifestArgs.builder()
        .fromStage(ListingManifestFromStageArgs.builder()
            .stage("string")
            .location("string")
            .versionComment("string")
            .versionName("string")
            .build())
        .fromString("string")
        .build())
    .applicationPackage("string")
    .comment("string")
    .name("string")
    .publish("string")
    .share("string")
    .build());

listing_resource = snowflake.Listing("listingResource",
    manifest={
        "from_stage": {
            "stage": "string",
            "location": "string",
            "version_comment": "string",
            "version_name": "string",
        },
        "from_string": "string",
    },
    application_package="string",
    comment="string",
    name="string",
    publish="string",
    share="string")

const listingResource = new snowflake.Listing("listingResource", {
    manifest: {
        fromStage: {
            stage: "string",
            location: "string",
            versionComment: "string",
            versionName: "string",
        },
        fromString: "string",
    },
    applicationPackage: "string",
    comment: "string",
    name: "string",
    publish: "string",
    share: "string",
});

type: snowflake:Listing
properties:
    applicationPackage: string
    comment: string
    manifest:
        fromStage:
            location: string
            stage: string
            versionComment: string
            versionName: string
        fromString: string
    name: string
    publish: string
    share: string

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

Manifest ListingManifest
ApplicationPackage string: Specifies the application package attached to the listing.
Comment string: Specifies a comment for the listing.
Name string: Specifies the listing identifier (name). It must be unique within the organization, regardless of which Snowflake region the account is located in. Must start with an alphabetic character and cannot contain spaces or special characters except for underscores.
Publish string: (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Determines if the listing should be published.
Share string: Specifies the identifier for the share to attach to the listing.

Manifest ListingManifestArgs
ApplicationPackage string: Specifies the application package attached to the listing.
Comment string: Specifies a comment for the listing.
Name string: Specifies the listing identifier (name). It must be unique within the organization, regardless of which Snowflake region the account is located in. Must start with an alphabetic character and cannot contain spaces or special characters except for underscores.
Publish string: (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Determines if the listing should be published.
Share string: Specifies the identifier for the share to attach to the listing.

manifest ListingManifest
applicationPackage String: Specifies the application package attached to the listing.
comment String: Specifies a comment for the listing.
name String: Specifies the listing identifier (name). It must be unique within the organization, regardless of which Snowflake region the account is located in. Must start with an alphabetic character and cannot contain spaces or special characters except for underscores.
publish String: (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Determines if the listing should be published.
share String: Specifies the identifier for the share to attach to the listing.

manifest ListingManifest
applicationPackage string: Specifies the application package attached to the listing.
comment string: Specifies a comment for the listing.
name string: Specifies the listing identifier (name). It must be unique within the organization, regardless of which Snowflake region the account is located in. Must start with an alphabetic character and cannot contain spaces or special characters except for underscores.
publish string: (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Determines if the listing should be published.
share string: Specifies the identifier for the share to attach to the listing.

manifest ListingManifestArgs
application_package str: Specifies the application package attached to the listing.
comment str: Specifies a comment for the listing.
name str: Specifies the listing identifier (name). It must be unique within the organization, regardless of which Snowflake region the account is located in. Must start with an alphabetic character and cannot contain spaces or special characters except for underscores.
publish str: (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Determines if the listing should be published.
share str: Specifies the identifier for the share to attach to the listing.

manifest Property Map
applicationPackage String: Specifies the application package attached to the listing.
comment String: Specifies a comment for the listing.
name String: Specifies the listing identifier (name). It must be unique within the organization, regardless of which Snowflake region the account is located in. Must start with an alphabetic character and cannot contain spaces or special characters except for underscores.
publish String: (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Determines if the listing should be published.
share String: Specifies the identifier for the share to attach to the listing.

Outputs

All input properties are implicitly available as output properties. Additionally, the Listing 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.
ShowOutputs List<ListingShowOutput>: Outputs the result of SHOW LISTINGS for the given listing.

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 []ListingShowOutput: Outputs the result of SHOW LISTINGS for the given listing.

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<ListingShowOutput>: Outputs the result of SHOW LISTINGS for the given listing.

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 ListingShowOutput[]: Outputs the result of SHOW LISTINGS for the given listing.

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[ListingShowOutput]: Outputs the result of SHOW LISTINGS for the given listing.

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 LISTINGS for the given listing.

Look up Existing Listing Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        application_package: Optional[str] = None,
        comment: Optional[str] = None,
        fully_qualified_name: Optional[str] = None,
        manifest: Optional[ListingManifestArgs] = None,
        name: Optional[str] = None,
        publish: Optional[str] = None,
        share: Optional[str] = None,
        show_outputs: Optional[Sequence[ListingShowOutputArgs]] = None) -> Listing

func GetListing(ctx *Context, name string, id IDInput, state *ListingState, opts ...ResourceOption) (*Listing, error)

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

public static Listing get(String name, Output<String> id, ListingState state, CustomResourceOptions options)

resources:  _:    type: snowflake:Listing    get:      id: ${id}

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:

ApplicationPackage string: Specifies the application package attached to the listing.
Comment string: Specifies a comment for the listing.
FullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
Manifest ListingManifest
Name string: Specifies the listing identifier (name). It must be unique within the organization, regardless of which Snowflake region the account is located in. Must start with an alphabetic character and cannot contain spaces or special characters except for underscores.
Publish string: (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Determines if the listing should be published.
Share string: Specifies the identifier for the share to attach to the listing.
ShowOutputs List<ListingShowOutput>: Outputs the result of SHOW LISTINGS for the given listing.

ApplicationPackage string: Specifies the application package attached to the listing.
Comment string: Specifies a comment for the listing.
FullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
Manifest ListingManifestArgs
Name string: Specifies the listing identifier (name). It must be unique within the organization, regardless of which Snowflake region the account is located in. Must start with an alphabetic character and cannot contain spaces or special characters except for underscores.
Publish string: (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Determines if the listing should be published.
Share string: Specifies the identifier for the share to attach to the listing.
ShowOutputs []ListingShowOutputArgs: Outputs the result of SHOW LISTINGS for the given listing.

applicationPackage String: Specifies the application package attached to the listing.
comment String: Specifies a comment for the listing.
fullyQualifiedName String: Fully qualified name of the resource. For more information, see object name resolution.
manifest ListingManifest
name String: Specifies the listing identifier (name). It must be unique within the organization, regardless of which Snowflake region the account is located in. Must start with an alphabetic character and cannot contain spaces or special characters except for underscores.
publish String: (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Determines if the listing should be published.
share String: Specifies the identifier for the share to attach to the listing.
showOutputs List<ListingShowOutput>: Outputs the result of SHOW LISTINGS for the given listing.

applicationPackage string: Specifies the application package attached to the listing.
comment string: Specifies a comment for the listing.
fullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
manifest ListingManifest
name string: Specifies the listing identifier (name). It must be unique within the organization, regardless of which Snowflake region the account is located in. Must start with an alphabetic character and cannot contain spaces or special characters except for underscores.
publish string: (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Determines if the listing should be published.
share string: Specifies the identifier for the share to attach to the listing.
showOutputs ListingShowOutput[]: Outputs the result of SHOW LISTINGS for the given listing.

application_package str: Specifies the application package attached to the listing.
comment str: Specifies a comment for the listing.
fully_qualified_name str: Fully qualified name of the resource. For more information, see object name resolution.
manifest ListingManifestArgs
name str: Specifies the listing identifier (name). It must be unique within the organization, regardless of which Snowflake region the account is located in. Must start with an alphabetic character and cannot contain spaces or special characters except for underscores.
publish str: (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Determines if the listing should be published.
share str: Specifies the identifier for the share to attach to the listing.
show_outputs Sequence[ListingShowOutputArgs]: Outputs the result of SHOW LISTINGS for the given listing.

applicationPackage String: Specifies the application package attached to the listing.
comment String: Specifies a comment for the listing.
fullyQualifiedName String: Fully qualified name of the resource. For more information, see object name resolution.
manifest Property Map
name String: Specifies the listing identifier (name). It must be unique within the organization, regardless of which Snowflake region the account is located in. Must start with an alphabetic character and cannot contain spaces or special characters except for underscores.
publish String: (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Determines if the listing should be published.
share String: Specifies the identifier for the share to attach to the listing.
showOutputs List<Property Map>: Outputs the result of SHOW LISTINGS for the given listing.

Supporting Types

ListingManifest, ListingManifestArgs

FromStage ListingManifestFromStage: Manifest provided from a given stage. If the manifest file is in the root, only stage needs to be passed. For more information on manifest syntax, see Listing manifest reference. A proper YAML indentation (2 spaces) is required.
FromString string: Manifest provided as a string. Wrapping $$ signs are added by the provider automatically; do not include them. For more information on manifest syntax, see Listing manifest reference. Also, the multiline string syntax is a must here. A proper YAML indentation (2 spaces) is required.

FromStage ListingManifestFromStage: Manifest provided from a given stage. If the manifest file is in the root, only stage needs to be passed. For more information on manifest syntax, see Listing manifest reference. A proper YAML indentation (2 spaces) is required.
FromString string: Manifest provided as a string. Wrapping $$ signs are added by the provider automatically; do not include them. For more information on manifest syntax, see Listing manifest reference. Also, the multiline string syntax is a must here. A proper YAML indentation (2 spaces) is required.

fromStage ListingManifestFromStage: Manifest provided from a given stage. If the manifest file is in the root, only stage needs to be passed. For more information on manifest syntax, see Listing manifest reference. A proper YAML indentation (2 spaces) is required.
fromString String: Manifest provided as a string. Wrapping $$ signs are added by the provider automatically; do not include them. For more information on manifest syntax, see Listing manifest reference. Also, the multiline string syntax is a must here. A proper YAML indentation (2 spaces) is required.

fromStage ListingManifestFromStage: Manifest provided from a given stage. If the manifest file is in the root, only stage needs to be passed. For more information on manifest syntax, see Listing manifest reference. A proper YAML indentation (2 spaces) is required.
fromString string: Manifest provided as a string. Wrapping $$ signs are added by the provider automatically; do not include them. For more information on manifest syntax, see Listing manifest reference. Also, the multiline string syntax is a must here. A proper YAML indentation (2 spaces) is required.

from_stage ListingManifestFromStage: Manifest provided from a given stage. If the manifest file is in the root, only stage needs to be passed. For more information on manifest syntax, see Listing manifest reference. A proper YAML indentation (2 spaces) is required.
from_string str: Manifest provided as a string. Wrapping $$ signs are added by the provider automatically; do not include them. For more information on manifest syntax, see Listing manifest reference. Also, the multiline string syntax is a must here. A proper YAML indentation (2 spaces) is required.

fromStage Property Map: Manifest provided from a given stage. If the manifest file is in the root, only stage needs to be passed. For more information on manifest syntax, see Listing manifest reference. A proper YAML indentation (2 spaces) is required.
fromString String: Manifest provided as a string. Wrapping $$ signs are added by the provider automatically; do not include them. For more information on manifest syntax, see Listing manifest reference. Also, the multiline string syntax is a must here. A proper YAML indentation (2 spaces) is required.

ListingManifestFromStage, ListingManifestFromStageArgs

Stage string: Identifier of the stage where the manifest file is located.
Location string: Location of the manifest file in the stage. If not specified, the manifest file will be expected to be at the root of the stage.
VersionComment string: Specifies a comment for the listing version. Whenever a new version is created, this comment will be associated with it. The comment on the version will be visible in the SHOW VERSIONS IN LISTING command output.
VersionName string: Represents manifest version name. It's case-sensitive and used in manifest versioning. Version name should be specified or changed whenever any changes in the manifest should be applied to the listing. Later on the versions of the listing can be analyzed by calling the SHOW VERSIONS IN LISTING command. The resource does not track the changes on the specified stage.

Stage string: Identifier of the stage where the manifest file is located.
Location string: Location of the manifest file in the stage. If not specified, the manifest file will be expected to be at the root of the stage.
VersionComment string: Specifies a comment for the listing version. Whenever a new version is created, this comment will be associated with it. The comment on the version will be visible in the SHOW VERSIONS IN LISTING command output.
VersionName string: Represents manifest version name. It's case-sensitive and used in manifest versioning. Version name should be specified or changed whenever any changes in the manifest should be applied to the listing. Later on the versions of the listing can be analyzed by calling the SHOW VERSIONS IN LISTING command. The resource does not track the changes on the specified stage.

stage String: Identifier of the stage where the manifest file is located.
location String: Location of the manifest file in the stage. If not specified, the manifest file will be expected to be at the root of the stage.
versionComment String: Specifies a comment for the listing version. Whenever a new version is created, this comment will be associated with it. The comment on the version will be visible in the SHOW VERSIONS IN LISTING command output.
versionName String: Represents manifest version name. It's case-sensitive and used in manifest versioning. Version name should be specified or changed whenever any changes in the manifest should be applied to the listing. Later on the versions of the listing can be analyzed by calling the SHOW VERSIONS IN LISTING command. The resource does not track the changes on the specified stage.

stage string: Identifier of the stage where the manifest file is located.
location string: Location of the manifest file in the stage. If not specified, the manifest file will be expected to be at the root of the stage.
versionComment string: Specifies a comment for the listing version. Whenever a new version is created, this comment will be associated with it. The comment on the version will be visible in the SHOW VERSIONS IN LISTING command output.
versionName string: Represents manifest version name. It's case-sensitive and used in manifest versioning. Version name should be specified or changed whenever any changes in the manifest should be applied to the listing. Later on the versions of the listing can be analyzed by calling the SHOW VERSIONS IN LISTING command. The resource does not track the changes on the specified stage.

stage str: Identifier of the stage where the manifest file is located.
location str: Location of the manifest file in the stage. If not specified, the manifest file will be expected to be at the root of the stage.
version_comment str: Specifies a comment for the listing version. Whenever a new version is created, this comment will be associated with it. The comment on the version will be visible in the SHOW VERSIONS IN LISTING command output.
version_name str: Represents manifest version name. It's case-sensitive and used in manifest versioning. Version name should be specified or changed whenever any changes in the manifest should be applied to the listing. Later on the versions of the listing can be analyzed by calling the SHOW VERSIONS IN LISTING command. The resource does not track the changes on the specified stage.

stage String: Identifier of the stage where the manifest file is located.
location String: Location of the manifest file in the stage. If not specified, the manifest file will be expected to be at the root of the stage.
versionComment String: Specifies a comment for the listing version. Whenever a new version is created, this comment will be associated with it. The comment on the version will be visible in the SHOW VERSIONS IN LISTING command output.
versionName String: Represents manifest version name. It's case-sensitive and used in manifest versioning. Version name should be specified or changed whenever any changes in the manifest should be applied to the listing. Later on the versions of the listing can be analyzed by calling the SHOW VERSIONS IN LISTING command. The resource does not track the changes on the specified stage.