1. Packages
  2. Packages
  3. Chronosphere
  4. API Docs
  5. Collection
Viewing docs for Chronosphere v0.9.16
published on Friday, Jun 5, 2026 by Chronosphere
Viewing docs for Chronosphere v0.9.16
published on Friday, Jun 5, 2026 by Chronosphere

    A logical grouping of monitors, dashboards, SLOs, and other resources, typically aligned with a team or system. Provides a default notification policy for contained monitors and SLOs that do not explicitly reference one.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Pulumi = Chronosphere.Pulumi;
    
    return await Deployment.RunAsync(() => 
    {
        var infra = new Pulumi.Collection("infra", new()
        {
            Description = "Collection of resources related to infrastructure services.",
            Name = "Infrastructure Collection",
        });
    
    });
    
    package main
    
    import (
    	"github.com/chronosphereio/pulumi-chronosphere/sdk/go/chronosphere"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := chronosphere.NewCollection(ctx, "infra", &chronosphere.CollectionArgs{
    			Description: pulumi.String("Collection of resources related to infrastructure services."),
    			Name:        pulumi.String("Infrastructure Collection"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    

    Example coming soon!

    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.chronosphere.Collection;
    import com.pulumi.chronosphere.CollectionArgs;
    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 infra = new Collection("infra", CollectionArgs.builder()        
                .description("Collection of resources related to infrastructure services.")
                .name("Infrastructure Collection")
                .build());
    
        }
    }
    
    import * as pulumi from "@pulumi/pulumi";
    import * as chronosphere from "@pulumi-chronosphere/pulumi-chronosphere";
    
    const infra = new chronosphere.Collection("infra", {
        description: "Collection of resources related to infrastructure services.",
        name: "Infrastructure Collection",
    });
    
    import pulumi
    import pulumi_chronosphere as chronosphere
    
    infra = chronosphere.Collection("infra",
        description="Collection of resources related to infrastructure services.",
        name="Infrastructure Collection")
    
    resources:
      infra:
        type: chronosphere:Collection
        properties:
          description: Collection of resources related to infrastructure services.
          name: Infrastructure Collection
    

    Create Collection Resource

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

    Constructor syntax

    new Collection(name: string, args: CollectionArgs, opts?: CustomResourceOptions);
    @overload
    def Collection(resource_name: str,
                   args: CollectionArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def Collection(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   name: Optional[str] = None,
                   description: Optional[str] = None,
                   notification_policy_id: Optional[str] = None,
                   slug: Optional[str] = None,
                   team_id: Optional[str] = None)
    func NewCollection(ctx *Context, name string, args CollectionArgs, opts ...ResourceOption) (*Collection, error)
    public Collection(string name, CollectionArgs args, CustomResourceOptions? opts = null)
    public Collection(String name, CollectionArgs args)
    public Collection(String name, CollectionArgs args, CustomResourceOptions options)
    
    type: chronosphere:Collection
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "chronosphere_collection" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args CollectionArgs
    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 CollectionArgs
    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 CollectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CollectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CollectionArgs
    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 collectionResource = new Pulumi.Collection("collectionResource", new()
    {
        Name = "string",
        Description = "string",
        NotificationPolicyId = "string",
        Slug = "string",
        TeamId = "string",
    });
    
    example, err := chronosphere.NewCollection(ctx, "collectionResource", &chronosphere.CollectionArgs{
    	Name:                 pulumi.String("string"),
    	Description:          pulumi.String("string"),
    	NotificationPolicyId: pulumi.String("string"),
    	Slug:                 pulumi.String("string"),
    	TeamId:               pulumi.String("string"),
    })
    
    resource "chronosphere_collection" "collectionResource" {
      name                   = "string"
      description            = "string"
      notification_policy_id = "string"
      slug                   = "string"
      team_id                = "string"
    }
    
    var collectionResource = new Collection("collectionResource", CollectionArgs.builder()
        .name("string")
        .description("string")
        .notificationPolicyId("string")
        .slug("string")
        .teamId("string")
        .build());
    
    collection_resource = chronosphere.Collection("collectionResource",
        name="string",
        description="string",
        notification_policy_id="string",
        slug="string",
        team_id="string")
    
    const collectionResource = new chronosphere.Collection("collectionResource", {
        name: "string",
        description: "string",
        notificationPolicyId: "string",
        slug: "string",
        teamId: "string",
    });
    
    type: chronosphere:Collection
    properties:
        description: string
        name: string
        notificationPolicyId: string
        slug: string
        teamId: string
    

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

    Name string
    Display name of the collection. Can be changed after creation.
    Description string
    Free-form description of the collection.
    NotificationPolicyId string
    ID of the default notification policy applied to monitors in this collection that do not explicitly reference one. Monitors that set their own notification_policy_id are not overridden.
    Slug string
    Stable identifier for the collection. Generated from name if omitted. Immutable after creation.
    TeamId string
    ID of the team that owns this collection.
    Name string
    Display name of the collection. Can be changed after creation.
    Description string
    Free-form description of the collection.
    NotificationPolicyId string
    ID of the default notification policy applied to monitors in this collection that do not explicitly reference one. Monitors that set their own notification_policy_id are not overridden.
    Slug string
    Stable identifier for the collection. Generated from name if omitted. Immutable after creation.
    TeamId string
    ID of the team that owns this collection.
    name string
    Display name of the collection. Can be changed after creation.
    description string
    Free-form description of the collection.
    notification_policy_id string
    ID of the default notification policy applied to monitors in this collection that do not explicitly reference one. Monitors that set their own notification_policy_id are not overridden.
    slug string
    Stable identifier for the collection. Generated from name if omitted. Immutable after creation.
    team_id string
    ID of the team that owns this collection.
    name String
    Display name of the collection. Can be changed after creation.
    description String
    Free-form description of the collection.
    notificationPolicyId String
    ID of the default notification policy applied to monitors in this collection that do not explicitly reference one. Monitors that set their own notification_policy_id are not overridden.
    slug String
    Stable identifier for the collection. Generated from name if omitted. Immutable after creation.
    teamId String
    ID of the team that owns this collection.
    name string
    Display name of the collection. Can be changed after creation.
    description string
    Free-form description of the collection.
    notificationPolicyId string
    ID of the default notification policy applied to monitors in this collection that do not explicitly reference one. Monitors that set their own notification_policy_id are not overridden.
    slug string
    Stable identifier for the collection. Generated from name if omitted. Immutable after creation.
    teamId string
    ID of the team that owns this collection.
    name str
    Display name of the collection. Can be changed after creation.
    description str
    Free-form description of the collection.
    notification_policy_id str
    ID of the default notification policy applied to monitors in this collection that do not explicitly reference one. Monitors that set their own notification_policy_id are not overridden.
    slug str
    Stable identifier for the collection. Generated from name if omitted. Immutable after creation.
    team_id str
    ID of the team that owns this collection.
    name String
    Display name of the collection. Can be changed after creation.
    description String
    Free-form description of the collection.
    notificationPolicyId String
    ID of the default notification policy applied to monitors in this collection that do not explicitly reference one. Monitors that set their own notification_policy_id are not overridden.
    slug String
    Stable identifier for the collection. Generated from name if omitted. Immutable after creation.
    teamId String
    ID of the team that owns this collection.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Collection Resource

    Get an existing Collection 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?: CollectionState, opts?: CustomResourceOptions): Collection
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            name: Optional[str] = None,
            notification_policy_id: Optional[str] = None,
            slug: Optional[str] = None,
            team_id: Optional[str] = None) -> Collection
    func GetCollection(ctx *Context, name string, id IDInput, state *CollectionState, opts ...ResourceOption) (*Collection, error)
    public static Collection Get(string name, Input<string> id, CollectionState? state, CustomResourceOptions? opts = null)
    public static Collection get(String name, Output<String> id, CollectionState state, CustomResourceOptions options)
    resources:  _:    type: chronosphere:Collection    get:      id: ${id}
    import {
      to = chronosphere_collection.example
      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:
    Description string
    Free-form description of the collection.
    Name string
    Display name of the collection. Can be changed after creation.
    NotificationPolicyId string
    ID of the default notification policy applied to monitors in this collection that do not explicitly reference one. Monitors that set their own notification_policy_id are not overridden.
    Slug string
    Stable identifier for the collection. Generated from name if omitted. Immutable after creation.
    TeamId string
    ID of the team that owns this collection.
    Description string
    Free-form description of the collection.
    Name string
    Display name of the collection. Can be changed after creation.
    NotificationPolicyId string
    ID of the default notification policy applied to monitors in this collection that do not explicitly reference one. Monitors that set their own notification_policy_id are not overridden.
    Slug string
    Stable identifier for the collection. Generated from name if omitted. Immutable after creation.
    TeamId string
    ID of the team that owns this collection.
    description string
    Free-form description of the collection.
    name string
    Display name of the collection. Can be changed after creation.
    notification_policy_id string
    ID of the default notification policy applied to monitors in this collection that do not explicitly reference one. Monitors that set their own notification_policy_id are not overridden.
    slug string
    Stable identifier for the collection. Generated from name if omitted. Immutable after creation.
    team_id string
    ID of the team that owns this collection.
    description String
    Free-form description of the collection.
    name String
    Display name of the collection. Can be changed after creation.
    notificationPolicyId String
    ID of the default notification policy applied to monitors in this collection that do not explicitly reference one. Monitors that set their own notification_policy_id are not overridden.
    slug String
    Stable identifier for the collection. Generated from name if omitted. Immutable after creation.
    teamId String
    ID of the team that owns this collection.
    description string
    Free-form description of the collection.
    name string
    Display name of the collection. Can be changed after creation.
    notificationPolicyId string
    ID of the default notification policy applied to monitors in this collection that do not explicitly reference one. Monitors that set their own notification_policy_id are not overridden.
    slug string
    Stable identifier for the collection. Generated from name if omitted. Immutable after creation.
    teamId string
    ID of the team that owns this collection.
    description str
    Free-form description of the collection.
    name str
    Display name of the collection. Can be changed after creation.
    notification_policy_id str
    ID of the default notification policy applied to monitors in this collection that do not explicitly reference one. Monitors that set their own notification_policy_id are not overridden.
    slug str
    Stable identifier for the collection. Generated from name if omitted. Immutable after creation.
    team_id str
    ID of the team that owns this collection.
    description String
    Free-form description of the collection.
    name String
    Display name of the collection. Can be changed after creation.
    notificationPolicyId String
    ID of the default notification policy applied to monitors in this collection that do not explicitly reference one. Monitors that set their own notification_policy_id are not overridden.
    slug String
    Stable identifier for the collection. Generated from name if omitted. Immutable after creation.
    teamId String
    ID of the team that owns this collection.

    Package Details

    Repository
    chronosphere chronosphereio/pulumi-chronosphere
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the chronosphere Terraform Provider.
    Viewing docs for Chronosphere v0.9.16
    published on Friday, Jun 5, 2026 by Chronosphere

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial