BlueprintRelation

Port v2.25.0, Sep 1 26

Viewing docs for Port v2.25.0
published on Tuesday, Sep 1, 2026 by port-labs

Schema (JSON)

port-labs/pulumi-port

Viewing docs for Port v2.25.0
published on Tuesday, Sep 1, 2026 by port-labs

Schema (JSON)

port-labs/pulumi-port

Create BlueprintRelation Resource

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

Constructor syntax

new BlueprintRelation(name: string, args: BlueprintRelationArgs, opts?: CustomResourceOptions);

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

@overload
def BlueprintRelation(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      blueprint: Optional[str] = None,
                      identifier: Optional[str] = None,
                      target: Optional[str] = None,
                      description: Optional[str] = None,
                      many: Optional[bool] = None,
                      required: Optional[bool] = None,
                      title: Optional[str] = None)

func NewBlueprintRelation(ctx *Context, name string, args BlueprintRelationArgs, opts ...ResourceOption) (*BlueprintRelation, error)

public BlueprintRelation(string name, BlueprintRelationArgs args, CustomResourceOptions? opts = null)

public BlueprintRelation(String name, BlueprintRelationArgs args)
public BlueprintRelation(String name, BlueprintRelationArgs args, CustomResourceOptions options)

type: port:BlueprintRelation
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

resource "port_blueprint_relation" "name" {
    # resource properties
}

Parameters

name string: The unique name of the resource.
args BlueprintRelationArgs: 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 BlueprintRelationArgs: 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 BlueprintRelationArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args BlueprintRelationArgs: 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 blueprintRelationResource = new Port.BlueprintRelation("blueprintRelationResource", new()
{
    Blueprint = "string",
    Identifier = "string",
    Target = "string",
    Description = "string",
    Many = false,
    Required = false,
    Title = "string",
});

example, err := port.NewBlueprintRelation(ctx, "blueprintRelationResource", &port.BlueprintRelationArgs{
	Blueprint:   pulumi.String("string"),
	Identifier:  pulumi.String("string"),
	Target:      pulumi.String("string"),
	Description: pulumi.String("string"),
	Many:        pulumi.Bool(false),
	Required:    pulumi.Bool(false),
	Title:       pulumi.String("string"),
})

resource "port_blueprint_relation" "blueprintRelationResource" {
  lifecycle {
    create_before_destroy = true
  }
  blueprint   = "string"
  identifier  = "string"
  target      = "string"
  description = "string"
  many        = false
  required    = false
  title       = "string"
}

var blueprintRelationResource = new BlueprintRelation("blueprintRelationResource", BlueprintRelationArgs.builder()
    .blueprint("string")
    .identifier("string")
    .target("string")
    .description("string")
    .many(false)
    .required(false)
    .title("string")
    .build());

blueprint_relation_resource = port.BlueprintRelation("blueprintRelationResource",
    blueprint="string",
    identifier="string",
    target="string",
    description="string",
    many=False,
    required=False,
    title="string")

const blueprintRelationResource = new port.BlueprintRelation("blueprintRelationResource", {
    blueprint: "string",
    identifier: "string",
    target: "string",
    description: "string",
    many: false,
    required: false,
    title: "string",
});

type: port:BlueprintRelation
properties:
    blueprint: string
    description: string
    identifier: string
    many: false
    required: false
    target: string
    title: string

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

Blueprint string: The identifier of the blueprint the relation belongs to
Identifier string: The identifier of the relation
Target string: The identifier of the blueprint the relation points at
Description string: The description of the relation. Port does not accept an empty value for this field, so removing it from the configuration leaves the existing description in place rather than clearing it.
Many bool: Whether the relation points at many entities
Required bool: Whether the relation is required. Port rejects a required relation whose target blueprint already has a required relation back to this one, so at most one direction of a circular pair can be required.
Title string: The title of the relation. Port does not accept an empty value for this field, so removing it from the configuration leaves the existing title in place rather than clearing it.

Blueprint string: The identifier of the blueprint the relation belongs to
Identifier string: The identifier of the relation
Target string: The identifier of the blueprint the relation points at
Description string: The description of the relation. Port does not accept an empty value for this field, so removing it from the configuration leaves the existing description in place rather than clearing it.
Many bool: Whether the relation points at many entities
Required bool: Whether the relation is required. Port rejects a required relation whose target blueprint already has a required relation back to this one, so at most one direction of a circular pair can be required.
Title string: The title of the relation. Port does not accept an empty value for this field, so removing it from the configuration leaves the existing title in place rather than clearing it.

blueprint string: The identifier of the blueprint the relation belongs to
identifier string: The identifier of the relation
target string: The identifier of the blueprint the relation points at
description string: The description of the relation. Port does not accept an empty value for this field, so removing it from the configuration leaves the existing description in place rather than clearing it.
many bool: Whether the relation points at many entities
required bool: Whether the relation is required. Port rejects a required relation whose target blueprint already has a required relation back to this one, so at most one direction of a circular pair can be required.
title string: The title of the relation. Port does not accept an empty value for this field, so removing it from the configuration leaves the existing title in place rather than clearing it.

blueprint String: The identifier of the blueprint the relation belongs to
identifier String: The identifier of the relation
target String: The identifier of the blueprint the relation points at
description String: The description of the relation. Port does not accept an empty value for this field, so removing it from the configuration leaves the existing description in place rather than clearing it.
many Boolean: Whether the relation points at many entities
required Boolean: Whether the relation is required. Port rejects a required relation whose target blueprint already has a required relation back to this one, so at most one direction of a circular pair can be required.
title String: The title of the relation. Port does not accept an empty value for this field, so removing it from the configuration leaves the existing title in place rather than clearing it.

blueprint string: The identifier of the blueprint the relation belongs to
identifier string: The identifier of the relation
target string: The identifier of the blueprint the relation points at
description string: The description of the relation. Port does not accept an empty value for this field, so removing it from the configuration leaves the existing description in place rather than clearing it.
many boolean: Whether the relation points at many entities
required boolean: Whether the relation is required. Port rejects a required relation whose target blueprint already has a required relation back to this one, so at most one direction of a circular pair can be required.
title string: The title of the relation. Port does not accept an empty value for this field, so removing it from the configuration leaves the existing title in place rather than clearing it.

blueprint str: The identifier of the blueprint the relation belongs to
identifier str: The identifier of the relation
target str: The identifier of the blueprint the relation points at
description str: The description of the relation. Port does not accept an empty value for this field, so removing it from the configuration leaves the existing description in place rather than clearing it.
many bool: Whether the relation points at many entities
required bool: Whether the relation is required. Port rejects a required relation whose target blueprint already has a required relation back to this one, so at most one direction of a circular pair can be required.
title str: The title of the relation. Port does not accept an empty value for this field, so removing it from the configuration leaves the existing title in place rather than clearing it.

blueprint String: The identifier of the blueprint the relation belongs to
identifier String: The identifier of the relation
target String: The identifier of the blueprint the relation points at
description String: The description of the relation. Port does not accept an empty value for this field, so removing it from the configuration leaves the existing description in place rather than clearing it.
many Boolean: Whether the relation points at many entities
required Boolean: Whether the relation is required. Port rejects a required relation whose target blueprint already has a required relation back to this one, so at most one direction of a circular pair can be required.
title String: The title of the relation. Port does not accept an empty value for this field, so removing it from the configuration leaves the existing title in place rather than clearing it.

Outputs

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

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        blueprint: Optional[str] = None,
        description: Optional[str] = None,
        identifier: Optional[str] = None,
        many: Optional[bool] = None,
        required: Optional[bool] = None,
        target: Optional[str] = None,
        title: Optional[str] = None) -> BlueprintRelation

func GetBlueprintRelation(ctx *Context, name string, id IDInput, state *BlueprintRelationState, opts ...ResourceOption) (*BlueprintRelation, error)

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

public static BlueprintRelation get(String name, Output<String> id, BlueprintRelationState state, CustomResourceOptions options)

resources:  _:    type: port:BlueprintRelation    get:      id: ${id}

import {
  to = port_blueprint_relation.example
  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:

Blueprint string: The identifier of the blueprint the relation belongs to
Description string: The description of the relation. Port does not accept an empty value for this field, so removing it from the configuration leaves the existing description in place rather than clearing it.
Identifier string: The identifier of the relation
Many bool: Whether the relation points at many entities
Required bool: Whether the relation is required. Port rejects a required relation whose target blueprint already has a required relation back to this one, so at most one direction of a circular pair can be required.
Target string: The identifier of the blueprint the relation points at
Title string: The title of the relation. Port does not accept an empty value for this field, so removing it from the configuration leaves the existing title in place rather than clearing it.

Blueprint string: The identifier of the blueprint the relation belongs to
Description string: The description of the relation. Port does not accept an empty value for this field, so removing it from the configuration leaves the existing description in place rather than clearing it.
Identifier string: The identifier of the relation
Many bool: Whether the relation points at many entities
Required bool: Whether the relation is required. Port rejects a required relation whose target blueprint already has a required relation back to this one, so at most one direction of a circular pair can be required.
Target string: The identifier of the blueprint the relation points at
Title string: The title of the relation. Port does not accept an empty value for this field, so removing it from the configuration leaves the existing title in place rather than clearing it.

blueprint string: The identifier of the blueprint the relation belongs to
description string: The description of the relation. Port does not accept an empty value for this field, so removing it from the configuration leaves the existing description in place rather than clearing it.
identifier string: The identifier of the relation
many bool: Whether the relation points at many entities
required bool: Whether the relation is required. Port rejects a required relation whose target blueprint already has a required relation back to this one, so at most one direction of a circular pair can be required.
target string: The identifier of the blueprint the relation points at
title string: The title of the relation. Port does not accept an empty value for this field, so removing it from the configuration leaves the existing title in place rather than clearing it.

blueprint String: The identifier of the blueprint the relation belongs to
description String: The description of the relation. Port does not accept an empty value for this field, so removing it from the configuration leaves the existing description in place rather than clearing it.
identifier String: The identifier of the relation
many Boolean: Whether the relation points at many entities
required Boolean: Whether the relation is required. Port rejects a required relation whose target blueprint already has a required relation back to this one, so at most one direction of a circular pair can be required.
target String: The identifier of the blueprint the relation points at
title String: The title of the relation. Port does not accept an empty value for this field, so removing it from the configuration leaves the existing title in place rather than clearing it.

blueprint string: The identifier of the blueprint the relation belongs to
description string: The description of the relation. Port does not accept an empty value for this field, so removing it from the configuration leaves the existing description in place rather than clearing it.
identifier string: The identifier of the relation
many boolean: Whether the relation points at many entities
required boolean: Whether the relation is required. Port rejects a required relation whose target blueprint already has a required relation back to this one, so at most one direction of a circular pair can be required.
target string: The identifier of the blueprint the relation points at
title string: The title of the relation. Port does not accept an empty value for this field, so removing it from the configuration leaves the existing title in place rather than clearing it.

blueprint str: The identifier of the blueprint the relation belongs to
description str: The description of the relation. Port does not accept an empty value for this field, so removing it from the configuration leaves the existing description in place rather than clearing it.
identifier str: The identifier of the relation
many bool: Whether the relation points at many entities
required bool: Whether the relation is required. Port rejects a required relation whose target blueprint already has a required relation back to this one, so at most one direction of a circular pair can be required.
target str: The identifier of the blueprint the relation points at
title str: The title of the relation. Port does not accept an empty value for this field, so removing it from the configuration leaves the existing title in place rather than clearing it.

blueprint String: The identifier of the blueprint the relation belongs to
description String: The description of the relation. Port does not accept an empty value for this field, so removing it from the configuration leaves the existing description in place rather than clearing it.
identifier String: The identifier of the relation
many Boolean: Whether the relation points at many entities
required Boolean: Whether the relation is required. Port rejects a required relation whose target blueprint already has a required relation back to this one, so at most one direction of a circular pair can be required.
target String: The identifier of the blueprint the relation points at
title String: The title of the relation. Port does not accept an empty value for this field, so removing it from the configuration leaves the existing title in place rather than clearing it.

Package Details

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

Viewing docs for Port v2.25.0
published on Tuesday, Sep 1, 2026 by port-labs

Schema (JSON)

port-labs/pulumi-port

port.BlueprintRelation

On this page

On this page

Create BlueprintRelation Resource

Constructor syntax

Parameters

Constructor example

BlueprintRelation Resource Properties

Inputs

Outputs

Look up Existing BlueprintRelation Resource

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

port.BlueprintRelation

On this page

On this page

Create BlueprintRelation Resource

Constructor syntax

Parameters

Constructor example

BlueprintRelation Resource Properties

Inputs

Outputs

Look up Existing BlueprintRelation Resource

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.