Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cisco Catalyst SD-WAN Provider
  3. API Docs
  4. getRuleSetPolicyDefinition
Cisco Catalyst SD-WAN v0.3.0 published on Friday, Mar 28, 2025 by Pulumi
pulumi/pulumi-sdwan

sdwan.getRuleSetPolicyDefinition

Explore with Pulumi AI

Cisco Catalyst SD-WAN v0.3.0 published on Friday, Mar 28, 2025 by Pulumi
pulumi/pulumi-sdwan

This data source can read the Rule Set Policy Definition .

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as sdwan from "@pulumi/sdwan";

const example = sdwan.getRuleSetPolicyDefinition({
    id: "f6b2c44c-693c-4763-b010-895aa3d236bd",
});
Copy
import pulumi
import pulumi_sdwan as sdwan

example = sdwan.get_rule_set_policy_definition(id="f6b2c44c-693c-4763-b010-895aa3d236bd")
Copy
package main

import (
	"github.com/pulumi/pulumi-sdwan/sdk/go/sdwan"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sdwan.LookupRuleSetPolicyDefinition(ctx, &sdwan.LookupRuleSetPolicyDefinitionArgs{
			Id: "f6b2c44c-693c-4763-b010-895aa3d236bd",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Sdwan = Pulumi.Sdwan;

return await Deployment.RunAsync(() => 
{
    var example = Sdwan.GetRuleSetPolicyDefinition.Invoke(new()
    {
        Id = "f6b2c44c-693c-4763-b010-895aa3d236bd",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sdwan.SdwanFunctions;
import com.pulumi.sdwan.inputs.GetRuleSetPolicyDefinitionArgs;
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) {
        final var example = SdwanFunctions.getRuleSetPolicyDefinition(GetRuleSetPolicyDefinitionArgs.builder()
            .id("f6b2c44c-693c-4763-b010-895aa3d236bd")
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: sdwan:getRuleSetPolicyDefinition
      arguments:
        id: f6b2c44c-693c-4763-b010-895aa3d236bd
Copy

Using getRuleSetPolicyDefinition

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getRuleSetPolicyDefinition(args: GetRuleSetPolicyDefinitionArgs, opts?: InvokeOptions): Promise<GetRuleSetPolicyDefinitionResult>
function getRuleSetPolicyDefinitionOutput(args: GetRuleSetPolicyDefinitionOutputArgs, opts?: InvokeOptions): Output<GetRuleSetPolicyDefinitionResult>
Copy
def get_rule_set_policy_definition(id: Optional[str] = None,
                                   opts: Optional[InvokeOptions] = None) -> GetRuleSetPolicyDefinitionResult
def get_rule_set_policy_definition_output(id: Optional[pulumi.Input[str]] = None,
                                   opts: Optional[InvokeOptions] = None) -> Output[GetRuleSetPolicyDefinitionResult]
Copy
func LookupRuleSetPolicyDefinition(ctx *Context, args *LookupRuleSetPolicyDefinitionArgs, opts ...InvokeOption) (*LookupRuleSetPolicyDefinitionResult, error)
func LookupRuleSetPolicyDefinitionOutput(ctx *Context, args *LookupRuleSetPolicyDefinitionOutputArgs, opts ...InvokeOption) LookupRuleSetPolicyDefinitionResultOutput
Copy

> Note: This function is named LookupRuleSetPolicyDefinition in the Go SDK.

public static class GetRuleSetPolicyDefinition 
{
    public static Task<GetRuleSetPolicyDefinitionResult> InvokeAsync(GetRuleSetPolicyDefinitionArgs args, InvokeOptions? opts = null)
    public static Output<GetRuleSetPolicyDefinitionResult> Invoke(GetRuleSetPolicyDefinitionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetRuleSetPolicyDefinitionResult> getRuleSetPolicyDefinition(GetRuleSetPolicyDefinitionArgs args, InvokeOptions options)
public static Output<GetRuleSetPolicyDefinitionResult> getRuleSetPolicyDefinition(GetRuleSetPolicyDefinitionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: sdwan:index/getRuleSetPolicyDefinition:getRuleSetPolicyDefinition
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id This property is required. string
The id of the object
Id This property is required. string
The id of the object
id This property is required. String
The id of the object
id This property is required. string
The id of the object
id This property is required. str
The id of the object
id This property is required. String
The id of the object

getRuleSetPolicyDefinition Result

The following output properties are available:

Description string
The description of the policy definition
Id string
The id of the object
Name string
The name of the policy definition
Rules List<GetRuleSetPolicyDefinitionRule>
List of rules
Version int
The version of the object
Description string
The description of the policy definition
Id string
The id of the object
Name string
The name of the policy definition
Rules []GetRuleSetPolicyDefinitionRule
List of rules
Version int
The version of the object
description String
The description of the policy definition
id String
The id of the object
name String
The name of the policy definition
rules List<GetRuleSetPolicyDefinitionRule>
List of rules
version Integer
The version of the object
description string
The description of the policy definition
id string
The id of the object
name string
The name of the policy definition
rules GetRuleSetPolicyDefinitionRule[]
List of rules
version number
The version of the object
description str
The description of the policy definition
id str
The id of the object
name str
The name of the policy definition
rules Sequence[GetRuleSetPolicyDefinitionRule]
List of rules
version int
The version of the object
description String
The description of the policy definition
id String
The id of the object
name String
The name of the policy definition
rules List<Property Map>
List of rules
version Number
The version of the object

Supporting Types

GetRuleSetPolicyDefinitionRule

DestinationDataFqdnPrefixListId This property is required. string
Destination data FQDN prefix list ID
DestinationDataFqdnPrefixListVersion This property is required. int
Destination data FQDN prefix list version
DestinationDataIpv4PrefixListId This property is required. string
Destination data IPv4 prefix list ID
DestinationDataIpv4PrefixListVersion This property is required. int
Destination data IPv4 prefix list version
DestinationFqdn This property is required. string
Destination fully qualified domain name
DestinationGeoLocation This property is required. string
Destination geo location
DestinationGeoLocationListId This property is required. string
Destination geo location list ID
DestinationGeoLocationListVersion This property is required. int
Destination geo location list version
DestinationIpv4Prefix This property is required. string
Destination IPv4 prefix
DestinationIpv4PrefixVariable This property is required. string
Destination IPv4 prefix variable name
DestinationObjectGroupId This property is required. string
Destination object group ID
DestinationObjectGroupVersion This property is required. int
Destination object group version
DestinationPort This property is required. string
Destination port or range of ports
DestinationPortListId This property is required. string
Destination port list ID
DestinationPortListVersion This property is required. int
Destination port list version
Name This property is required. string
The name of the rule
Order This property is required. int
The order of the rule
Protocol This property is required. string
Protocol name
ProtocolListId This property is required. string
Protocol list ID
ProtocolListVersion This property is required. int
Protocol list version
ProtocolNumber This property is required. int
Protocol number
SourceDataFqdnPrefixListId This property is required. string
Source data FQDN prefix list ID
SourceDataFqdnPrefixListVersion This property is required. int
Source data FQDN prefix list version
SourceDataIpv4PrefixListId This property is required. string
Source data IPv4 prefix list ID
SourceDataIpv4PrefixListVersion This property is required. int
Source data IPv4 prefix list version
SourceFqdn This property is required. string
Source fully qualified domain name
SourceGeoLocation This property is required. string
Source geo location
SourceGeoLocationListId This property is required. string
Source geo location list ID
SourceGeoLocationListVersion This property is required. int
Source geo location list version
SourceIpv4Prefix This property is required. string
Source IPv4 prefix
SourceIpv4PrefixVariable This property is required. string
Source IPv4 prefix variable name
SourceObjectGroupId This property is required. string
Source object group ID
SourceObjectGroupVersion This property is required. int
Source object group version
SourcePort This property is required. string
Source port or range of ports
SourcePortListId This property is required. string
Source port list ID
SourcePortListVersion This property is required. int
Source port list version
DestinationDataFqdnPrefixListId This property is required. string
Destination data FQDN prefix list ID
DestinationDataFqdnPrefixListVersion This property is required. int
Destination data FQDN prefix list version
DestinationDataIpv4PrefixListId This property is required. string
Destination data IPv4 prefix list ID
DestinationDataIpv4PrefixListVersion This property is required. int
Destination data IPv4 prefix list version
DestinationFqdn This property is required. string
Destination fully qualified domain name
DestinationGeoLocation This property is required. string
Destination geo location
DestinationGeoLocationListId This property is required. string
Destination geo location list ID
DestinationGeoLocationListVersion This property is required. int
Destination geo location list version
DestinationIpv4Prefix This property is required. string
Destination IPv4 prefix
DestinationIpv4PrefixVariable This property is required. string
Destination IPv4 prefix variable name
DestinationObjectGroupId This property is required. string
Destination object group ID
DestinationObjectGroupVersion This property is required. int
Destination object group version
DestinationPort This property is required. string
Destination port or range of ports
DestinationPortListId This property is required. string
Destination port list ID
DestinationPortListVersion This property is required. int
Destination port list version
Name This property is required. string
The name of the rule
Order This property is required. int
The order of the rule
Protocol This property is required. string
Protocol name
ProtocolListId This property is required. string
Protocol list ID
ProtocolListVersion This property is required. int
Protocol list version
ProtocolNumber This property is required. int
Protocol number
SourceDataFqdnPrefixListId This property is required. string
Source data FQDN prefix list ID
SourceDataFqdnPrefixListVersion This property is required. int
Source data FQDN prefix list version
SourceDataIpv4PrefixListId This property is required. string
Source data IPv4 prefix list ID
SourceDataIpv4PrefixListVersion This property is required. int
Source data IPv4 prefix list version
SourceFqdn This property is required. string
Source fully qualified domain name
SourceGeoLocation This property is required. string
Source geo location
SourceGeoLocationListId This property is required. string
Source geo location list ID
SourceGeoLocationListVersion This property is required. int
Source geo location list version
SourceIpv4Prefix This property is required. string
Source IPv4 prefix
SourceIpv4PrefixVariable This property is required. string
Source IPv4 prefix variable name
SourceObjectGroupId This property is required. string
Source object group ID
SourceObjectGroupVersion This property is required. int
Source object group version
SourcePort This property is required. string
Source port or range of ports
SourcePortListId This property is required. string
Source port list ID
SourcePortListVersion This property is required. int
Source port list version
destinationDataFqdnPrefixListId This property is required. String
Destination data FQDN prefix list ID
destinationDataFqdnPrefixListVersion This property is required. Integer
Destination data FQDN prefix list version
destinationDataIpv4PrefixListId This property is required. String
Destination data IPv4 prefix list ID
destinationDataIpv4PrefixListVersion This property is required. Integer
Destination data IPv4 prefix list version
destinationFqdn This property is required. String
Destination fully qualified domain name
destinationGeoLocation This property is required. String
Destination geo location
destinationGeoLocationListId This property is required. String
Destination geo location list ID
destinationGeoLocationListVersion This property is required. Integer
Destination geo location list version
destinationIpv4Prefix This property is required. String
Destination IPv4 prefix
destinationIpv4PrefixVariable This property is required. String
Destination IPv4 prefix variable name
destinationObjectGroupId This property is required. String
Destination object group ID
destinationObjectGroupVersion This property is required. Integer
Destination object group version
destinationPort This property is required. String
Destination port or range of ports
destinationPortListId This property is required. String
Destination port list ID
destinationPortListVersion This property is required. Integer
Destination port list version
name This property is required. String
The name of the rule
order This property is required. Integer
The order of the rule
protocol This property is required. String
Protocol name
protocolListId This property is required. String
Protocol list ID
protocolListVersion This property is required. Integer
Protocol list version
protocolNumber This property is required. Integer
Protocol number
sourceDataFqdnPrefixListId This property is required. String
Source data FQDN prefix list ID
sourceDataFqdnPrefixListVersion This property is required. Integer
Source data FQDN prefix list version
sourceDataIpv4PrefixListId This property is required. String
Source data IPv4 prefix list ID
sourceDataIpv4PrefixListVersion This property is required. Integer
Source data IPv4 prefix list version
sourceFqdn This property is required. String
Source fully qualified domain name
sourceGeoLocation This property is required. String
Source geo location
sourceGeoLocationListId This property is required. String
Source geo location list ID
sourceGeoLocationListVersion This property is required. Integer
Source geo location list version
sourceIpv4Prefix This property is required. String
Source IPv4 prefix
sourceIpv4PrefixVariable This property is required. String
Source IPv4 prefix variable name
sourceObjectGroupId This property is required. String
Source object group ID
sourceObjectGroupVersion This property is required. Integer
Source object group version
sourcePort This property is required. String
Source port or range of ports
sourcePortListId This property is required. String
Source port list ID
sourcePortListVersion This property is required. Integer
Source port list version
destinationDataFqdnPrefixListId This property is required. string
Destination data FQDN prefix list ID
destinationDataFqdnPrefixListVersion This property is required. number
Destination data FQDN prefix list version
destinationDataIpv4PrefixListId This property is required. string
Destination data IPv4 prefix list ID
destinationDataIpv4PrefixListVersion This property is required. number
Destination data IPv4 prefix list version
destinationFqdn This property is required. string
Destination fully qualified domain name
destinationGeoLocation This property is required. string
Destination geo location
destinationGeoLocationListId This property is required. string
Destination geo location list ID
destinationGeoLocationListVersion This property is required. number
Destination geo location list version
destinationIpv4Prefix This property is required. string
Destination IPv4 prefix
destinationIpv4PrefixVariable This property is required. string
Destination IPv4 prefix variable name
destinationObjectGroupId This property is required. string
Destination object group ID
destinationObjectGroupVersion This property is required. number
Destination object group version
destinationPort This property is required. string
Destination port or range of ports
destinationPortListId This property is required. string
Destination port list ID
destinationPortListVersion This property is required. number
Destination port list version
name This property is required. string
The name of the rule
order This property is required. number
The order of the rule
protocol This property is required. string
Protocol name
protocolListId This property is required. string
Protocol list ID
protocolListVersion This property is required. number
Protocol list version
protocolNumber This property is required. number
Protocol number
sourceDataFqdnPrefixListId This property is required. string
Source data FQDN prefix list ID
sourceDataFqdnPrefixListVersion This property is required. number
Source data FQDN prefix list version
sourceDataIpv4PrefixListId This property is required. string
Source data IPv4 prefix list ID
sourceDataIpv4PrefixListVersion This property is required. number
Source data IPv4 prefix list version
sourceFqdn This property is required. string
Source fully qualified domain name
sourceGeoLocation This property is required. string
Source geo location
sourceGeoLocationListId This property is required. string
Source geo location list ID
sourceGeoLocationListVersion This property is required. number
Source geo location list version
sourceIpv4Prefix This property is required. string
Source IPv4 prefix
sourceIpv4PrefixVariable This property is required. string
Source IPv4 prefix variable name
sourceObjectGroupId This property is required. string
Source object group ID
sourceObjectGroupVersion This property is required. number
Source object group version
sourcePort This property is required. string
Source port or range of ports
sourcePortListId This property is required. string
Source port list ID
sourcePortListVersion This property is required. number
Source port list version
destination_data_fqdn_prefix_list_id This property is required. str
Destination data FQDN prefix list ID
destination_data_fqdn_prefix_list_version This property is required. int
Destination data FQDN prefix list version
destination_data_ipv4_prefix_list_id This property is required. str
Destination data IPv4 prefix list ID
destination_data_ipv4_prefix_list_version This property is required. int
Destination data IPv4 prefix list version
destination_fqdn This property is required. str
Destination fully qualified domain name
destination_geo_location This property is required. str
Destination geo location
destination_geo_location_list_id This property is required. str
Destination geo location list ID
destination_geo_location_list_version This property is required. int
Destination geo location list version
destination_ipv4_prefix This property is required. str
Destination IPv4 prefix
destination_ipv4_prefix_variable This property is required. str
Destination IPv4 prefix variable name
destination_object_group_id This property is required. str
Destination object group ID
destination_object_group_version This property is required. int
Destination object group version
destination_port This property is required. str
Destination port or range of ports
destination_port_list_id This property is required. str
Destination port list ID
destination_port_list_version This property is required. int
Destination port list version
name This property is required. str
The name of the rule
order This property is required. int
The order of the rule
protocol This property is required. str
Protocol name
protocol_list_id This property is required. str
Protocol list ID
protocol_list_version This property is required. int
Protocol list version
protocol_number This property is required. int
Protocol number
source_data_fqdn_prefix_list_id This property is required. str
Source data FQDN prefix list ID
source_data_fqdn_prefix_list_version This property is required. int
Source data FQDN prefix list version
source_data_ipv4_prefix_list_id This property is required. str
Source data IPv4 prefix list ID
source_data_ipv4_prefix_list_version This property is required. int
Source data IPv4 prefix list version
source_fqdn This property is required. str
Source fully qualified domain name
source_geo_location This property is required. str
Source geo location
source_geo_location_list_id This property is required. str
Source geo location list ID
source_geo_location_list_version This property is required. int
Source geo location list version
source_ipv4_prefix This property is required. str
Source IPv4 prefix
source_ipv4_prefix_variable This property is required. str
Source IPv4 prefix variable name
source_object_group_id This property is required. str
Source object group ID
source_object_group_version This property is required. int
Source object group version
source_port This property is required. str
Source port or range of ports
source_port_list_id This property is required. str
Source port list ID
source_port_list_version This property is required. int
Source port list version
destinationDataFqdnPrefixListId This property is required. String
Destination data FQDN prefix list ID
destinationDataFqdnPrefixListVersion This property is required. Number
Destination data FQDN prefix list version
destinationDataIpv4PrefixListId This property is required. String
Destination data IPv4 prefix list ID
destinationDataIpv4PrefixListVersion This property is required. Number
Destination data IPv4 prefix list version
destinationFqdn This property is required. String
Destination fully qualified domain name
destinationGeoLocation This property is required. String
Destination geo location
destinationGeoLocationListId This property is required. String
Destination geo location list ID
destinationGeoLocationListVersion This property is required. Number
Destination geo location list version
destinationIpv4Prefix This property is required. String
Destination IPv4 prefix
destinationIpv4PrefixVariable This property is required. String
Destination IPv4 prefix variable name
destinationObjectGroupId This property is required. String
Destination object group ID
destinationObjectGroupVersion This property is required. Number
Destination object group version
destinationPort This property is required. String
Destination port or range of ports
destinationPortListId This property is required. String
Destination port list ID
destinationPortListVersion This property is required. Number
Destination port list version
name This property is required. String
The name of the rule
order This property is required. Number
The order of the rule
protocol This property is required. String
Protocol name
protocolListId This property is required. String
Protocol list ID
protocolListVersion This property is required. Number
Protocol list version
protocolNumber This property is required. Number
Protocol number
sourceDataFqdnPrefixListId This property is required. String
Source data FQDN prefix list ID
sourceDataFqdnPrefixListVersion This property is required. Number
Source data FQDN prefix list version
sourceDataIpv4PrefixListId This property is required. String
Source data IPv4 prefix list ID
sourceDataIpv4PrefixListVersion This property is required. Number
Source data IPv4 prefix list version
sourceFqdn This property is required. String
Source fully qualified domain name
sourceGeoLocation This property is required. String
Source geo location
sourceGeoLocationListId This property is required. String
Source geo location list ID
sourceGeoLocationListVersion This property is required. Number
Source geo location list version
sourceIpv4Prefix This property is required. String
Source IPv4 prefix
sourceIpv4PrefixVariable This property is required. String
Source IPv4 prefix variable name
sourceObjectGroupId This property is required. String
Source object group ID
sourceObjectGroupVersion This property is required. Number
Source object group version
sourcePort This property is required. String
Source port or range of ports
sourcePortListId This property is required. String
Source port list ID
sourcePortListVersion This property is required. Number
Source port list version

Package Details

Repository
sdwan pulumi/pulumi-sdwan
License
Apache-2.0
Notes
This Pulumi package is based on the sdwan Terraform Provider.
Cisco Catalyst SD-WAN v0.3.0 published on Friday, Mar 28, 2025 by Pulumi
pulumi/pulumi-sdwan