Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Statsig Provider
  3. API Docs
  4. EntityProperty
Statsig v0.0.1 published on Friday, Jun 6, 2025 by Statsig
statsig-io/pulumi-statsig

statsig.EntityProperty

Explore with Pulumi AI

statsig logo
Statsig v0.0.1 published on Friday, Jun 6, 2025 by Statsig
statsig-io/pulumi-statsig

    This resource allows you to configure entity properties for your Statsig project.

    To learn more about entity properties, see Entity Properties Documentation

    To learn more about the API powering this resource, see Experiments API Documentation

    Note: This resource is only available for Warehouse Native projects

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    resources:
  example:
    type: statsig:EntityProperty
    properties:
      description: A short description of this entity property.
      idTypeMappings:
        - column: user_id
          statsig_unit_id: userID
      isReadOnly: false
      sql: SELECT * FROM `shoppy-sales.kenny_dev.users`
      tags:
        - test-tag
      timestampColumn: ts

    Create EntityProperty Resource

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

    Constructor syntax

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

@overload
def EntityProperty(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   id_type_mappings: Optional[Sequence[EntityPropertyIdTypeMappingArgs]] = None,
                   sql: Optional[str] = None,
                   description: Optional[str] = None,
                   is_read_only: Optional[bool] = None,
                   name: Optional[str] = None,
                   tags: Optional[Sequence[str]] = None,
                   timestamp_as_day: Optional[bool] = None,
                   timestamp_column: Optional[str] = None)
    func NewEntityProperty(ctx *Context, name string, args EntityPropertyArgs, opts ...ResourceOption) (*EntityProperty, error)
    public EntityProperty(string name, EntityPropertyArgs args, CustomResourceOptions? opts = null)
    public EntityProperty(String name, EntityPropertyArgs args)
public EntityProperty(String name, EntityPropertyArgs args, CustomResourceOptions options)

    type: statsig:EntityProperty
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 EntityPropertyArgs
    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 EntityPropertyArgs
    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 EntityPropertyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EntityPropertyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EntityPropertyArgs
    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 entityPropertyResource = new Pulumi.EntityProperty("entityPropertyResource", new()
{
    IdTypeMappings = new[]
    {
        new Pulumi.Inputs.EntityPropertyIdTypeMappingArgs
        {
            Column = "string",
            StatsigUnitId = "string",
        },
    },
    Sql = "string",
    Description = "string",
    IsReadOnly = false,
    Name = "string",
    Tags = new[]
    {
        "string",
    },
    TimestampAsDay = false,
    TimestampColumn = "string",
});

    example, err := statsig.NewEntityProperty(ctx, "entityPropertyResource", &statsig.EntityPropertyArgs{
	IdTypeMappings: statsig.EntityPropertyIdTypeMappingArray{
		&statsig.EntityPropertyIdTypeMappingArgs{
			Column:        pulumi.String("string"),
			StatsigUnitId: pulumi.String("string"),
		},
	},
	Sql:         pulumi.String("string"),
	Description: pulumi.String("string"),
	IsReadOnly:  pulumi.Bool(false),
	Name:        pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	TimestampAsDay:  pulumi.Bool(false),
	TimestampColumn: pulumi.String("string"),
})

    var entityPropertyResource = new EntityProperty("entityPropertyResource", EntityPropertyArgs.builder()
    .idTypeMappings(EntityPropertyIdTypeMappingArgs.builder()
        .column("string")
        .statsigUnitId("string")
        .build())
    .sql("string")
    .description("string")
    .isReadOnly(false)
    .name("string")
    .tags("string")
    .timestampAsDay(false)
    .timestampColumn("string")
    .build());

    entity_property_resource = statsig.EntityProperty("entityPropertyResource",
    id_type_mappings=[{
        "column": "string",
        "statsig_unit_id": "string",
    }],
    sql="string",
    description="string",
    is_read_only=False,
    name="string",
    tags=["string"],
    timestamp_as_day=False,
    timestamp_column="string")

    const entityPropertyResource = new statsig.EntityProperty("entityPropertyResource", {
    idTypeMappings: [{
        column: "string",
        statsigUnitId: "string",
    }],
    sql: "string",
    description: "string",
    isReadOnly: false,
    name: "string",
    tags: ["string"],
    timestampAsDay: false,
    timestampColumn: "string",
});

    type: statsig:EntityProperty
properties:
    description: string
    idTypeMappings:
        - column: string
          statsigUnitId: string
    isReadOnly: false
    name: string
    sql: string
    tags:
        - string
    timestampAsDay: false
    timestampColumn: string

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

    IdTypeMappings List<Statsig.Pulumi.Inputs.EntityPropertyIdTypeMapping>
    Mappings of Statsig units to their columns.
    Sql string
    SQL query defining the data source.
    Description string
    Optional detailed context for the entity property source.
    IsReadOnly bool
    Specifies if the source can only be edited via the Console API.
    Name string
    Unique identifier for the entity property source.
    Tags List<string>
    Optional tags for categorization.
    TimestampAsDay bool
    Indicates if the timestamp is treated as a day.
    TimestampColumn string
    Optional column name for timestamp.
    IdTypeMappings []EntityPropertyIdTypeMappingArgs
    Mappings of Statsig units to their columns.
    Sql string
    SQL query defining the data source.
    Description string
    Optional detailed context for the entity property source.
    IsReadOnly bool
    Specifies if the source can only be edited via the Console API.
    Name string
    Unique identifier for the entity property source.
    Tags []string
    Optional tags for categorization.
    TimestampAsDay bool
    Indicates if the timestamp is treated as a day.
    TimestampColumn string
    Optional column name for timestamp.
    idTypeMappings List<EntityPropertyIdTypeMapping>
    Mappings of Statsig units to their columns.
    sql String
    SQL query defining the data source.
    description String
    Optional detailed context for the entity property source.
    isReadOnly Boolean
    Specifies if the source can only be edited via the Console API.
    name String
    Unique identifier for the entity property source.
    tags List<String>
    Optional tags for categorization.
    timestampAsDay Boolean
    Indicates if the timestamp is treated as a day.
    timestampColumn String
    Optional column name for timestamp.
    idTypeMappings EntityPropertyIdTypeMapping[]
    Mappings of Statsig units to their columns.
    sql string
    SQL query defining the data source.
    description string
    Optional detailed context for the entity property source.
    isReadOnly boolean
    Specifies if the source can only be edited via the Console API.
    name string
    Unique identifier for the entity property source.
    tags string[]
    Optional tags for categorization.
    timestampAsDay boolean
    Indicates if the timestamp is treated as a day.
    timestampColumn string
    Optional column name for timestamp.
    id_type_mappings Sequence[EntityPropertyIdTypeMappingArgs]
    Mappings of Statsig units to their columns.
    sql str
    SQL query defining the data source.
    description str
    Optional detailed context for the entity property source.
    is_read_only bool
    Specifies if the source can only be edited via the Console API.
    name str
    Unique identifier for the entity property source.
    tags Sequence[str]
    Optional tags for categorization.
    timestamp_as_day bool
    Indicates if the timestamp is treated as a day.
    timestamp_column str
    Optional column name for timestamp.
    idTypeMappings List<Property Map>
    Mappings of Statsig units to their columns.
    sql String
    SQL query defining the data source.
    description String
    Optional detailed context for the entity property source.
    isReadOnly Boolean
    Specifies if the source can only be edited via the Console API.
    name String
    Unique identifier for the entity property source.
    tags List<String>
    Optional tags for categorization.
    timestampAsDay Boolean
    Indicates if the timestamp is treated as a day.
    timestampColumn String
    Optional column name for timestamp.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Owner Statsig.Pulumi.Outputs.EntityPropertyOwner
    Schema for owner data including ID, type, name. Note that if Entity is created by CONSOLE API, owner will be undefined.
    Id string
    The provider-assigned unique ID for this managed resource.
    Owner EntityPropertyOwner
    Schema for owner data including ID, type, name. Note that if Entity is created by CONSOLE API, owner will be undefined.
    id String
    The provider-assigned unique ID for this managed resource.
    owner EntityPropertyOwner
    Schema for owner data including ID, type, name. Note that if Entity is created by CONSOLE API, owner will be undefined.
    id string
    The provider-assigned unique ID for this managed resource.
    owner EntityPropertyOwner
    Schema for owner data including ID, type, name. Note that if Entity is created by CONSOLE API, owner will be undefined.
    id str
    The provider-assigned unique ID for this managed resource.
    owner EntityPropertyOwner
    Schema for owner data including ID, type, name. Note that if Entity is created by CONSOLE API, owner will be undefined.
    id String
    The provider-assigned unique ID for this managed resource.
    owner Property Map
    Schema for owner data including ID, type, name. Note that if Entity is created by CONSOLE API, owner will be undefined.

    Look up Existing EntityProperty Resource

    Get an existing EntityProperty 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?: EntityPropertyState, opts?: CustomResourceOptions): EntityProperty
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        id_type_mappings: Optional[Sequence[EntityPropertyIdTypeMappingArgs]] = None,
        is_read_only: Optional[bool] = None,
        name: Optional[str] = None,
        owner: Optional[EntityPropertyOwnerArgs] = None,
        sql: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        timestamp_as_day: Optional[bool] = None,
        timestamp_column: Optional[str] = None) -> EntityProperty
    func GetEntityProperty(ctx *Context, name string, id IDInput, state *EntityPropertyState, opts ...ResourceOption) (*EntityProperty, error)
    public static EntityProperty Get(string name, Input<string> id, EntityPropertyState? state, CustomResourceOptions? opts = null)
    public static EntityProperty get(String name, Output<String> id, EntityPropertyState state, CustomResourceOptions options)
    resources:  _:    type: statsig:EntityProperty    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:
    Description string
    Optional detailed context for the entity property source.
    IdTypeMappings List<Statsig.Pulumi.Inputs.EntityPropertyIdTypeMapping>
    Mappings of Statsig units to their columns.
    IsReadOnly bool
    Specifies if the source can only be edited via the Console API.
    Name string
    Unique identifier for the entity property source.
    Owner Statsig.Pulumi.Inputs.EntityPropertyOwner
    Schema for owner data including ID, type, name. Note that if Entity is created by CONSOLE API, owner will be undefined.
    Sql string
    SQL query defining the data source.
    Tags List<string>
    Optional tags for categorization.
    TimestampAsDay bool
    Indicates if the timestamp is treated as a day.
    TimestampColumn string
    Optional column name for timestamp.
    Description string
    Optional detailed context for the entity property source.
    IdTypeMappings []EntityPropertyIdTypeMappingArgs
    Mappings of Statsig units to their columns.
    IsReadOnly bool
    Specifies if the source can only be edited via the Console API.
    Name string
    Unique identifier for the entity property source.
    Owner EntityPropertyOwnerArgs
    Schema for owner data including ID, type, name. Note that if Entity is created by CONSOLE API, owner will be undefined.
    Sql string
    SQL query defining the data source.
    Tags []string
    Optional tags for categorization.
    TimestampAsDay bool
    Indicates if the timestamp is treated as a day.
    TimestampColumn string
    Optional column name for timestamp.
    description String
    Optional detailed context for the entity property source.
    idTypeMappings List<EntityPropertyIdTypeMapping>
    Mappings of Statsig units to their columns.
    isReadOnly Boolean
    Specifies if the source can only be edited via the Console API.
    name String
    Unique identifier for the entity property source.
    owner EntityPropertyOwner
    Schema for owner data including ID, type, name. Note that if Entity is created by CONSOLE API, owner will be undefined.
    sql String
    SQL query defining the data source.
    tags List<String>
    Optional tags for categorization.
    timestampAsDay Boolean
    Indicates if the timestamp is treated as a day.
    timestampColumn String
    Optional column name for timestamp.
    description string
    Optional detailed context for the entity property source.
    idTypeMappings EntityPropertyIdTypeMapping[]
    Mappings of Statsig units to their columns.
    isReadOnly boolean
    Specifies if the source can only be edited via the Console API.
    name string
    Unique identifier for the entity property source.
    owner EntityPropertyOwner
    Schema for owner data including ID, type, name. Note that if Entity is created by CONSOLE API, owner will be undefined.
    sql string
    SQL query defining the data source.
    tags string[]
    Optional tags for categorization.
    timestampAsDay boolean
    Indicates if the timestamp is treated as a day.
    timestampColumn string
    Optional column name for timestamp.
    description str
    Optional detailed context for the entity property source.
    id_type_mappings Sequence[EntityPropertyIdTypeMappingArgs]
    Mappings of Statsig units to their columns.
    is_read_only bool
    Specifies if the source can only be edited via the Console API.
    name str
    Unique identifier for the entity property source.
    owner EntityPropertyOwnerArgs
    Schema for owner data including ID, type, name. Note that if Entity is created by CONSOLE API, owner will be undefined.
    sql str
    SQL query defining the data source.
    tags Sequence[str]
    Optional tags for categorization.
    timestamp_as_day bool
    Indicates if the timestamp is treated as a day.
    timestamp_column str
    Optional column name for timestamp.
    description String
    Optional detailed context for the entity property source.
    idTypeMappings List<Property Map>
    Mappings of Statsig units to their columns.
    isReadOnly Boolean
    Specifies if the source can only be edited via the Console API.
    name String
    Unique identifier for the entity property source.
    owner Property Map
    Schema for owner data including ID, type, name. Note that if Entity is created by CONSOLE API, owner will be undefined.
    sql String
    SQL query defining the data source.
    tags List<String>
    Optional tags for categorization.
    timestampAsDay Boolean
    Indicates if the timestamp is treated as a day.
    timestampColumn String
    Optional column name for timestamp.

    Supporting Types

    EntityPropertyIdTypeMapping, EntityPropertyIdTypeMappingArgs

    Column string
    Column name linked to the ID.
    StatsigUnitId string
    ID for the Statsig unit.
    Column string
    Column name linked to the ID.
    StatsigUnitId string
    ID for the Statsig unit.
    column String
    Column name linked to the ID.
    statsigUnitId String
    ID for the Statsig unit.
    column string
    Column name linked to the ID.
    statsigUnitId string
    ID for the Statsig unit.
    column str
    Column name linked to the ID.
    statsig_unit_id str
    ID for the Statsig unit.
    column String
    Column name linked to the ID.
    statsigUnitId String
    ID for the Statsig unit.

    EntityPropertyOwner, EntityPropertyOwnerArgs

    OwnerEmail string
    The email of the owner. This field is optional.
    OwnerId string
    ID of the owner
    OwnerName string
    The name of the owner. This field is optional.
    OwnerType string
    Type of the owner (e.g., SDK_KEY or USER)
    OwnerEmail string
    The email of the owner. This field is optional.
    OwnerId string
    ID of the owner
    OwnerName string
    The name of the owner. This field is optional.
    OwnerType string
    Type of the owner (e.g., SDK_KEY or USER)
    ownerEmail String
    The email of the owner. This field is optional.
    ownerId String
    ID of the owner
    ownerName String
    The name of the owner. This field is optional.
    ownerType String
    Type of the owner (e.g., SDK_KEY or USER)
    ownerEmail string
    The email of the owner. This field is optional.
    ownerId string
    ID of the owner
    ownerName string
    The name of the owner. This field is optional.
    ownerType string
    Type of the owner (e.g., SDK_KEY or USER)
    owner_email str
    The email of the owner. This field is optional.
    owner_id str
    ID of the owner
    owner_name str
    The name of the owner. This field is optional.
    owner_type str
    Type of the owner (e.g., SDK_KEY or USER)
    ownerEmail String
    The email of the owner. This field is optional.
    ownerId String
    ID of the owner
    ownerName String
    The name of the owner. This field is optional.
    ownerType String
    Type of the owner (e.g., SDK_KEY or USER)

    Package Details

    Repository
    statsig statsig-io/pulumi-statsig
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the statsig Terraform Provider.
    statsig logo
    Statsig v0.0.1 published on Friday, Jun 6, 2025 by Statsig
    statsig-io/pulumi-statsig