Port v1.10.6, Apr 19 24

Port v1.10.6 published on Friday, Apr 19, 2024 by port-labs

port.Page

Explore with Pulumi AI

Port v1.10.6 published on Friday, Apr 19, 2024 by port-labs

Create Page Resource

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

Constructor syntax

new Page(name: string, args: PageArgs, opts?: CustomResourceOptions);

@overload
def Page(resource_name: str,
         args: PageArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def Page(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         identifier: Optional[str] = None,
         type: Optional[str] = None,
         after: Optional[str] = None,
         blueprint: Optional[str] = None,
         icon: Optional[str] = None,
         locked: Optional[bool] = None,
         parent: Optional[str] = None,
         title: Optional[str] = None,
         widgets: Optional[Sequence[str]] = None)

func NewPage(ctx *Context, name string, args PageArgs, opts ...ResourceOption) (*Page, error)

public Page(string name, PageArgs args, CustomResourceOptions? opts = null)

public Page(String name, PageArgs args)
public Page(String name, PageArgs args, CustomResourceOptions options)

type: port:Page
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 PageArgs: 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 PageArgs: 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 PageArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args PageArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args PageArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Example

The following reference example uses placeholder values for all input properties.

var pageResource = new Port.Page("pageResource", new()
{
    Identifier = "string",
    Type = "string",
    After = "string",
    Blueprint = "string",
    Icon = "string",
    Locked = false,
    Parent = "string",
    Title = "string",
    Widgets = new[]
    {
        "string",
    },
});

example, err := port.NewPage(ctx, "pageResource", &port.PageArgs{
	Identifier: pulumi.String("string"),
	Type:       pulumi.String("string"),
	After:      pulumi.String("string"),
	Blueprint:  pulumi.String("string"),
	Icon:       pulumi.String("string"),
	Locked:     pulumi.Bool(false),
	Parent:     pulumi.String("string"),
	Title:      pulumi.String("string"),
	Widgets: pulumi.StringArray{
		pulumi.String("string"),
	},
})

var pageResource = new Page("pageResource", PageArgs.builder()        
    .identifier("string")
    .type("string")
    .after("string")
    .blueprint("string")
    .icon("string")
    .locked(false)
    .parent("string")
    .title("string")
    .widgets("string")
    .build());

page_resource = port.Page("pageResource",
    identifier="string",
    type="string",
    after="string",
    blueprint="string",
    icon="string",
    locked=False,
    parent="string",
    title="string",
    widgets=["string"])

const pageResource = new port.Page("pageResource", {
    identifier: "string",
    type: "string",
    after: "string",
    blueprint: "string",
    icon: "string",
    locked: false,
    parent: "string",
    title: "string",
    widgets: ["string"],
});

type: port:Page
properties:
    after: string
    blueprint: string
    icon: string
    identifier: string
    locked: false
    parent: string
    title: string
    type: string
    widgets:
        - string

Page Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Page resource accepts the following input properties:

Identifier string: The Identifier of the page
Type string: The type of the page, can be one of "blueprint-entities", "dashboard" or "home"
After string: The identifier of the page/folder after which the page should be placed
Blueprint string: The blueprint for which the page is created, relevant only for pages of type "blueprint-entities"
Icon string: The icon of the page
Locked bool: Whether the page is locked, if true, viewers will not be able to edit the page widgets and filters
Parent string: The identifier of the folder in which the page is in, default is the root of the sidebar
Title string: The title of the page
Widgets List<string>: The widgets of the page

Identifier string: The Identifier of the page
Type string: The type of the page, can be one of "blueprint-entities", "dashboard" or "home"
After string: The identifier of the page/folder after which the page should be placed
Blueprint string: The blueprint for which the page is created, relevant only for pages of type "blueprint-entities"
Icon string: The icon of the page
Locked bool: Whether the page is locked, if true, viewers will not be able to edit the page widgets and filters
Parent string: The identifier of the folder in which the page is in, default is the root of the sidebar
Title string: The title of the page
Widgets []string: The widgets of the page

identifier String: The Identifier of the page
type String: The type of the page, can be one of "blueprint-entities", "dashboard" or "home"
after String: The identifier of the page/folder after which the page should be placed
blueprint String: The blueprint for which the page is created, relevant only for pages of type "blueprint-entities"
icon String: The icon of the page
locked Boolean: Whether the page is locked, if true, viewers will not be able to edit the page widgets and filters
parent String: The identifier of the folder in which the page is in, default is the root of the sidebar
title String: The title of the page
widgets List<String>: The widgets of the page

identifier string: The Identifier of the page
type string: The type of the page, can be one of "blueprint-entities", "dashboard" or "home"
after string: The identifier of the page/folder after which the page should be placed
blueprint string: The blueprint for which the page is created, relevant only for pages of type "blueprint-entities"
icon string: The icon of the page
locked boolean: Whether the page is locked, if true, viewers will not be able to edit the page widgets and filters
parent string: The identifier of the folder in which the page is in, default is the root of the sidebar
title string: The title of the page
widgets string[]: The widgets of the page

identifier str: The Identifier of the page
type str: The type of the page, can be one of "blueprint-entities", "dashboard" or "home"
after str: The identifier of the page/folder after which the page should be placed
blueprint str: The blueprint for which the page is created, relevant only for pages of type "blueprint-entities"
icon str: The icon of the page
locked bool: Whether the page is locked, if true, viewers will not be able to edit the page widgets and filters
parent str: The identifier of the folder in which the page is in, default is the root of the sidebar
title str: The title of the page
widgets Sequence[str]: The widgets of the page

identifier String: The Identifier of the page
type String: The type of the page, can be one of "blueprint-entities", "dashboard" or "home"
after String: The identifier of the page/folder after which the page should be placed
blueprint String: The blueprint for which the page is created, relevant only for pages of type "blueprint-entities"
icon String: The icon of the page
locked Boolean: Whether the page is locked, if true, viewers will not be able to edit the page widgets and filters
parent String: The identifier of the folder in which the page is in, default is the root of the sidebar
title String: The title of the page
widgets List<String>: The widgets of the page

Outputs

All input properties are implicitly available as output properties. Additionally, the Page resource produces the following output properties:

CreatedAt string: The creation date of the page
CreatedBy string: The creator of the page
Id string: The provider-assigned unique ID for this managed resource.
UpdatedAt string: The last update date of the page
UpdatedBy string: The last updater of the page

CreatedAt string: The creation date of the page
CreatedBy string: The creator of the page
Id string: The provider-assigned unique ID for this managed resource.
UpdatedAt string: The last update date of the page
UpdatedBy string: The last updater of the page

createdAt String: The creation date of the page
createdBy String: The creator of the page
id String: The provider-assigned unique ID for this managed resource.
updatedAt String: The last update date of the page
updatedBy String: The last updater of the page

createdAt string: The creation date of the page
createdBy string: The creator of the page
id string: The provider-assigned unique ID for this managed resource.
updatedAt string: The last update date of the page
updatedBy string: The last updater of the page

created_at str: The creation date of the page
created_by str: The creator of the page
id str: The provider-assigned unique ID for this managed resource.
updated_at str: The last update date of the page
updated_by str: The last updater of the page

createdAt String: The creation date of the page
createdBy String: The creator of the page
id String: The provider-assigned unique ID for this managed resource.
updatedAt String: The last update date of the page
updatedBy String: The last updater of the page

Look up Existing Page Resource

Get an existing Page 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?: PageState, opts?: CustomResourceOptions): Page

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        after: Optional[str] = None,
        blueprint: Optional[str] = None,
        created_at: Optional[str] = None,
        created_by: Optional[str] = None,
        icon: Optional[str] = None,
        identifier: Optional[str] = None,
        locked: Optional[bool] = None,
        parent: Optional[str] = None,
        title: Optional[str] = None,
        type: Optional[str] = None,
        updated_at: Optional[str] = None,
        updated_by: Optional[str] = None,
        widgets: Optional[Sequence[str]] = None) -> Page

func GetPage(ctx *Context, name string, id IDInput, state *PageState, opts ...ResourceOption) (*Page, error)

public static Page Get(string name, Input<string> id, PageState? state, CustomResourceOptions? opts = null)

public static Page get(String name, Output<String> id, PageState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

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:

After string: The identifier of the page/folder after which the page should be placed
Blueprint string: The blueprint for which the page is created, relevant only for pages of type "blueprint-entities"
CreatedAt string: The creation date of the page
CreatedBy string: The creator of the page
Icon string: The icon of the page
Identifier string: The Identifier of the page
Locked bool: Whether the page is locked, if true, viewers will not be able to edit the page widgets and filters
Parent string: The identifier of the folder in which the page is in, default is the root of the sidebar
Title string: The title of the page
Type string: The type of the page, can be one of "blueprint-entities", "dashboard" or "home"
UpdatedAt string: The last update date of the page
UpdatedBy string: The last updater of the page
Widgets List<string>: The widgets of the page

After string: The identifier of the page/folder after which the page should be placed
Blueprint string: The blueprint for which the page is created, relevant only for pages of type "blueprint-entities"
CreatedAt string: The creation date of the page
CreatedBy string: The creator of the page
Icon string: The icon of the page
Identifier string: The Identifier of the page
Locked bool: Whether the page is locked, if true, viewers will not be able to edit the page widgets and filters
Parent string: The identifier of the folder in which the page is in, default is the root of the sidebar
Title string: The title of the page
Type string: The type of the page, can be one of "blueprint-entities", "dashboard" or "home"
UpdatedAt string: The last update date of the page
UpdatedBy string: The last updater of the page
Widgets []string: The widgets of the page

after String: The identifier of the page/folder after which the page should be placed
blueprint String: The blueprint for which the page is created, relevant only for pages of type "blueprint-entities"
createdAt String: The creation date of the page
createdBy String: The creator of the page
icon String: The icon of the page
identifier String: The Identifier of the page
locked Boolean: Whether the page is locked, if true, viewers will not be able to edit the page widgets and filters
parent String: The identifier of the folder in which the page is in, default is the root of the sidebar
title String: The title of the page
type String: The type of the page, can be one of "blueprint-entities", "dashboard" or "home"
updatedAt String: The last update date of the page
updatedBy String: The last updater of the page
widgets List<String>: The widgets of the page

after string: The identifier of the page/folder after which the page should be placed
blueprint string: The blueprint for which the page is created, relevant only for pages of type "blueprint-entities"
createdAt string: The creation date of the page
createdBy string: The creator of the page
icon string: The icon of the page
identifier string: The Identifier of the page
locked boolean: Whether the page is locked, if true, viewers will not be able to edit the page widgets and filters
parent string: The identifier of the folder in which the page is in, default is the root of the sidebar
title string: The title of the page
type string: The type of the page, can be one of "blueprint-entities", "dashboard" or "home"
updatedAt string: The last update date of the page
updatedBy string: The last updater of the page
widgets string[]: The widgets of the page

after str: The identifier of the page/folder after which the page should be placed
blueprint str: The blueprint for which the page is created, relevant only for pages of type "blueprint-entities"
created_at str: The creation date of the page
created_by str: The creator of the page
icon str: The icon of the page
identifier str: The Identifier of the page
locked bool: Whether the page is locked, if true, viewers will not be able to edit the page widgets and filters
parent str: The identifier of the folder in which the page is in, default is the root of the sidebar
title str: The title of the page
type str: The type of the page, can be one of "blueprint-entities", "dashboard" or "home"
updated_at str: The last update date of the page
updated_by str: The last updater of the page
widgets Sequence[str]: The widgets of the page

after String: The identifier of the page/folder after which the page should be placed
blueprint String: The blueprint for which the page is created, relevant only for pages of type "blueprint-entities"
createdAt String: The creation date of the page
createdBy String: The creator of the page
icon String: The icon of the page
identifier String: The Identifier of the page
locked Boolean: Whether the page is locked, if true, viewers will not be able to edit the page widgets and filters
parent String: The identifier of the folder in which the page is in, default is the root of the sidebar
title String: The title of the page
type String: The type of the page, can be one of "blueprint-entities", "dashboard" or "home"
updatedAt String: The last update date of the page
updatedBy String: The last updater of the page
widgets List<String>: The widgets of the page

Package Details

Repository: port port-labs/pulumi-port
License: Apache-2.0
Notes: This Pulumi package is based on the port Terraform Provider.

Port v1.10.6 published on Friday, Apr 19, 2024 by port-labs

port-labs/pulumi-port

port.Page

On this page

On this page

Create Page Resource

Constructor syntax

Parameters

Example

Page Resource Properties

Inputs

Outputs

Look up Existing Page Resource

Package Details

On this page

On this page