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.
Constructor 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",
PathFilters = new[]
{
new Port.Inputs.AggregationPropertiesPropertiesPathFilterArgs
{
Paths = new[]
{
"string",
},
FromBlueprint = "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"),
PathFilters: port.AggregationPropertiesPropertiesPathFilterArray{
&port.AggregationPropertiesPropertiesPathFilterArgs{
Paths: pulumi.StringArray{
pulumi.String("string"),
},
FromBlueprint: pulumi.String("string"),
},
},
Query: pulumi.String("string"),
Title: pulumi.String("string"),
},
},
})
var aggregationPropertiesResource = new AggregationProperties("aggregationPropertiesResource", AggregationPropertiesArgs.builder()
.blueprintIdentifier("string")
.properties(Map.of("string", AggregationPropertiesPropertiesArgs.builder()
.method(AggregationPropertiesPropertiesMethodArgs.builder()
.aggregateByProperty(AggregationPropertiesPropertiesMethodAggregateByPropertyArgs.builder()
.func("string")
.property("string")
.build())
.averageByProperty(AggregationPropertiesPropertiesMethodAverageByPropertyArgs.builder()
.averageOf("string")
.measureTimeBy("string")
.property("string")
.build())
.averageEntities(AggregationPropertiesPropertiesMethodAverageEntitiesArgs.builder()
.averageOf("string")
.measureTimeBy("string")
.build())
.countEntities(false)
.build())
.targetBlueprintIdentifier("string")
.description("string")
.icon("string")
.pathFilters(AggregationPropertiesPropertiesPathFilterArgs.builder()
.paths("string")
.fromBlueprint("string")
.build())
.query("string")
.title("string")
.build()))
.build());
aggregation_properties_resource = port.AggregationProperties("aggregationPropertiesResource",
blueprint_identifier="string",
properties={
"string": {
"method": {
"aggregate_by_property": {
"func": "string",
"property": "string",
},
"average_by_property": {
"average_of": "string",
"measure_time_by": "string",
"property": "string",
},
"average_entities": {
"average_of": "string",
"measure_time_by": "string",
},
"count_entities": False,
},
"target_blueprint_identifier": "string",
"description": "string",
"icon": "string",
"path_filters": [{
"paths": ["string"],
"from_blueprint": "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",
pathFilters: [{
paths: ["string"],
fromBlueprint: "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
pathFilters:
- fromBlueprint: string
paths:
- string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The AggregationProperties resource accepts the following input properties:
- Blueprint
Identifier string - The identifier of the blueprint the aggregation property will be added to
- Properties
Dictionary<string, port_
labs. Port. Inputs. Aggregation Properties Properties Args> - The aggregation property of the blueprint
- Blueprint
Identifier string - The identifier of the blueprint the aggregation property will be added to
- Properties
map[string]Aggregation
Properties Properties Args - The aggregation property of the blueprint
- blueprint
Identifier String - The identifier of the blueprint the aggregation property will be added to
- properties
Map<String,Aggregation
Properties Properties Args> - The aggregation property of the blueprint
- blueprint
Identifier string - The identifier of the blueprint the aggregation property will be added to
- properties
{[key: string]: Aggregation
Properties Properties Args} - The aggregation property of the blueprint
- blueprint_
identifier str - The identifier of the blueprint the aggregation property will be added to
- properties
Mapping[str, Aggregation
Properties Properties Args] - The aggregation property of the blueprint
- blueprint
Identifier 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) -> AggregationPropertiesfunc 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)resources: _: type: port:AggregationProperties 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.
- Blueprint
Identifier string - The identifier of the blueprint the aggregation property will be added to
- Properties
Dictionary<string, port_
labs. Port. Inputs. Aggregation Properties Properties Args> - The aggregation property of the blueprint
- Blueprint
Identifier string - The identifier of the blueprint the aggregation property will be added to
- Properties
map[string]Aggregation
Properties Properties Args - The aggregation property of the blueprint
- blueprint
Identifier String - The identifier of the blueprint the aggregation property will be added to
- properties
Map<String,Aggregation
Properties Properties Args> - The aggregation property of the blueprint
- blueprint
Identifier string - The identifier of the blueprint the aggregation property will be added to
- properties
{[key: string]: Aggregation
Properties Properties Args} - The aggregation property of the blueprint
- blueprint_
identifier str - The identifier of the blueprint the aggregation property will be added to
- properties
Mapping[str, Aggregation
Properties Properties Args] - The aggregation property of the blueprint
- blueprint
Identifier 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. Aggregation Properties Properties Method - The aggregation method to perform on the target blueprint, one of count_entities, average_entities, average_by_property, aggregate_by_property
- Target
Blueprint stringIdentifier - 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
- Path
Filters List<port_labs. Port. Inputs. Aggregation Properties Properties Path Filter> - Path filter to filter entities based on relation path
- Query string
- Query to filter the target entities
- Title string
- The title of the aggregation property
- Method
Aggregation
Properties Properties Method - The aggregation method to perform on the target blueprint, one of count_entities, average_entities, average_by_property, aggregate_by_property
- Target
Blueprint stringIdentifier - 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
- Path
Filters []AggregationProperties Properties Path Filter - Path filter to filter entities based on relation path
- Query string
- Query to filter the target entities
- Title string
- The title of the aggregation property
- method
Aggregation
Properties Properties Method - The aggregation method to perform on the target blueprint, one of count_entities, average_entities, average_by_property, aggregate_by_property
- target
Blueprint StringIdentifier - 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
- path
Filters List<AggregationProperties Properties Path Filter> - Path filter to filter entities based on relation path
- query String
- Query to filter the target entities
- title String
- The title of the aggregation property
- method
Aggregation
Properties Properties Method - The aggregation method to perform on the target blueprint, one of count_entities, average_entities, average_by_property, aggregate_by_property
- target
Blueprint stringIdentifier - 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
- path
Filters AggregationProperties Properties Path Filter[] - Path filter to filter entities based on relation path
- query string
- Query to filter the target entities
- title string
- The title of the aggregation property
- method
Aggregation
Properties Properties Method - The aggregation method to perform on the target blueprint, one of count_entities, average_entities, average_by_property, aggregate_by_property
- target_
blueprint_ stridentifier - 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
- path_
filters Sequence[AggregationProperties Properties Path Filter] - Path filter to filter entities based on relation path
- 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
- target
Blueprint StringIdentifier - 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
- path
Filters List<Property Map> - Path filter to filter entities based on relation path
- query String
- Query to filter the target entities
- title String
- The title of the aggregation property
AggregationPropertiesPropertiesMethod, AggregationPropertiesPropertiesMethodArgs
- Aggregate
By port_Property labs. Port. Inputs. Aggregation Properties Properties Method Aggregate By Property - Function to calculate the aggregate by property value of the target entities, such as sum, min, max, median
- Average
By port_Property labs. Port. Inputs. Aggregation Properties Properties Method Average By Property - Function to calculate the average by property value of the target entities
- Average
Entities port_labs. Port. Inputs. Aggregation Properties Properties Method Average Entities - Function to average the entities of the target entities
- Count
Entities bool - Function to count the entities of the target entities
- Aggregate
By AggregationProperty Properties Properties Method Aggregate By Property - Function to calculate the aggregate by property value of the target entities, such as sum, min, max, median
- Average
By AggregationProperty Properties Properties Method Average By Property - Function to calculate the average by property value of the target entities
- Average
Entities AggregationProperties Properties Method Average Entities - Function to average the entities of the target entities
- Count
Entities bool - Function to count the entities of the target entities
- aggregate
By AggregationProperty Properties Properties Method Aggregate By Property - Function to calculate the aggregate by property value of the target entities, such as sum, min, max, median
- average
By AggregationProperty Properties Properties Method Average By Property - Function to calculate the average by property value of the target entities
- average
Entities AggregationProperties Properties Method Average Entities - Function to average the entities of the target entities
- count
Entities Boolean - Function to count the entities of the target entities
- aggregate
By AggregationProperty Properties Properties Method Aggregate By Property - Function to calculate the aggregate by property value of the target entities, such as sum, min, max, median
- average
By AggregationProperty Properties Properties Method Average By Property - Function to calculate the average by property value of the target entities
- average
Entities AggregationProperties Properties Method Average Entities - Function to average the entities of the target entities
- count
Entities boolean - Function to count the entities of the target entities
- aggregate_
by_ Aggregationproperty Properties Properties Method Aggregate By Property - Function to calculate the aggregate by property value of the target entities, such as sum, min, max, median
- average_
by_ Aggregationproperty Properties Properties Method Average By Property - Function to calculate the average by property value of the target entities
- average_
entities AggregationProperties Properties Method Average Entities - Function to average the entities of the target entities
- count_
entities bool - Function to count the entities of the target entities
- aggregate
By Property MapProperty - Function to calculate the aggregate by property value of the target entities, such as sum, min, max, median
- average
By Property MapProperty - Function to calculate the average by property value of the target entities
- average
Entities Property Map - Function to average the entities of the target entities
- count
Entities Boolean - Function to count the entities of the target entities
AggregationPropertiesPropertiesMethodAggregateByProperty, AggregationPropertiesPropertiesMethodAggregateByPropertyArgs
AggregationPropertiesPropertiesMethodAverageByProperty, AggregationPropertiesPropertiesMethodAverageByPropertyArgs
- Average
Of string - The time periods to calculate the average by, e.g. hour, day, week, month
- Measure
Time stringBy - 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 string - The time periods to calculate the average by, e.g. hour, day, week, month
- Measure
Time stringBy - 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 String - The time periods to calculate the average by, e.g. hour, day, week, month
- measure
Time StringBy - 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 string - The time periods to calculate the average by, e.g. hour, day, week, month
- measure
Time stringBy - 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_ strby - 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
- average
Of String - The time periods to calculate the average by, e.g. hour, day, week, month
- measure
Time StringBy - 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
- Average
Of string - The time periods to calculate the average of, e.g. hour, day, week, month
- Measure
Time stringBy - The property name on which to calculate the the time periods, e.g. $createdAt, $updated_at or any other date property
- Average
Of string - The time periods to calculate the average of, e.g. hour, day, week, month
- Measure
Time stringBy - The property name on which to calculate the the time periods, e.g. $createdAt, $updated_at or any other date property
- average
Of String - The time periods to calculate the average of, e.g. hour, day, week, month
- measure
Time StringBy - The property name on which to calculate the the time periods, e.g. $createdAt, $updated_at or any other date property
- average
Of string - The time periods to calculate the average of, e.g. hour, day, week, month
- measure
Time stringBy - 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_ strby - The property name on which to calculate the the time periods, e.g. $createdAt, $updated_at or any other date property
- average
Of String - The time periods to calculate the average of, e.g. hour, day, week, month
- measure
Time StringBy - The property name on which to calculate the the time periods, e.g. $createdAt, $updated_at or any other date property
AggregationPropertiesPropertiesPathFilter, AggregationPropertiesPropertiesPathFilterArgs
- Paths List<string>
- The path array of relations to filter by
- From
Blueprint string - The blueprint to start the path from. Should be the target blueprint or undefined to start from the source blueprint
- Paths []string
- The path array of relations to filter by
- From
Blueprint string - The blueprint to start the path from. Should be the target blueprint or undefined to start from the source blueprint
- paths List<String>
- The path array of relations to filter by
- from
Blueprint String - The blueprint to start the path from. Should be the target blueprint or undefined to start from the source blueprint
- paths string[]
- The path array of relations to filter by
- from
Blueprint string - The blueprint to start the path from. Should be the target blueprint or undefined to start from the source blueprint
- paths Sequence[str]
- The path array of relations to filter by
- from_
blueprint str - The blueprint to start the path from. Should be the target blueprint or undefined to start from the source blueprint
- paths List<String>
- The path array of relations to filter by
- from
Blueprint String - The blueprint to start the path from. Should be the target blueprint or undefined to start from the source blueprint
Package Details
- Repository
- port port-labs/pulumi-port
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
port-labsTerraform Provider.
