snowflake.Listing

!> Warning Versioning only works if your listing ever sourced the manifest from stage. This is a Snowflake limitation.

!> Warning External changes to the manifest (inlined and staged) won’t be detected by the provider automatically. You need to manually trigger updates when manifest content changes.

!> Warning This resource isn’t suitable for public listings because its review process doesn’t align with Terraform’s standard method for managing infrastructure resources. The challenge is that the review process often takes time and might need several manual revisions. We need to reconsider how to integrate this process into a resource. Although we plan to support this in the future, it might be added later. Currently, the resource may not function well with public listings because review requests are closely connected to the publish field.

!> Warning To use external resources in your manifest (e.g., company logo) you must be sourcing your manifest from a stage. Any references to external resources are relative to the manifest location in the stage.

!> Warning Currently, this resource doesn’t support organization listings. We plan to add support for this in the future (through separate parameter or entirely new resource). There is a workaround for this provided in this issue: #3982, but beware that in the next major version of the provider such workarounds may not be allowed.

Note When using manifest from stage, the change in either stage id, location, or version will create a new listing version that can be seen by calling the SHOW VERSIONS IN LISTING command.

Note For inlined manifest version, only string is accepted. The manifest structure is not mapped to the resource schema to keep it simple and aligned with other resources that accept similar metadata (e.g., service templates). While it’s more recommended to keep your manifest in a stage, the inlined version may be useful for initial setup and testing.

Note For manifest reference visit Snowflake’s listing manifest reference documentation.

Note To use listings in gov deployments, please read the Government providers documentation first.

Resource used to manage listing objects. For more information, check listing documentation.

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

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

The Listing resource accepts the following input properties:

Outputs

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

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}

Supporting Types

ListingManifest, ListingManifestArgs

ListingManifestFromStage, ListingManifestFromStageArgs

ListingShowOutput, ListingShowOutputArgs

Import

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

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository

Snowflake pulumi/pulumi-snowflake

License

Apache-2.0

Notes

This Pulumi package is based on the snowflake Terraform Provider.