@port-labs/port/blueprint.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";
export declare class Blueprint extends pulumi.CustomResource {
    /**
     * Get an existing Blueprint 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?: BlueprintState, opts?: pulumi.CustomResourceOptions): Blueprint;
    /**
     * Returns true if the given object is an instance of Blueprint.  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 Blueprint;
    /**
     * The calculation properties of the blueprint
     */
    readonly calculationProperties: pulumi.Output<{
        [key: string]: outputs.BlueprintCalculationProperties;
    } | undefined>;
    /**
     * This flag is only relevant for blueprint creation, by default if not set, a catalog page will be created for the blueprint
     */
    readonly createCatalogPage: pulumi.Output<boolean>;
    /**
     * The creation date of the blueprint
     */
    readonly createdAt: pulumi.Output<string>;
    /**
     * The creator of the blueprint
     */
    readonly createdBy: pulumi.Output<string>;
    /**
     * The description of the blueprint
     */
    readonly description: pulumi.Output<string | undefined>;
    readonly forceDeleteEntities: pulumi.Output<boolean>;
    /**
     * The icon of the blueprint
     */
    readonly icon: pulumi.Output<string | undefined>;
    /**
     * The identifier of the blueprint
     */
    readonly identifier: pulumi.Output<string>;
    /**
     * The changelog destination of the blueprint
     */
    readonly kafkaChangelogDestination: pulumi.Output<outputs.BlueprintKafkaChangelogDestination | undefined>;
    /**
     * The mirror properties of the blueprint
     */
    readonly mirrorProperties: pulumi.Output<{
        [key: string]: outputs.BlueprintMirrorProperties;
    } | undefined>;
    /**
     * Optional ownership field for Blueprint. 'type' can be Inherited or Direct. If 'Inherited', then 'path' is required and must be a valid relation identifiers path.
     */
    readonly ownership: pulumi.Output<outputs.BlueprintOwnership | undefined>;
    /**
     * The properties of the blueprint
     */
    readonly properties: pulumi.Output<outputs.BlueprintProperties | undefined>;
    /**
     * The relations of the blueprint
     */
    readonly relations: pulumi.Output<{
        [key: string]: outputs.BlueprintRelations;
    } | undefined>;
    /**
     * The team inheritance of the blueprint
     *
     * @deprecated After the Users and Teams migration, `teamInheritance` will be ignored in favor of `ownership`
     */
    readonly teamInheritance: pulumi.Output<outputs.BlueprintTeamInheritance | undefined>;
    /**
     * The display name of the blueprint
     */
    readonly title: pulumi.Output<string>;
    /**
     * The last update date of the blueprint
     */
    readonly updatedAt: pulumi.Output<string>;
    /**
     * The last updater of the blueprint
     */
    readonly updatedBy: pulumi.Output<string>;
    /**
     * The webhook changelog destination of the blueprint
     */
    readonly webhookChangelogDestination: pulumi.Output<outputs.BlueprintWebhookChangelogDestination | undefined>;
    /**
     * Create a Blueprint 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: BlueprintArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Blueprint resources.
 */
export interface BlueprintState {
    /**
     * The calculation properties of the blueprint
     */
    calculationProperties?: pulumi.Input<{
        [key: string]: pulumi.Input<inputs.BlueprintCalculationProperties>;
    }>;
    /**
     * This flag is only relevant for blueprint creation, by default if not set, a catalog page will be created for the blueprint
     */
    createCatalogPage?: pulumi.Input<boolean>;
    /**
     * The creation date of the blueprint
     */
    createdAt?: pulumi.Input<string>;
    /**
     * The creator of the blueprint
     */
    createdBy?: pulumi.Input<string>;
    /**
     * The description of the blueprint
     */
    description?: pulumi.Input<string>;
    forceDeleteEntities?: pulumi.Input<boolean>;
    /**
     * The icon of the blueprint
     */
    icon?: pulumi.Input<string>;
    /**
     * The identifier of the blueprint
     */
    identifier?: pulumi.Input<string>;
    /**
     * The changelog destination of the blueprint
     */
    kafkaChangelogDestination?: pulumi.Input<inputs.BlueprintKafkaChangelogDestination>;
    /**
     * The mirror properties of the blueprint
     */
    mirrorProperties?: pulumi.Input<{
        [key: string]: pulumi.Input<inputs.BlueprintMirrorProperties>;
    }>;
    /**
     * Optional ownership field for Blueprint. 'type' can be Inherited or Direct. If 'Inherited', then 'path' is required and must be a valid relation identifiers path.
     */
    ownership?: pulumi.Input<inputs.BlueprintOwnership>;
    /**
     * The properties of the blueprint
     */
    properties?: pulumi.Input<inputs.BlueprintProperties>;
    /**
     * The relations of the blueprint
     */
    relations?: pulumi.Input<{
        [key: string]: pulumi.Input<inputs.BlueprintRelations>;
    }>;
    /**
     * The team inheritance of the blueprint
     *
     * @deprecated After the Users and Teams migration, `teamInheritance` will be ignored in favor of `ownership`
     */
    teamInheritance?: pulumi.Input<inputs.BlueprintTeamInheritance>;
    /**
     * The display name of the blueprint
     */
    title?: pulumi.Input<string>;
    /**
     * The last update date of the blueprint
     */
    updatedAt?: pulumi.Input<string>;
    /**
     * The last updater of the blueprint
     */
    updatedBy?: pulumi.Input<string>;
    /**
     * The webhook changelog destination of the blueprint
     */
    webhookChangelogDestination?: pulumi.Input<inputs.BlueprintWebhookChangelogDestination>;
}
/**
 * The set of arguments for constructing a Blueprint resource.
 */
export interface BlueprintArgs {
    /**
     * The calculation properties of the blueprint
     */
    calculationProperties?: pulumi.Input<{
        [key: string]: pulumi.Input<inputs.BlueprintCalculationProperties>;
    }>;
    /**
     * This flag is only relevant for blueprint creation, by default if not set, a catalog page will be created for the blueprint
     */
    createCatalogPage?: pulumi.Input<boolean>;
    /**
     * The description of the blueprint
     */
    description?: pulumi.Input<string>;
    forceDeleteEntities?: pulumi.Input<boolean>;
    /**
     * The icon of the blueprint
     */
    icon?: pulumi.Input<string>;
    /**
     * The identifier of the blueprint
     */
    identifier: pulumi.Input<string>;
    /**
     * The changelog destination of the blueprint
     */
    kafkaChangelogDestination?: pulumi.Input<inputs.BlueprintKafkaChangelogDestination>;
    /**
     * The mirror properties of the blueprint
     */
    mirrorProperties?: pulumi.Input<{
        [key: string]: pulumi.Input<inputs.BlueprintMirrorProperties>;
    }>;
    /**
     * Optional ownership field for Blueprint. 'type' can be Inherited or Direct. If 'Inherited', then 'path' is required and must be a valid relation identifiers path.
     */
    ownership?: pulumi.Input<inputs.BlueprintOwnership>;
    /**
     * The properties of the blueprint
     */
    properties?: pulumi.Input<inputs.BlueprintProperties>;
    /**
     * The relations of the blueprint
     */
    relations?: pulumi.Input<{
        [key: string]: pulumi.Input<inputs.BlueprintRelations>;
    }>;
    /**
     * The team inheritance of the blueprint
     *
     * @deprecated After the Users and Teams migration, `teamInheritance` will be ignored in favor of `ownership`
     */
    teamInheritance?: pulumi.Input<inputs.BlueprintTeamInheritance>;
    /**
     * The display name of the blueprint
     */
    title: pulumi.Input<string>;
    /**
     * The webhook changelog destination of the blueprint
     */
    webhookChangelogDestination?: pulumi.Input<inputs.BlueprintWebhookChangelogDestination>;
}