Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as routeros from "@pulumi/routeros";
const test = new routeros.IpTrafficFlow("test", {
packetSampling: true,
samplingInterval: 2222,
samplingSpace: 1111,
});
import pulumi
import pulumi_routeros as routeros
test = routeros.IpTrafficFlow("test",
packet_sampling=True,
sampling_interval=2222,
sampling_space=1111)
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/routeros/routeros"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := routeros.NewIpTrafficFlow(ctx, "test", &routeros.IpTrafficFlowArgs{
PacketSampling: pulumi.Bool(true),
SamplingInterval: pulumi.Float64(2222),
SamplingSpace: pulumi.Float64(1111),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Routeros = Pulumi.Routeros;
return await Deployment.RunAsync(() =>
{
var test = new Routeros.IpTrafficFlow("test", new()
{
PacketSampling = true,
SamplingInterval = 2222,
SamplingSpace = 1111,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.routeros.IpTrafficFlow;
import com.pulumi.routeros.IpTrafficFlowArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var test = new IpTrafficFlow("test", IpTrafficFlowArgs.builder()
.packetSampling(true)
.samplingInterval(2222.0)
.samplingSpace(1111.0)
.build());
}
}
resources:
test:
type: routeros:IpTrafficFlow
properties:
packetSampling: true
samplingInterval: 2222
samplingSpace: 1111
Create IpTrafficFlow Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new IpTrafficFlow(name: string, args?: IpTrafficFlowArgs, opts?: CustomResourceOptions);@overload
def IpTrafficFlow(resource_name: str,
args: Optional[IpTrafficFlowArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def IpTrafficFlow(resource_name: str,
opts: Optional[ResourceOptions] = None,
___id_: Optional[float] = None,
___path_: Optional[str] = None,
active_flow_timeout: Optional[str] = None,
cache_entries: Optional[str] = None,
inactive_flow_timeout: Optional[str] = None,
interfaces: Optional[str] = None,
ip_traffic_flow_id: Optional[str] = None,
packet_sampling: Optional[bool] = None,
sampling_interval: Optional[float] = None,
sampling_space: Optional[float] = None)func NewIpTrafficFlow(ctx *Context, name string, args *IpTrafficFlowArgs, opts ...ResourceOption) (*IpTrafficFlow, error)public IpTrafficFlow(string name, IpTrafficFlowArgs? args = null, CustomResourceOptions? opts = null)
public IpTrafficFlow(String name, IpTrafficFlowArgs args)
public IpTrafficFlow(String name, IpTrafficFlowArgs args, CustomResourceOptions options)
type: routeros:IpTrafficFlow
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 IpTrafficFlowArgs
- 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 IpTrafficFlowArgs
- 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 IpTrafficFlowArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args IpTrafficFlowArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args IpTrafficFlowArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
IpTrafficFlow 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 IpTrafficFlow resource accepts the following input properties:
- Active
Flow stringTimeout - Maximum life-time of a flow.
- Cache
Entries string - Number of flows which can be in router's memory simultaneously.
- Inactive
Flow stringTimeout - How long to keep the flow active, if it is idle. If a connection does not see any packet within this timeout, then traffic-flow will send a packet out as a new flow. If this timeout is too small it can create a significant amount of flows and overflow the buffer.
- Interfaces string
- Names of those interfaces will be used to gather statistics for traffic-flow. To specify more than one interface, separate them with a comma.
- Ip
Traffic stringFlow Id - The ID of this resource.
- Packet
Sampling bool - Enable or disable packet sampling feature.
- Sampling
Interval double - The number of packets that are consecutively sampled.
- Sampling
Space double - The number of packets that are consecutively omitted.
- ___
id_ double - Resource ID type (.id / name). This is an internal service field, setting a value is not required.
- ___
path_ string - Resource path for CRUD operations. This is an internal service field, setting a value is not required.
- Active
Flow stringTimeout - Maximum life-time of a flow.
- Cache
Entries string - Number of flows which can be in router's memory simultaneously.
- Inactive
Flow stringTimeout - How long to keep the flow active, if it is idle. If a connection does not see any packet within this timeout, then traffic-flow will send a packet out as a new flow. If this timeout is too small it can create a significant amount of flows and overflow the buffer.
- Interfaces string
- Names of those interfaces will be used to gather statistics for traffic-flow. To specify more than one interface, separate them with a comma.
- Ip
Traffic stringFlow Id - The ID of this resource.
- Packet
Sampling bool - Enable or disable packet sampling feature.
- Sampling
Interval float64 - The number of packets that are consecutively sampled.
- Sampling
Space float64 - The number of packets that are consecutively omitted.
- ___
id_ float64 - Resource ID type (.id / name). This is an internal service field, setting a value is not required.
- ___
path_ string - Resource path for CRUD operations. This is an internal service field, setting a value is not required.
- ___
id_ Double - Resource ID type (.id / name). This is an internal service field, setting a value is not required.
- ___
path_ String - Resource path for CRUD operations. This is an internal service field, setting a value is not required.
- active
Flow StringTimeout - Maximum life-time of a flow.
- cache
Entries String - Number of flows which can be in router's memory simultaneously.
- inactive
Flow StringTimeout - How long to keep the flow active, if it is idle. If a connection does not see any packet within this timeout, then traffic-flow will send a packet out as a new flow. If this timeout is too small it can create a significant amount of flows and overflow the buffer.
- interfaces String
- Names of those interfaces will be used to gather statistics for traffic-flow. To specify more than one interface, separate them with a comma.
- ip
Traffic StringFlow Id - The ID of this resource.
- packet
Sampling Boolean - Enable or disable packet sampling feature.
- sampling
Interval Double - The number of packets that are consecutively sampled.
- sampling
Space Double - The number of packets that are consecutively omitted.
- ___
id_ number - Resource ID type (.id / name). This is an internal service field, setting a value is not required.
- ___
path_ string - Resource path for CRUD operations. This is an internal service field, setting a value is not required.
- active
Flow stringTimeout - Maximum life-time of a flow.
- cache
Entries string - Number of flows which can be in router's memory simultaneously.
- inactive
Flow stringTimeout - How long to keep the flow active, if it is idle. If a connection does not see any packet within this timeout, then traffic-flow will send a packet out as a new flow. If this timeout is too small it can create a significant amount of flows and overflow the buffer.
- interfaces string
- Names of those interfaces will be used to gather statistics for traffic-flow. To specify more than one interface, separate them with a comma.
- ip
Traffic stringFlow Id - The ID of this resource.
- packet
Sampling boolean - Enable or disable packet sampling feature.
- sampling
Interval number - The number of packets that are consecutively sampled.
- sampling
Space number - The number of packets that are consecutively omitted.
- ___
id_ float - Resource ID type (.id / name). This is an internal service field, setting a value is not required.
- ___
path_ str - Resource path for CRUD operations. This is an internal service field, setting a value is not required.
- active_
flow_ strtimeout - Maximum life-time of a flow.
- cache_
entries str - Number of flows which can be in router's memory simultaneously.
- inactive_
flow_ strtimeout - How long to keep the flow active, if it is idle. If a connection does not see any packet within this timeout, then traffic-flow will send a packet out as a new flow. If this timeout is too small it can create a significant amount of flows and overflow the buffer.
- interfaces str
- Names of those interfaces will be used to gather statistics for traffic-flow. To specify more than one interface, separate them with a comma.
- ip_
traffic_ strflow_ id - The ID of this resource.
- packet_
sampling bool - Enable or disable packet sampling feature.
- sampling_
interval float - The number of packets that are consecutively sampled.
- sampling_
space float - The number of packets that are consecutively omitted.
- ___
id_ Number - Resource ID type (.id / name). This is an internal service field, setting a value is not required.
- ___
path_ String - Resource path for CRUD operations. This is an internal service field, setting a value is not required.
- active
Flow StringTimeout - Maximum life-time of a flow.
- cache
Entries String - Number of flows which can be in router's memory simultaneously.
- inactive
Flow StringTimeout - How long to keep the flow active, if it is idle. If a connection does not see any packet within this timeout, then traffic-flow will send a packet out as a new flow. If this timeout is too small it can create a significant amount of flows and overflow the buffer.
- interfaces String
- Names of those interfaces will be used to gather statistics for traffic-flow. To specify more than one interface, separate them with a comma.
- ip
Traffic StringFlow Id - The ID of this resource.
- packet
Sampling Boolean - Enable or disable packet sampling feature.
- sampling
Interval Number - The number of packets that are consecutively sampled.
- sampling
Space Number - The number of packets that are consecutively omitted.
Outputs
All input properties are implicitly available as output properties. Additionally, the IpTrafficFlow 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 IpTrafficFlow Resource
Get an existing IpTrafficFlow 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?: IpTrafficFlowState, opts?: CustomResourceOptions): IpTrafficFlow@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
___id_: Optional[float] = None,
___path_: Optional[str] = None,
active_flow_timeout: Optional[str] = None,
cache_entries: Optional[str] = None,
inactive_flow_timeout: Optional[str] = None,
interfaces: Optional[str] = None,
ip_traffic_flow_id: Optional[str] = None,
packet_sampling: Optional[bool] = None,
sampling_interval: Optional[float] = None,
sampling_space: Optional[float] = None) -> IpTrafficFlowfunc GetIpTrafficFlow(ctx *Context, name string, id IDInput, state *IpTrafficFlowState, opts ...ResourceOption) (*IpTrafficFlow, error)public static IpTrafficFlow Get(string name, Input<string> id, IpTrafficFlowState? state, CustomResourceOptions? opts = null)public static IpTrafficFlow get(String name, Output<String> id, IpTrafficFlowState state, CustomResourceOptions options)resources: _: type: routeros:IpTrafficFlow 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.
- Active
Flow stringTimeout - Maximum life-time of a flow.
- Cache
Entries string - Number of flows which can be in router's memory simultaneously.
- Inactive
Flow stringTimeout - How long to keep the flow active, if it is idle. If a connection does not see any packet within this timeout, then traffic-flow will send a packet out as a new flow. If this timeout is too small it can create a significant amount of flows and overflow the buffer.
- Interfaces string
- Names of those interfaces will be used to gather statistics for traffic-flow. To specify more than one interface, separate them with a comma.
- Ip
Traffic stringFlow Id - The ID of this resource.
- Packet
Sampling bool - Enable or disable packet sampling feature.
- Sampling
Interval double - The number of packets that are consecutively sampled.
- Sampling
Space double - The number of packets that are consecutively omitted.
- ___
id_ double - Resource ID type (.id / name). This is an internal service field, setting a value is not required.
- ___
path_ string - Resource path for CRUD operations. This is an internal service field, setting a value is not required.
- Active
Flow stringTimeout - Maximum life-time of a flow.
- Cache
Entries string - Number of flows which can be in router's memory simultaneously.
- Inactive
Flow stringTimeout - How long to keep the flow active, if it is idle. If a connection does not see any packet within this timeout, then traffic-flow will send a packet out as a new flow. If this timeout is too small it can create a significant amount of flows and overflow the buffer.
- Interfaces string
- Names of those interfaces will be used to gather statistics for traffic-flow. To specify more than one interface, separate them with a comma.
- Ip
Traffic stringFlow Id - The ID of this resource.
- Packet
Sampling bool - Enable or disable packet sampling feature.
- Sampling
Interval float64 - The number of packets that are consecutively sampled.
- Sampling
Space float64 - The number of packets that are consecutively omitted.
- ___
id_ float64 - Resource ID type (.id / name). This is an internal service field, setting a value is not required.
- ___
path_ string - Resource path for CRUD operations. This is an internal service field, setting a value is not required.
- ___
id_ Double - Resource ID type (.id / name). This is an internal service field, setting a value is not required.
- ___
path_ String - Resource path for CRUD operations. This is an internal service field, setting a value is not required.
- active
Flow StringTimeout - Maximum life-time of a flow.
- cache
Entries String - Number of flows which can be in router's memory simultaneously.
- inactive
Flow StringTimeout - How long to keep the flow active, if it is idle. If a connection does not see any packet within this timeout, then traffic-flow will send a packet out as a new flow. If this timeout is too small it can create a significant amount of flows and overflow the buffer.
- interfaces String
- Names of those interfaces will be used to gather statistics for traffic-flow. To specify more than one interface, separate them with a comma.
- ip
Traffic StringFlow Id - The ID of this resource.
- packet
Sampling Boolean - Enable or disable packet sampling feature.
- sampling
Interval Double - The number of packets that are consecutively sampled.
- sampling
Space Double - The number of packets that are consecutively omitted.
- ___
id_ number - Resource ID type (.id / name). This is an internal service field, setting a value is not required.
- ___
path_ string - Resource path for CRUD operations. This is an internal service field, setting a value is not required.
- active
Flow stringTimeout - Maximum life-time of a flow.
- cache
Entries string - Number of flows which can be in router's memory simultaneously.
- inactive
Flow stringTimeout - How long to keep the flow active, if it is idle. If a connection does not see any packet within this timeout, then traffic-flow will send a packet out as a new flow. If this timeout is too small it can create a significant amount of flows and overflow the buffer.
- interfaces string
- Names of those interfaces will be used to gather statistics for traffic-flow. To specify more than one interface, separate them with a comma.
- ip
Traffic stringFlow Id - The ID of this resource.
- packet
Sampling boolean - Enable or disable packet sampling feature.
- sampling
Interval number - The number of packets that are consecutively sampled.
- sampling
Space number - The number of packets that are consecutively omitted.
- ___
id_ float - Resource ID type (.id / name). This is an internal service field, setting a value is not required.
- ___
path_ str - Resource path for CRUD operations. This is an internal service field, setting a value is not required.
- active_
flow_ strtimeout - Maximum life-time of a flow.
- cache_
entries str - Number of flows which can be in router's memory simultaneously.
- inactive_
flow_ strtimeout - How long to keep the flow active, if it is idle. If a connection does not see any packet within this timeout, then traffic-flow will send a packet out as a new flow. If this timeout is too small it can create a significant amount of flows and overflow the buffer.
- interfaces str
- Names of those interfaces will be used to gather statistics for traffic-flow. To specify more than one interface, separate them with a comma.
- ip_
traffic_ strflow_ id - The ID of this resource.
- packet_
sampling bool - Enable or disable packet sampling feature.
- sampling_
interval float - The number of packets that are consecutively sampled.
- sampling_
space float - The number of packets that are consecutively omitted.
- ___
id_ Number - Resource ID type (.id / name). This is an internal service field, setting a value is not required.
- ___
path_ String - Resource path for CRUD operations. This is an internal service field, setting a value is not required.
- active
Flow StringTimeout - Maximum life-time of a flow.
- cache
Entries String - Number of flows which can be in router's memory simultaneously.
- inactive
Flow StringTimeout - How long to keep the flow active, if it is idle. If a connection does not see any packet within this timeout, then traffic-flow will send a packet out as a new flow. If this timeout is too small it can create a significant amount of flows and overflow the buffer.
- interfaces String
- Names of those interfaces will be used to gather statistics for traffic-flow. To specify more than one interface, separate them with a comma.
- ip
Traffic StringFlow Id - The ID of this resource.
- packet
Sampling Boolean - Enable or disable packet sampling feature.
- sampling
Interval Number - The number of packets that are consecutively sampled.
- sampling
Space Number - The number of packets that are consecutively omitted.
Import
$ pulumi import routeros:index/ipTrafficFlow:IpTrafficFlow test .
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- routeros terraform-routeros/terraform-provider-routeros
- License
- Notes
- This Pulumi package is based on the
routerosTerraform Provider.
