sdwan.CflowdPolicyDefinition
Explore with Pulumi AI
This resource can manage a Cflowd Policy Definition .
Example Usage
Coming soon!
Coming soon!
Coming soon!
Coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sdwan.CflowdPolicyDefinition;
import com.pulumi.sdwan.CflowdPolicyDefinitionArgs;
import com.pulumi.sdwan.inputs.CflowdPolicyDefinitionCollectorArgs;
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 example = new CflowdPolicyDefinition("example", CflowdPolicyDefinitionArgs.builder()
            .name("Example")
            .description("My description")
            .activeFlowTimeout(100)
            .inactiveFlowTimeout(10)
            .samplingInterval(10)
            .flowRefresh(120)
            .protocol("ipv4")
            .tos(true)
            .remarkedDscp(true)
            .collectors(CflowdPolicyDefinitionCollectorArgs.builder()
                .vpn_id(1)
                .ip_address("10.0.0.1")
                .port(12345)
                .transport("transport_tcp")
                .source_interface("Ethernet1")
                .export_spreading("enable")
                .bfd_metrics_exporting(true)
                .exporting_interval(86400)
                .build())
            .build());
    }
}
resources:
  example:
    type: sdwan:CflowdPolicyDefinition
    properties:
      name: Example
      description: My description
      activeFlowTimeout: 100
      inactiveFlowTimeout: 10
      samplingInterval: 10
      flowRefresh: 120
      protocol: ipv4
      tos: true
      remarkedDscp: true
      collectors:
        - vpn_id: 1
          ip_address: 10.0.0.1
          port: 12345
          transport: transport_tcp
          source_interface: Ethernet1
          export_spreading: enable
          bfd_metrics_exporting: true
          exporting_interval: 86400
Create CflowdPolicyDefinition Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new CflowdPolicyDefinition(name: string, args: CflowdPolicyDefinitionArgs, opts?: CustomResourceOptions);@overload
def CflowdPolicyDefinition(resource_name: str,
                           args: CflowdPolicyDefinitionArgs,
                           opts: Optional[ResourceOptions] = None)
@overload
def CflowdPolicyDefinition(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           collectors: Optional[Sequence[CflowdPolicyDefinitionCollectorArgs]] = None,
                           description: Optional[str] = None,
                           active_flow_timeout: Optional[int] = None,
                           flow_refresh: Optional[int] = None,
                           inactive_flow_timeout: Optional[int] = None,
                           name: Optional[str] = None,
                           protocol: Optional[str] = None,
                           remarked_dscp: Optional[bool] = None,
                           sampling_interval: Optional[int] = None,
                           tos: Optional[bool] = None)func NewCflowdPolicyDefinition(ctx *Context, name string, args CflowdPolicyDefinitionArgs, opts ...ResourceOption) (*CflowdPolicyDefinition, error)public CflowdPolicyDefinition(string name, CflowdPolicyDefinitionArgs args, CustomResourceOptions? opts = null)
public CflowdPolicyDefinition(String name, CflowdPolicyDefinitionArgs args)
public CflowdPolicyDefinition(String name, CflowdPolicyDefinitionArgs args, CustomResourceOptions options)
type: sdwan:CflowdPolicyDefinition
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 CflowdPolicyDefinitionArgs
- 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 CflowdPolicyDefinitionArgs
- 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 CflowdPolicyDefinitionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CflowdPolicyDefinitionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CflowdPolicyDefinitionArgs
- 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 cflowdPolicyDefinitionResource = new Sdwan.CflowdPolicyDefinition("cflowdPolicyDefinitionResource", new()
{
    Collectors = new[]
    {
        new Sdwan.Inputs.CflowdPolicyDefinitionCollectorArgs
        {
            BfdMetricsExporting = false,
            ExportSpreading = "string",
            ExportingInterval = 0,
            IpAddress = "string",
            Port = 0,
            SourceInterface = "string",
            Transport = "string",
            VpnId = 0,
        },
    },
    Description = "string",
    ActiveFlowTimeout = 0,
    FlowRefresh = 0,
    InactiveFlowTimeout = 0,
    Name = "string",
    Protocol = "string",
    RemarkedDscp = false,
    SamplingInterval = 0,
    Tos = false,
});
example, err := sdwan.NewCflowdPolicyDefinition(ctx, "cflowdPolicyDefinitionResource", &sdwan.CflowdPolicyDefinitionArgs{
	Collectors: sdwan.CflowdPolicyDefinitionCollectorArray{
		&sdwan.CflowdPolicyDefinitionCollectorArgs{
			BfdMetricsExporting: pulumi.Bool(false),
			ExportSpreading:     pulumi.String("string"),
			ExportingInterval:   pulumi.Int(0),
			IpAddress:           pulumi.String("string"),
			Port:                pulumi.Int(0),
			SourceInterface:     pulumi.String("string"),
			Transport:           pulumi.String("string"),
			VpnId:               pulumi.Int(0),
		},
	},
	Description:         pulumi.String("string"),
	ActiveFlowTimeout:   pulumi.Int(0),
	FlowRefresh:         pulumi.Int(0),
	InactiveFlowTimeout: pulumi.Int(0),
	Name:                pulumi.String("string"),
	Protocol:            pulumi.String("string"),
	RemarkedDscp:        pulumi.Bool(false),
	SamplingInterval:    pulumi.Int(0),
	Tos:                 pulumi.Bool(false),
})
var cflowdPolicyDefinitionResource = new CflowdPolicyDefinition("cflowdPolicyDefinitionResource", CflowdPolicyDefinitionArgs.builder()
    .collectors(CflowdPolicyDefinitionCollectorArgs.builder()
        .bfdMetricsExporting(false)
        .exportSpreading("string")
        .exportingInterval(0)
        .ipAddress("string")
        .port(0)
        .sourceInterface("string")
        .transport("string")
        .vpnId(0)
        .build())
    .description("string")
    .activeFlowTimeout(0)
    .flowRefresh(0)
    .inactiveFlowTimeout(0)
    .name("string")
    .protocol("string")
    .remarkedDscp(false)
    .samplingInterval(0)
    .tos(false)
    .build());
cflowd_policy_definition_resource = sdwan.CflowdPolicyDefinition("cflowdPolicyDefinitionResource",
    collectors=[{
        "bfd_metrics_exporting": False,
        "export_spreading": "string",
        "exporting_interval": 0,
        "ip_address": "string",
        "port": 0,
        "source_interface": "string",
        "transport": "string",
        "vpn_id": 0,
    }],
    description="string",
    active_flow_timeout=0,
    flow_refresh=0,
    inactive_flow_timeout=0,
    name="string",
    protocol="string",
    remarked_dscp=False,
    sampling_interval=0,
    tos=False)
const cflowdPolicyDefinitionResource = new sdwan.CflowdPolicyDefinition("cflowdPolicyDefinitionResource", {
    collectors: [{
        bfdMetricsExporting: false,
        exportSpreading: "string",
        exportingInterval: 0,
        ipAddress: "string",
        port: 0,
        sourceInterface: "string",
        transport: "string",
        vpnId: 0,
    }],
    description: "string",
    activeFlowTimeout: 0,
    flowRefresh: 0,
    inactiveFlowTimeout: 0,
    name: "string",
    protocol: "string",
    remarkedDscp: false,
    samplingInterval: 0,
    tos: false,
});
type: sdwan:CflowdPolicyDefinition
properties:
    activeFlowTimeout: 0
    collectors:
        - bfdMetricsExporting: false
          exportSpreading: string
          exportingInterval: 0
          ipAddress: string
          port: 0
          sourceInterface: string
          transport: string
          vpnId: 0
    description: string
    flowRefresh: 0
    inactiveFlowTimeout: 0
    name: string
    protocol: string
    remarkedDscp: false
    samplingInterval: 0
    tos: false
CflowdPolicyDefinition 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 CflowdPolicyDefinition resource accepts the following input properties:
- Collectors
List<CflowdPolicy Definition Collector> 
- List of collectors
- Description string
- The description of the policy definition
- ActiveFlow intTimeout 
- Active flow timeout in seconds - Range: 30-3600
- FlowRefresh int
- Flow refresh in seconds - Range: 60-86400
- InactiveFlow intTimeout 
- Inactive flow timeout in seconds - Range: 1-3600
- Name string
- The name of the policy definition
- Protocol string
- Protocol, either ipv4,ipv6orall- Choices:ipv4,ipv6,all
- RemarkedDscp bool
- Collect remarked DSCP
- SamplingInterval int
- Flow sampling interval - Range: 1-65536
- Tos bool
- Collect TOS record field
- Collectors
[]CflowdPolicy Definition Collector Args 
- List of collectors
- Description string
- The description of the policy definition
- ActiveFlow intTimeout 
- Active flow timeout in seconds - Range: 30-3600
- FlowRefresh int
- Flow refresh in seconds - Range: 60-86400
- InactiveFlow intTimeout 
- Inactive flow timeout in seconds - Range: 1-3600
- Name string
- The name of the policy definition
- Protocol string
- Protocol, either ipv4,ipv6orall- Choices:ipv4,ipv6,all
- RemarkedDscp bool
- Collect remarked DSCP
- SamplingInterval int
- Flow sampling interval - Range: 1-65536
- Tos bool
- Collect TOS record field
- collectors
List<CflowdPolicy Definition Collector> 
- List of collectors
- description String
- The description of the policy definition
- activeFlow IntegerTimeout 
- Active flow timeout in seconds - Range: 30-3600
- flowRefresh Integer
- Flow refresh in seconds - Range: 60-86400
- inactiveFlow IntegerTimeout 
- Inactive flow timeout in seconds - Range: 1-3600
- name String
- The name of the policy definition
- protocol String
- Protocol, either ipv4,ipv6orall- Choices:ipv4,ipv6,all
- remarkedDscp Boolean
- Collect remarked DSCP
- samplingInterval Integer
- Flow sampling interval - Range: 1-65536
- tos Boolean
- Collect TOS record field
- collectors
CflowdPolicy Definition Collector[] 
- List of collectors
- description string
- The description of the policy definition
- activeFlow numberTimeout 
- Active flow timeout in seconds - Range: 30-3600
- flowRefresh number
- Flow refresh in seconds - Range: 60-86400
- inactiveFlow numberTimeout 
- Inactive flow timeout in seconds - Range: 1-3600
- name string
- The name of the policy definition
- protocol string
- Protocol, either ipv4,ipv6orall- Choices:ipv4,ipv6,all
- remarkedDscp boolean
- Collect remarked DSCP
- samplingInterval number
- Flow sampling interval - Range: 1-65536
- tos boolean
- Collect TOS record field
- collectors
Sequence[CflowdPolicy Definition Collector Args] 
- List of collectors
- description str
- The description of the policy definition
- active_flow_ inttimeout 
- Active flow timeout in seconds - Range: 30-3600
- flow_refresh int
- Flow refresh in seconds - Range: 60-86400
- inactive_flow_ inttimeout 
- Inactive flow timeout in seconds - Range: 1-3600
- name str
- The name of the policy definition
- protocol str
- Protocol, either ipv4,ipv6orall- Choices:ipv4,ipv6,all
- remarked_dscp bool
- Collect remarked DSCP
- sampling_interval int
- Flow sampling interval - Range: 1-65536
- tos bool
- Collect TOS record field
- collectors List<Property Map>
- List of collectors
- description String
- The description of the policy definition
- activeFlow NumberTimeout 
- Active flow timeout in seconds - Range: 30-3600
- flowRefresh Number
- Flow refresh in seconds - Range: 60-86400
- inactiveFlow NumberTimeout 
- Inactive flow timeout in seconds - Range: 1-3600
- name String
- The name of the policy definition
- protocol String
- Protocol, either ipv4,ipv6orall- Choices:ipv4,ipv6,all
- remarkedDscp Boolean
- Collect remarked DSCP
- samplingInterval Number
- Flow sampling interval - Range: 1-65536
- tos Boolean
- Collect TOS record field
Outputs
All input properties are implicitly available as output properties. Additionally, the CflowdPolicyDefinition resource produces the following output properties:
Look up Existing CflowdPolicyDefinition Resource
Get an existing CflowdPolicyDefinition 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?: CflowdPolicyDefinitionState, opts?: CustomResourceOptions): CflowdPolicyDefinition@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active_flow_timeout: Optional[int] = None,
        collectors: Optional[Sequence[CflowdPolicyDefinitionCollectorArgs]] = None,
        description: Optional[str] = None,
        flow_refresh: Optional[int] = None,
        inactive_flow_timeout: Optional[int] = None,
        name: Optional[str] = None,
        protocol: Optional[str] = None,
        remarked_dscp: Optional[bool] = None,
        sampling_interval: Optional[int] = None,
        tos: Optional[bool] = None,
        type: Optional[str] = None,
        version: Optional[int] = None) -> CflowdPolicyDefinitionfunc GetCflowdPolicyDefinition(ctx *Context, name string, id IDInput, state *CflowdPolicyDefinitionState, opts ...ResourceOption) (*CflowdPolicyDefinition, error)public static CflowdPolicyDefinition Get(string name, Input<string> id, CflowdPolicyDefinitionState? state, CustomResourceOptions? opts = null)public static CflowdPolicyDefinition get(String name, Output<String> id, CflowdPolicyDefinitionState state, CustomResourceOptions options)resources:  _:    type: sdwan:CflowdPolicyDefinition    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.
- ActiveFlow intTimeout 
- Active flow timeout in seconds - Range: 30-3600
- Collectors
List<CflowdPolicy Definition Collector> 
- List of collectors
- Description string
- The description of the policy definition
- FlowRefresh int
- Flow refresh in seconds - Range: 60-86400
- InactiveFlow intTimeout 
- Inactive flow timeout in seconds - Range: 1-3600
- Name string
- The name of the policy definition
- Protocol string
- Protocol, either ipv4,ipv6orall- Choices:ipv4,ipv6,all
- RemarkedDscp bool
- Collect remarked DSCP
- SamplingInterval int
- Flow sampling interval - Range: 1-65536
- Tos bool
- Collect TOS record field
- Type string
- Type
- Version int
- The version of the object
- ActiveFlow intTimeout 
- Active flow timeout in seconds - Range: 30-3600
- Collectors
[]CflowdPolicy Definition Collector Args 
- List of collectors
- Description string
- The description of the policy definition
- FlowRefresh int
- Flow refresh in seconds - Range: 60-86400
- InactiveFlow intTimeout 
- Inactive flow timeout in seconds - Range: 1-3600
- Name string
- The name of the policy definition
- Protocol string
- Protocol, either ipv4,ipv6orall- Choices:ipv4,ipv6,all
- RemarkedDscp bool
- Collect remarked DSCP
- SamplingInterval int
- Flow sampling interval - Range: 1-65536
- Tos bool
- Collect TOS record field
- Type string
- Type
- Version int
- The version of the object
- activeFlow IntegerTimeout 
- Active flow timeout in seconds - Range: 30-3600
- collectors
List<CflowdPolicy Definition Collector> 
- List of collectors
- description String
- The description of the policy definition
- flowRefresh Integer
- Flow refresh in seconds - Range: 60-86400
- inactiveFlow IntegerTimeout 
- Inactive flow timeout in seconds - Range: 1-3600
- name String
- The name of the policy definition
- protocol String
- Protocol, either ipv4,ipv6orall- Choices:ipv4,ipv6,all
- remarkedDscp Boolean
- Collect remarked DSCP
- samplingInterval Integer
- Flow sampling interval - Range: 1-65536
- tos Boolean
- Collect TOS record field
- type String
- Type
- version Integer
- The version of the object
- activeFlow numberTimeout 
- Active flow timeout in seconds - Range: 30-3600
- collectors
CflowdPolicy Definition Collector[] 
- List of collectors
- description string
- The description of the policy definition
- flowRefresh number
- Flow refresh in seconds - Range: 60-86400
- inactiveFlow numberTimeout 
- Inactive flow timeout in seconds - Range: 1-3600
- name string
- The name of the policy definition
- protocol string
- Protocol, either ipv4,ipv6orall- Choices:ipv4,ipv6,all
- remarkedDscp boolean
- Collect remarked DSCP
- samplingInterval number
- Flow sampling interval - Range: 1-65536
- tos boolean
- Collect TOS record field
- type string
- Type
- version number
- The version of the object
- active_flow_ inttimeout 
- Active flow timeout in seconds - Range: 30-3600
- collectors
Sequence[CflowdPolicy Definition Collector Args] 
- List of collectors
- description str
- The description of the policy definition
- flow_refresh int
- Flow refresh in seconds - Range: 60-86400
- inactive_flow_ inttimeout 
- Inactive flow timeout in seconds - Range: 1-3600
- name str
- The name of the policy definition
- protocol str
- Protocol, either ipv4,ipv6orall- Choices:ipv4,ipv6,all
- remarked_dscp bool
- Collect remarked DSCP
- sampling_interval int
- Flow sampling interval - Range: 1-65536
- tos bool
- Collect TOS record field
- type str
- Type
- version int
- The version of the object
- activeFlow NumberTimeout 
- Active flow timeout in seconds - Range: 30-3600
- collectors List<Property Map>
- List of collectors
- description String
- The description of the policy definition
- flowRefresh Number
- Flow refresh in seconds - Range: 60-86400
- inactiveFlow NumberTimeout 
- Inactive flow timeout in seconds - Range: 1-3600
- name String
- The name of the policy definition
- protocol String
- Protocol, either ipv4,ipv6orall- Choices:ipv4,ipv6,all
- remarkedDscp Boolean
- Collect remarked DSCP
- samplingInterval Number
- Flow sampling interval - Range: 1-65536
- tos Boolean
- Collect TOS record field
- type String
- Type
- version Number
- The version of the object
Supporting Types
CflowdPolicyDefinitionCollector, CflowdPolicyDefinitionCollectorArgs        
- BfdMetrics boolExporting 
- BFD metrics exporting
- ExportSpreading string
- Export spreading- Choices: enable,disable
 
- Choices: 
- ExportingInterval int
- Exporting interval
- IpAddress string
- IP address
- Port int
- Port- Range: 1024-65535
 
- Range: 
- SourceInterface string
- Source interface
- Transport string
- Transport protocol- Choices: transport_tcp,transport_udp
 
- Choices: 
- VpnId int
- VPN ID- Range: 1-65535
 
- Range: 
- BfdMetrics boolExporting 
- BFD metrics exporting
- ExportSpreading string
- Export spreading- Choices: enable,disable
 
- Choices: 
- ExportingInterval int
- Exporting interval
- IpAddress string
- IP address
- Port int
- Port- Range: 1024-65535
 
- Range: 
- SourceInterface string
- Source interface
- Transport string
- Transport protocol- Choices: transport_tcp,transport_udp
 
- Choices: 
- VpnId int
- VPN ID- Range: 1-65535
 
- Range: 
- bfdMetrics BooleanExporting 
- BFD metrics exporting
- exportSpreading String
- Export spreading- Choices: enable,disable
 
- Choices: 
- exportingInterval Integer
- Exporting interval
- ipAddress String
- IP address
- port Integer
- Port- Range: 1024-65535
 
- Range: 
- sourceInterface String
- Source interface
- transport String
- Transport protocol- Choices: transport_tcp,transport_udp
 
- Choices: 
- vpnId Integer
- VPN ID- Range: 1-65535
 
- Range: 
- bfdMetrics booleanExporting 
- BFD metrics exporting
- exportSpreading string
- Export spreading- Choices: enable,disable
 
- Choices: 
- exportingInterval number
- Exporting interval
- ipAddress string
- IP address
- port number
- Port- Range: 1024-65535
 
- Range: 
- sourceInterface string
- Source interface
- transport string
- Transport protocol- Choices: transport_tcp,transport_udp
 
- Choices: 
- vpnId number
- VPN ID- Range: 1-65535
 
- Range: 
- bfd_metrics_ boolexporting 
- BFD metrics exporting
- export_spreading str
- Export spreading- Choices: enable,disable
 
- Choices: 
- exporting_interval int
- Exporting interval
- ip_address str
- IP address
- port int
- Port- Range: 1024-65535
 
- Range: 
- source_interface str
- Source interface
- transport str
- Transport protocol- Choices: transport_tcp,transport_udp
 
- Choices: 
- vpn_id int
- VPN ID- Range: 1-65535
 
- Range: 
- bfdMetrics BooleanExporting 
- BFD metrics exporting
- exportSpreading String
- Export spreading- Choices: enable,disable
 
- Choices: 
- exportingInterval Number
- Exporting interval
- ipAddress String
- IP address
- port Number
- Port- Range: 1024-65535
 
- Range: 
- sourceInterface String
- Source interface
- transport String
- Transport protocol- Choices: transport_tcp,transport_udp
 
- Choices: 
- vpnId Number
- VPN ID- Range: 1-65535
 
- Range: 
Import
$ pulumi import sdwan:index/cflowdPolicyDefinition:CflowdPolicyDefinition example "f6b2c44c-693c-4763-b010-895aa3d236bd"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- sdwan pulumi/pulumi-sdwan
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the sdwanTerraform Provider.
