Port v1.6.0, Sep 14 23

Port v1.6.0 published on Thursday, Sep 14, 2023 by port-labs

port.Blueprint

Explore with Pulumi AI

Port v1.6.0 published on Thursday, Sep 14, 2023 by port-labs

Create Blueprint Resource

new Blueprint(name: string, args: BlueprintArgs, opts?: CustomResourceOptions);

@overload
def Blueprint(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              calculation_properties: Optional[Mapping[str, BlueprintCalculationPropertiesArgs]] = None,
              description: Optional[str] = None,
              icon: Optional[str] = None,
              identifier: Optional[str] = None,
              kafka_changelog_destination: Optional[BlueprintKafkaChangelogDestinationArgs] = None,
              mirror_properties: Optional[Mapping[str, BlueprintMirrorPropertiesArgs]] = None,
              properties: Optional[BlueprintPropertiesArgs] = None,
              relations: Optional[Mapping[str, BlueprintRelationsArgs]] = None,
              team_inheritance: Optional[BlueprintTeamInheritanceArgs] = None,
              title: Optional[str] = None,
              webhook_changelog_destination: Optional[BlueprintWebhookChangelogDestinationArgs] = None)
@overload
def Blueprint(resource_name: str,
              args: BlueprintArgs,
              opts: Optional[ResourceOptions] = None)

func NewBlueprint(ctx *Context, name string, args BlueprintArgs, opts ...ResourceOption) (*Blueprint, error)

public Blueprint(string name, BlueprintArgs args, CustomResourceOptions? opts = null)

public Blueprint(String name, BlueprintArgs args)
public Blueprint(String name, BlueprintArgs args, CustomResourceOptions options)

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

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

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

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

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

Identifier string: The identifier of the blueprint
Title string: The display name of the blueprint
CalculationProperties Dictionary<string, port_labs.Port.Inputs.BlueprintCalculationPropertiesArgs>: The calculation properties of the blueprint
Description string: The description of the blueprint
Icon string: The icon of the blueprint
KafkaChangelogDestination port_labs.Port.Inputs.BlueprintKafkaChangelogDestination: The changelog destination of the blueprint
MirrorProperties Dictionary<string, port_labs.Port.Inputs.BlueprintMirrorPropertiesArgs>: The mirror properties of the blueprint
Properties port_labs.Port.Inputs.BlueprintProperties: The properties of the blueprint
Relations Dictionary<string, port_labs.Port.Inputs.BlueprintRelationsArgs>: The relations of the blueprint
TeamInheritance port_labs.Port.Inputs.BlueprintTeamInheritance: The team inheritance of the blueprint
WebhookChangelogDestination port_labs.Port.Inputs.BlueprintWebhookChangelogDestination: The webhook changelog destination of the blueprint

Identifier string: The identifier of the blueprint
Title string: The display name of the blueprint
CalculationProperties map[string]BlueprintCalculationPropertiesArgs: The calculation properties of the blueprint
Description string: The description of the blueprint
Icon string: The icon of the blueprint
KafkaChangelogDestination BlueprintKafkaChangelogDestinationArgs: The changelog destination of the blueprint
MirrorProperties map[string]BlueprintMirrorPropertiesArgs: The mirror properties of the blueprint
Properties BlueprintPropertiesArgs: The properties of the blueprint
Relations map[string]BlueprintRelationsArgs: The relations of the blueprint
TeamInheritance BlueprintTeamInheritanceArgs: The team inheritance of the blueprint
WebhookChangelogDestination BlueprintWebhookChangelogDestinationArgs: The webhook changelog destination of the blueprint

identifier String: The identifier of the blueprint
title String: The display name of the blueprint
calculationProperties Map<String,BlueprintCalculationPropertiesArgs>: The calculation properties of the blueprint
description String: The description of the blueprint
icon String: The icon of the blueprint
kafkaChangelogDestination BlueprintKafkaChangelogDestination: The changelog destination of the blueprint
mirrorProperties Map<String,BlueprintMirrorPropertiesArgs>: The mirror properties of the blueprint
properties BlueprintProperties: The properties of the blueprint
relations Map<String,BlueprintRelationsArgs>: The relations of the blueprint
teamInheritance BlueprintTeamInheritance: The team inheritance of the blueprint
webhookChangelogDestination BlueprintWebhookChangelogDestination: The webhook changelog destination of the blueprint

identifier string: The identifier of the blueprint
title string: The display name of the blueprint
calculationProperties {[key: string]: BlueprintCalculationPropertiesArgs}: The calculation properties of the blueprint
description string: The description of the blueprint
icon string: The icon of the blueprint
kafkaChangelogDestination BlueprintKafkaChangelogDestination: The changelog destination of the blueprint
mirrorProperties {[key: string]: BlueprintMirrorPropertiesArgs}: The mirror properties of the blueprint
properties BlueprintProperties: The properties of the blueprint
relations {[key: string]: BlueprintRelationsArgs}: The relations of the blueprint
teamInheritance BlueprintTeamInheritance: The team inheritance of the blueprint
webhookChangelogDestination BlueprintWebhookChangelogDestination: The webhook changelog destination of the blueprint

identifier str: The identifier of the blueprint
title str: The display name of the blueprint
calculation_properties Mapping[str, BlueprintCalculationPropertiesArgs]: The calculation properties of the blueprint
description str: The description of the blueprint
icon str: The icon of the blueprint
kafka_changelog_destination BlueprintKafkaChangelogDestinationArgs: The changelog destination of the blueprint
mirror_properties Mapping[str, BlueprintMirrorPropertiesArgs]: The mirror properties of the blueprint
properties BlueprintPropertiesArgs: The properties of the blueprint
relations Mapping[str, BlueprintRelationsArgs]: The relations of the blueprint
team_inheritance BlueprintTeamInheritanceArgs: The team inheritance of the blueprint
webhook_changelog_destination BlueprintWebhookChangelogDestinationArgs: The webhook changelog destination of the blueprint

identifier String: The identifier of the blueprint
title String: The display name of the blueprint
calculationProperties Map<Property Map>: The calculation properties of the blueprint
description String: The description of the blueprint
icon String: The icon of the blueprint
kafkaChangelogDestination Property Map: The changelog destination of the blueprint
mirrorProperties Map<Property Map>: The mirror properties of the blueprint
properties Property Map: The properties of the blueprint
relations Map<Property Map>: The relations of the blueprint
teamInheritance Property Map: The team inheritance of the blueprint
webhookChangelogDestination Property Map: The webhook changelog destination of the blueprint

Outputs

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

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

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

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

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

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

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

Look up Existing Blueprint Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        calculation_properties: Optional[Mapping[str, BlueprintCalculationPropertiesArgs]] = None,
        created_at: Optional[str] = None,
        created_by: Optional[str] = None,
        description: Optional[str] = None,
        icon: Optional[str] = None,
        identifier: Optional[str] = None,
        kafka_changelog_destination: Optional[BlueprintKafkaChangelogDestinationArgs] = None,
        mirror_properties: Optional[Mapping[str, BlueprintMirrorPropertiesArgs]] = None,
        properties: Optional[BlueprintPropertiesArgs] = None,
        relations: Optional[Mapping[str, BlueprintRelationsArgs]] = None,
        team_inheritance: Optional[BlueprintTeamInheritanceArgs] = None,
        title: Optional[str] = None,
        updated_at: Optional[str] = None,
        updated_by: Optional[str] = None,
        webhook_changelog_destination: Optional[BlueprintWebhookChangelogDestinationArgs] = None) -> Blueprint

func GetBlueprint(ctx *Context, name string, id IDInput, state *BlueprintState, opts ...ResourceOption) (*Blueprint, error)

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

public static Blueprint get(String name, Output<String> id, BlueprintState 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:

CalculationProperties Dictionary<string, port_labs.Port.Inputs.BlueprintCalculationPropertiesArgs>: The calculation properties of the blueprint
CreatedAt string: The creation date of the blueprint
CreatedBy string: The creator of the blueprint
Description string: The description of the blueprint
Icon string: The icon of the blueprint
Identifier string: The identifier of the blueprint
KafkaChangelogDestination port_labs.Port.Inputs.BlueprintKafkaChangelogDestination: The changelog destination of the blueprint
MirrorProperties Dictionary<string, port_labs.Port.Inputs.BlueprintMirrorPropertiesArgs>: The mirror properties of the blueprint
Properties port_labs.Port.Inputs.BlueprintProperties: The properties of the blueprint
Relations Dictionary<string, port_labs.Port.Inputs.BlueprintRelationsArgs>: The relations of the blueprint
TeamInheritance port_labs.Port.Inputs.BlueprintTeamInheritance: The team inheritance of the blueprint
Title string: The display name of the blueprint
UpdatedAt string: The last update date of the blueprint
UpdatedBy string: The last updater of the blueprint
WebhookChangelogDestination port_labs.Port.Inputs.BlueprintWebhookChangelogDestination: The webhook changelog destination of the blueprint

CalculationProperties map[string]BlueprintCalculationPropertiesArgs: The calculation properties of the blueprint
CreatedAt string: The creation date of the blueprint
CreatedBy string: The creator of the blueprint
Description string: The description of the blueprint
Icon string: The icon of the blueprint
Identifier string: The identifier of the blueprint
KafkaChangelogDestination BlueprintKafkaChangelogDestinationArgs: The changelog destination of the blueprint
MirrorProperties map[string]BlueprintMirrorPropertiesArgs: The mirror properties of the blueprint
Properties BlueprintPropertiesArgs: The properties of the blueprint
Relations map[string]BlueprintRelationsArgs: The relations of the blueprint
TeamInheritance BlueprintTeamInheritanceArgs: The team inheritance of the blueprint
Title string: The display name of the blueprint
UpdatedAt string: The last update date of the blueprint
UpdatedBy string: The last updater of the blueprint
WebhookChangelogDestination BlueprintWebhookChangelogDestinationArgs: The webhook changelog destination of the blueprint

calculationProperties Map<String,BlueprintCalculationPropertiesArgs>: The calculation properties of the blueprint
createdAt String: The creation date of the blueprint
createdBy String: The creator of the blueprint
description String: The description of the blueprint
icon String: The icon of the blueprint
identifier String: The identifier of the blueprint
kafkaChangelogDestination BlueprintKafkaChangelogDestination: The changelog destination of the blueprint
mirrorProperties Map<String,BlueprintMirrorPropertiesArgs>: The mirror properties of the blueprint
properties BlueprintProperties: The properties of the blueprint
relations Map<String,BlueprintRelationsArgs>: The relations of the blueprint
teamInheritance BlueprintTeamInheritance: The team inheritance of the blueprint
title String: The display name of the blueprint
updatedAt String: The last update date of the blueprint
updatedBy String: The last updater of the blueprint
webhookChangelogDestination BlueprintWebhookChangelogDestination: The webhook changelog destination of the blueprint

calculationProperties {[key: string]: BlueprintCalculationPropertiesArgs}: The calculation properties of the blueprint
createdAt string: The creation date of the blueprint
createdBy string: The creator of the blueprint
description string: The description of the blueprint
icon string: The icon of the blueprint
identifier string: The identifier of the blueprint
kafkaChangelogDestination BlueprintKafkaChangelogDestination: The changelog destination of the blueprint
mirrorProperties {[key: string]: BlueprintMirrorPropertiesArgs}: The mirror properties of the blueprint
properties BlueprintProperties: The properties of the blueprint
relations {[key: string]: BlueprintRelationsArgs}: The relations of the blueprint
teamInheritance BlueprintTeamInheritance: The team inheritance of the blueprint
title string: The display name of the blueprint
updatedAt string: The last update date of the blueprint
updatedBy string: The last updater of the blueprint
webhookChangelogDestination BlueprintWebhookChangelogDestination: The webhook changelog destination of the blueprint

calculation_properties Mapping[str, BlueprintCalculationPropertiesArgs]: The calculation properties of the blueprint
created_at str: The creation date of the blueprint
created_by str: The creator of the blueprint
description str: The description of the blueprint
icon str: The icon of the blueprint
identifier str: The identifier of the blueprint
kafka_changelog_destination BlueprintKafkaChangelogDestinationArgs: The changelog destination of the blueprint
mirror_properties Mapping[str, BlueprintMirrorPropertiesArgs]: The mirror properties of the blueprint
properties BlueprintPropertiesArgs: The properties of the blueprint
relations Mapping[str, BlueprintRelationsArgs]: The relations of the blueprint
team_inheritance BlueprintTeamInheritanceArgs: The team inheritance of the blueprint
title str: The display name of the blueprint
updated_at str: The last update date of the blueprint
updated_by str: The last updater of the blueprint
webhook_changelog_destination BlueprintWebhookChangelogDestinationArgs: The webhook changelog destination of the blueprint

calculationProperties Map<Property Map>: The calculation properties of the blueprint
createdAt String: The creation date of the blueprint
createdBy String: The creator of the blueprint
description String: The description of the blueprint
icon String: The icon of the blueprint
identifier String: The identifier of the blueprint
kafkaChangelogDestination Property Map: The changelog destination of the blueprint
mirrorProperties Map<Property Map>: The mirror properties of the blueprint
properties Property Map: The properties of the blueprint
relations Map<Property Map>: The relations of the blueprint
teamInheritance Property Map: The team inheritance of the blueprint
title String: The display name of the blueprint
updatedAt String: The last update date of the blueprint
updatedBy String: The last updater of the blueprint
webhookChangelogDestination Property Map: The webhook changelog destination of the blueprint

Supporting Types

BlueprintCalculationProperties, BlueprintCalculationPropertiesArgs

Calculation string
Type string
Colorized bool
Colors Dictionary<string, string>
Description string
Format string
Icon string
Title string

Calculation string
Type string
Colorized bool
Colors map[string]string
Description string
Format string
Icon string
Title string

calculation String
type String
colorized Boolean
colors Map<String,String>
description String
format String
icon String
title String

calculation string
type string
colorized boolean
colors {[key: string]: string}
description string
format string
icon string
title string

calculation str
type str
colorized bool
colors Mapping[str, str]
description str
format str
icon str
title str

calculation String
type String
colorized Boolean
colors Map<String>
description String
format String
icon String
title String

BlueprintMirrorProperties, BlueprintMirrorPropertiesArgs

Path string
Title string

Path string
Title string

path String
title String

path string
title string

path str
title str

path String
title String

BlueprintProperties, BlueprintPropertiesArgs

ArrayProps Dictionary<string, port_labs.Port.Inputs.BlueprintPropertiesArrayProps>
BooleanProps Dictionary<string, port_labs.Port.Inputs.BlueprintPropertiesBooleanProps>
NumberProps Dictionary<string, port_labs.Port.Inputs.BlueprintPropertiesNumberProps>
ObjectProps Dictionary<string, port_labs.Port.Inputs.BlueprintPropertiesObjectProps>
StringProps Dictionary<string, port_labs.Port.Inputs.BlueprintPropertiesStringProps>