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

incident.CatalogEntry

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 CatalogEntry Resource

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

    Constructor syntax

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

@overload
def CatalogEntry(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 attribute_values: Optional[Sequence[CatalogEntryAttributeValueArgs]] = None,
                 catalog_type_id: Optional[str] = None,
                 aliases: Optional[Sequence[str]] = None,
                 external_id: Optional[str] = None,
                 managed_attributes: Optional[Sequence[str]] = None,
                 name: Optional[str] = None,
                 rank: Optional[float] = None)
    func NewCatalogEntry(ctx *Context, name string, args CatalogEntryArgs, opts ...ResourceOption) (*CatalogEntry, error)
    public CatalogEntry(string name, CatalogEntryArgs args, CustomResourceOptions? opts = null)
    public CatalogEntry(String name, CatalogEntryArgs args)
public CatalogEntry(String name, CatalogEntryArgs args, CustomResourceOptions options)

    type: incident:CatalogEntry
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 CatalogEntryArgs
    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 CatalogEntryArgs
    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 CatalogEntryArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CatalogEntryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CatalogEntryArgs
    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 catalogEntryResource = new Incident.CatalogEntry("catalogEntryResource", new()
{
    AttributeValues = new[]
    {
        new Incident.Inputs.CatalogEntryAttributeValueArgs
        {
            Attribute = "string",
            ArrayValues = new[]
            {
                "string",
            },
            Value = "string",
        },
    },
    CatalogTypeId = "string",
    Aliases = new[]
    {
        "string",
    },
    ExternalId = "string",
    ManagedAttributes = new[]
    {
        "string",
    },
    Name = "string",
    Rank = 0,
});

    example, err := incident.NewCatalogEntry(ctx, "catalogEntryResource", &incident.CatalogEntryArgs{
	AttributeValues: incident.CatalogEntryAttributeValueArray{
		&incident.CatalogEntryAttributeValueArgs{
			Attribute: pulumi.String("string"),
			ArrayValues: pulumi.StringArray{
				pulumi.String("string"),
			},
			Value: pulumi.String("string"),
		},
	},
	CatalogTypeId: pulumi.String("string"),
	Aliases: pulumi.StringArray{
		pulumi.String("string"),
	},
	ExternalId: pulumi.String("string"),
	ManagedAttributes: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	Rank: pulumi.Float64(0),
})

    var catalogEntryResource = new CatalogEntry("catalogEntryResource", CatalogEntryArgs.builder()
    .attributeValues(CatalogEntryAttributeValueArgs.builder()
        .attribute("string")
        .arrayValues("string")
        .value("string")
        .build())
    .catalogTypeId("string")
    .aliases("string")
    .externalId("string")
    .managedAttributes("string")
    .name("string")
    .rank(0)
    .build());

    catalog_entry_resource = incident.CatalogEntry("catalogEntryResource",
    attribute_values=[{
        "attribute": "string",
        "array_values": ["string"],
        "value": "string",
    }],
    catalog_type_id="string",
    aliases=["string"],
    external_id="string",
    managed_attributes=["string"],
    name="string",
    rank=0)

    const catalogEntryResource = new incident.CatalogEntry("catalogEntryResource", {
    attributeValues: [{
        attribute: "string",
        arrayValues: ["string"],
        value: "string",
    }],
    catalogTypeId: "string",
    aliases: ["string"],
    externalId: "string",
    managedAttributes: ["string"],
    name: "string",
    rank: 0,
});

    type: incident:CatalogEntry
properties:
    aliases:
        - string
    attributeValues:
        - arrayValues:
            - string
          attribute: string
          value: string
    catalogTypeId: string
    externalId: string
    managedAttributes:
        - string
    name: string
    rank: 0

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

    AttributeValues List<CatalogEntryAttributeValue>
    CatalogTypeId string
    ID of this catalog type
    Aliases List<string>
    Optional aliases that can be used to reference this entry
    ExternalId string
    An optional alternative ID for this entry, which is ensured to be unique for the type
    ManagedAttributes List<string>
    The set of attributes that are managed by this resource. By default, all attributes are managed by this resource.
    Name string
    Name is the human readable name of this entry
    Rank double
    When catalog type is ranked, this is used to help order things
    AttributeValues []CatalogEntryAttributeValueArgs
    CatalogTypeId string
    ID of this catalog type
    Aliases []string
    Optional aliases that can be used to reference this entry
    ExternalId string
    An optional alternative ID for this entry, which is ensured to be unique for the type
    ManagedAttributes []string
    The set of attributes that are managed by this resource. By default, all attributes are managed by this resource.
    Name string
    Name is the human readable name of this entry
    Rank float64
    When catalog type is ranked, this is used to help order things
    attributeValues List<CatalogEntryAttributeValue>
    catalogTypeId String
    ID of this catalog type
    aliases List<String>
    Optional aliases that can be used to reference this entry
    externalId String
    An optional alternative ID for this entry, which is ensured to be unique for the type
    managedAttributes List<String>
    The set of attributes that are managed by this resource. By default, all attributes are managed by this resource.
    name String
    Name is the human readable name of this entry
    rank Double
    When catalog type is ranked, this is used to help order things
    attributeValues CatalogEntryAttributeValue[]
    catalogTypeId string
    ID of this catalog type
    aliases string[]
    Optional aliases that can be used to reference this entry
    externalId string
    An optional alternative ID for this entry, which is ensured to be unique for the type
    managedAttributes string[]
    The set of attributes that are managed by this resource. By default, all attributes are managed by this resource.
    name string
    Name is the human readable name of this entry
    rank number
    When catalog type is ranked, this is used to help order things
    attribute_values Sequence[CatalogEntryAttributeValueArgs]
    catalog_type_id str
    ID of this catalog type
    aliases Sequence[str]
    Optional aliases that can be used to reference this entry
    external_id str
    An optional alternative ID for this entry, which is ensured to be unique for the type
    managed_attributes Sequence[str]
    The set of attributes that are managed by this resource. By default, all attributes are managed by this resource.
    name str
    Name is the human readable name of this entry
    rank float
    When catalog type is ranked, this is used to help order things
    attributeValues List<Property Map>
    catalogTypeId String
    ID of this catalog type
    aliases List<String>
    Optional aliases that can be used to reference this entry
    externalId String
    An optional alternative ID for this entry, which is ensured to be unique for the type
    managedAttributes List<String>
    The set of attributes that are managed by this resource. By default, all attributes are managed by this resource.
    name String
    Name is the human readable name of this entry
    rank Number
    When catalog type is ranked, this is used to help order things

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CatalogEntry 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 CatalogEntry Resource

    Get an existing CatalogEntry 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?: CatalogEntryState, opts?: CustomResourceOptions): CatalogEntry
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aliases: Optional[Sequence[str]] = None,
        attribute_values: Optional[Sequence[CatalogEntryAttributeValueArgs]] = None,
        catalog_type_id: Optional[str] = None,
        external_id: Optional[str] = None,
        managed_attributes: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        rank: Optional[float] = None) -> CatalogEntry
    func GetCatalogEntry(ctx *Context, name string, id IDInput, state *CatalogEntryState, opts ...ResourceOption) (*CatalogEntry, error)
    public static CatalogEntry Get(string name, Input<string> id, CatalogEntryState? state, CustomResourceOptions? opts = null)
    public static CatalogEntry get(String name, Output<String> id, CatalogEntryState state, CustomResourceOptions options)
    resources:  _:    type: incident:CatalogEntry    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:
    Aliases List<string>
    Optional aliases that can be used to reference this entry
    AttributeValues List<CatalogEntryAttributeValue>
    CatalogTypeId string
    ID of this catalog type
    ExternalId string
    An optional alternative ID for this entry, which is ensured to be unique for the type
    ManagedAttributes List<string>
    The set of attributes that are managed by this resource. By default, all attributes are managed by this resource.
    Name string
    Name is the human readable name of this entry
    Rank double
    When catalog type is ranked, this is used to help order things
    Aliases []string
    Optional aliases that can be used to reference this entry
    AttributeValues []CatalogEntryAttributeValueArgs
    CatalogTypeId string
    ID of this catalog type
    ExternalId string
    An optional alternative ID for this entry, which is ensured to be unique for the type
    ManagedAttributes []string
    The set of attributes that are managed by this resource. By default, all attributes are managed by this resource.
    Name string
    Name is the human readable name of this entry
    Rank float64
    When catalog type is ranked, this is used to help order things
    aliases List<String>
    Optional aliases that can be used to reference this entry
    attributeValues List<CatalogEntryAttributeValue>
    catalogTypeId String
    ID of this catalog type
    externalId String
    An optional alternative ID for this entry, which is ensured to be unique for the type
    managedAttributes List<String>
    The set of attributes that are managed by this resource. By default, all attributes are managed by this resource.
    name String
    Name is the human readable name of this entry
    rank Double
    When catalog type is ranked, this is used to help order things
    aliases string[]
    Optional aliases that can be used to reference this entry
    attributeValues CatalogEntryAttributeValue[]
    catalogTypeId string
    ID of this catalog type
    externalId string
    An optional alternative ID for this entry, which is ensured to be unique for the type
    managedAttributes string[]
    The set of attributes that are managed by this resource. By default, all attributes are managed by this resource.
    name string
    Name is the human readable name of this entry
    rank number
    When catalog type is ranked, this is used to help order things
    aliases Sequence[str]
    Optional aliases that can be used to reference this entry
    attribute_values Sequence[CatalogEntryAttributeValueArgs]
    catalog_type_id str
    ID of this catalog type
    external_id str
    An optional alternative ID for this entry, which is ensured to be unique for the type
    managed_attributes Sequence[str]
    The set of attributes that are managed by this resource. By default, all attributes are managed by this resource.
    name str
    Name is the human readable name of this entry
    rank float
    When catalog type is ranked, this is used to help order things
    aliases List<String>
    Optional aliases that can be used to reference this entry
    attributeValues List<Property Map>
    catalogTypeId String
    ID of this catalog type
    externalId String
    An optional alternative ID for this entry, which is ensured to be unique for the type
    managedAttributes List<String>
    The set of attributes that are managed by this resource. By default, all attributes are managed by this resource.
    name String
    Name is the human readable name of this entry
    rank Number
    When catalog type is ranked, this is used to help order things

    Supporting Types

    CatalogEntryAttributeValue, CatalogEntryAttributeValueArgs

    Attribute string
    The ID of this attribute, usually loaded from the incidentcatalogtype_attribute resource.
    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.
    Attribute string
    The ID of this attribute, usually loaded from the incidentcatalogtype_attribute resource.
    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.
    attribute String
    The ID of this attribute, usually loaded from the incidentcatalogtype_attribute resource.
    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.
    attribute string
    The ID of this attribute, usually loaded from the incidentcatalogtype_attribute resource.
    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.
    attribute str
    The ID of this attribute, usually loaded from the incidentcatalogtype_attribute resource.
    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.
    attribute String
    The ID of this attribute, usually loaded from the incidentcatalogtype_attribute resource.
    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 a catalog entry using its ID

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

    $ pulumi import incident:index/catalogEntry:CatalogEntry 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