@port-labs/port/entity.d.ts

A Pulumi package for creating and managing Port resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
 * Entity resource
 */
export declare class Entity extends pulumi.CustomResource {
    /**
     * Get an existing Entity resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: EntityState, opts?: pulumi.CustomResourceOptions): Entity;
    /**
     * Returns true if the given object is an instance of Entity.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is Entity;
    /**
     * The blueprint identifier the entity relates to
     */
    readonly blueprint: pulumi.Output<string>;
    /**
     * Whether to create missing related entities
     */
    readonly createMissingRelatedEntities: pulumi.Output<boolean>;
    /**
     * The creation date of the entity
     */
    readonly createdAt: pulumi.Output<string>;
    /**
     * The creator of the entity
     */
    readonly createdBy: pulumi.Output<string>;
    /**
     * The icon of the entity
     */
    readonly icon: pulumi.Output<string | undefined>;
    /**
     * The identifier of the entity
     */
    readonly identifier: pulumi.Output<string>;
    /**
     * The properties of the entity
     */
    readonly properties: pulumi.Output<outputs.EntityProperties | undefined>;
    /**
     * The relations of the entity
     */
    readonly relations: pulumi.Output<outputs.EntityRelations | undefined>;
    /**
     * The runID of the action run that created the entity
     */
    readonly runId: pulumi.Output<string | undefined>;
    /**
     * The teams the entity belongs to
     */
    readonly teams: pulumi.Output<string[] | undefined>;
    /**
     * The title of the entity
     */
    readonly title: pulumi.Output<string>;
    /**
     * The last update date of the entity
     */
    readonly updatedAt: pulumi.Output<string>;
    /**
     * The last updater of the entity
     */
    readonly updatedBy: pulumi.Output<string>;
    /**
     * Create a Entity resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: EntityArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Entity resources.
 */
export interface EntityState {
    /**
     * The blueprint identifier the entity relates to
     */
    blueprint?: pulumi.Input<string>;
    /**
     * Whether to create missing related entities
     */
    createMissingRelatedEntities?: pulumi.Input<boolean>;
    /**
     * The creation date of the entity
     */
    createdAt?: pulumi.Input<string>;
    /**
     * The creator of the entity
     */
    createdBy?: pulumi.Input<string>;
    /**
     * The icon of the entity
     */
    icon?: pulumi.Input<string>;
    /**
     * The identifier of the entity
     */
    identifier?: pulumi.Input<string>;
    /**
     * The properties of the entity
     */
    properties?: pulumi.Input<inputs.EntityProperties>;
    /**
     * The relations of the entity
     */
    relations?: pulumi.Input<inputs.EntityRelations>;
    /**
     * The runID of the action run that created the entity
     */
    runId?: pulumi.Input<string>;
    /**
     * The teams the entity belongs to
     */
    teams?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * The title of the entity
     */
    title?: pulumi.Input<string>;
    /**
     * The last update date of the entity
     */
    updatedAt?: pulumi.Input<string>;
    /**
     * The last updater of the entity
     */
    updatedBy?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a Entity resource.
 */
export interface EntityArgs {
    /**
     * The blueprint identifier the entity relates to
     */
    blueprint: pulumi.Input<string>;
    /**
     * Whether to create missing related entities
     */
    createMissingRelatedEntities?: pulumi.Input<boolean>;
    /**
     * The icon of the entity
     */
    icon?: pulumi.Input<string>;
    /**
     * The identifier of the entity
     */
    identifier?: pulumi.Input<string>;
    /**
     * The properties of the entity
     */
    properties?: pulumi.Input<inputs.EntityProperties>;
    /**
     * The relations of the entity
     */
    relations?: pulumi.Input<inputs.EntityRelations>;
    /**
     * The runID of the action run that created the entity
     */
    runId?: pulumi.Input<string>;
    /**
     * The teams the entity belongs to
     */
    teams?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * The title of the entity
     */
    title: pulumi.Input<string>;
}