Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cisco Catalyst SD-WAN
  3. API Docs
  4. ObjectGroupPolicyDefinition
Cisco Catalyst SD-WAN v0.1.3 published on Tuesday, Sep 24, 2024 by Pulumi
pulumi/pulumi-sdwan

sdwan.ObjectGroupPolicyDefinition

Explore with Pulumi AI

sdwan logo
Cisco Catalyst SD-WAN v0.1.3 published on Tuesday, Sep 24, 2024 by Pulumi
pulumi/pulumi-sdwan

    This resource can manage a Object Group Policy Definition .

    Example Usage

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

const example = new sdwan.ObjectGroupPolicyDefinition("example", {
    name: "Example",
    description: "My description",
    ipv4Prefix: "10.1.1.0/24",
    fqdn: "cisco.com",
    port: "80-90",
    geoLocation: "AF",
});

    import pulumi
import pulumi_sdwan as sdwan

example = sdwan.ObjectGroupPolicyDefinition("example",
    name="Example",
    description="My description",
    ipv4_prefix="10.1.1.0/24",
    fqdn="cisco.com",
    port="80-90",
    geo_location="AF")

    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.NewObjectGroupPolicyDefinition(ctx, "example", &sdwan.ObjectGroupPolicyDefinitionArgs{
			Name:        pulumi.String("Example"),
			Description: pulumi.String("My description"),
			Ipv4Prefix:  pulumi.String("10.1.1.0/24"),
			Fqdn:        pulumi.String("cisco.com"),
			Port:        pulumi.String("80-90"),
			GeoLocation: pulumi.String("AF"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Sdwan = Pulumi.Sdwan;

return await Deployment.RunAsync(() => 
{
    var example = new Sdwan.ObjectGroupPolicyDefinition("example", new()
    {
        Name = "Example",
        Description = "My description",
        Ipv4Prefix = "10.1.1.0/24",
        Fqdn = "cisco.com",
        Port = "80-90",
        GeoLocation = "AF",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sdwan.ObjectGroupPolicyDefinition;
import com.pulumi.sdwan.ObjectGroupPolicyDefinitionArgs;
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 ObjectGroupPolicyDefinition("example", ObjectGroupPolicyDefinitionArgs.builder()
            .name("Example")
            .description("My description")
            .ipv4Prefix("10.1.1.0/24")
            .fqdn("cisco.com")
            .port("80-90")
            .geoLocation("AF")
            .build());

    }
}

    resources:
  example:
    type: sdwan:ObjectGroupPolicyDefinition
    properties:
      name: Example
      description: My description
      ipv4Prefix: 10.1.1.0/24
      fqdn: cisco.com
      port: 80-90
      geoLocation: AF

    Create ObjectGroupPolicyDefinition Resource

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

    Constructor syntax

    new ObjectGroupPolicyDefinition(name: string, args: ObjectGroupPolicyDefinitionArgs, opts?: CustomResourceOptions);
    @overload
def ObjectGroupPolicyDefinition(resource_name: str,
                                args: ObjectGroupPolicyDefinitionArgs,
                                opts: Optional[ResourceOptions] = None)

@overload
def ObjectGroupPolicyDefinition(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                description: Optional[str] = None,
                                geo_location: Optional[str] = None,
                                geo_location_list_version: Optional[int] = None,
                                data_ipv4_prefix_list_version: Optional[int] = None,
                                data_fqdn_prefix_list_version: Optional[int] = None,
                                fqdn: Optional[str] = None,
                                data_fqdn_prefix_list_id: Optional[str] = None,
                                geo_location_list_id: Optional[str] = None,
                                data_ipv4_prefix_list_id: Optional[str] = None,
                                ipv4_prefix: Optional[str] = None,
                                ipv4_prefix_variable: Optional[str] = None,
                                name: Optional[str] = None,
                                port: Optional[str] = None,
                                port_list_id: Optional[str] = None,
                                port_list_version: Optional[int] = None)
    func NewObjectGroupPolicyDefinition(ctx *Context, name string, args ObjectGroupPolicyDefinitionArgs, opts ...ResourceOption) (*ObjectGroupPolicyDefinition, error)
    public ObjectGroupPolicyDefinition(string name, ObjectGroupPolicyDefinitionArgs args, CustomResourceOptions? opts = null)
    public ObjectGroupPolicyDefinition(String name, ObjectGroupPolicyDefinitionArgs args)
public ObjectGroupPolicyDefinition(String name, ObjectGroupPolicyDefinitionArgs args, CustomResourceOptions options)

    type: sdwan:ObjectGroupPolicyDefinition
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 ObjectGroupPolicyDefinitionArgs
    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 ObjectGroupPolicyDefinitionArgs
    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 ObjectGroupPolicyDefinitionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ObjectGroupPolicyDefinitionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ObjectGroupPolicyDefinitionArgs
    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 objectGroupPolicyDefinitionResource = new Sdwan.ObjectGroupPolicyDefinition("objectGroupPolicyDefinitionResource", new()
{
    Description = "string",
    GeoLocation = "string",
    GeoLocationListVersion = 0,
    DataIpv4PrefixListVersion = 0,
    DataFqdnPrefixListVersion = 0,
    Fqdn = "string",
    DataFqdnPrefixListId = "string",
    GeoLocationListId = "string",
    DataIpv4PrefixListId = "string",
    Ipv4Prefix = "string",
    Ipv4PrefixVariable = "string",
    Name = "string",
    Port = "string",
    PortListId = "string",
    PortListVersion = 0,
});

    example, err := sdwan.NewObjectGroupPolicyDefinition(ctx, "objectGroupPolicyDefinitionResource", &sdwan.ObjectGroupPolicyDefinitionArgs{
	Description:               pulumi.String("string"),
	GeoLocation:               pulumi.String("string"),
	GeoLocationListVersion:    pulumi.Int(0),
	DataIpv4PrefixListVersion: pulumi.Int(0),
	DataFqdnPrefixListVersion: pulumi.Int(0),
	Fqdn:                      pulumi.String("string"),
	DataFqdnPrefixListId:      pulumi.String("string"),
	GeoLocationListId:         pulumi.String("string"),
	DataIpv4PrefixListId:      pulumi.String("string"),
	Ipv4Prefix:                pulumi.String("string"),
	Ipv4PrefixVariable:        pulumi.String("string"),
	Name:                      pulumi.String("string"),
	Port:                      pulumi.String("string"),
	PortListId:                pulumi.String("string"),
	PortListVersion:           pulumi.Int(0),
})

    var objectGroupPolicyDefinitionResource = new ObjectGroupPolicyDefinition("objectGroupPolicyDefinitionResource", ObjectGroupPolicyDefinitionArgs.builder()
    .description("string")
    .geoLocation("string")
    .geoLocationListVersion(0)
    .dataIpv4PrefixListVersion(0)
    .dataFqdnPrefixListVersion(0)
    .fqdn("string")
    .dataFqdnPrefixListId("string")
    .geoLocationListId("string")
    .dataIpv4PrefixListId("string")
    .ipv4Prefix("string")
    .ipv4PrefixVariable("string")
    .name("string")
    .port("string")
    .portListId("string")
    .portListVersion(0)
    .build());

    object_group_policy_definition_resource = sdwan.ObjectGroupPolicyDefinition("objectGroupPolicyDefinitionResource",
    description="string",
    geo_location="string",
    geo_location_list_version=0,
    data_ipv4_prefix_list_version=0,
    data_fqdn_prefix_list_version=0,
    fqdn="string",
    data_fqdn_prefix_list_id="string",
    geo_location_list_id="string",
    data_ipv4_prefix_list_id="string",
    ipv4_prefix="string",
    ipv4_prefix_variable="string",
    name="string",
    port="string",
    port_list_id="string",
    port_list_version=0)

    const objectGroupPolicyDefinitionResource = new sdwan.ObjectGroupPolicyDefinition("objectGroupPolicyDefinitionResource", {
    description: "string",
    geoLocation: "string",
    geoLocationListVersion: 0,
    dataIpv4PrefixListVersion: 0,
    dataFqdnPrefixListVersion: 0,
    fqdn: "string",
    dataFqdnPrefixListId: "string",
    geoLocationListId: "string",
    dataIpv4PrefixListId: "string",
    ipv4Prefix: "string",
    ipv4PrefixVariable: "string",
    name: "string",
    port: "string",
    portListId: "string",
    portListVersion: 0,
});

    type: sdwan:ObjectGroupPolicyDefinition
properties:
    dataFqdnPrefixListId: string
    dataFqdnPrefixListVersion: 0
    dataIpv4PrefixListId: string
    dataIpv4PrefixListVersion: 0
    description: string
    fqdn: string
    geoLocation: string
    geoLocationListId: string
    geoLocationListVersion: 0
    ipv4Prefix: string
    ipv4PrefixVariable: string
    name: string
    port: string
    portListId: string
    portListVersion: 0

    ObjectGroupPolicyDefinition Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ObjectGroupPolicyDefinition resource accepts the following input properties:

    Description string
    The description of the policy definition
    DataFqdnPrefixListId string
    Data FQDN prefix list ID
    DataFqdnPrefixListVersion int
    Data FQDN prefix list version
    DataIpv4PrefixListId string
    Data IPv4 prefix list ID
    DataIpv4PrefixListVersion int
    Data IPv4 prefix list version
    Fqdn string
    Fully qualified domain name
    GeoLocation string
    Geo location
    GeoLocationListId string
    Geo location list ID
    GeoLocationListVersion int
    Geo location list version
    Ipv4Prefix string
    IPv4 prefix
    Ipv4PrefixVariable string
    IPv4 prefix variable name
    Name string
    The name of the policy definition
    Port string
    Port or range of ports
    PortListId string
    Port list ID
    PortListVersion int
    Port list version
    Description string
    The description of the policy definition
    DataFqdnPrefixListId string
    Data FQDN prefix list ID
    DataFqdnPrefixListVersion int
    Data FQDN prefix list version
    DataIpv4PrefixListId string
    Data IPv4 prefix list ID
    DataIpv4PrefixListVersion int
    Data IPv4 prefix list version
    Fqdn string
    Fully qualified domain name
    GeoLocation string
    Geo location
    GeoLocationListId string
    Geo location list ID
    GeoLocationListVersion int
    Geo location list version
    Ipv4Prefix string
    IPv4 prefix
    Ipv4PrefixVariable string
    IPv4 prefix variable name
    Name string
    The name of the policy definition
    Port string
    Port or range of ports
    PortListId string
    Port list ID
    PortListVersion int
    Port list version
    description String
    The description of the policy definition
    dataFqdnPrefixListId String
    Data FQDN prefix list ID
    dataFqdnPrefixListVersion Integer
    Data FQDN prefix list version
    dataIpv4PrefixListId String
    Data IPv4 prefix list ID
    dataIpv4PrefixListVersion Integer
    Data IPv4 prefix list version
    fqdn String
    Fully qualified domain name
    geoLocation String
    Geo location
    geoLocationListId String
    Geo location list ID
    geoLocationListVersion Integer
    Geo location list version
    ipv4Prefix String
    IPv4 prefix
    ipv4PrefixVariable String
    IPv4 prefix variable name
    name String
    The name of the policy definition
    port String
    Port or range of ports
    portListId String
    Port list ID
    portListVersion Integer
    Port list version
    description string
    The description of the policy definition
    dataFqdnPrefixListId string
    Data FQDN prefix list ID
    dataFqdnPrefixListVersion number
    Data FQDN prefix list version
    dataIpv4PrefixListId string
    Data IPv4 prefix list ID
    dataIpv4PrefixListVersion number
    Data IPv4 prefix list version
    fqdn string
    Fully qualified domain name
    geoLocation string
    Geo location
    geoLocationListId string
    Geo location list ID
    geoLocationListVersion number
    Geo location list version
    ipv4Prefix string
    IPv4 prefix
    ipv4PrefixVariable string
    IPv4 prefix variable name
    name string
    The name of the policy definition
    port string
    Port or range of ports
    portListId string
    Port list ID
    portListVersion number
    Port list version
    description str
    The description of the policy definition
    data_fqdn_prefix_list_id str
    Data FQDN prefix list ID
    data_fqdn_prefix_list_version int
    Data FQDN prefix list version
    data_ipv4_prefix_list_id str
    Data IPv4 prefix list ID
    data_ipv4_prefix_list_version int
    Data IPv4 prefix list version
    fqdn str
    Fully qualified domain name
    geo_location str
    Geo location
    geo_location_list_id str
    Geo location list ID
    geo_location_list_version int
    Geo location list version
    ipv4_prefix str
    IPv4 prefix
    ipv4_prefix_variable str
    IPv4 prefix variable name
    name str
    The name of the policy definition
    port str
    Port or range of ports
    port_list_id str
    Port list ID
    port_list_version int
    Port list version
    description String
    The description of the policy definition
    dataFqdnPrefixListId String
    Data FQDN prefix list ID
    dataFqdnPrefixListVersion Number
    Data FQDN prefix list version
    dataIpv4PrefixListId String
    Data IPv4 prefix list ID
    dataIpv4PrefixListVersion Number
    Data IPv4 prefix list version
    fqdn String
    Fully qualified domain name
    geoLocation String
    Geo location
    geoLocationListId String
    Geo location list ID
    geoLocationListVersion Number
    Geo location list version
    ipv4Prefix String
    IPv4 prefix
    ipv4PrefixVariable String
    IPv4 prefix variable name
    name String
    The name of the policy definition
    port String
    Port or range of ports
    portListId String
    Port list ID
    portListVersion Number
    Port list version

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Version int
    The version of the object
    Id string
    The provider-assigned unique ID for this managed resource.
    Version int
    The version of the object
    id String
    The provider-assigned unique ID for this managed resource.
    version Integer
    The version of the object
    id string
    The provider-assigned unique ID for this managed resource.
    version number
    The version of the object
    id str
    The provider-assigned unique ID for this managed resource.
    version int
    The version of the object
    id String
    The provider-assigned unique ID for this managed resource.
    version Number
    The version of the object

    Look up Existing ObjectGroupPolicyDefinition Resource

    Get an existing ObjectGroupPolicyDefinition 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?: ObjectGroupPolicyDefinitionState, opts?: CustomResourceOptions): ObjectGroupPolicyDefinition
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        data_fqdn_prefix_list_id: Optional[str] = None,
        data_fqdn_prefix_list_version: Optional[int] = None,
        data_ipv4_prefix_list_id: Optional[str] = None,
        data_ipv4_prefix_list_version: Optional[int] = None,
        description: Optional[str] = None,
        fqdn: Optional[str] = None,
        geo_location: Optional[str] = None,
        geo_location_list_id: Optional[str] = None,
        geo_location_list_version: Optional[int] = None,
        ipv4_prefix: Optional[str] = None,
        ipv4_prefix_variable: Optional[str] = None,
        name: Optional[str] = None,
        port: Optional[str] = None,
        port_list_id: Optional[str] = None,
        port_list_version: Optional[int] = None,
        version: Optional[int] = None) -> ObjectGroupPolicyDefinition
    func GetObjectGroupPolicyDefinition(ctx *Context, name string, id IDInput, state *ObjectGroupPolicyDefinitionState, opts ...ResourceOption) (*ObjectGroupPolicyDefinition, error)
    public static ObjectGroupPolicyDefinition Get(string name, Input<string> id, ObjectGroupPolicyDefinitionState? state, CustomResourceOptions? opts = null)
    public static ObjectGroupPolicyDefinition get(String name, Output<String> id, ObjectGroupPolicyDefinitionState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DataFqdnPrefixListId string
    Data FQDN prefix list ID
    DataFqdnPrefixListVersion int
    Data FQDN prefix list version
    DataIpv4PrefixListId string
    Data IPv4 prefix list ID
    DataIpv4PrefixListVersion int
    Data IPv4 prefix list version
    Description string
    The description of the policy definition
    Fqdn string
    Fully qualified domain name
    GeoLocation string
    Geo location
    GeoLocationListId string
    Geo location list ID
    GeoLocationListVersion int
    Geo location list version
    Ipv4Prefix string
    IPv4 prefix
    Ipv4PrefixVariable string
    IPv4 prefix variable name
    Name string
    The name of the policy definition
    Port string
    Port or range of ports
    PortListId string
    Port list ID
    PortListVersion int
    Port list version
    Version int
    The version of the object
    DataFqdnPrefixListId string
    Data FQDN prefix list ID
    DataFqdnPrefixListVersion int
    Data FQDN prefix list version
    DataIpv4PrefixListId string
    Data IPv4 prefix list ID
    DataIpv4PrefixListVersion int
    Data IPv4 prefix list version
    Description string
    The description of the policy definition
    Fqdn string
    Fully qualified domain name
    GeoLocation string
    Geo location
    GeoLocationListId string
    Geo location list ID
    GeoLocationListVersion int
    Geo location list version
    Ipv4Prefix string
    IPv4 prefix
    Ipv4PrefixVariable string
    IPv4 prefix variable name
    Name string
    The name of the policy definition
    Port string
    Port or range of ports
    PortListId string
    Port list ID
    PortListVersion int
    Port list version
    Version int
    The version of the object
    dataFqdnPrefixListId String
    Data FQDN prefix list ID
    dataFqdnPrefixListVersion Integer
    Data FQDN prefix list version
    dataIpv4PrefixListId String
    Data IPv4 prefix list ID
    dataIpv4PrefixListVersion Integer
    Data IPv4 prefix list version
    description String
    The description of the policy definition
    fqdn String
    Fully qualified domain name
    geoLocation String
    Geo location
    geoLocationListId String
    Geo location list ID
    geoLocationListVersion Integer
    Geo location list version
    ipv4Prefix String
    IPv4 prefix
    ipv4PrefixVariable String
    IPv4 prefix variable name
    name String
    The name of the policy definition
    port String
    Port or range of ports
    portListId String
    Port list ID
    portListVersion Integer
    Port list version
    version Integer
    The version of the object
    dataFqdnPrefixListId string
    Data FQDN prefix list ID
    dataFqdnPrefixListVersion number
    Data FQDN prefix list version
    dataIpv4PrefixListId string
    Data IPv4 prefix list ID
    dataIpv4PrefixListVersion number
    Data IPv4 prefix list version
    description string
    The description of the policy definition
    fqdn string
    Fully qualified domain name
    geoLocation string
    Geo location
    geoLocationListId string
    Geo location list ID
    geoLocationListVersion number
    Geo location list version
    ipv4Prefix string
    IPv4 prefix
    ipv4PrefixVariable string
    IPv4 prefix variable name
    name string
    The name of the policy definition
    port string
    Port or range of ports
    portListId string
    Port list ID
    portListVersion number
    Port list version
    version number
    The version of the object
    data_fqdn_prefix_list_id str
    Data FQDN prefix list ID
    data_fqdn_prefix_list_version int
    Data FQDN prefix list version
    data_ipv4_prefix_list_id str
    Data IPv4 prefix list ID
    data_ipv4_prefix_list_version int
    Data IPv4 prefix list version
    description str
    The description of the policy definition
    fqdn str
    Fully qualified domain name
    geo_location str
    Geo location
    geo_location_list_id str
    Geo location list ID
    geo_location_list_version int
    Geo location list version
    ipv4_prefix str
    IPv4 prefix
    ipv4_prefix_variable str
    IPv4 prefix variable name
    name str
    The name of the policy definition
    port str
    Port or range of ports
    port_list_id str
    Port list ID
    port_list_version int
    Port list version
    version int
    The version of the object
    dataFqdnPrefixListId String
    Data FQDN prefix list ID
    dataFqdnPrefixListVersion Number
    Data FQDN prefix list version
    dataIpv4PrefixListId String
    Data IPv4 prefix list ID
    dataIpv4PrefixListVersion Number
    Data IPv4 prefix list version
    description String
    The description of the policy definition
    fqdn String
    Fully qualified domain name
    geoLocation String
    Geo location
    geoLocationListId String
    Geo location list ID
    geoLocationListVersion Number
    Geo location list version
    ipv4Prefix String
    IPv4 prefix
    ipv4PrefixVariable String
    IPv4 prefix variable name
    name String
    The name of the policy definition
    port String
    Port or range of ports
    portListId String
    Port list ID
    portListVersion Number
    Port list version
    version Number
    The version of the object

    Import

    $ pulumi import sdwan:index/objectGroupPolicyDefinition:ObjectGroupPolicyDefinition 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 sdwan Terraform Provider.
    sdwan logo
    Cisco Catalyst SD-WAN v0.1.3 published on Tuesday, Sep 24, 2024 by Pulumi
    pulumi/pulumi-sdwan