1. Packages
  2. Port
  3. API Docs
  4. AggregationProperties
Port v1.10.5 published on Sunday, Mar 24, 2024 by port-labs

port.AggregationProperties

Explore with Pulumi AI

port logo
Port v1.10.5 published on Sunday, Mar 24, 2024 by port-labs

    Create AggregationProperties Resource

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

    Constructor syntax

    new AggregationProperties(name: string, args: AggregationPropertiesArgs, opts?: CustomResourceOptions);
    @overload
    def AggregationProperties(resource_name: str,
                              args: AggregationPropertiesArgs,
                              opts: Optional[ResourceOptions] = None)
    
    @overload
    def AggregationProperties(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              blueprint_identifier: Optional[str] = None,
                              properties: Optional[Mapping[str, AggregationPropertiesPropertiesArgs]] = None)
    func NewAggregationProperties(ctx *Context, name string, args AggregationPropertiesArgs, opts ...ResourceOption) (*AggregationProperties, error)
    public AggregationProperties(string name, AggregationPropertiesArgs args, CustomResourceOptions? opts = null)
    public AggregationProperties(String name, AggregationPropertiesArgs args)
    public AggregationProperties(String name, AggregationPropertiesArgs args, CustomResourceOptions options)
    
    type: port:AggregationProperties
    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 AggregationPropertiesArgs
    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 AggregationPropertiesArgs
    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 AggregationPropertiesArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AggregationPropertiesArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AggregationPropertiesArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var aggregationPropertiesResource = new Port.AggregationProperties("aggregationPropertiesResource", new()
    {
        BlueprintIdentifier = "string",
        Properties = 
        {
            { "string", new Port.Inputs.AggregationPropertiesPropertiesArgs
            {
                Method = new Port.Inputs.AggregationPropertiesPropertiesMethodArgs
                {
                    AggregateByProperty = new Port.Inputs.AggregationPropertiesPropertiesMethodAggregateByPropertyArgs
                    {
                        Func = "string",
                        Property = "string",
                    },
                    AverageByProperty = new Port.Inputs.AggregationPropertiesPropertiesMethodAverageByPropertyArgs
                    {
                        AverageOf = "string",
                        MeasureTimeBy = "string",
                        Property = "string",
                    },
                    AverageEntities = new Port.Inputs.AggregationPropertiesPropertiesMethodAverageEntitiesArgs
                    {
                        AverageOf = "string",
                        MeasureTimeBy = "string",
                    },
                    CountEntities = false,
                },
                TargetBlueprintIdentifier = "string",
                Description = "string",
                Icon = "string",
                Query = "string",
                Title = "string",
            } },
        },
    });
    
    example, err := port.NewAggregationProperties(ctx, "aggregationPropertiesResource", &port.AggregationPropertiesArgs{
    	BlueprintIdentifier: pulumi.String("string"),
    	Properties: port.AggregationPropertiesPropertiesMap{
    		"string": &port.AggregationPropertiesPropertiesArgs{
    			Method: &port.AggregationPropertiesPropertiesMethodArgs{
    				AggregateByProperty: &port.AggregationPropertiesPropertiesMethodAggregateByPropertyArgs{
    					Func:     pulumi.String("string"),
    					Property: pulumi.String("string"),
    				},
    				AverageByProperty: &port.AggregationPropertiesPropertiesMethodAverageByPropertyArgs{
    					AverageOf:     pulumi.String("string"),
    					MeasureTimeBy: pulumi.String("string"),
    					Property:      pulumi.String("string"),
    				},
    				AverageEntities: &port.AggregationPropertiesPropertiesMethodAverageEntitiesArgs{
    					AverageOf:     pulumi.String("string"),
    					MeasureTimeBy: pulumi.String("string"),
    				},
    				CountEntities: pulumi.Bool(false),
    			},
    			TargetBlueprintIdentifier: pulumi.String("string"),
    			Description:               pulumi.String("string"),
    			Icon:                      pulumi.String("string"),
    			Query:                     pulumi.String("string"),
    			Title:                     pulumi.String("string"),
    		},
    	},
    })
    
    var aggregationPropertiesResource = new AggregationProperties("aggregationPropertiesResource", AggregationPropertiesArgs.builder()        
        .blueprintIdentifier("string")
        .properties(Map.of("string", Map.ofEntries(
            Map.entry("method", Map.ofEntries(
                Map.entry("aggregateByProperty", Map.ofEntries(
                    Map.entry("func", "string"),
                    Map.entry("property", "string")
                )),
                Map.entry("averageByProperty", Map.ofEntries(
                    Map.entry("averageOf", "string"),
                    Map.entry("measureTimeBy", "string"),
                    Map.entry("property", "string")
                )),
                Map.entry("averageEntities", Map.ofEntries(
                    Map.entry("averageOf", "string"),
                    Map.entry("measureTimeBy", "string")
                )),
                Map.entry("countEntities", false)
            )),
            Map.entry("targetBlueprintIdentifier", "string"),
            Map.entry("description", "string"),
            Map.entry("icon", "string"),
            Map.entry("query", "string"),
            Map.entry("title", "string")
        )))
        .build());
    
    aggregation_properties_resource = port.AggregationProperties("aggregationPropertiesResource",
        blueprint_identifier="string",
        properties={
            "string": port.AggregationPropertiesPropertiesArgs(
                method=port.AggregationPropertiesPropertiesMethodArgs(
                    aggregate_by_property=port.AggregationPropertiesPropertiesMethodAggregateByPropertyArgs(
                        func="string",
                        property="string",
                    ),
                    average_by_property=port.AggregationPropertiesPropertiesMethodAverageByPropertyArgs(
                        average_of="string",
                        measure_time_by="string",
                        property="string",
                    ),
                    average_entities=port.AggregationPropertiesPropertiesMethodAverageEntitiesArgs(
                        average_of="string",
                        measure_time_by="string",
                    ),
                    count_entities=False,
                ),
                target_blueprint_identifier="string",
                description="string",
                icon="string",
                query="string",
                title="string",
            ),
        })
    
    const aggregationPropertiesResource = new port.AggregationProperties("aggregationPropertiesResource", {
        blueprintIdentifier: "string",
        properties: {
            string: {
                method: {
                    aggregateByProperty: {
                        func: "string",
                        property: "string",
                    },
                    averageByProperty: {
                        averageOf: "string",
                        measureTimeBy: "string",
                        property: "string",
                    },
                    averageEntities: {
                        averageOf: "string",
                        measureTimeBy: "string",
                    },
                    countEntities: false,
                },
                targetBlueprintIdentifier: "string",
                description: "string",
                icon: "string",
                query: "string",
                title: "string",
            },
        },
    });
    
    type: port:AggregationProperties
    properties:
        blueprintIdentifier: string
        properties:
            string:
                description: string
                icon: string
                method:
                    aggregateByProperty:
                        func: string
                        property: string
                    averageByProperty:
                        averageOf: string
                        measureTimeBy: string
                        property: string
                    averageEntities:
                        averageOf: string
                        measureTimeBy: string
                    countEntities: false
                query: string
                targetBlueprintIdentifier: string
                title: string
    

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

    BlueprintIdentifier string
    The identifier of the blueprint the aggregation property will be added to
    Properties Dictionary<string, port_labs.Port.Inputs.AggregationPropertiesPropertiesArgs>
    The aggregation property of the blueprint
    BlueprintIdentifier string
    The identifier of the blueprint the aggregation property will be added to
    Properties map[string]AggregationPropertiesPropertiesArgs
    The aggregation property of the blueprint
    blueprintIdentifier String
    The identifier of the blueprint the aggregation property will be added to
    properties Map<String,AggregationPropertiesPropertiesArgs>
    The aggregation property of the blueprint
    blueprintIdentifier string
    The identifier of the blueprint the aggregation property will be added to
    properties {[key: string]: AggregationPropertiesPropertiesArgs}
    The aggregation property of the blueprint
    blueprint_identifier str
    The identifier of the blueprint the aggregation property will be added to
    properties Mapping[str, AggregationPropertiesPropertiesArgs]
    The aggregation property of the blueprint
    blueprintIdentifier String
    The identifier of the blueprint the aggregation property will be added to
    properties Map<Property Map>
    The aggregation property of the blueprint

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing AggregationProperties Resource

    Get an existing AggregationProperties 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?: AggregationPropertiesState, opts?: CustomResourceOptions): AggregationProperties
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            blueprint_identifier: Optional[str] = None,
            properties: Optional[Mapping[str, AggregationPropertiesPropertiesArgs]] = None) -> AggregationProperties
    func GetAggregationProperties(ctx *Context, name string, id IDInput, state *AggregationPropertiesState, opts ...ResourceOption) (*AggregationProperties, error)
    public static AggregationProperties Get(string name, Input<string> id, AggregationPropertiesState? state, CustomResourceOptions? opts = null)
    public static AggregationProperties get(String name, Output<String> id, AggregationPropertiesState 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:
    BlueprintIdentifier string
    The identifier of the blueprint the aggregation property will be added to
    Properties Dictionary<string, port_labs.Port.Inputs.AggregationPropertiesPropertiesArgs>
    The aggregation property of the blueprint
    BlueprintIdentifier string
    The identifier of the blueprint the aggregation property will be added to
    Properties map[string]AggregationPropertiesPropertiesArgs
    The aggregation property of the blueprint
    blueprintIdentifier String
    The identifier of the blueprint the aggregation property will be added to
    properties Map<String,AggregationPropertiesPropertiesArgs>
    The aggregation property of the blueprint
    blueprintIdentifier string
    The identifier of the blueprint the aggregation property will be added to
    properties {[key: string]: AggregationPropertiesPropertiesArgs}
    The aggregation property of the blueprint
    blueprint_identifier str
    The identifier of the blueprint the aggregation property will be added to
    properties Mapping[str, AggregationPropertiesPropertiesArgs]
    The aggregation property of the blueprint
    blueprintIdentifier String
    The identifier of the blueprint the aggregation property will be added to
    properties Map<Property Map>
    The aggregation property of the blueprint

    Supporting Types

    AggregationPropertiesProperties, AggregationPropertiesPropertiesArgs

    Method port_labs.Port.Inputs.AggregationPropertiesPropertiesMethod
    The aggregation method to perform on the target blueprint, one of count_entities, average_entities, average_by_property, aggregate_by_property
    TargetBlueprintIdentifier string
    The identifier of the blueprint to perform the aggregation on
    Description string
    The description of the aggregation property
    Icon string
    The icon of the aggregation property
    Query string
    Query to filter the target entities
    Title string
    The title of the aggregation property
    Method AggregationPropertiesPropertiesMethod
    The aggregation method to perform on the target blueprint, one of count_entities, average_entities, average_by_property, aggregate_by_property
    TargetBlueprintIdentifier string
    The identifier of the blueprint to perform the aggregation on
    Description string
    The description of the aggregation property
    Icon string
    The icon of the aggregation property
    Query string
    Query to filter the target entities
    Title string
    The title of the aggregation property
    method AggregationPropertiesPropertiesMethod
    The aggregation method to perform on the target blueprint, one of count_entities, average_entities, average_by_property, aggregate_by_property
    targetBlueprintIdentifier String
    The identifier of the blueprint to perform the aggregation on
    description String
    The description of the aggregation property
    icon String
    The icon of the aggregation property
    query String
    Query to filter the target entities
    title String
    The title of the aggregation property
    method AggregationPropertiesPropertiesMethod
    The aggregation method to perform on the target blueprint, one of count_entities, average_entities, average_by_property, aggregate_by_property
    targetBlueprintIdentifier string
    The identifier of the blueprint to perform the aggregation on
    description string
    The description of the aggregation property
    icon string
    The icon of the aggregation property
    query string
    Query to filter the target entities
    title string
    The title of the aggregation property
    method AggregationPropertiesPropertiesMethod
    The aggregation method to perform on the target blueprint, one of count_entities, average_entities, average_by_property, aggregate_by_property
    target_blueprint_identifier str
    The identifier of the blueprint to perform the aggregation on
    description str
    The description of the aggregation property
    icon str
    The icon of the aggregation property
    query str
    Query to filter the target entities
    title str
    The title of the aggregation property
    method Property Map
    The aggregation method to perform on the target blueprint, one of count_entities, average_entities, average_by_property, aggregate_by_property
    targetBlueprintIdentifier String
    The identifier of the blueprint to perform the aggregation on
    description String
    The description of the aggregation property
    icon String
    The icon of the aggregation property
    query String
    Query to filter the target entities
    title String
    The title of the aggregation property

    AggregationPropertiesPropertiesMethod, AggregationPropertiesPropertiesMethodArgs

    AggregateByProperty port_labs.Port.Inputs.AggregationPropertiesPropertiesMethodAggregateByProperty
    Function to calculate the aggregate by property value of the target entities, such as sum, min, max, median
    AverageByProperty port_labs.Port.Inputs.AggregationPropertiesPropertiesMethodAverageByProperty
    Function to calculate the average by property value of the target entities
    AverageEntities port_labs.Port.Inputs.AggregationPropertiesPropertiesMethodAverageEntities
    Function to average the entities of the target entities
    CountEntities bool
    Function to count the entities of the target entities
    AggregateByProperty AggregationPropertiesPropertiesMethodAggregateByProperty
    Function to calculate the aggregate by property value of the target entities, such as sum, min, max, median
    AverageByProperty AggregationPropertiesPropertiesMethodAverageByProperty
    Function to calculate the average by property value of the target entities
    AverageEntities AggregationPropertiesPropertiesMethodAverageEntities
    Function to average the entities of the target entities
    CountEntities bool
    Function to count the entities of the target entities
    aggregateByProperty AggregationPropertiesPropertiesMethodAggregateByProperty
    Function to calculate the aggregate by property value of the target entities, such as sum, min, max, median
    averageByProperty AggregationPropertiesPropertiesMethodAverageByProperty
    Function to calculate the average by property value of the target entities
    averageEntities AggregationPropertiesPropertiesMethodAverageEntities
    Function to average the entities of the target entities
    countEntities Boolean
    Function to count the entities of the target entities
    aggregateByProperty AggregationPropertiesPropertiesMethodAggregateByProperty
    Function to calculate the aggregate by property value of the target entities, such as sum, min, max, median
    averageByProperty AggregationPropertiesPropertiesMethodAverageByProperty
    Function to calculate the average by property value of the target entities
    averageEntities AggregationPropertiesPropertiesMethodAverageEntities
    Function to average the entities of the target entities
    countEntities boolean
    Function to count the entities of the target entities
    aggregate_by_property AggregationPropertiesPropertiesMethodAggregateByProperty
    Function to calculate the aggregate by property value of the target entities, such as sum, min, max, median
    average_by_property AggregationPropertiesPropertiesMethodAverageByProperty
    Function to calculate the average by property value of the target entities
    average_entities AggregationPropertiesPropertiesMethodAverageEntities
    Function to average the entities of the target entities
    count_entities bool
    Function to count the entities of the target entities
    aggregateByProperty Property Map
    Function to calculate the aggregate by property value of the target entities, such as sum, min, max, median
    averageByProperty Property Map
    Function to calculate the average by property value of the target entities
    averageEntities Property Map
    Function to average the entities of the target entities
    countEntities Boolean
    Function to count the entities of the target entities

    AggregationPropertiesPropertiesMethodAggregateByProperty, AggregationPropertiesPropertiesMethodAggregateByPropertyArgs

    Func string
    The func of the aggregate by property
    Property string
    The property of the aggregate by property
    Func string
    The func of the aggregate by property
    Property string
    The property of the aggregate by property
    func String
    The func of the aggregate by property
    property String
    The property of the aggregate by property
    func string
    The func of the aggregate by property
    property string
    The property of the aggregate by property
    func str
    The func of the aggregate by property
    property str
    The property of the aggregate by property
    func String
    The func of the aggregate by property
    property String
    The property of the aggregate by property

    AggregationPropertiesPropertiesMethodAverageByProperty, AggregationPropertiesPropertiesMethodAverageByPropertyArgs

    AverageOf string
    The time periods to calculate the average by, e.g. hour, day, week, month
    MeasureTimeBy string
    The property name on which to calculate the the time periods, e.g. $createdAt, $updated_at or any other date property
    Property string
    The property name on which to calculate the average by
    AverageOf string
    The time periods to calculate the average by, e.g. hour, day, week, month
    MeasureTimeBy string
    The property name on which to calculate the the time periods, e.g. $createdAt, $updated_at or any other date property
    Property string
    The property name on which to calculate the average by
    averageOf String
    The time periods to calculate the average by, e.g. hour, day, week, month
    measureTimeBy String
    The property name on which to calculate the the time periods, e.g. $createdAt, $updated_at or any other date property
    property String
    The property name on which to calculate the average by
    averageOf string
    The time periods to calculate the average by, e.g. hour, day, week, month
    measureTimeBy string
    The property name on which to calculate the the time periods, e.g. $createdAt, $updated_at or any other date property
    property string
    The property name on which to calculate the average by
    average_of str
    The time periods to calculate the average by, e.g. hour, day, week, month
    measure_time_by str
    The property name on which to calculate the the time periods, e.g. $createdAt, $updated_at or any other date property
    property str
    The property name on which to calculate the average by
    averageOf String
    The time periods to calculate the average by, e.g. hour, day, week, month
    measureTimeBy String
    The property name on which to calculate the the time periods, e.g. $createdAt, $updated_at or any other date property
    property String
    The property name on which to calculate the average by

    AggregationPropertiesPropertiesMethodAverageEntities, AggregationPropertiesPropertiesMethodAverageEntitiesArgs

    AverageOf string
    The time periods to calculate the average of, e.g. hour, day, week, month
    MeasureTimeBy string
    The property name on which to calculate the the time periods, e.g. $createdAt, $updated_at or any other date property
    AverageOf string
    The time periods to calculate the average of, e.g. hour, day, week, month
    MeasureTimeBy string
    The property name on which to calculate the the time periods, e.g. $createdAt, $updated_at or any other date property
    averageOf String
    The time periods to calculate the average of, e.g. hour, day, week, month
    measureTimeBy String
    The property name on which to calculate the the time periods, e.g. $createdAt, $updated_at or any other date property
    averageOf string
    The time periods to calculate the average of, e.g. hour, day, week, month
    measureTimeBy string
    The property name on which to calculate the the time periods, e.g. $createdAt, $updated_at or any other date property
    average_of str
    The time periods to calculate the average of, e.g. hour, day, week, month
    measure_time_by str
    The property name on which to calculate the the time periods, e.g. $createdAt, $updated_at or any other date property
    averageOf String
    The time periods to calculate the average of, e.g. hour, day, week, month
    measureTimeBy String
    The property name on which to calculate the the time periods, e.g. $createdAt, $updated_at or any other date property

    Package Details

    Repository
    port port-labs/pulumi-port
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the port Terraform Provider.
    port logo
    Port v1.10.5 published on Sunday, Mar 24, 2024 by port-labs