Note Quoted names for special characters or case-sensitive names are not supported. The same constraint also applies to database and schema names where you create an image repository. That is, database and schema names without quotes are valid when creating an image repository. This limitation in the provider follows the limitation in Snowflake (see docs). Please use only characters compatible with unquoted identifiers.
Resource used to manage image repositories. For more information, check image repositories documentation. Snowpark Container Services provides an OCIv2-compliant image registry service and a storage unit call repository to store images. See Working with an image registry and repository developer guide for more details.
Example Usage
Note Instead of using fully_qualified_name, you can reference objects managed outside Terraform by constructing a correct ID, consult identifiers guide.
import * as pulumi from "@pulumi/pulumi";
import * as snowflake from "@pulumi/snowflake";
// basic resource
const basic = new snowflake.ImageRepository("basic", {
database: "DATABASE",
schema: "SCHEMA",
name: "BASIC",
});
// complete resource
const complete = new snowflake.ImageRepository("complete", {
database: "DATABASE",
schema: "SCHEMA",
name: "BASIC",
comment: "An example image repository",
});
import pulumi
import pulumi_snowflake as snowflake
# basic resource
basic = snowflake.ImageRepository("basic",
database="DATABASE",
schema="SCHEMA",
name="BASIC")
# complete resource
complete = snowflake.ImageRepository("complete",
database="DATABASE",
schema="SCHEMA",
name="BASIC",
comment="An example image repository")
package main
import (
"github.com/pulumi/pulumi-snowflake/sdk/v2/go/snowflake"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
// basic resource
_, err := snowflake.NewImageRepository(ctx, "basic", &snowflake.ImageRepositoryArgs{
Database: pulumi.String("DATABASE"),
Schema: pulumi.String("SCHEMA"),
Name: pulumi.String("BASIC"),
})
if err != nil {
return err
}
// complete resource
_, err = snowflake.NewImageRepository(ctx, "complete", &snowflake.ImageRepositoryArgs{
Database: pulumi.String("DATABASE"),
Schema: pulumi.String("SCHEMA"),
Name: pulumi.String("BASIC"),
Comment: pulumi.String("An example image repository"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Snowflake = Pulumi.Snowflake;
return await Deployment.RunAsync(() =>
{
// basic resource
var basic = new Snowflake.ImageRepository("basic", new()
{
Database = "DATABASE",
Schema = "SCHEMA",
Name = "BASIC",
});
// complete resource
var complete = new Snowflake.ImageRepository("complete", new()
{
Database = "DATABASE",
Schema = "SCHEMA",
Name = "BASIC",
Comment = "An example image repository",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.snowflake.ImageRepository;
import com.pulumi.snowflake.ImageRepositoryArgs;
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) {
// basic resource
var basic = new ImageRepository("basic", ImageRepositoryArgs.builder()
.database("DATABASE")
.schema("SCHEMA")
.name("BASIC")
.build());
// complete resource
var complete = new ImageRepository("complete", ImageRepositoryArgs.builder()
.database("DATABASE")
.schema("SCHEMA")
.name("BASIC")
.comment("An example image repository")
.build());
}
}
resources:
# basic resource
basic:
type: snowflake:ImageRepository
properties:
database: DATABASE
schema: SCHEMA
name: BASIC
# complete resource
complete:
type: snowflake:ImageRepository
properties:
database: DATABASE
schema: SCHEMA
name: BASIC
comment: An example image repository
Note If a field has a default value, it is shown next to the type in the schema.
Create ImageRepository Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ImageRepository(name: string, args: ImageRepositoryArgs, opts?: CustomResourceOptions);@overload
def ImageRepository(resource_name: str,
args: ImageRepositoryArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ImageRepository(resource_name: str,
opts: Optional[ResourceOptions] = None,
database: Optional[str] = None,
schema: Optional[str] = None,
comment: Optional[str] = None,
name: Optional[str] = None)func NewImageRepository(ctx *Context, name string, args ImageRepositoryArgs, opts ...ResourceOption) (*ImageRepository, error)public ImageRepository(string name, ImageRepositoryArgs args, CustomResourceOptions? opts = null)
public ImageRepository(String name, ImageRepositoryArgs args)
public ImageRepository(String name, ImageRepositoryArgs args, CustomResourceOptions options)
type: snowflake:ImageRepository
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 ImageRepositoryArgs
- 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 ImageRepositoryArgs
- 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 ImageRepositoryArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ImageRepositoryArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ImageRepositoryArgs
- 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 imageRepositoryResource = new Snowflake.ImageRepository("imageRepositoryResource", new()
{
Database = "string",
Schema = "string",
Comment = "string",
Name = "string",
});
example, err := snowflake.NewImageRepository(ctx, "imageRepositoryResource", &snowflake.ImageRepositoryArgs{
Database: pulumi.String("string"),
Schema: pulumi.String("string"),
Comment: pulumi.String("string"),
Name: pulumi.String("string"),
})
var imageRepositoryResource = new ImageRepository("imageRepositoryResource", ImageRepositoryArgs.builder()
.database("string")
.schema("string")
.comment("string")
.name("string")
.build());
image_repository_resource = snowflake.ImageRepository("imageRepositoryResource",
database="string",
schema="string",
comment="string",
name="string")
const imageRepositoryResource = new snowflake.ImageRepository("imageRepositoryResource", {
database: "string",
schema: "string",
comment: "string",
name: "string",
});
type: snowflake:ImageRepository
properties:
comment: string
database: string
name: string
schema: string
ImageRepository 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 ImageRepository resource accepts the following input properties:
- Database string
- The database in which to create the image repository. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - Schema string
- The schema in which to create the image repository. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - Comment string
- Specifies a comment for the object.
- Name string
- Specifies the identifier for the image repository; must be unique for the schema in which the image repository is created. Due to technical limitations (read more here), avoid using the following characters:
|,.,".
- Database string
- The database in which to create the image repository. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - Schema string
- The schema in which to create the image repository. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - Comment string
- Specifies a comment for the object.
- Name string
- Specifies the identifier for the image repository; must be unique for the schema in which the image repository is created. Due to technical limitations (read more here), avoid using the following characters:
|,.,".
- database String
- The database in which to create the image repository. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - schema String
- The schema in which to create the image repository. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - comment String
- Specifies a comment for the object.
- name String
- Specifies the identifier for the image repository; must be unique for the schema in which the image repository is created. Due to technical limitations (read more here), avoid using the following characters:
|,.,".
- database string
- The database in which to create the image repository. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - schema string
- The schema in which to create the image repository. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - comment string
- Specifies a comment for the object.
- name string
- Specifies the identifier for the image repository; must be unique for the schema in which the image repository is created. Due to technical limitations (read more here), avoid using the following characters:
|,.,".
- database str
- The database in which to create the image repository. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - schema str
- The schema in which to create the image repository. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - comment str
- Specifies a comment for the object.
- name str
- Specifies the identifier for the image repository; must be unique for the schema in which the image repository is created. Due to technical limitations (read more here), avoid using the following characters:
|,.,".
- database String
- The database in which to create the image repository. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - schema String
- The schema in which to create the image repository. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - comment String
- Specifies a comment for the object.
- name String
- Specifies the identifier for the image repository; must be unique for the schema in which the image repository is created. Due to technical limitations (read more here), avoid using the following characters:
|,.,".
Outputs
All input properties are implicitly available as output properties. Additionally, the ImageRepository resource produces the following output properties:
- Fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- Id string
- The provider-assigned unique ID for this managed resource.
- Show
Outputs List<ImageRepository Show Output> - Outputs the result of
SHOW IMAGE REPOSITORIESfor the given image repository.
- Fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- Id string
- The provider-assigned unique ID for this managed resource.
- Show
Outputs []ImageRepository Show Output - Outputs the result of
SHOW IMAGE REPOSITORIESfor the given image repository.
- fully
Qualified StringName - Fully qualified name of the resource. For more information, see object name resolution.
- id String
- The provider-assigned unique ID for this managed resource.
- show
Outputs List<ImageRepository Show Output> - Outputs the result of
SHOW IMAGE REPOSITORIESfor the given image repository.
- fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- id string
- The provider-assigned unique ID for this managed resource.
- show
Outputs ImageRepository Show Output[] - Outputs the result of
SHOW IMAGE REPOSITORIESfor the given image repository.
- fully_
qualified_ strname - 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[ImageRepository Show Output] - Outputs the result of
SHOW IMAGE REPOSITORIESfor the given image repository.
- fully
Qualified StringName - Fully qualified name of the resource. For more information, see object name resolution.
- id String
- The provider-assigned unique ID for this managed resource.
- show
Outputs List<Property Map> - Outputs the result of
SHOW IMAGE REPOSITORIESfor the given image repository.
Look up Existing ImageRepository Resource
Get an existing ImageRepository 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?: ImageRepositoryState, opts?: CustomResourceOptions): ImageRepository@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
comment: Optional[str] = None,
database: Optional[str] = None,
fully_qualified_name: Optional[str] = None,
name: Optional[str] = None,
schema: Optional[str] = None,
show_outputs: Optional[Sequence[ImageRepositoryShowOutputArgs]] = None) -> ImageRepositoryfunc GetImageRepository(ctx *Context, name string, id IDInput, state *ImageRepositoryState, opts ...ResourceOption) (*ImageRepository, error)public static ImageRepository Get(string name, Input<string> id, ImageRepositoryState? state, CustomResourceOptions? opts = null)public static ImageRepository get(String name, Output<String> id, ImageRepositoryState state, CustomResourceOptions options)resources: _: type: snowflake:ImageRepository 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.
- Comment string
- Specifies a comment for the object.
- Database string
- The database in which to create the image repository. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - Fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- Name string
- Specifies the identifier for the image repository; must be unique for the schema in which the image repository is created. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - Schema string
- The schema in which to create the image repository. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - Show
Outputs List<ImageRepository Show Output> - Outputs the result of
SHOW IMAGE REPOSITORIESfor the given image repository.
- Comment string
- Specifies a comment for the object.
- Database string
- The database in which to create the image repository. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - Fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- Name string
- Specifies the identifier for the image repository; must be unique for the schema in which the image repository is created. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - Schema string
- The schema in which to create the image repository. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - Show
Outputs []ImageRepository Show Output Args - Outputs the result of
SHOW IMAGE REPOSITORIESfor the given image repository.
- comment String
- Specifies a comment for the object.
- database String
- The database in which to create the image repository. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - fully
Qualified StringName - Fully qualified name of the resource. For more information, see object name resolution.
- name String
- Specifies the identifier for the image repository; must be unique for the schema in which the image repository is created. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - schema String
- The schema in which to create the image repository. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - show
Outputs List<ImageRepository Show Output> - Outputs the result of
SHOW IMAGE REPOSITORIESfor the given image repository.
- comment string
- Specifies a comment for the object.
- database string
- The database in which to create the image repository. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- name string
- Specifies the identifier for the image repository; must be unique for the schema in which the image repository is created. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - schema string
- The schema in which to create the image repository. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - show
Outputs ImageRepository Show Output[] - Outputs the result of
SHOW IMAGE REPOSITORIESfor the given image repository.
- comment str
- Specifies a comment for the object.
- database str
- The database in which to create the image repository. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - fully_
qualified_ strname - Fully qualified name of the resource. For more information, see object name resolution.
- name str
- Specifies the identifier for the image repository; must be unique for the schema in which the image repository is created. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - schema str
- The schema in which to create the image repository. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - show_
outputs Sequence[ImageRepository Show Output Args] - Outputs the result of
SHOW IMAGE REPOSITORIESfor the given image repository.
- comment String
- Specifies a comment for the object.
- database String
- The database in which to create the image repository. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - fully
Qualified StringName - Fully qualified name of the resource. For more information, see object name resolution.
- name String
- Specifies the identifier for the image repository; must be unique for the schema in which the image repository is created. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - schema String
- The schema in which to create the image repository. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - show
Outputs List<Property Map> - Outputs the result of
SHOW IMAGE REPOSITORIESfor the given image repository.
Supporting Types
ImageRepositoryShowOutput, ImageRepositoryShowOutputArgs
- Comment string
- Created
On string - Database
Name string - Name string
- Owner string
- Owner
Role stringType - Privatelink
Repository stringUrl - Repository
Url string - Schema
Name string
- Comment string
- Created
On string - Database
Name string - Name string
- Owner string
- Owner
Role stringType - Privatelink
Repository stringUrl - Repository
Url string - Schema
Name string
- comment String
- created
On String - database
Name String - name String
- owner String
- owner
Role StringType - privatelink
Repository StringUrl - repository
Url String - schema
Name String
- comment string
- created
On string - database
Name string - name string
- owner string
- owner
Role stringType - privatelink
Repository stringUrl - repository
Url string - schema
Name string
- comment str
- created_
on str - database_
name str - name str
- owner str
- owner_
role_ strtype - privatelink_
repository_ strurl - repository_
url str - schema_
name str
- comment String
- created
On String - database
Name String - name String
- owner String
- owner
Role StringType - privatelink
Repository StringUrl - repository
Url String - schema
Name String
Import
$ pulumi import snowflake:index/imageRepository:ImageRepository example '"<database_name>"."<schema_name>"."<image_repository_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
snowflakeTerraform Provider.
