Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Incident Provider
  3. API Docs
  4. CatalogEntries
incident 5.5.0 published on Wednesday, Apr 30, 2025 by incident-io
incident-io/terraform-provider-incident

incident.CatalogEntries

Explore with Pulumi AI

incident logo
incident 5.5.0 published on Wednesday, Apr 30, 2025 by incident-io
incident-io/terraform-provider-incident

    Example Usage

    Create CatalogEntries Resource

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

    Constructor syntax

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

@overload
def CatalogEntries(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   catalog_entries_id: Optional[str] = None,
                   entries: Optional[Mapping[str, CatalogEntriesEntriesArgs]] = None,
                   managed_attributes: Optional[Sequence[str]] = None)
    func NewCatalogEntries(ctx *Context, name string, args CatalogEntriesArgs, opts ...ResourceOption) (*CatalogEntries, error)
    public CatalogEntries(string name, CatalogEntriesArgs args, CustomResourceOptions? opts = null)
    public CatalogEntries(String name, CatalogEntriesArgs args)
public CatalogEntries(String name, CatalogEntriesArgs args, CustomResourceOptions options)

    type: incident:CatalogEntries
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 CatalogEntriesArgs
    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 CatalogEntriesArgs
    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 CatalogEntriesArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CatalogEntriesArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CatalogEntriesArgs
    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 catalogEntriesResource = new Incident.CatalogEntries("catalogEntriesResource", new()
{
    CatalogEntriesId = "string",
    Entries = 
    {
        { "string", new Incident.Inputs.CatalogEntriesEntriesArgs
        {
            AttributeValues = 
            {
                { "string", new Incident.Inputs.CatalogEntriesEntriesAttributeValuesArgs
                {
                    ArrayValues = new[]
                    {
                        "string",
                    },
                    Value = "string",
                } },
            },
            Name = "string",
            Aliases = new[]
            {
                "string",
            },
            Id = "string",
            Rank = 0,
        } },
    },
    ManagedAttributes = new[]
    {
        "string",
    },
});

    example, err := incident.NewCatalogEntries(ctx, "catalogEntriesResource", &incident.CatalogEntriesArgs{
	CatalogEntriesId: pulumi.String("string"),
	Entries: incident.CatalogEntriesEntriesMap{
		"string": &incident.CatalogEntriesEntriesArgs{
			AttributeValues: incident.CatalogEntriesEntriesAttributeValuesMap{
				"string": &incident.CatalogEntriesEntriesAttributeValuesArgs{
					ArrayValues: pulumi.StringArray{
						pulumi.String("string"),
					},
					Value: pulumi.String("string"),
				},
			},
			Name: pulumi.String("string"),
			Aliases: pulumi.StringArray{
				pulumi.String("string"),
			},
			Id:   pulumi.String("string"),
			Rank: pulumi.Float64(0),
		},
	},
	ManagedAttributes: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var catalogEntriesResource = new CatalogEntries("catalogEntriesResource", CatalogEntriesArgs.builder()
    .catalogEntriesId("string")
    .entries(Map.of("string", Map.ofEntries(
        Map.entry("attributeValues", Map.of("string", Map.ofEntries(
            Map.entry("arrayValues", "string"),
            Map.entry("value", "string")
        ))),
        Map.entry("name", "string"),
        Map.entry("aliases", "string"),
        Map.entry("id", "string"),
        Map.entry("rank", 0)
    )))
    .managedAttributes("string")
    .build());

    catalog_entries_resource = incident.CatalogEntries("catalogEntriesResource",
    catalog_entries_id="string",
    entries={
        "string": {
            "attribute_values": {
                "string": {
                    "array_values": ["string"],
                    "value": "string",
                },
            },
            "name": "string",
            "aliases": ["string"],
            "id": "string",
            "rank": 0,
        },
    },
    managed_attributes=["string"])

    const catalogEntriesResource = new incident.CatalogEntries("catalogEntriesResource", {
    catalogEntriesId: "string",
    entries: {
        string: {
            attributeValues: {
                string: {
                    arrayValues: ["string"],
                    value: "string",
                },
            },
            name: "string",
            aliases: ["string"],
            id: "string",
            rank: 0,
        },
    },
    managedAttributes: ["string"],
});

    type: incident:CatalogEntries
properties:
    catalogEntriesId: string
    entries:
        string:
            aliases:
                - string
            attributeValues:
                string:
                    arrayValues:
                        - string
                    value: string
            id: string
            name: string
            rank: 0
    managedAttributes:
        - string

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

    CatalogEntriesId string
    ID of this catalog type
    Entries Dictionary<string, CatalogEntriesEntriesArgs>
    Map of external ID to entry in the catalog.
    ManagedAttributes List<string>
    The set of attributes that are managed by this resource. By default, all attributes are managed by this resource.
    CatalogEntriesId string
    ID of this catalog type
    Entries map[string]CatalogEntriesEntriesArgs
    Map of external ID to entry in the catalog.
    ManagedAttributes []string
    The set of attributes that are managed by this resource. By default, all attributes are managed by this resource.
    catalogEntriesId String
    ID of this catalog type
    entries Map<String,CatalogEntriesEntriesArgs>
    Map of external ID to entry in the catalog.
    managedAttributes List<String>
    The set of attributes that are managed by this resource. By default, all attributes are managed by this resource.
    catalogEntriesId string
    ID of this catalog type
    entries {[key: string]: CatalogEntriesEntriesArgs}
    Map of external ID to entry in the catalog.
    managedAttributes string[]
    The set of attributes that are managed by this resource. By default, all attributes are managed by this resource.
    catalog_entries_id str
    ID of this catalog type
    entries Mapping[str, CatalogEntriesEntriesArgs]
    Map of external ID to entry in the catalog.
    managed_attributes Sequence[str]
    The set of attributes that are managed by this resource. By default, all attributes are managed by this resource.
    catalogEntriesId String
    ID of this catalog type
    entries Map<Property Map>
    Map of external ID to entry in the catalog.
    managedAttributes List<String>
    The set of attributes that are managed by this resource. By default, all attributes are managed by this resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CatalogEntries 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 str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing CatalogEntries Resource

    Get an existing CatalogEntries 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?: CatalogEntriesState, opts?: CustomResourceOptions): CatalogEntries
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        catalog_entries_id: Optional[str] = None,
        entries: Optional[Mapping[str, CatalogEntriesEntriesArgs]] = None,
        managed_attributes: Optional[Sequence[str]] = None) -> CatalogEntries
    func GetCatalogEntries(ctx *Context, name string, id IDInput, state *CatalogEntriesState, opts ...ResourceOption) (*CatalogEntries, error)
    public static CatalogEntries Get(string name, Input<string> id, CatalogEntriesState? state, CustomResourceOptions? opts = null)
    public static CatalogEntries get(String name, Output<String> id, CatalogEntriesState state, CustomResourceOptions options)
    resources:  _:    type: incident:CatalogEntries    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.
    The following state arguments are supported:
    CatalogEntriesId string
    ID of this catalog type
    Entries Dictionary<string, CatalogEntriesEntriesArgs>
    Map of external ID to entry in the catalog.
    ManagedAttributes List<string>
    The set of attributes that are managed by this resource. By default, all attributes are managed by this resource.
    CatalogEntriesId string
    ID of this catalog type
    Entries map[string]CatalogEntriesEntriesArgs
    Map of external ID to entry in the catalog.
    ManagedAttributes []string
    The set of attributes that are managed by this resource. By default, all attributes are managed by this resource.
    catalogEntriesId String
    ID of this catalog type
    entries Map<String,CatalogEntriesEntriesArgs>
    Map of external ID to entry in the catalog.
    managedAttributes List<String>
    The set of attributes that are managed by this resource. By default, all attributes are managed by this resource.
    catalogEntriesId string
    ID of this catalog type
    entries {[key: string]: CatalogEntriesEntriesArgs}
    Map of external ID to entry in the catalog.
    managedAttributes string[]
    The set of attributes that are managed by this resource. By default, all attributes are managed by this resource.
    catalog_entries_id str
    ID of this catalog type
    entries Mapping[str, CatalogEntriesEntriesArgs]
    Map of external ID to entry in the catalog.
    managed_attributes Sequence[str]
    The set of attributes that are managed by this resource. By default, all attributes are managed by this resource.
    catalogEntriesId String
    ID of this catalog type
    entries Map<Property Map>
    Map of external ID to entry in the catalog.
    managedAttributes List<String>
    The set of attributes that are managed by this resource. By default, all attributes are managed by this resource.

    Supporting Types

    CatalogEntriesEntries, CatalogEntriesEntriesArgs

    AttributeValues Dictionary<string, CatalogEntriesEntriesAttributeValues>
    Name string
    Name is the human readable name of this entry
    Aliases List<string>
    Optional aliases that can be used to reference this entry
    Id string
    ID of this catalog entry
    Rank double
    When catalog type is ranked, this is used to help order things
    AttributeValues map[string]CatalogEntriesEntriesAttributeValues
    Name string
    Name is the human readable name of this entry
    Aliases []string
    Optional aliases that can be used to reference this entry
    Id string
    ID of this catalog entry
    Rank float64
    When catalog type is ranked, this is used to help order things
    attributeValues Map<String,CatalogEntriesEntriesAttributeValues>
    name String
    Name is the human readable name of this entry
    aliases List<String>
    Optional aliases that can be used to reference this entry
    id String
    ID of this catalog entry
    rank Double
    When catalog type is ranked, this is used to help order things
    attributeValues {[key: string]: CatalogEntriesEntriesAttributeValues}
    name string
    Name is the human readable name of this entry
    aliases string[]
    Optional aliases that can be used to reference this entry
    id string
    ID of this catalog entry
    rank number
    When catalog type is ranked, this is used to help order things
    attribute_values Mapping[str, CatalogEntriesEntriesAttributeValues]
    name str
    Name is the human readable name of this entry
    aliases Sequence[str]
    Optional aliases that can be used to reference this entry
    id str
    ID of this catalog entry
    rank float
    When catalog type is ranked, this is used to help order things
    attributeValues Map<Property Map>
    name String
    Name is the human readable name of this entry
    aliases List<String>
    Optional aliases that can be used to reference this entry
    id String
    ID of this catalog entry
    rank Number
    When catalog type is ranked, this is used to help order things

    CatalogEntriesEntriesAttributeValues, CatalogEntriesEntriesAttributeValuesArgs

    ArrayValues List<string>
    The value of this element of the array, in a format suitable for this attribute type.
    Value string
    The value of this attribute, in a format suitable for this attribute type.
    ArrayValues []string
    The value of this element of the array, in a format suitable for this attribute type.
    Value string
    The value of this attribute, in a format suitable for this attribute type.
    arrayValues List<String>
    The value of this element of the array, in a format suitable for this attribute type.
    value String
    The value of this attribute, in a format suitable for this attribute type.
    arrayValues string[]
    The value of this element of the array, in a format suitable for this attribute type.
    value string
    The value of this attribute, in a format suitable for this attribute type.
    array_values Sequence[str]
    The value of this element of the array, in a format suitable for this attribute type.
    value str
    The value of this attribute, in a format suitable for this attribute type.
    arrayValues List<String>
    The value of this element of the array, in a format suitable for this attribute type.
    value String
    The value of this attribute, in a format suitable for this attribute type.

    Import

    #!/bin/bash

    Import catalog entries using the catalog_type_id

    Replace the ID with a real catalog type ID from your incident.io organization

    $ pulumi import incident:index/catalogEntries:CatalogEntries example 01ABC123DEF456GHI789JKL

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

    Package Details

    Repository
    incident incident-io/terraform-provider-incident
    License
    Notes
    This Pulumi package is based on the incident Terraform Provider.
    incident logo
    incident 5.5.0 published on Wednesday, Apr 30, 2025 by incident-io
    incident-io/terraform-provider-incident