port.Entity
Explore with Pulumi AI
Create Entity Resource
new Entity(name: string, args: EntityArgs, opts?: CustomResourceOptions);
@overload
def Entity(resource_name: str,
opts: Optional[ResourceOptions] = None,
blueprint: Optional[str] = None,
icon: Optional[str] = None,
identifier: Optional[str] = None,
properties: Optional[EntityPropertiesArgs] = None,
relations: Optional[EntityRelationsArgs] = None,
run_id: Optional[str] = None,
teams: Optional[Sequence[str]] = None,
title: Optional[str] = None)
@overload
def Entity(resource_name: str,
args: EntityArgs,
opts: Optional[ResourceOptions] = None)
func NewEntity(ctx *Context, name string, args EntityArgs, opts ...ResourceOption) (*Entity, error)
public Entity(string name, EntityArgs args, CustomResourceOptions? opts = null)
public Entity(String name, EntityArgs args)
public Entity(String name, EntityArgs args, CustomResourceOptions options)
type: port:Entity
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args EntityArgs
- 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 EntityArgs
- 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 EntityArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args EntityArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args EntityArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Entity 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 Entity resource accepts the following input properties:
- Blueprint string
The blueprint identifier the entity relates to
- Icon string
The icon of the entity
- Identifier string
The identifier of the entity
- Properties
port_
labs. Port. Inputs. Entity Properties The properties of the entity
- Relations
port_
labs. Port. Inputs. Entity Relations The relations of the entity
- Run
Id string The runID of the action run that created the entity
- Teams List<string>
The teams the entity belongs to
- Title string
The title of the entity
- Blueprint string
The blueprint identifier the entity relates to
- Icon string
The icon of the entity
- Identifier string
The identifier of the entity
- Properties
Entity
Properties Args The properties of the entity
- Relations
Entity
Relations Args The relations of the entity
- Run
Id string The runID of the action run that created the entity
- Teams []string
The teams the entity belongs to
- Title string
The title of the entity
- blueprint String
The blueprint identifier the entity relates to
- icon String
The icon of the entity
- identifier String
The identifier of the entity
- properties
Entity
Properties The properties of the entity
- relations
Entity
Relations The relations of the entity
- run
Id String The runID of the action run that created the entity
- teams List<String>
The teams the entity belongs to
- title String
The title of the entity
- blueprint string
The blueprint identifier the entity relates to
- icon string
The icon of the entity
- identifier string
The identifier of the entity
- properties
Entity
Properties The properties of the entity
- relations
Entity
Relations The relations of the entity
- run
Id string The runID of the action run that created the entity
- teams string[]
The teams the entity belongs to
- title string
The title of the entity
- blueprint str
The blueprint identifier the entity relates to
- icon str
The icon of the entity
- identifier str
The identifier of the entity
- properties
Entity
Properties Args The properties of the entity
- relations
Entity
Relations Args The relations of the entity
- run_
id str The runID of the action run that created the entity
- teams Sequence[str]
The teams the entity belongs to
- title str
The title of the entity
- blueprint String
The blueprint identifier the entity relates to
- icon String
The icon of the entity
- identifier String
The identifier of the entity
- properties Property Map
The properties of the entity
- relations Property Map
The relations of the entity
- run
Id String The runID of the action run that created the entity
- teams List<String>
The teams the entity belongs to
- title String
The title of the entity
Outputs
All input properties are implicitly available as output properties. Additionally, the Entity resource produces the following output properties:
- created_
at str The creation date of the entity
- created_
by str The creator of the entity
- id str
The provider-assigned unique ID for this managed resource.
- updated_
at str The last update date of the entity
- updated_
by str The last updater of the entity
Look up Existing Entity Resource
Get an existing Entity 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?: EntityState, opts?: CustomResourceOptions): Entity
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
blueprint: Optional[str] = None,
created_at: Optional[str] = None,
created_by: Optional[str] = None,
icon: Optional[str] = None,
identifier: Optional[str] = None,
properties: Optional[EntityPropertiesArgs] = None,
relations: Optional[EntityRelationsArgs] = None,
run_id: Optional[str] = None,
teams: Optional[Sequence[str]] = None,
title: Optional[str] = None,
updated_at: Optional[str] = None,
updated_by: Optional[str] = None) -> Entity
func GetEntity(ctx *Context, name string, id IDInput, state *EntityState, opts ...ResourceOption) (*Entity, error)
public static Entity Get(string name, Input<string> id, EntityState? state, CustomResourceOptions? opts = null)
public static Entity get(String name, Output<String> id, EntityState 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.
- Blueprint string
The blueprint identifier the entity relates to
- Created
At string The creation date of the entity
- Created
By string The creator of the entity
- Icon string
The icon of the entity
- Identifier string
The identifier of the entity
- Properties
port_
labs. Port. Inputs. Entity Properties The properties of the entity
- Relations
port_
labs. Port. Inputs. Entity Relations The relations of the entity
- Run
Id string The runID of the action run that created the entity
- Teams List<string>
The teams the entity belongs to
- Title string
The title of the entity
- Updated
At string The last update date of the entity
- Updated
By string The last updater of the entity
- Blueprint string
The blueprint identifier the entity relates to
- Created
At string The creation date of the entity
- Created
By string The creator of the entity
- Icon string
The icon of the entity
- Identifier string
The identifier of the entity
- Properties
Entity
Properties Args The properties of the entity
- Relations
Entity
Relations Args The relations of the entity
- Run
Id string The runID of the action run that created the entity
- Teams []string
The teams the entity belongs to
- Title string
The title of the entity
- Updated
At string The last update date of the entity
- Updated
By string The last updater of the entity
- blueprint String
The blueprint identifier the entity relates to
- created
At String The creation date of the entity
- created
By String The creator of the entity
- icon String
The icon of the entity
- identifier String
The identifier of the entity
- properties
Entity
Properties The properties of the entity
- relations
Entity
Relations The relations of the entity
- run
Id String The runID of the action run that created the entity
- teams List<String>
The teams the entity belongs to
- title String
The title of the entity
- updated
At String The last update date of the entity
- updated
By String The last updater of the entity
- blueprint string
The blueprint identifier the entity relates to
- created
At string The creation date of the entity
- created
By string The creator of the entity
- icon string
The icon of the entity
- identifier string
The identifier of the entity
- properties
Entity
Properties The properties of the entity
- relations
Entity
Relations The relations of the entity
- run
Id string The runID of the action run that created the entity
- teams string[]
The teams the entity belongs to
- title string
The title of the entity
- updated
At string The last update date of the entity
- updated
By string The last updater of the entity
- blueprint str
The blueprint identifier the entity relates to
- created_
at str The creation date of the entity
- created_
by str The creator of the entity
- icon str
The icon of the entity
- identifier str
The identifier of the entity
- properties
Entity
Properties Args The properties of the entity
- relations
Entity
Relations Args The relations of the entity
- run_
id str The runID of the action run that created the entity
- teams Sequence[str]
The teams the entity belongs to
- title str
The title of the entity
- updated_
at str The last update date of the entity
- updated_
by str The last updater of the entity
- blueprint String
The blueprint identifier the entity relates to
- created
At String The creation date of the entity
- created
By String The creator of the entity
- icon String
The icon of the entity
- identifier String
The identifier of the entity
- properties Property Map
The properties of the entity
- relations Property Map
The relations of the entity
- run
Id String The runID of the action run that created the entity
- teams List<String>
The teams the entity belongs to
- title String
The title of the entity
- updated
At String The last update date of the entity
- updated
By String The last updater of the entity
Supporting Types
EntityProperties, EntityPropertiesArgs
- Array
Props port_labs. Port. Inputs. Entity Properties Array Props - Boolean
Props Dictionary<string, bool> - Number
Props Dictionary<string, double> - Object
Props Dictionary<string, string> - String
Props Dictionary<string, string>
- Array
Props EntityProperties Array Props - Boolean
Props map[string]bool - Number
Props map[string]float64 - Object
Props map[string]string - String
Props map[string]string
- array
Props EntityProperties Array Props - boolean
Props Map<String,Boolean> - number
Props Map<String,Double> - object
Props Map<String,String> - string
Props Map<String,String>
- array
Props EntityProperties Array Props - boolean
Props {[key: string]: boolean} - number
Props {[key: string]: number} - object
Props {[key: string]: string} - string
Props {[key: string]: string}
- array_
props EntityProperties Array Props - boolean_
props Mapping[str, bool] - number_
props Mapping[str, float] - object_
props Mapping[str, str] - string_
props Mapping[str, str]
- array
Props Property Map - boolean
Props Map<Boolean> - number
Props Map<Number> - object
Props Map<String> - string
Props Map<String>
EntityPropertiesArrayProps, EntityPropertiesArrayPropsArgs
- Boolean
Items Dictionary<string, ImmutableArray<bool>> - Number
Items Dictionary<string, ImmutableArray<double>> - Object
Items Dictionary<string, ImmutableArray<string>> - String
Items Dictionary<string, ImmutableArray<string>>
- Boolean
Items map[string][]bool - Number
Items map[string][]float64 - Object
Items map[string][]string - String
Items map[string][]string
- boolean
Items Map<String,List<Boolean>> - number
Items Map<String,List<Double>> - object
Items Map<String,List<String>> - string
Items Map<String,List<String>>
- boolean
Items {[key: string]: boolean[]} - number
Items {[key: string]: number[]} - object
Items {[key: string]: string[]} - string
Items {[key: string]: string[]}
- boolean_
items Mapping[str, Sequence[bool]] - number_
items Mapping[str, Sequence[float]] - object_
items Mapping[str, Sequence[str]] - string_
items Mapping[str, Sequence[str]]
- boolean
Items Map<List<Boolean>> - number
Items Map<List<Number>> - object
Items Map<List<String>> - string
Items Map<List<String>>
EntityRelations, EntityRelationsArgs
- Many
Relations Dictionary<string, ImmutableArray<string>> - Single
Relations Dictionary<string, string>
- Many
Relations map[string][]string - Single
Relations map[string]string
- many
Relations Map<String,List<String>> - single
Relations Map<String,String>
- many
Relations {[key: string]: string[]} - single
Relations {[key: string]: string}
- many_
relations Mapping[str, Sequence[str]] - single_
relations Mapping[str, str]
- many
Relations Map<List<String>> - single
Relations Map<String>
Package Details
- Repository
- port port-labs/pulumi-port
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
port
Terraform Provider.