Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Port
  3. API Docs
  4. Entity
Port v2.7.1 published on Tuesday, May 6, 2025 by port-labs
port-labs/pulumi-port

port.Entity

Explore with Pulumi AI

port logo
Port v2.7.1 published on Tuesday, May 6, 2025 by port-labs
port-labs/pulumi-port

    Entity resource

    Create Entity Resource

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

    Constructor syntax

    new Entity(name: string, args: EntityArgs, opts?: CustomResourceOptions);
    @overload
def Entity(resource_name: str,
           args: EntityArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Entity(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           blueprint: Optional[str] = None,
           title: Optional[str] = None,
           create_missing_related_entities: Optional[bool] = 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)
    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.

    Parameters

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var entityResource = new Port.Entity("entityResource", new()
{
    Blueprint = "string",
    Title = "string",
    CreateMissingRelatedEntities = false,
    Icon = "string",
    Identifier = "string",
    Properties = new Port.Inputs.EntityPropertiesArgs
    {
        ArrayProps = new Port.Inputs.EntityPropertiesArrayPropsArgs
        {
            BooleanItems = 
            {
                { "string", new[]
                {
                    false,
                } },
            },
            NumberItems = 
            {
                { "string", new[]
                {
                    0,
                } },
            },
            ObjectItems = 
            {
                { "string", new[]
                {
                    "string",
                } },
            },
            StringItems = 
            {
                { "string", new[]
                {
                    "string",
                } },
            },
        },
        BooleanProps = 
        {
            { "string", false },
        },
        NumberProps = 
        {
            { "string", 0 },
        },
        ObjectProps = 
        {
            { "string", "string" },
        },
        StringProps = 
        {
            { "string", "string" },
        },
    },
    Relations = new Port.Inputs.EntityRelationsArgs
    {
        ManyRelations = 
        {
            { "string", new[]
            {
                "string",
            } },
        },
        SingleRelations = 
        {
            { "string", "string" },
        },
    },
    RunId = "string",
    Teams = new[]
    {
        "string",
    },
});

    example, err := port.NewEntity(ctx, "entityResource", &port.EntityArgs{
	Blueprint:                    pulumi.String("string"),
	Title:                        pulumi.String("string"),
	CreateMissingRelatedEntities: pulumi.Bool(false),
	Icon:                         pulumi.String("string"),
	Identifier:                   pulumi.String("string"),
	Properties: &port.EntityPropertiesArgs{
		ArrayProps: &port.EntityPropertiesArrayPropsArgs{
			BooleanItems: pulumi.BoolArrayMap{
				"string": pulumi.BoolArray{
					pulumi.Bool(false),
				},
			},
			NumberItems: pulumi.Float64ArrayMap{
				"string": pulumi.Float64Array{
					pulumi.Float64(0),
				},
			},
			ObjectItems: pulumi.StringArrayMap{
				"string": pulumi.StringArray{
					pulumi.String("string"),
				},
			},
			StringItems: pulumi.StringArrayMap{
				"string": pulumi.StringArray{
					pulumi.String("string"),
				},
			},
		},
		BooleanProps: pulumi.BoolMap{
			"string": pulumi.Bool(false),
		},
		NumberProps: pulumi.Float64Map{
			"string": pulumi.Float64(0),
		},
		ObjectProps: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		StringProps: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
	},
	Relations: &port.EntityRelationsArgs{
		ManyRelations: pulumi.StringArrayMap{
			"string": pulumi.StringArray{
				pulumi.String("string"),
			},
		},
		SingleRelations: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
	},
	RunId: pulumi.String("string"),
	Teams: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var entityResource = new Entity("entityResource", EntityArgs.builder()
    .blueprint("string")
    .title("string")
    .createMissingRelatedEntities(false)
    .icon("string")
    .identifier("string")
    .properties(EntityPropertiesArgs.builder()
        .arrayProps(EntityPropertiesArrayPropsArgs.builder()
            .booleanItems(Map.of("string", false))
            .numberItems(Map.of("string", 0.0))
            .objectItems(Map.of("string", "string"))
            .stringItems(Map.of("string", "string"))
            .build())
        .booleanProps(Map.of("string", false))
        .numberProps(Map.of("string", 0.0))
        .objectProps(Map.of("string", "string"))
        .stringProps(Map.of("string", "string"))
        .build())
    .relations(EntityRelationsArgs.builder()
        .manyRelations(Map.of("string", "string"))
        .singleRelations(Map.of("string", "string"))
        .build())
    .runId("string")
    .teams("string")
    .build());

    entity_resource = port.Entity("entityResource",
    blueprint="string",
    title="string",
    create_missing_related_entities=False,
    icon="string",
    identifier="string",
    properties={
        "array_props": {
            "boolean_items": {
                "string": [False],
            },
            "number_items": {
                "string": [0],
            },
            "object_items": {
                "string": ["string"],
            },
            "string_items": {
                "string": ["string"],
            },
        },
        "boolean_props": {
            "string": False,
        },
        "number_props": {
            "string": 0,
        },
        "object_props": {
            "string": "string",
        },
        "string_props": {
            "string": "string",
        },
    },
    relations={
        "many_relations": {
            "string": ["string"],
        },
        "single_relations": {
            "string": "string",
        },
    },
    run_id="string",
    teams=["string"])

    const entityResource = new port.Entity("entityResource", {
    blueprint: "string",
    title: "string",
    createMissingRelatedEntities: false,
    icon: "string",
    identifier: "string",
    properties: {
        arrayProps: {
            booleanItems: {
                string: [false],
            },
            numberItems: {
                string: [0],
            },
            objectItems: {
                string: ["string"],
            },
            stringItems: {
                string: ["string"],
            },
        },
        booleanProps: {
            string: false,
        },
        numberProps: {
            string: 0,
        },
        objectProps: {
            string: "string",
        },
        stringProps: {
            string: "string",
        },
    },
    relations: {
        manyRelations: {
            string: ["string"],
        },
        singleRelations: {
            string: "string",
        },
    },
    runId: "string",
    teams: ["string"],
});

    type: port:Entity
properties:
    blueprint: string
    createMissingRelatedEntities: false
    icon: string
    identifier: string
    properties:
        arrayProps:
            booleanItems:
                string:
                    - false
            numberItems:
                string:
                    - 0
            objectItems:
                string:
                    - string
            stringItems:
                string:
                    - string
        booleanProps:
            string: false
        numberProps:
            string: 0
        objectProps:
            string: string
        stringProps:
            string: string
    relations:
        manyRelations:
            string:
                - string
        singleRelations:
            string: string
    runId: string
    teams:
        - string
    title: string

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Entity resource accepts the following input properties:

    Blueprint string
    The blueprint identifier the entity relates to
    Title string
    The title of the entity
    CreateMissingRelatedEntities bool
    Whether to create missing related entities
    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
    Blueprint string
    The blueprint identifier the entity relates to
    Title string
    The title of the entity
    CreateMissingRelatedEntities bool
    Whether to create missing related entities
    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
    blueprint String
    The blueprint identifier the entity relates to
    title String
    The title of the entity
    createMissingRelatedEntities Boolean
    Whether to create missing related entities
    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
    blueprint string
    The blueprint identifier the entity relates to
    title string
    The title of the entity
    createMissingRelatedEntities boolean
    Whether to create missing related entities
    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
    blueprint str
    The blueprint identifier the entity relates to
    title str
    The title of the entity
    create_missing_related_entities bool
    Whether to create missing related entities
    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
    blueprint String
    The blueprint identifier the entity relates to
    title String
    The title of the entity
    createMissingRelatedEntities Boolean
    Whether to create missing related entities
    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

    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,
        create_missing_related_entities: Optional[bool] = 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)
    resources:  _:    type: port:Entity    get:      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 blueprint identifier the entity relates to
    CreateMissingRelatedEntities bool
    Whether to create missing related entities
    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
    CreateMissingRelatedEntities bool
    Whether to create missing related entities
    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
    createMissingRelatedEntities Boolean
    Whether to create missing related entities
    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
    createMissingRelatedEntities boolean
    Whether to create missing related entities
    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
    create_missing_related_entities bool
    Whether to create missing related entities
    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
    createMissingRelatedEntities Boolean
    Whether to create missing related entities
    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
    The array properties of the entity
    BooleanProps Dictionary<string, bool>
    The bool properties of the entity
    NumberProps Dictionary<string, double>
    The number properties of the entity
    ObjectProps Dictionary<string, string>
    The object properties of the entity
    StringProps Dictionary<string, string>
    The string properties of the entity
    ArrayProps EntityPropertiesArrayProps
    The array properties of the entity
    BooleanProps map[string]bool
    The bool properties of the entity
    NumberProps map[string]float64
    The number properties of the entity
    ObjectProps map[string]string
    The object properties of the entity
    StringProps map[string]string
    The string properties of the entity
    arrayProps EntityPropertiesArrayProps
    The array properties of the entity
    booleanProps Map<String,Boolean>
    The bool properties of the entity
    numberProps Map<String,Double>
    The number properties of the entity
    objectProps Map<String,String>
    The object properties of the entity
    stringProps Map<String,String>
    The string properties of the entity
    arrayProps EntityPropertiesArrayProps
    The array properties of the entity
    booleanProps {[key: string]: boolean}
    The bool properties of the entity
    numberProps {[key: string]: number}
    The number properties of the entity
    objectProps {[key: string]: string}
    The object properties of the entity
    stringProps {[key: string]: string}
    The string properties of the entity
    array_props EntityPropertiesArrayProps
    The array properties of the entity
    boolean_props Mapping[str, bool]
    The bool properties of the entity
    number_props Mapping[str, float]
    The number properties of the entity
    object_props Mapping[str, str]
    The object properties of the entity
    string_props Mapping[str, str]
    The string properties of the entity
    arrayProps Property Map
    The array properties of the entity
    booleanProps Map<Boolean>
    The bool properties of the entity
    numberProps Map<Number>
    The number properties of the entity
    objectProps Map<String>
    The object properties of the entity
    stringProps Map<String>
    The string properties of the entity

    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>>
    The many relation of the entity
    SingleRelations Dictionary<string, string>
    The single relation of the entity
    ManyRelations map[string][]string
    The many relation of the entity
    SingleRelations map[string]string
    The single relation of the entity
    manyRelations Map<String,List<String>>
    The many relation of the entity
    singleRelations Map<String,String>
    The single relation of the entity
    manyRelations {[key: string]: string[]}
    The many relation of the entity
    singleRelations {[key: string]: string}
    The single relation of the entity
    many_relations Mapping[str, Sequence[str]]
    The many relation of the entity
    single_relations Mapping[str, str]
    The single relation of the entity
    manyRelations Map<List<String>>
    The many relation of the entity
    singleRelations Map<String>
    The single relation of the entity

    Package Details

    Repository
    port port-labs/pulumi-port
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the port-labs Terraform Provider.
    port logo
    Port v2.7.1 published on Tuesday, May 6, 2025 by port-labs
    port-labs/pulumi-port