1. Packages
  2. Cisco NX OS Resource Provider
  3. API Docs
  4. RouteMapRuleEntry
Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs

nxos.RouteMapRuleEntry

Explore with Pulumi AI

nxos logo
Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs

    This resource can manage a Route-Map Rule Entry configuration.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Nxos = Lbrlabs.PulumiPackage.Nxos;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Nxos.RouteMapRuleEntry("example", new()
        {
            Action = "permit",
            Order = 10,
            RuleName = "RULE1",
        });
    
    });
    
    package main
    
    import (
    	"github.com/lbrlabs/pulumi-nxos/sdk/go/nxos"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := nxos.NewRouteMapRuleEntry(ctx, "example", &nxos.RouteMapRuleEntryArgs{
    			Action:   pulumi.String("permit"),
    			Order:    pulumi.Int(10),
    			RuleName: pulumi.String("RULE1"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.nxos.RouteMapRuleEntry;
    import com.pulumi.nxos.RouteMapRuleEntryArgs;
    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 RouteMapRuleEntry("example", RouteMapRuleEntryArgs.builder()        
                .action("permit")
                .order(10)
                .ruleName("RULE1")
                .build());
    
        }
    }
    
    import pulumi
    import lbrlabs_pulumi_nxos as nxos
    
    example = nxos.RouteMapRuleEntry("example",
        action="permit",
        order=10,
        rule_name="RULE1")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as nxos from "@lbrlabs/pulumi-nxos";
    
    const example = new nxos.RouteMapRuleEntry("example", {
        action: "permit",
        order: 10,
        ruleName: "RULE1",
    });
    
    resources:
      example:
        type: nxos:RouteMapRuleEntry
        properties:
          action: permit
          order: 10
          ruleName: RULE1
    

    Create RouteMapRuleEntry Resource

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

    Constructor syntax

    new RouteMapRuleEntry(name: string, args: RouteMapRuleEntryArgs, opts?: CustomResourceOptions);
    @overload
    def RouteMapRuleEntry(resource_name: str,
                          args: RouteMapRuleEntryArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def RouteMapRuleEntry(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          order: Optional[int] = None,
                          rule_name: Optional[str] = None,
                          action: Optional[str] = None,
                          device: Optional[str] = None)
    func NewRouteMapRuleEntry(ctx *Context, name string, args RouteMapRuleEntryArgs, opts ...ResourceOption) (*RouteMapRuleEntry, error)
    public RouteMapRuleEntry(string name, RouteMapRuleEntryArgs args, CustomResourceOptions? opts = null)
    public RouteMapRuleEntry(String name, RouteMapRuleEntryArgs args)
    public RouteMapRuleEntry(String name, RouteMapRuleEntryArgs args, CustomResourceOptions options)
    
    type: nxos:RouteMapRuleEntry
    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 RouteMapRuleEntryArgs
    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 RouteMapRuleEntryArgs
    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 RouteMapRuleEntryArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RouteMapRuleEntryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RouteMapRuleEntryArgs
    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 routeMapRuleEntryResource = new Nxos.RouteMapRuleEntry("routeMapRuleEntryResource", new()
    {
        Order = 0,
        RuleName = "string",
        Action = "string",
        Device = "string",
    });
    
    example, err := nxos.NewRouteMapRuleEntry(ctx, "routeMapRuleEntryResource", &nxos.RouteMapRuleEntryArgs{
    	Order:    pulumi.Int(0),
    	RuleName: pulumi.String("string"),
    	Action:   pulumi.String("string"),
    	Device:   pulumi.String("string"),
    })
    
    var routeMapRuleEntryResource = new RouteMapRuleEntry("routeMapRuleEntryResource", RouteMapRuleEntryArgs.builder()
        .order(0)
        .ruleName("string")
        .action("string")
        .device("string")
        .build());
    
    route_map_rule_entry_resource = nxos.RouteMapRuleEntry("routeMapRuleEntryResource",
        order=0,
        rule_name="string",
        action="string",
        device="string")
    
    const routeMapRuleEntryResource = new nxos.RouteMapRuleEntry("routeMapRuleEntryResource", {
        order: 0,
        ruleName: "string",
        action: "string",
        device: "string",
    });
    
    type: nxos:RouteMapRuleEntry
    properties:
        action: string
        device: string
        order: 0
        ruleName: string
    

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

    Order int
    Route-Map Rule Entry order. - Range: 0-65535
    RuleName string
    Route Map rule name.
    Action string
    Route-Map Rule Entry action. - Choices: deny, permit - Default value: permit
    Device string
    A device name from the provider configuration.
    Order int
    Route-Map Rule Entry order. - Range: 0-65535
    RuleName string
    Route Map rule name.
    Action string
    Route-Map Rule Entry action. - Choices: deny, permit - Default value: permit
    Device string
    A device name from the provider configuration.
    order Integer
    Route-Map Rule Entry order. - Range: 0-65535
    ruleName String
    Route Map rule name.
    action String
    Route-Map Rule Entry action. - Choices: deny, permit - Default value: permit
    device String
    A device name from the provider configuration.
    order number
    Route-Map Rule Entry order. - Range: 0-65535
    ruleName string
    Route Map rule name.
    action string
    Route-Map Rule Entry action. - Choices: deny, permit - Default value: permit
    device string
    A device name from the provider configuration.
    order int
    Route-Map Rule Entry order. - Range: 0-65535
    rule_name str
    Route Map rule name.
    action str
    Route-Map Rule Entry action. - Choices: deny, permit - Default value: permit
    device str
    A device name from the provider configuration.
    order Number
    Route-Map Rule Entry order. - Range: 0-65535
    ruleName String
    Route Map rule name.
    action String
    Route-Map Rule Entry action. - Choices: deny, permit - Default value: permit
    device String
    A device name from the provider configuration.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the RouteMapRuleEntry 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 RouteMapRuleEntry Resource

    Get an existing RouteMapRuleEntry 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?: RouteMapRuleEntryState, opts?: CustomResourceOptions): RouteMapRuleEntry
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            action: Optional[str] = None,
            device: Optional[str] = None,
            order: Optional[int] = None,
            rule_name: Optional[str] = None) -> RouteMapRuleEntry
    func GetRouteMapRuleEntry(ctx *Context, name string, id IDInput, state *RouteMapRuleEntryState, opts ...ResourceOption) (*RouteMapRuleEntry, error)
    public static RouteMapRuleEntry Get(string name, Input<string> id, RouteMapRuleEntryState? state, CustomResourceOptions? opts = null)
    public static RouteMapRuleEntry get(String name, Output<String> id, RouteMapRuleEntryState 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:
    Action string
    Route-Map Rule Entry action. - Choices: deny, permit - Default value: permit
    Device string
    A device name from the provider configuration.
    Order int
    Route-Map Rule Entry order. - Range: 0-65535
    RuleName string
    Route Map rule name.
    Action string
    Route-Map Rule Entry action. - Choices: deny, permit - Default value: permit
    Device string
    A device name from the provider configuration.
    Order int
    Route-Map Rule Entry order. - Range: 0-65535
    RuleName string
    Route Map rule name.
    action String
    Route-Map Rule Entry action. - Choices: deny, permit - Default value: permit
    device String
    A device name from the provider configuration.
    order Integer
    Route-Map Rule Entry order. - Range: 0-65535
    ruleName String
    Route Map rule name.
    action string
    Route-Map Rule Entry action. - Choices: deny, permit - Default value: permit
    device string
    A device name from the provider configuration.
    order number
    Route-Map Rule Entry order. - Range: 0-65535
    ruleName string
    Route Map rule name.
    action str
    Route-Map Rule Entry action. - Choices: deny, permit - Default value: permit
    device str
    A device name from the provider configuration.
    order int
    Route-Map Rule Entry order. - Range: 0-65535
    rule_name str
    Route Map rule name.
    action String
    Route-Map Rule Entry action. - Choices: deny, permit - Default value: permit
    device String
    A device name from the provider configuration.
    order Number
    Route-Map Rule Entry order. - Range: 0-65535
    ruleName String
    Route Map rule name.

    Import

     $ pulumi import nxos:index/routeMapRuleEntry:RouteMapRuleEntry example "sys/rpm/rtmap-[RULE1]/ent-[10]"
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    nxos lbrlabs/pulumi-nxos
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the nxos Terraform Provider.
    nxos logo
    Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs