port.Blueprint
Explore with Pulumi AI
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
- Calculation
Properties Dictionary<string, port_labs. Port. Inputs. Blueprint Calculation Properties Args> The calculation properties of the blueprint
- Description string
The description of the blueprint
- Icon string
The icon of the blueprint
- Kafka
Changelog port_Destination labs. Port. Inputs. Blueprint Kafka Changelog Destination The changelog destination of the blueprint
- Mirror
Properties Dictionary<string, port_labs. Port. Inputs. Blueprint Mirror Properties Args> The mirror properties of the blueprint
- Properties
port_
labs. Port. Inputs. Blueprint Properties The properties of the blueprint
- Relations
Dictionary<string, port_
labs. Port. Inputs. Blueprint Relations Args> The relations of the blueprint
- Team
Inheritance port_labs. Port. Inputs. Blueprint Team Inheritance The team inheritance of the blueprint
- Webhook
Changelog port_Destination labs. Port. Inputs. Blueprint Webhook Changelog Destination The webhook changelog destination of the blueprint
- Identifier string
The identifier of the blueprint
- Title string
The display name of the blueprint
- Calculation
Properties map[string]BlueprintCalculation Properties Args The calculation properties of the blueprint
- Description string
The description of the blueprint
- Icon string
The icon of the blueprint
- Kafka
Changelog BlueprintDestination Kafka Changelog Destination Args The changelog destination of the blueprint
- Mirror
Properties map[string]BlueprintMirror Properties Args The mirror properties of the blueprint
- Properties
Blueprint
Properties Args The properties of the blueprint
- Relations
map[string]Blueprint
Relations Args The relations of the blueprint
- Team
Inheritance BlueprintTeam Inheritance Args The team inheritance of the blueprint
- Webhook
Changelog BlueprintDestination Webhook Changelog Destination Args The webhook changelog destination of the blueprint
- identifier String
The identifier of the blueprint
- title String
The display name of the blueprint
- calculation
Properties Map<String,BlueprintCalculation Properties Args> The calculation properties of the blueprint
- description String
The description of the blueprint
- icon String
The icon of the blueprint
- kafka
Changelog BlueprintDestination Kafka Changelog Destination The changelog destination of the blueprint
- mirror
Properties Map<String,BlueprintMirror Properties Args> The mirror properties of the blueprint
- properties
Blueprint
Properties The properties of the blueprint
- relations
Map<String,Blueprint
Relations Args> The relations of the blueprint
- team
Inheritance BlueprintTeam Inheritance The team inheritance of the blueprint
- webhook
Changelog BlueprintDestination Webhook Changelog Destination The webhook changelog destination of the blueprint
- identifier string
The identifier of the blueprint
- title string
The display name of the blueprint
- calculation
Properties {[key: string]: BlueprintCalculation Properties Args} The calculation properties of the blueprint
- description string
The description of the blueprint
- icon string
The icon of the blueprint
- kafka
Changelog BlueprintDestination Kafka Changelog Destination The changelog destination of the blueprint
- mirror
Properties {[key: string]: BlueprintMirror Properties Args} The mirror properties of the blueprint
- properties
Blueprint
Properties The properties of the blueprint
- relations
{[key: string]: Blueprint
Relations Args} The relations of the blueprint
- team
Inheritance BlueprintTeam Inheritance The team inheritance of the blueprint
- webhook
Changelog BlueprintDestination Webhook Changelog Destination 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, BlueprintCalculation Properties Args] The calculation properties of the blueprint
- description str
The description of the blueprint
- icon str
The icon of the blueprint
- kafka_
changelog_ Blueprintdestination Kafka Changelog Destination Args The changelog destination of the blueprint
- mirror_
properties Mapping[str, BlueprintMirror Properties Args] The mirror properties of the blueprint
- properties
Blueprint
Properties Args The properties of the blueprint
- relations
Mapping[str, Blueprint
Relations Args] The relations of the blueprint
- team_
inheritance BlueprintTeam Inheritance Args The team inheritance of the blueprint
- webhook_
changelog_ Blueprintdestination Webhook Changelog Destination Args The webhook changelog destination of the blueprint
- identifier String
The identifier of the blueprint
- title String
The display name of the blueprint
- calculation
Properties Map<Property Map> The calculation properties of the blueprint
- description String
The description of the blueprint
- icon String
The icon of the blueprint
- kafka
Changelog Property MapDestination The changelog destination of the blueprint
- mirror
Properties 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
- team
Inheritance Property Map The team inheritance of the blueprint
- webhook
Changelog Property MapDestination 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:
- 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
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.
- Calculation
Properties Dictionary<string, port_labs. Port. Inputs. Blueprint Calculation Properties Args> The calculation properties of the blueprint
- Created
At string The creation date of the blueprint
- Created
By 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
- Kafka
Changelog port_Destination labs. Port. Inputs. Blueprint Kafka Changelog Destination The changelog destination of the blueprint
- Mirror
Properties Dictionary<string, port_labs. Port. Inputs. Blueprint Mirror Properties Args> The mirror properties of the blueprint
- Properties
port_
labs. Port. Inputs. Blueprint Properties The properties of the blueprint
- Relations
Dictionary<string, port_
labs. Port. Inputs. Blueprint Relations Args> The relations of the blueprint
- Team
Inheritance port_labs. Port. Inputs. Blueprint Team Inheritance The team inheritance of the blueprint
- Title string
The display name of the blueprint
- Updated
At string The last update date of the blueprint
- Updated
By string The last updater of the blueprint
- Webhook
Changelog port_Destination labs. Port. Inputs. Blueprint Webhook Changelog Destination The webhook changelog destination of the blueprint
- Calculation
Properties map[string]BlueprintCalculation Properties Args The calculation properties of the blueprint
- Created
At string The creation date of the blueprint
- Created
By 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
- Kafka
Changelog BlueprintDestination Kafka Changelog Destination Args The changelog destination of the blueprint
- Mirror
Properties map[string]BlueprintMirror Properties Args The mirror properties of the blueprint
- Properties
Blueprint
Properties Args The properties of the blueprint
- Relations
map[string]Blueprint
Relations Args The relations of the blueprint
- Team
Inheritance BlueprintTeam Inheritance Args The team inheritance of the blueprint
- Title string
The display name of the blueprint
- Updated
At string The last update date of the blueprint
- Updated
By string The last updater of the blueprint
- Webhook
Changelog BlueprintDestination Webhook Changelog Destination Args The webhook changelog destination of the blueprint
- calculation
Properties Map<String,BlueprintCalculation Properties Args> The calculation properties of the blueprint
- created
At String The creation date of the blueprint
- created
By 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
- kafka
Changelog BlueprintDestination Kafka Changelog Destination The changelog destination of the blueprint
- mirror
Properties Map<String,BlueprintMirror Properties Args> The mirror properties of the blueprint
- properties
Blueprint
Properties The properties of the blueprint
- relations
Map<String,Blueprint
Relations Args> The relations of the blueprint
- team
Inheritance BlueprintTeam Inheritance The team inheritance of the blueprint
- title String
The display name of the blueprint
- updated
At String The last update date of the blueprint
- updated
By String The last updater of the blueprint
- webhook
Changelog BlueprintDestination Webhook Changelog Destination The webhook changelog destination of the blueprint
- calculation
Properties {[key: string]: BlueprintCalculation Properties Args} The calculation properties of the blueprint
- created
At string The creation date of the blueprint
- created
By 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
- kafka
Changelog BlueprintDestination Kafka Changelog Destination The changelog destination of the blueprint
- mirror
Properties {[key: string]: BlueprintMirror Properties Args} The mirror properties of the blueprint
- properties
Blueprint
Properties The properties of the blueprint
- relations
{[key: string]: Blueprint
Relations Args} The relations of the blueprint
- team
Inheritance BlueprintTeam Inheritance The team inheritance of the blueprint
- title string
The display name of the blueprint
- updated
At string The last update date of the blueprint
- updated
By string The last updater of the blueprint
- webhook
Changelog BlueprintDestination Webhook Changelog Destination The webhook changelog destination of the blueprint
- calculation_
properties Mapping[str, BlueprintCalculation Properties Args] 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_ Blueprintdestination Kafka Changelog Destination Args The changelog destination of the blueprint
- mirror_
properties Mapping[str, BlueprintMirror Properties Args] The mirror properties of the blueprint
- properties
Blueprint
Properties Args The properties of the blueprint
- relations
Mapping[str, Blueprint
Relations Args] The relations of the blueprint
- team_
inheritance BlueprintTeam Inheritance Args 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_ Blueprintdestination Webhook Changelog Destination Args The webhook changelog destination of the blueprint
- calculation
Properties Map<Property Map> The calculation properties of the blueprint
- created
At String The creation date of the blueprint
- created
By 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
- kafka
Changelog Property MapDestination The changelog destination of the blueprint
- mirror
Properties 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
- team
Inheritance Property Map The team inheritance of the blueprint
- title String
The display name of the blueprint
- updated
At String The last update date of the blueprint
- updated
By String The last updater of the blueprint
- webhook
Changelog Property MapDestination 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
BlueprintProperties, BlueprintPropertiesArgs
- Array
Props Dictionary<string, port_labs. Port. Inputs. Blueprint Properties Array Props> - Boolean
Props Dictionary<string, port_labs. Port. Inputs. Blueprint Properties Boolean Props> - Number
Props Dictionary<string, port_labs. Port. Inputs. Blueprint Properties Number Props> - Object
Props Dictionary<string, port_labs. Port. Inputs. Blueprint Properties Object Props> - String
Props Dictionary<string, port_labs. Port. Inputs. Blueprint Properties String Props>
- Array
Props map[string]BlueprintProperties Array Props - Boolean
Props map[string]BlueprintProperties Boolean Props - Number
Props map[string]BlueprintProperties Number Props - Object
Props map[string]BlueprintProperties Object Props - String
Props map[string]BlueprintProperties String Props
- array
Props Map<String,BlueprintProperties Array Props> - boolean
Props Map<String,BlueprintProperties Boolean Props> - number
Props Map<String,BlueprintProperties Number Props> - object
Props Map<String,BlueprintProperties Object Props> - string
Props Map<String,BlueprintProperties String Props>
- array
Props {[key: string]: BlueprintProperties Array Props} - boolean
Props {[key: string]: BlueprintProperties Boolean Props} - number
Props {[key: string]: BlueprintProperties Number Props} - object
Props {[key: string]: BlueprintProperties Object Props} - string
Props {[key: string]: BlueprintProperties String Props}
- array_
props Mapping[str, BlueprintProperties Array Props] - boolean_
props Mapping[str, BlueprintProperties Boolean Props] - number_
props Mapping[str, BlueprintProperties Number Props] - object_
props Mapping[str, BlueprintProperties Object Props] - string_
props Mapping[str, BlueprintProperties String Props]
- array
Props Map<Property Map> - boolean
Props Map<Property Map> - number
Props Map<Property Map> - object
Props Map<Property Map> - string
Props Map<Property Map>
BlueprintPropertiesArrayProps, BlueprintPropertiesArrayPropsArgs
- Boolean
Items port_labs. Port. Inputs. Blueprint Properties Array Props Boolean Items - Description string
- Icon string
- Max
Items int - Min
Items int - Number
Items port_labs. Port. Inputs. Blueprint Properties Array Props Number Items - Object
Items port_labs. Port. Inputs. Blueprint Properties Array Props Object Items - Required bool
- String
Items port_labs. Port. Inputs. Blueprint Properties Array Props String Items - Title string
- boolean
Items Property Map - description String
- icon String
- max
Items Number - min
Items Number - number
Items Property Map - object
Items Property Map - required Boolean
- string
Items Property Map - title String
BlueprintPropertiesArrayPropsBooleanItems, BlueprintPropertiesArrayPropsBooleanItemsArgs
- Defaults List<bool>
- Defaults []bool
- defaults List<Boolean>
- defaults boolean[]
- defaults Sequence[bool]
- defaults List<Boolean>
BlueprintPropertiesArrayPropsNumberItems, BlueprintPropertiesArrayPropsNumberItemsArgs
- Defaults List<double>
- Defaults []float64
- defaults List<Double>
- defaults number[]
- defaults Sequence[float]
- defaults List<Number>
BlueprintPropertiesArrayPropsObjectItems, BlueprintPropertiesArrayPropsObjectItemsArgs
- Defaults List<string>
- Defaults []string
- defaults List<String>
- defaults string[]
- defaults Sequence[str]
- defaults List<String>
BlueprintPropertiesArrayPropsStringItems, BlueprintPropertiesArrayPropsStringItemsArgs
BlueprintPropertiesBooleanProps, BlueprintPropertiesBooleanPropsArgs
- Default bool
- Description string
- Icon string
- Required bool
- Title string
- Default bool
- Description string
- Icon string
- Required bool
- Title string
- default_ Boolean
- description String
- icon String
- required Boolean
- title String
- default boolean
- description string
- icon string
- required boolean
- title string
- default bool
- description str
- icon str
- required bool
- title str
- default Boolean
- description String
- icon String
- required Boolean
- title String
BlueprintPropertiesNumberProps, BlueprintPropertiesNumberPropsArgs
- Default double
- Description string
- Enum
Colors Dictionary<string, string> - Enums List<double>
- Icon string
- Maximum double
- Minimum double
- Required bool
- Title string
- Default float64
- Description string
- Enum
Colors map[string]string - Enums []float64
- Icon string
- Maximum float64
- Minimum float64
- Required bool
- Title string
- default_ Double
- description String
- enum
Colors Map<String,String> - enums List<Double>
- icon String
- maximum Double
- minimum Double
- required Boolean
- title String
- default number
- description string
- enum
Colors {[key: string]: string} - enums number[]
- icon string
- maximum number
- minimum number
- required boolean
- title string
- default float
- description str
- enum_
colors Mapping[str, str] - enums Sequence[float]
- icon str
- maximum float
- minimum float
- required bool
- title str
- default Number
- description String
- enum
Colors Map<String> - enums List<Number>
- icon String
- maximum Number
- minimum Number
- required Boolean
- title String
BlueprintPropertiesObjectProps, BlueprintPropertiesObjectPropsArgs
BlueprintPropertiesStringProps, BlueprintPropertiesStringPropsArgs
- Default string
- Description string
- Enum
Colors Dictionary<string, string> - Enums List<string>
- Format string
- Icon string
- Max
Length int - Min
Length int - Pattern string
- Required bool
- Spec string
- Spec
Authentication port_labs. Port. Inputs. Blueprint Properties String Props Spec Authentication - Title string
- Default string
- Description string
- Enum
Colors map[string]string - Enums []string
- Format string
- Icon string
- Max
Length int - Min
Length int - Pattern string
- Required bool
- Spec string
- Spec
Authentication BlueprintProperties String Props Spec Authentication - Title string
- default_ String
- description String
- enum
Colors Map<String,String> - enums List<String>
- format String
- icon String
- max
Length Integer - min
Length Integer - pattern String
- required Boolean
- spec String
- spec
Authentication BlueprintProperties String Props Spec Authentication - title String
- default string
- description string
- enum
Colors {[key: string]: string} - enums string[]
- format string
- icon string
- max
Length number - min
Length number - pattern string
- required boolean
- spec string
- spec
Authentication BlueprintProperties String Props Spec Authentication - title string
- default str
- description str
- enum_
colors Mapping[str, str] - enums Sequence[str]
- format str
- icon str
- max_
length int - min_
length int - pattern str
- required bool
- spec str
- spec_
authentication BlueprintProperties String Props Spec Authentication - title str
- default String
- description String
- enum
Colors Map<String> - enums List<String>
- format String
- icon String
- max
Length Number - min
Length Number - pattern String
- required Boolean
- spec String
- spec
Authentication Property Map - title String
BlueprintPropertiesStringPropsSpecAuthentication, BlueprintPropertiesStringPropsSpecAuthenticationArgs
BlueprintRelations, BlueprintRelationsArgs
BlueprintTeamInheritance, BlueprintTeamInheritanceArgs
- Path string
- Path string
- path String
- path string
- path str
- path String
BlueprintWebhookChangelogDestination, BlueprintWebhookChangelogDestinationArgs
Package Details
- Repository
- port port-labs/pulumi-port
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
port
Terraform Provider.