@port-labs/port
Version:
A Pulumi package for creating and managing Port resources.
201 lines (200 loc) • 6.74 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
export declare class Page extends pulumi.CustomResource {
/**
* Get an existing Page 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?: PageState, opts?: pulumi.CustomResourceOptions): Page;
/**
* Returns true if the given object is an instance of Page. 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 Page;
/**
* The identifier of the page/folder after which the page should be placed
*/
readonly after: pulumi.Output<string | undefined>;
/**
* The blueprint for which the page is created, relevant only for pages of type "blueprint-entities"
*/
readonly blueprint: pulumi.Output<string | undefined>;
/**
* The creation date of the page
*/
readonly createdAt: pulumi.Output<string>;
/**
* The creator of the page
*/
readonly createdBy: pulumi.Output<string>;
/**
* The page description
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The icon of the page
*/
readonly icon: pulumi.Output<string | undefined>;
/**
* The Identifier of the page
*/
readonly identifier: pulumi.Output<string>;
/**
* Whether the page is locked, if true, viewers will not be able to edit the page widgets and filters
*/
readonly locked: pulumi.Output<boolean | undefined>;
/**
* The page filters. Each filter is a JSON object with 'identifier' (string), 'title' (string), and 'query' (object with 'combinator' and 'rules' array). The rules array can contain any filter type.
*/
readonly pageFilters: pulumi.Output<string[] | undefined>;
/**
* The identifier of the folder in which the page is in, default is the root of the sidebar
*/
readonly parent: pulumi.Output<string | undefined>;
/**
* The title of the page
*/
readonly title: pulumi.Output<string | undefined>;
/**
* The type of the page, can be one of "blueprint-entities", "dashboard" or "home"
*/
readonly type: pulumi.Output<string>;
/**
* The last update date of the page
*/
readonly updatedAt: pulumi.Output<string>;
/**
* The last updater of the page
*/
readonly updatedBy: pulumi.Output<string>;
/**
* The widgets of the page
*/
readonly widgets: pulumi.Output<string[] | undefined>;
/**
* Create a Page 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: PageArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Page resources.
*/
export interface PageState {
/**
* The identifier of the page/folder after which the page should be placed
*/
after?: pulumi.Input<string>;
/**
* The blueprint for which the page is created, relevant only for pages of type "blueprint-entities"
*/
blueprint?: pulumi.Input<string>;
/**
* The creation date of the page
*/
createdAt?: pulumi.Input<string>;
/**
* The creator of the page
*/
createdBy?: pulumi.Input<string>;
/**
* The page description
*/
description?: pulumi.Input<string>;
/**
* The icon of the page
*/
icon?: pulumi.Input<string>;
/**
* The Identifier of the page
*/
identifier?: pulumi.Input<string>;
/**
* Whether the page is locked, if true, viewers will not be able to edit the page widgets and filters
*/
locked?: pulumi.Input<boolean>;
/**
* The page filters. Each filter is a JSON object with 'identifier' (string), 'title' (string), and 'query' (object with 'combinator' and 'rules' array). The rules array can contain any filter type.
*/
pageFilters?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The identifier of the folder in which the page is in, default is the root of the sidebar
*/
parent?: pulumi.Input<string>;
/**
* The title of the page
*/
title?: pulumi.Input<string>;
/**
* The type of the page, can be one of "blueprint-entities", "dashboard" or "home"
*/
type?: pulumi.Input<string>;
/**
* The last update date of the page
*/
updatedAt?: pulumi.Input<string>;
/**
* The last updater of the page
*/
updatedBy?: pulumi.Input<string>;
/**
* The widgets of the page
*/
widgets?: pulumi.Input<pulumi.Input<string>[]>;
}
/**
* The set of arguments for constructing a Page resource.
*/
export interface PageArgs {
/**
* The identifier of the page/folder after which the page should be placed
*/
after?: pulumi.Input<string>;
/**
* The blueprint for which the page is created, relevant only for pages of type "blueprint-entities"
*/
blueprint?: pulumi.Input<string>;
/**
* The page description
*/
description?: pulumi.Input<string>;
/**
* The icon of the page
*/
icon?: pulumi.Input<string>;
/**
* The Identifier of the page
*/
identifier: pulumi.Input<string>;
/**
* Whether the page is locked, if true, viewers will not be able to edit the page widgets and filters
*/
locked?: pulumi.Input<boolean>;
/**
* The page filters. Each filter is a JSON object with 'identifier' (string), 'title' (string), and 'query' (object with 'combinator' and 'rules' array). The rules array can contain any filter type.
*/
pageFilters?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The identifier of the folder in which the page is in, default is the root of the sidebar
*/
parent?: pulumi.Input<string>;
/**
* The title of the page
*/
title?: pulumi.Input<string>;
/**
* The type of the page, can be one of "blueprint-entities", "dashboard" or "home"
*/
type: pulumi.Input<string>;
/**
* The widgets of the page
*/
widgets?: pulumi.Input<pulumi.Input<string>[]>;
}