Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vultr
  3. API Docs
  4. ContainerRegistry
Vultr v2.23.1 published on Tuesday, Dec 10, 2024 by dirien
dirien/pulumi-vultr

vultr.ContainerRegistry

Explore with Pulumi AI

Vultr v2.23.1 published on Tuesday, Dec 10, 2024 by dirien
dirien/pulumi-vultr

Create and update a Vultr container registry.

Example Usage

Create a new container registry:

import * as pulumi from "@pulumi/pulumi";
import * as vultr from "@ediri/vultr";

const vcr1 = new vultr.ContainerRegistry("vcr1", {
    name: "examplecontainerregistry",
    plan: "start_up",
    "public": false,
    region: "sjc",
});
Copy
import pulumi
import ediri_vultr as vultr

vcr1 = vultr.ContainerRegistry("vcr1",
    name="examplecontainerregistry",
    plan="start_up",
    public=False,
    region="sjc")
Copy
package main

import (
	"github.com/dirien/pulumi-vultr/sdk/v2/go/vultr"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vultr.NewContainerRegistry(ctx, "vcr1", &vultr.ContainerRegistryArgs{
			Name:   pulumi.String("examplecontainerregistry"),
			Plan:   pulumi.String("start_up"),
			Public: pulumi.Bool(false),
			Region: pulumi.String("sjc"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vultr = ediri.Vultr;

return await Deployment.RunAsync(() => 
{
    var vcr1 = new Vultr.ContainerRegistry("vcr1", new()
    {
        Name = "examplecontainerregistry",
        Plan = "start_up",
        Public = false,
        Region = "sjc",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vultr.ContainerRegistry;
import com.pulumi.vultr.ContainerRegistryArgs;
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 vcr1 = new ContainerRegistry("vcr1", ContainerRegistryArgs.builder()
            .name("examplecontainerregistry")
            .plan("start_up")
            .public_(false)
            .region("sjc")
            .build());

    }
}
Copy
resources:
  vcr1:
    type: vultr:ContainerRegistry
    properties:
      name: examplecontainerregistry
      plan: start_up
      public: false
      region: sjc
Copy

The name for container registries must be all lowercase and only contain alphanumeric characters.

Create ContainerRegistry Resource

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

Constructor syntax

new ContainerRegistry(name: string, args: ContainerRegistryArgs, opts?: CustomResourceOptions);
@overload
def ContainerRegistry(resource_name: str,
                      args: ContainerRegistryArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def ContainerRegistry(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      name: Optional[str] = None,
                      plan: Optional[str] = None,
                      public: Optional[bool] = None,
                      region: Optional[str] = None)
func NewContainerRegistry(ctx *Context, name string, args ContainerRegistryArgs, opts ...ResourceOption) (*ContainerRegistry, error)
public ContainerRegistry(string name, ContainerRegistryArgs args, CustomResourceOptions? opts = null)
public ContainerRegistry(String name, ContainerRegistryArgs args)
public ContainerRegistry(String name, ContainerRegistryArgs args, CustomResourceOptions options)

type: vultr:ContainerRegistry
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ContainerRegistryArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ContainerRegistryArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ContainerRegistryArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ContainerRegistryArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ContainerRegistryArgs
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 containerRegistryResource = new Vultr.ContainerRegistry("containerRegistryResource", new()
{
    Name = "string",
    Plan = "string",
    Public = false,
    Region = "string",
});
Copy
example, err := vultr.NewContainerRegistry(ctx, "containerRegistryResource", &vultr.ContainerRegistryArgs{
	Name:   pulumi.String("string"),
	Plan:   pulumi.String("string"),
	Public: pulumi.Bool(false),
	Region: pulumi.String("string"),
})
Copy
var containerRegistryResource = new ContainerRegistry("containerRegistryResource", ContainerRegistryArgs.builder()
    .name("string")
    .plan("string")
    .public_(false)
    .region("string")
    .build());
Copy
container_registry_resource = vultr.ContainerRegistry("containerRegistryResource",
    name="string",
    plan="string",
    public=False,
    region="string")
Copy
const containerRegistryResource = new vultr.ContainerRegistry("containerRegistryResource", {
    name: "string",
    plan: "string",
    "public": false,
    region: "string",
});
Copy
type: vultr:ContainerRegistry
properties:
    name: string
    plan: string
    public: false
    region: string
Copy

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

Name This property is required. string
The name for your container registry. Must be lowercase and only alphanumeric characters.
Plan This property is required. string
The billing plan for the container registry. See available plans
Public This property is required. bool
Boolean indicating if the container registry should be created with public visibility or if it should require credentials.
Region This property is required. string
The region where your container registry will be deployed. See available regions
Name This property is required. string
The name for your container registry. Must be lowercase and only alphanumeric characters.
Plan This property is required. string
The billing plan for the container registry. See available plans
Public This property is required. bool
Boolean indicating if the container registry should be created with public visibility or if it should require credentials.
Region This property is required. string
The region where your container registry will be deployed. See available regions
name This property is required. String
The name for your container registry. Must be lowercase and only alphanumeric characters.
plan This property is required. String
The billing plan for the container registry. See available plans
public_ This property is required. Boolean
Boolean indicating if the container registry should be created with public visibility or if it should require credentials.
region This property is required. String
The region where your container registry will be deployed. See available regions
name This property is required. string
The name for your container registry. Must be lowercase and only alphanumeric characters.
plan This property is required. string
The billing plan for the container registry. See available plans
public This property is required. boolean
Boolean indicating if the container registry should be created with public visibility or if it should require credentials.
region This property is required. string
The region where your container registry will be deployed. See available regions
name This property is required. str
The name for your container registry. Must be lowercase and only alphanumeric characters.
plan This property is required. str
The billing plan for the container registry. See available plans
public This property is required. bool
Boolean indicating if the container registry should be created with public visibility or if it should require credentials.
region This property is required. str
The region where your container registry will be deployed. See available regions
name This property is required. String
The name for your container registry. Must be lowercase and only alphanumeric characters.
plan This property is required. String
The billing plan for the container registry. See available plans
public This property is required. Boolean
Boolean indicating if the container registry should be created with public visibility or if it should require credentials.
region This property is required. String
The region where your container registry will be deployed. See available regions

Outputs

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

DateCreated string
A date-time of when the root user was created.
Id string
The provider-assigned unique ID for this managed resource.
RootUser Dictionary<string, string>
The user associated with the container registry.
Storage Dictionary<string, string>
A listing of current storage usage relevant to the container registry.
Urn string
The URN of the container registry.
DateCreated string
A date-time of when the root user was created.
Id string
The provider-assigned unique ID for this managed resource.
RootUser map[string]string
The user associated with the container registry.
Storage map[string]string
A listing of current storage usage relevant to the container registry.
Urn string
The URN of the container registry.
dateCreated String
A date-time of when the root user was created.
id String
The provider-assigned unique ID for this managed resource.
rootUser Map<String,String>
The user associated with the container registry.
storage Map<String,String>
A listing of current storage usage relevant to the container registry.
urn String
The URN of the container registry.
dateCreated string
A date-time of when the root user was created.
id string
The provider-assigned unique ID for this managed resource.
rootUser {[key: string]: string}
The user associated with the container registry.
storage {[key: string]: string}
A listing of current storage usage relevant to the container registry.
urn string
The URN of the container registry.
date_created str
A date-time of when the root user was created.
id str
The provider-assigned unique ID for this managed resource.
root_user Mapping[str, str]
The user associated with the container registry.
storage Mapping[str, str]
A listing of current storage usage relevant to the container registry.
urn str
The URN of the container registry.
dateCreated String
A date-time of when the root user was created.
id String
The provider-assigned unique ID for this managed resource.
rootUser Map<String>
The user associated with the container registry.
storage Map<String>
A listing of current storage usage relevant to the container registry.
urn String
The URN of the container registry.

Look up Existing ContainerRegistry Resource

Get an existing ContainerRegistry 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?: ContainerRegistryState, opts?: CustomResourceOptions): ContainerRegistry
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        date_created: Optional[str] = None,
        name: Optional[str] = None,
        plan: Optional[str] = None,
        public: Optional[bool] = None,
        region: Optional[str] = None,
        root_user: Optional[Mapping[str, str]] = None,
        storage: Optional[Mapping[str, str]] = None,
        urn: Optional[str] = None) -> ContainerRegistry
func GetContainerRegistry(ctx *Context, name string, id IDInput, state *ContainerRegistryState, opts ...ResourceOption) (*ContainerRegistry, error)
public static ContainerRegistry Get(string name, Input<string> id, ContainerRegistryState? state, CustomResourceOptions? opts = null)
public static ContainerRegistry get(String name, Output<String> id, ContainerRegistryState state, CustomResourceOptions options)
resources:  _:    type: vultr:ContainerRegistry    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
DateCreated string
A date-time of when the root user was created.
Name string
The name for your container registry. Must be lowercase and only alphanumeric characters.
Plan string
The billing plan for the container registry. See available plans
Public bool
Boolean indicating if the container registry should be created with public visibility or if it should require credentials.
Region string
The region where your container registry will be deployed. See available regions
RootUser Dictionary<string, string>
The user associated with the container registry.
Storage Dictionary<string, string>
A listing of current storage usage relevant to the container registry.
Urn string
The URN of the container registry.
DateCreated string
A date-time of when the root user was created.
Name string
The name for your container registry. Must be lowercase and only alphanumeric characters.
Plan string
The billing plan for the container registry. See available plans
Public bool
Boolean indicating if the container registry should be created with public visibility or if it should require credentials.
Region string
The region where your container registry will be deployed. See available regions
RootUser map[string]string
The user associated with the container registry.
Storage map[string]string
A listing of current storage usage relevant to the container registry.
Urn string
The URN of the container registry.
dateCreated String
A date-time of when the root user was created.
name String
The name for your container registry. Must be lowercase and only alphanumeric characters.
plan String
The billing plan for the container registry. See available plans
public_ Boolean
Boolean indicating if the container registry should be created with public visibility or if it should require credentials.
region String
The region where your container registry will be deployed. See available regions
rootUser Map<String,String>
The user associated with the container registry.
storage Map<String,String>
A listing of current storage usage relevant to the container registry.
urn String
The URN of the container registry.
dateCreated string
A date-time of when the root user was created.
name string
The name for your container registry. Must be lowercase and only alphanumeric characters.
plan string
The billing plan for the container registry. See available plans
public boolean
Boolean indicating if the container registry should be created with public visibility or if it should require credentials.
region string
The region where your container registry will be deployed. See available regions
rootUser {[key: string]: string}
The user associated with the container registry.
storage {[key: string]: string}
A listing of current storage usage relevant to the container registry.
urn string
The URN of the container registry.
date_created str
A date-time of when the root user was created.
name str
The name for your container registry. Must be lowercase and only alphanumeric characters.
plan str
The billing plan for the container registry. See available plans
public bool
Boolean indicating if the container registry should be created with public visibility or if it should require credentials.
region str
The region where your container registry will be deployed. See available regions
root_user Mapping[str, str]
The user associated with the container registry.
storage Mapping[str, str]
A listing of current storage usage relevant to the container registry.
urn str
The URN of the container registry.
dateCreated String
A date-time of when the root user was created.
name String
The name for your container registry. Must be lowercase and only alphanumeric characters.
plan String
The billing plan for the container registry. See available plans
public Boolean
Boolean indicating if the container registry should be created with public visibility or if it should require credentials.
region String
The region where your container registry will be deployed. See available regions
rootUser Map<String>
The user associated with the container registry.
storage Map<String>
A listing of current storage usage relevant to the container registry.
urn String
The URN of the container registry.

Package Details

Repository
vultr dirien/pulumi-vultr
License
Apache-2.0
Notes
This Pulumi package is based on the vultr Terraform Provider.
Vultr v2.23.1 published on Tuesday, Dec 10, 2024 by dirien
dirien/pulumi-vultr