This resource allows you to create and manage a Buildkite Registry. Find out more information in our documentation.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as buildkite from "@pulumiverse/buildkite";
const example = new buildkite.organization.Registry("example", {
name: "example",
description: "super cool ruby registry",
ecosystem: "ruby",
emoji: ":ruby:",
color: "#ff0000",
});
import pulumi
import pulumiverse_buildkite as buildkite
example = buildkite.organization.Registry("example",
name="example",
description="super cool ruby registry",
ecosystem="ruby",
emoji=":ruby:",
color="#ff0000")
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumiverse/pulumi-buildkite/sdk/v3/go/buildkite/organization"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := organization.NewRegistry(ctx, "example", &organization.RegistryArgs{
Name: pulumi.String("example"),
Description: pulumi.String("super cool ruby registry"),
Ecosystem: pulumi.String("ruby"),
Emoji: pulumi.String(":ruby:"),
Color: pulumi.String("#ff0000"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Buildkite = Pulumiverse.Buildkite;
return await Deployment.RunAsync(() =>
{
var example = new Buildkite.Organization.Registry("example", new()
{
Name = "example",
Description = "super cool ruby registry",
Ecosystem = "ruby",
Emoji = ":ruby:",
Color = "#ff0000",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.buildkite.Organization.Registry;
import com.pulumi.buildkite.Organization.RegistryArgs;
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 example = new Registry("example", RegistryArgs.builder()
.name("example")
.description("super cool ruby registry")
.ecosystem("ruby")
.emoji(":ruby:")
.color("#ff0000")
.build());
}
}
resources:
example:
type: buildkite:Organization:Registry
properties:
name: example
description: super cool ruby registry
ecosystem: ruby
emoji: ':ruby:'
color: '#ff0000'
Create Registry Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Registry(name: string, args: RegistryArgs, opts?: CustomResourceOptions);@overload
def Registry(resource_name: str,
args: RegistryArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Registry(resource_name: str,
opts: Optional[ResourceOptions] = None,
ecosystem: Optional[str] = None,
color: Optional[str] = None,
description: Optional[str] = None,
emoji: Optional[str] = None,
name: Optional[str] = None,
oidc_policy: Optional[str] = None,
team_ids: Optional[Sequence[str]] = None)func NewRegistry(ctx *Context, name string, args RegistryArgs, opts ...ResourceOption) (*Registry, error)public Registry(string name, RegistryArgs args, CustomResourceOptions? opts = null)
public Registry(String name, RegistryArgs args)
public Registry(String name, RegistryArgs args, CustomResourceOptions options)
type: buildkite:Organization:Registry
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 RegistryArgs
- 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 RegistryArgs
- 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 RegistryArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args RegistryArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args RegistryArgs
- 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 registryResource = new Buildkite.Organization.Registry("registryResource", new()
{
Ecosystem = "string",
Color = "string",
Description = "string",
Emoji = "string",
Name = "string",
OidcPolicy = "string",
TeamIds = new[]
{
"string",
},
});
example, err := organization.NewRegistry(ctx, "registryResource", &organization.RegistryArgs{
Ecosystem: pulumi.String("string"),
Color: pulumi.String("string"),
Description: pulumi.String("string"),
Emoji: pulumi.String("string"),
Name: pulumi.String("string"),
OidcPolicy: pulumi.String("string"),
TeamIds: pulumi.StringArray{
pulumi.String("string"),
},
})
var registryResource = new Registry("registryResource", RegistryArgs.builder()
.ecosystem("string")
.color("string")
.description("string")
.emoji("string")
.name("string")
.oidcPolicy("string")
.teamIds("string")
.build());
registry_resource = buildkite.organization.Registry("registryResource",
ecosystem="string",
color="string",
description="string",
emoji="string",
name="string",
oidc_policy="string",
team_ids=["string"])
const registryResource = new buildkite.organization.Registry("registryResource", {
ecosystem: "string",
color: "string",
description: "string",
emoji: "string",
name: "string",
oidcPolicy: "string",
teamIds: ["string"],
});
type: buildkite:Organization:Registry
properties:
color: string
description: string
ecosystem: string
emoji: string
name: string
oidcPolicy: string
teamIds:
- string
Registry 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 Registry resource accepts the following input properties:
- Ecosystem string
- The ecosystem of the registry. Warning: This value cannot be changed after creation. Any attempts to update this field will result in API errors.
- Color string
- A color representation of the registry. Accepts hex codes, eg #BADA55.
- Description string
- This is a description for the registry, this may describe the usage for it, the region, or something else which would help identify the registry's purpose.
- Emoji string
- An emoji to use with the registry, this can either be set using :buildkite: notation, or with the emoji itself, such as π.
- Name string
- The name of the registry. Can only contain numbers and letters, no spaces or special characters.
- Oidc
Policy string - The registry's OIDC policy.
- Team
Ids List<string> - The team IDs that have access to the registry.
- Ecosystem string
- The ecosystem of the registry. Warning: This value cannot be changed after creation. Any attempts to update this field will result in API errors.
- Color string
- A color representation of the registry. Accepts hex codes, eg #BADA55.
- Description string
- This is a description for the registry, this may describe the usage for it, the region, or something else which would help identify the registry's purpose.
- Emoji string
- An emoji to use with the registry, this can either be set using :buildkite: notation, or with the emoji itself, such as π.
- Name string
- The name of the registry. Can only contain numbers and letters, no spaces or special characters.
- Oidc
Policy string - The registry's OIDC policy.
- Team
Ids []string - The team IDs that have access to the registry.
- ecosystem String
- The ecosystem of the registry. Warning: This value cannot be changed after creation. Any attempts to update this field will result in API errors.
- color String
- A color representation of the registry. Accepts hex codes, eg #BADA55.
- description String
- This is a description for the registry, this may describe the usage for it, the region, or something else which would help identify the registry's purpose.
- emoji String
- An emoji to use with the registry, this can either be set using :buildkite: notation, or with the emoji itself, such as π.
- name String
- The name of the registry. Can only contain numbers and letters, no spaces or special characters.
- oidc
Policy String - The registry's OIDC policy.
- team
Ids List<String> - The team IDs that have access to the registry.
- ecosystem string
- The ecosystem of the registry. Warning: This value cannot be changed after creation. Any attempts to update this field will result in API errors.
- color string
- A color representation of the registry. Accepts hex codes, eg #BADA55.
- description string
- This is a description for the registry, this may describe the usage for it, the region, or something else which would help identify the registry's purpose.
- emoji string
- An emoji to use with the registry, this can either be set using :buildkite: notation, or with the emoji itself, such as π.
- name string
- The name of the registry. Can only contain numbers and letters, no spaces or special characters.
- oidc
Policy string - The registry's OIDC policy.
- team
Ids string[] - The team IDs that have access to the registry.
- ecosystem str
- The ecosystem of the registry. Warning: This value cannot be changed after creation. Any attempts to update this field will result in API errors.
- color str
- A color representation of the registry. Accepts hex codes, eg #BADA55.
- description str
- This is a description for the registry, this may describe the usage for it, the region, or something else which would help identify the registry's purpose.
- emoji str
- An emoji to use with the registry, this can either be set using :buildkite: notation, or with the emoji itself, such as π.
- name str
- The name of the registry. Can only contain numbers and letters, no spaces or special characters.
- oidc_
policy str - The registry's OIDC policy.
- team_
ids Sequence[str] - The team IDs that have access to the registry.
- ecosystem String
- The ecosystem of the registry. Warning: This value cannot be changed after creation. Any attempts to update this field will result in API errors.
- color String
- A color representation of the registry. Accepts hex codes, eg #BADA55.
- description String
- This is a description for the registry, this may describe the usage for it, the region, or something else which would help identify the registry's purpose.
- emoji String
- An emoji to use with the registry, this can either be set using :buildkite: notation, or with the emoji itself, such as π.
- name String
- The name of the registry. Can only contain numbers and letters, no spaces or special characters.
- oidc
Policy String - The registry's OIDC policy.
- team
Ids List<String> - The team IDs that have access to the registry.
Outputs
All input properties are implicitly available as output properties. Additionally, the Registry resource produces the following output properties:
Look up Existing Registry Resource
Get an existing Registry 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?: RegistryState, opts?: CustomResourceOptions): Registry@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
color: Optional[str] = None,
description: Optional[str] = None,
ecosystem: Optional[str] = None,
emoji: Optional[str] = None,
name: Optional[str] = None,
oidc_policy: Optional[str] = None,
slug: Optional[str] = None,
team_ids: Optional[Sequence[str]] = None,
uuid: Optional[str] = None) -> Registryfunc GetRegistry(ctx *Context, name string, id IDInput, state *RegistryState, opts ...ResourceOption) (*Registry, error)public static Registry Get(string name, Input<string> id, RegistryState? state, CustomResourceOptions? opts = null)public static Registry get(String name, Output<String> id, RegistryState state, CustomResourceOptions options)resources: _: type: buildkite:Organization:Registry 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.
- Color string
- A color representation of the registry. Accepts hex codes, eg #BADA55.
- Description string
- This is a description for the registry, this may describe the usage for it, the region, or something else which would help identify the registry's purpose.
- Ecosystem string
- The ecosystem of the registry. Warning: This value cannot be changed after creation. Any attempts to update this field will result in API errors.
- Emoji string
- An emoji to use with the registry, this can either be set using :buildkite: notation, or with the emoji itself, such as π.
- Name string
- The name of the registry. Can only contain numbers and letters, no spaces or special characters.
- Oidc
Policy string - The registry's OIDC policy.
- Slug string
- The slug of the registry.
- Team
Ids List<string> - The team IDs that have access to the registry.
- Uuid string
- The UUID of the registry.
- Color string
- A color representation of the registry. Accepts hex codes, eg #BADA55.
- Description string
- This is a description for the registry, this may describe the usage for it, the region, or something else which would help identify the registry's purpose.
- Ecosystem string
- The ecosystem of the registry. Warning: This value cannot be changed after creation. Any attempts to update this field will result in API errors.
- Emoji string
- An emoji to use with the registry, this can either be set using :buildkite: notation, or with the emoji itself, such as π.
- Name string
- The name of the registry. Can only contain numbers and letters, no spaces or special characters.
- Oidc
Policy string - The registry's OIDC policy.
- Slug string
- The slug of the registry.
- Team
Ids []string - The team IDs that have access to the registry.
- Uuid string
- The UUID of the registry.
- color String
- A color representation of the registry. Accepts hex codes, eg #BADA55.
- description String
- This is a description for the registry, this may describe the usage for it, the region, or something else which would help identify the registry's purpose.
- ecosystem String
- The ecosystem of the registry. Warning: This value cannot be changed after creation. Any attempts to update this field will result in API errors.
- emoji String
- An emoji to use with the registry, this can either be set using :buildkite: notation, or with the emoji itself, such as π.
- name String
- The name of the registry. Can only contain numbers and letters, no spaces or special characters.
- oidc
Policy String - The registry's OIDC policy.
- slug String
- The slug of the registry.
- team
Ids List<String> - The team IDs that have access to the registry.
- uuid String
- The UUID of the registry.
- color string
- A color representation of the registry. Accepts hex codes, eg #BADA55.
- description string
- This is a description for the registry, this may describe the usage for it, the region, or something else which would help identify the registry's purpose.
- ecosystem string
- The ecosystem of the registry. Warning: This value cannot be changed after creation. Any attempts to update this field will result in API errors.
- emoji string
- An emoji to use with the registry, this can either be set using :buildkite: notation, or with the emoji itself, such as π.
- name string
- The name of the registry. Can only contain numbers and letters, no spaces or special characters.
- oidc
Policy string - The registry's OIDC policy.
- slug string
- The slug of the registry.
- team
Ids string[] - The team IDs that have access to the registry.
- uuid string
- The UUID of the registry.
- color str
- A color representation of the registry. Accepts hex codes, eg #BADA55.
- description str
- This is a description for the registry, this may describe the usage for it, the region, or something else which would help identify the registry's purpose.
- ecosystem str
- The ecosystem of the registry. Warning: This value cannot be changed after creation. Any attempts to update this field will result in API errors.
- emoji str
- An emoji to use with the registry, this can either be set using :buildkite: notation, or with the emoji itself, such as π.
- name str
- The name of the registry. Can only contain numbers and letters, no spaces or special characters.
- oidc_
policy str - The registry's OIDC policy.
- slug str
- The slug of the registry.
- team_
ids Sequence[str] - The team IDs that have access to the registry.
- uuid str
- The UUID of the registry.
- color String
- A color representation of the registry. Accepts hex codes, eg #BADA55.
- description String
- This is a description for the registry, this may describe the usage for it, the region, or something else which would help identify the registry's purpose.
- ecosystem String
- The ecosystem of the registry. Warning: This value cannot be changed after creation. Any attempts to update this field will result in API errors.
- emoji String
- An emoji to use with the registry, this can either be set using :buildkite: notation, or with the emoji itself, such as π.
- name String
- The name of the registry. Can only contain numbers and letters, no spaces or special characters.
- oidc
Policy String - The registry's OIDC policy.
- slug String
- The slug of the registry.
- team
Ids List<String> - The team IDs that have access to the registry.
- uuid String
- The UUID of the registry.
Package Details
- Repository
- buildkite pulumiverse/pulumi-buildkite
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
buildkiteTerraform Provider.
