1. Packages
  2. Cisco Catalyst SD-WAN
  3. API Docs
  4. PolicyObjectIpv4PrefixList
Cisco Catalyst SD-WAN v0.2.0 published on Friday, Nov 1, 2024 by Pulumi

sdwan.PolicyObjectIpv4PrefixList

Explore with Pulumi AI

sdwan logo
Cisco Catalyst SD-WAN v0.2.0 published on Friday, Nov 1, 2024 by Pulumi

    This resource can manage a Policy Object IPv4 Prefix List Policy_object.

    • Minimum SD-WAN Manager version: 20.12.0

    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.PolicyObjectIpv4PrefixList;
    import com.pulumi.sdwan.PolicyObjectIpv4PrefixListArgs;
    import com.pulumi.sdwan.inputs.PolicyObjectIpv4PrefixListEntryArgs;
    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 PolicyObjectIpv4PrefixList("example", PolicyObjectIpv4PrefixListArgs.builder()
                .name("Example")
                .description("My Example")
                .featureProfileId("f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac")
                .entries(PolicyObjectIpv4PrefixListEntryArgs.builder()
                    .ipv4_address("10.0.0.0")
                    .ipv4_prefix_length(8)
                    .le(24)
                    .ge(16)
                    .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: sdwan:PolicyObjectIpv4PrefixList
        properties:
          name: Example
          description: My Example
          featureProfileId: f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac
          entries:
            - ipv4_address: 10.0.0.0
              ipv4_prefix_length: 8
              le: 24
              ge: 16
    

    Create PolicyObjectIpv4PrefixList Resource

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

    Constructor syntax

    new PolicyObjectIpv4PrefixList(name: string, args: PolicyObjectIpv4PrefixListArgs, opts?: CustomResourceOptions);
    @overload
    def PolicyObjectIpv4PrefixList(resource_name: str,
                                   args: PolicyObjectIpv4PrefixListArgs,
                                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def PolicyObjectIpv4PrefixList(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   entries: Optional[Sequence[PolicyObjectIpv4PrefixListEntryArgs]] = None,
                                   feature_profile_id: Optional[str] = None,
                                   description: Optional[str] = None,
                                   name: Optional[str] = None)
    func NewPolicyObjectIpv4PrefixList(ctx *Context, name string, args PolicyObjectIpv4PrefixListArgs, opts ...ResourceOption) (*PolicyObjectIpv4PrefixList, error)
    public PolicyObjectIpv4PrefixList(string name, PolicyObjectIpv4PrefixListArgs args, CustomResourceOptions? opts = null)
    public PolicyObjectIpv4PrefixList(String name, PolicyObjectIpv4PrefixListArgs args)
    public PolicyObjectIpv4PrefixList(String name, PolicyObjectIpv4PrefixListArgs args, CustomResourceOptions options)
    
    type: sdwan:PolicyObjectIpv4PrefixList
    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 PolicyObjectIpv4PrefixListArgs
    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 PolicyObjectIpv4PrefixListArgs
    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 PolicyObjectIpv4PrefixListArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyObjectIpv4PrefixListArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyObjectIpv4PrefixListArgs
    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 policyObjectIpv4PrefixListResource = new Sdwan.PolicyObjectIpv4PrefixList("policyObjectIpv4PrefixListResource", new()
    {
        Entries = new[]
        {
            new Sdwan.Inputs.PolicyObjectIpv4PrefixListEntryArgs
            {
                Ge = 0,
                Ipv4Address = "string",
                Ipv4PrefixLength = 0,
                Le = 0,
            },
        },
        FeatureProfileId = "string",
        Description = "string",
        Name = "string",
    });
    
    example, err := sdwan.NewPolicyObjectIpv4PrefixList(ctx, "policyObjectIpv4PrefixListResource", &sdwan.PolicyObjectIpv4PrefixListArgs{
    	Entries: sdwan.PolicyObjectIpv4PrefixListEntryArray{
    		&sdwan.PolicyObjectIpv4PrefixListEntryArgs{
    			Ge:               pulumi.Int(0),
    			Ipv4Address:      pulumi.String("string"),
    			Ipv4PrefixLength: pulumi.Int(0),
    			Le:               pulumi.Int(0),
    		},
    	},
    	FeatureProfileId: pulumi.String("string"),
    	Description:      pulumi.String("string"),
    	Name:             pulumi.String("string"),
    })
    
    var policyObjectIpv4PrefixListResource = new PolicyObjectIpv4PrefixList("policyObjectIpv4PrefixListResource", PolicyObjectIpv4PrefixListArgs.builder()
        .entries(PolicyObjectIpv4PrefixListEntryArgs.builder()
            .ge(0)
            .ipv4Address("string")
            .ipv4PrefixLength(0)
            .le(0)
            .build())
        .featureProfileId("string")
        .description("string")
        .name("string")
        .build());
    
    policy_object_ipv4_prefix_list_resource = sdwan.PolicyObjectIpv4PrefixList("policyObjectIpv4PrefixListResource",
        entries=[{
            "ge": 0,
            "ipv4_address": "string",
            "ipv4_prefix_length": 0,
            "le": 0,
        }],
        feature_profile_id="string",
        description="string",
        name="string")
    
    const policyObjectIpv4PrefixListResource = new sdwan.PolicyObjectIpv4PrefixList("policyObjectIpv4PrefixListResource", {
        entries: [{
            ge: 0,
            ipv4Address: "string",
            ipv4PrefixLength: 0,
            le: 0,
        }],
        featureProfileId: "string",
        description: "string",
        name: "string",
    });
    
    type: sdwan:PolicyObjectIpv4PrefixList
    properties:
        description: string
        entries:
            - ge: 0
              ipv4Address: string
              ipv4PrefixLength: 0
              le: 0
        featureProfileId: string
        name: string
    

    PolicyObjectIpv4PrefixList 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 PolicyObjectIpv4PrefixList resource accepts the following input properties:

    Entries List<PolicyObjectIpv4PrefixListEntry>
    IPv4 Prefix List
    FeatureProfileId string
    Feature Profile ID
    Description string
    The description of the Policy_object
    Name string
    The name of the Policy_object
    Entries []PolicyObjectIpv4PrefixListEntryArgs
    IPv4 Prefix List
    FeatureProfileId string
    Feature Profile ID
    Description string
    The description of the Policy_object
    Name string
    The name of the Policy_object
    entries List<PolicyObjectIpv4PrefixListEntry>
    IPv4 Prefix List
    featureProfileId String
    Feature Profile ID
    description String
    The description of the Policy_object
    name String
    The name of the Policy_object
    entries PolicyObjectIpv4PrefixListEntry[]
    IPv4 Prefix List
    featureProfileId string
    Feature Profile ID
    description string
    The description of the Policy_object
    name string
    The name of the Policy_object
    entries Sequence[PolicyObjectIpv4PrefixListEntryArgs]
    IPv4 Prefix List
    feature_profile_id str
    Feature Profile ID
    description str
    The description of the Policy_object
    name str
    The name of the Policy_object
    entries List<Property Map>
    IPv4 Prefix List
    featureProfileId String
    Feature Profile ID
    description String
    The description of the Policy_object
    name String
    The name of the Policy_object

    Outputs

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

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

    Look up Existing PolicyObjectIpv4PrefixList Resource

    Get an existing PolicyObjectIpv4PrefixList 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?: PolicyObjectIpv4PrefixListState, opts?: CustomResourceOptions): PolicyObjectIpv4PrefixList
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            entries: Optional[Sequence[PolicyObjectIpv4PrefixListEntryArgs]] = None,
            feature_profile_id: Optional[str] = None,
            name: Optional[str] = None,
            version: Optional[int] = None) -> PolicyObjectIpv4PrefixList
    func GetPolicyObjectIpv4PrefixList(ctx *Context, name string, id IDInput, state *PolicyObjectIpv4PrefixListState, opts ...ResourceOption) (*PolicyObjectIpv4PrefixList, error)
    public static PolicyObjectIpv4PrefixList Get(string name, Input<string> id, PolicyObjectIpv4PrefixListState? state, CustomResourceOptions? opts = null)
    public static PolicyObjectIpv4PrefixList get(String name, Output<String> id, PolicyObjectIpv4PrefixListState 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:
    Description string
    The description of the Policy_object
    Entries List<PolicyObjectIpv4PrefixListEntry>
    IPv4 Prefix List
    FeatureProfileId string
    Feature Profile ID
    Name string
    The name of the Policy_object
    Version int
    The version of the Policy_object
    Description string
    The description of the Policy_object
    Entries []PolicyObjectIpv4PrefixListEntryArgs
    IPv4 Prefix List
    FeatureProfileId string
    Feature Profile ID
    Name string
    The name of the Policy_object
    Version int
    The version of the Policy_object
    description String
    The description of the Policy_object
    entries List<PolicyObjectIpv4PrefixListEntry>
    IPv4 Prefix List
    featureProfileId String
    Feature Profile ID
    name String
    The name of the Policy_object
    version Integer
    The version of the Policy_object
    description string
    The description of the Policy_object
    entries PolicyObjectIpv4PrefixListEntry[]
    IPv4 Prefix List
    featureProfileId string
    Feature Profile ID
    name string
    The name of the Policy_object
    version number
    The version of the Policy_object
    description str
    The description of the Policy_object
    entries Sequence[PolicyObjectIpv4PrefixListEntryArgs]
    IPv4 Prefix List
    feature_profile_id str
    Feature Profile ID
    name str
    The name of the Policy_object
    version int
    The version of the Policy_object
    description String
    The description of the Policy_object
    entries List<Property Map>
    IPv4 Prefix List
    featureProfileId String
    Feature Profile ID
    name String
    The name of the Policy_object
    version Number
    The version of the Policy_object

    Supporting Types

    PolicyObjectIpv4PrefixListEntry, PolicyObjectIpv4PrefixListEntryArgs

    Ge int
    IPv4 prefix length with ge range operator

    • Range: 1-32
    Ipv4Address string
    IPv4 address
    Ipv4PrefixLength int
    IPv4 prefix length

    • Range: 0-32
    Le int
    IPv4 prefix length with le range operator

    • Range: 1-32
    Ge int
    IPv4 prefix length with ge range operator

    • Range: 1-32
    Ipv4Address string
    IPv4 address
    Ipv4PrefixLength int
    IPv4 prefix length

    • Range: 0-32
    Le int
    IPv4 prefix length with le range operator

    • Range: 1-32
    ge Integer
    IPv4 prefix length with ge range operator

    • Range: 1-32
    ipv4Address String
    IPv4 address
    ipv4PrefixLength Integer
    IPv4 prefix length

    • Range: 0-32
    le Integer
    IPv4 prefix length with le range operator

    • Range: 1-32
    ge number
    IPv4 prefix length with ge range operator

    • Range: 1-32
    ipv4Address string
    IPv4 address
    ipv4PrefixLength number
    IPv4 prefix length

    • Range: 0-32
    le number
    IPv4 prefix length with le range operator

    • Range: 1-32
    ge int
    IPv4 prefix length with ge range operator

    • Range: 1-32
    ipv4_address str
    IPv4 address
    ipv4_prefix_length int
    IPv4 prefix length

    • Range: 0-32
    le int
    IPv4 prefix length with le range operator

    • Range: 1-32
    ge Number
    IPv4 prefix length with ge range operator

    • Range: 1-32
    ipv4Address String
    IPv4 address
    ipv4PrefixLength Number
    IPv4 prefix length

    • Range: 0-32
    le Number
    IPv4 prefix length with le range operator

    • Range: 1-32

    Import

    Expected import identifier with the format: “policy_object_ipv4_prefix_list_id,feature_profile_id”

    $ pulumi import sdwan:index/policyObjectIpv4PrefixList:PolicyObjectIpv4PrefixList example "f6b2c44c-693c-4763-b010-895aa3d236bd,f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac"
    

    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.2.0 published on Friday, Nov 1, 2024 by Pulumi