Port v1.6.0, Sep 14 23

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

port.Entity

Explore with Pulumi AI

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

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.EntityProperties: The properties of the entity
Relations port_labs.Port.Inputs.EntityRelations: The relations of the entity
RunId 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 EntityPropertiesArgs: The properties of the entity
Relations EntityRelationsArgs: The relations of the entity
RunId 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 EntityProperties: The properties of the entity
relations EntityRelations: The relations of the entity
runId 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 EntityProperties: The properties of the entity
relations EntityRelations: The relations of the entity
runId 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 EntityPropertiesArgs: The properties of the entity
relations EntityRelationsArgs: 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
runId 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:

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

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

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

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

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

createdAt String: The creation date of the entity
createdBy String: The creator of the entity
id String: The provider-assigned unique ID for this managed resource.
updatedAt String: The last update date of the entity
updatedBy String: 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.

The following state arguments are supported:

Blueprint string: The blueprint identifier the entity relates to
CreatedAt string: The creation date of the entity
CreatedBy 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.EntityProperties: The properties of the entity
Relations port_labs.Port.Inputs.EntityRelations: The relations of the entity
RunId 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
UpdatedAt string: The last update date of the entity
UpdatedBy string: The last updater of the entity

Blueprint string: The blueprint identifier the entity relates to
CreatedAt string: The creation date of the entity
CreatedBy string: The creator of the entity
Icon string: The icon of the entity
Identifier string: The identifier of the entity
Properties EntityPropertiesArgs: The properties of the entity
Relations EntityRelationsArgs: The relations of the entity
RunId 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
UpdatedAt string: The last update date of the entity
UpdatedBy string: The last updater of the entity

blueprint String: The blueprint identifier the entity relates to
createdAt String: The creation date of the entity
createdBy String: The creator of the entity
icon String: The icon of the entity
identifier String: The identifier of the entity
properties EntityProperties: The properties of the entity
relations EntityRelations: The relations of the entity
runId 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
updatedAt String: The last update date of the entity
updatedBy String: The last updater of the entity

blueprint string: The blueprint identifier the entity relates to
createdAt string: The creation date of the entity
createdBy string: The creator of the entity
icon string: The icon of the entity
identifier string: The identifier of the entity
properties EntityProperties: The properties of the entity
relations EntityRelations: The relations of the entity
runId 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
updatedAt string: The last update date of the entity
updatedBy 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 EntityPropertiesArgs: The properties of the entity
relations EntityRelationsArgs: 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
createdAt String: The creation date of the entity
createdBy 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
runId 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
updatedAt String: The last update date of the entity
updatedBy String: The last updater of the entity

Supporting Types

EntityProperties, EntityPropertiesArgs

ArrayProps port_labs.Port.Inputs.EntityPropertiesArrayProps
BooleanProps Dictionary<string, bool>
NumberProps Dictionary<string, double>
ObjectProps Dictionary<string, string>
StringProps Dictionary<string, string>

ArrayProps EntityPropertiesArrayProps
BooleanProps map[string]bool
NumberProps map[string]float64
ObjectProps map[string]string
StringProps map[string]string

arrayProps EntityPropertiesArrayProps
booleanProps Map<String,Boolean>
numberProps Map<String,Double>
objectProps Map<String,String>
stringProps Map<String,String>

arrayProps EntityPropertiesArrayProps
booleanProps {[key: string]: boolean}
numberProps {[key: string]: number}
objectProps {[key: string]: string}
stringProps {[key: string]: string}

array_props EntityPropertiesArrayProps
boolean_props Mapping[str, bool]
number_props Mapping[str, float]
object_props Mapping[str, str]
string_props Mapping[str, str]

arrayProps Property Map
booleanProps Map<Boolean>
numberProps Map<Number>
objectProps Map<String>
stringProps Map<String>

EntityPropertiesArrayProps, EntityPropertiesArrayPropsArgs

BooleanItems Dictionary<string, ImmutableArray<bool>>
NumberItems Dictionary<string, ImmutableArray<double>>
ObjectItems Dictionary<string, ImmutableArray<string>>
StringItems Dictionary<string, ImmutableArray<string>>

BooleanItems map[string][]bool
NumberItems map[string][]float64
ObjectItems map[string][]string
StringItems map[string][]string

booleanItems Map<String,List<Boolean>>
numberItems Map<String,List<Double>>
objectItems Map<String,List<String>>
stringItems Map<String,List<String>>

booleanItems {[key: string]: boolean[]}
numberItems {[key: string]: number[]}
objectItems {[key: string]: string[]}
stringItems {[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]]

booleanItems Map<List<Boolean>>
numberItems Map<List<Number>>
objectItems Map<List<String>>
stringItems Map<List<String>>

EntityRelations, EntityRelationsArgs

ManyRelations Dictionary<string, ImmutableArray<string>>
SingleRelations Dictionary<string, string>

ManyRelations map[string][]string
SingleRelations map[string]string

manyRelations Map<String,List<String>>
singleRelations Map<String,String>

manyRelations {[key: string]: string[]}
singleRelations {[key: string]: string}

many_relations Mapping[str, Sequence[str]]
single_relations Mapping[str, str]

manyRelations Map<List<String>>
singleRelations 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.

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

port-labs/pulumi-port

port.Entity

On this page

On this page

Create Entity Resource

Entity Resource Properties

Inputs

Outputs

Look up Existing Entity Resource

Supporting Types

EntityProperties, EntityPropertiesArgs

EntityPropertiesArrayProps, EntityPropertiesArrayPropsArgs

EntityRelations, EntityRelationsArgs

Package Details

On this page

On this page