1. Packages
  2. Avi Provider
  3. API Docs
  4. Botmapping
avi 31.1.1 published on Monday, Apr 14, 2025 by vmware

avi.Botmapping

Explore with Pulumi AI

avi logo
avi 31.1.1 published on Monday, Apr 14, 2025 by vmware

    <!–

    Copyright 2021 VMware, Inc.
    SPDX-License-Identifier: Mozilla Public License 2.0
    

    –>

    layout: “avi”

    page_title: “Avi: avi.Botmapping” sidebar_current: “docs-avi-resource-botmapping” description: |- Creates and manages Avi BotMapping.

    avi.Botmapping

    The BotMapping resource allows the creation and management of Avi BotMapping

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as avi from "@pulumi/avi";
    
    const foo = new avi.Botmapping("foo", {tenantRef: "/api/tenant/?name=admin"});
    
    import pulumi
    import pulumi_avi as avi
    
    foo = avi.Botmapping("foo", tenant_ref="/api/tenant/?name=admin")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/avi/v31/avi"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := avi.NewBotmapping(ctx, "foo", &avi.BotmappingArgs{
    			TenantRef: pulumi.String("/api/tenant/?name=admin"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Avi = Pulumi.Avi;
    
    return await Deployment.RunAsync(() => 
    {
        var foo = new Avi.Botmapping("foo", new()
        {
            TenantRef = "/api/tenant/?name=admin",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.avi.Botmapping;
    import com.pulumi.avi.BotmappingArgs;
    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 foo = new Botmapping("foo", BotmappingArgs.builder()
                .tenantRef("/api/tenant/?name=admin")
                .build());
    
        }
    }
    
    resources:
      foo:
        type: avi:Botmapping
        properties:
          tenantRef: /api/tenant/?name=admin
    

    Create Botmapping Resource

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

    Constructor syntax

    new Botmapping(name: string, args?: BotmappingArgs, opts?: CustomResourceOptions);
    @overload
    def Botmapping(resource_name: str,
                   args: Optional[BotmappingArgs] = None,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def Botmapping(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   botmapping_id: Optional[str] = None,
                   mapping_rules: Optional[Sequence[BotmappingMappingRuleArgs]] = None,
                   name: Optional[str] = None,
                   tenant_ref: Optional[str] = None,
                   uuid: Optional[str] = None)
    func NewBotmapping(ctx *Context, name string, args *BotmappingArgs, opts ...ResourceOption) (*Botmapping, error)
    public Botmapping(string name, BotmappingArgs? args = null, CustomResourceOptions? opts = null)
    public Botmapping(String name, BotmappingArgs args)
    public Botmapping(String name, BotmappingArgs args, CustomResourceOptions options)
    
    type: avi:Botmapping
    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 BotmappingArgs
    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 BotmappingArgs
    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 BotmappingArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BotmappingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BotmappingArgs
    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 botmappingResource = new Avi.Botmapping("botmappingResource", new()
    {
        BotmappingId = "string",
        MappingRules = new[]
        {
            new Avi.Inputs.BotmappingMappingRuleArgs
            {
                Classifications = new[]
                {
                    new Avi.Inputs.BotmappingMappingRuleClassificationArgs
                    {
                        Type = "string",
                        UserDefinedType = "string",
                    },
                },
                Index = "string",
                Matches = new[]
                {
                    new Avi.Inputs.BotmappingMappingRuleMatchArgs
                    {
                        ClassMatchers = new[]
                        {
                            new Avi.Inputs.BotmappingMappingRuleMatchClassMatcherArgs
                            {
                                ClientClasses = new[]
                                {
                                    "string",
                                },
                                Op = "string",
                            },
                        },
                        ClientIps = new[]
                        {
                            new Avi.Inputs.BotmappingMappingRuleMatchClientIpArgs
                            {
                                MatchCriteria = "string",
                                Addrs = new[]
                                {
                                    new Avi.Inputs.BotmappingMappingRuleMatchClientIpAddrArgs
                                    {
                                        Addr = "string",
                                        Type = "string",
                                    },
                                },
                                GroupRefs = new[]
                                {
                                    "string",
                                },
                                Prefixes = new[]
                                {
                                    new Avi.Inputs.BotmappingMappingRuleMatchClientIpPrefixArgs
                                    {
                                        IpAddrs = new[]
                                        {
                                            new Avi.Inputs.BotmappingMappingRuleMatchClientIpPrefixIpAddrArgs
                                            {
                                                Addr = "string",
                                                Type = "string",
                                            },
                                        },
                                        Mask = "string",
                                    },
                                },
                                Ranges = new[]
                                {
                                    new Avi.Inputs.BotmappingMappingRuleMatchClientIpRangeArgs
                                    {
                                        Begins = new[]
                                        {
                                            new Avi.Inputs.BotmappingMappingRuleMatchClientIpRangeBeginArgs
                                            {
                                                Addr = "string",
                                                Type = "string",
                                            },
                                        },
                                        Ends = new[]
                                        {
                                            new Avi.Inputs.BotmappingMappingRuleMatchClientIpRangeEndArgs
                                            {
                                                Addr = "string",
                                                Type = "string",
                                            },
                                        },
                                    },
                                },
                            },
                        },
                        ComponentMatcher = "string",
                        Hdrs = new[]
                        {
                            new Avi.Inputs.BotmappingMappingRuleMatchHdrArgs
                            {
                                Hdr = "string",
                                MatchCriteria = "string",
                                MatchCase = "string",
                                StringGroupRefs = new[]
                                {
                                    "string",
                                },
                                Values = new[]
                                {
                                    "string",
                                },
                            },
                        },
                        HostHdrs = new[]
                        {
                            new Avi.Inputs.BotmappingMappingRuleMatchHostHdrArgs
                            {
                                MatchCriteria = "string",
                                MatchCase = "string",
                                Values = new[]
                                {
                                    "string",
                                },
                            },
                        },
                        IdentifierMatchers = new[]
                        {
                            new Avi.Inputs.BotmappingMappingRuleMatchIdentifierMatcherArgs
                            {
                                MatchCriteria = "string",
                                MatchStrs = new[]
                                {
                                    "string",
                                },
                                StringGroupRefs = new[]
                                {
                                    "string",
                                },
                            },
                        },
                        Methods = new[]
                        {
                            new Avi.Inputs.BotmappingMappingRuleMatchMethodArgs
                            {
                                MatchCriteria = "string",
                                Methods = new[]
                                {
                                    "string",
                                },
                            },
                        },
                        Paths = new[]
                        {
                            new Avi.Inputs.BotmappingMappingRuleMatchPathArgs
                            {
                                MatchCriteria = "string",
                                MatchCase = "string",
                                MatchDecodedString = "string",
                                MatchStrs = new[]
                                {
                                    "string",
                                },
                                StringGroupRefs = new[]
                                {
                                    "string",
                                },
                            },
                        },
                        TypeMatchers = new[]
                        {
                            new Avi.Inputs.BotmappingMappingRuleMatchTypeMatcherArgs
                            {
                                ClientTypes = new[]
                                {
                                    "string",
                                },
                                Op = "string",
                            },
                        },
                    },
                },
                Name = "string",
            },
        },
        Name = "string",
        TenantRef = "string",
        Uuid = "string",
    });
    
    example, err := avi.NewBotmapping(ctx, "botmappingResource", &avi.BotmappingArgs{
    	BotmappingId: pulumi.String("string"),
    	MappingRules: avi.BotmappingMappingRuleArray{
    		&avi.BotmappingMappingRuleArgs{
    			Classifications: avi.BotmappingMappingRuleClassificationArray{
    				&avi.BotmappingMappingRuleClassificationArgs{
    					Type:            pulumi.String("string"),
    					UserDefinedType: pulumi.String("string"),
    				},
    			},
    			Index: pulumi.String("string"),
    			Matches: avi.BotmappingMappingRuleMatchArray{
    				&avi.BotmappingMappingRuleMatchArgs{
    					ClassMatchers: avi.BotmappingMappingRuleMatchClassMatcherArray{
    						&avi.BotmappingMappingRuleMatchClassMatcherArgs{
    							ClientClasses: pulumi.StringArray{
    								pulumi.String("string"),
    							},
    							Op: pulumi.String("string"),
    						},
    					},
    					ClientIps: avi.BotmappingMappingRuleMatchClientIpArray{
    						&avi.BotmappingMappingRuleMatchClientIpArgs{
    							MatchCriteria: pulumi.String("string"),
    							Addrs: avi.BotmappingMappingRuleMatchClientIpAddrArray{
    								&avi.BotmappingMappingRuleMatchClientIpAddrArgs{
    									Addr: pulumi.String("string"),
    									Type: pulumi.String("string"),
    								},
    							},
    							GroupRefs: pulumi.StringArray{
    								pulumi.String("string"),
    							},
    							Prefixes: avi.BotmappingMappingRuleMatchClientIpPrefixArray{
    								&avi.BotmappingMappingRuleMatchClientIpPrefixArgs{
    									IpAddrs: avi.BotmappingMappingRuleMatchClientIpPrefixIpAddrArray{
    										&avi.BotmappingMappingRuleMatchClientIpPrefixIpAddrArgs{
    											Addr: pulumi.String("string"),
    											Type: pulumi.String("string"),
    										},
    									},
    									Mask: pulumi.String("string"),
    								},
    							},
    							Ranges: avi.BotmappingMappingRuleMatchClientIpRangeArray{
    								&avi.BotmappingMappingRuleMatchClientIpRangeArgs{
    									Begins: avi.BotmappingMappingRuleMatchClientIpRangeBeginArray{
    										&avi.BotmappingMappingRuleMatchClientIpRangeBeginArgs{
    											Addr: pulumi.String("string"),
    											Type: pulumi.String("string"),
    										},
    									},
    									Ends: avi.BotmappingMappingRuleMatchClientIpRangeEndArray{
    										&avi.BotmappingMappingRuleMatchClientIpRangeEndArgs{
    											Addr: pulumi.String("string"),
    											Type: pulumi.String("string"),
    										},
    									},
    								},
    							},
    						},
    					},
    					ComponentMatcher: pulumi.String("string"),
    					Hdrs: avi.BotmappingMappingRuleMatchHdrArray{
    						&avi.BotmappingMappingRuleMatchHdrArgs{
    							Hdr:           pulumi.String("string"),
    							MatchCriteria: pulumi.String("string"),
    							MatchCase:     pulumi.String("string"),
    							StringGroupRefs: pulumi.StringArray{
    								pulumi.String("string"),
    							},
    							Values: pulumi.StringArray{
    								pulumi.String("string"),
    							},
    						},
    					},
    					HostHdrs: avi.BotmappingMappingRuleMatchHostHdrArray{
    						&avi.BotmappingMappingRuleMatchHostHdrArgs{
    							MatchCriteria: pulumi.String("string"),
    							MatchCase:     pulumi.String("string"),
    							Values: pulumi.StringArray{
    								pulumi.String("string"),
    							},
    						},
    					},
    					IdentifierMatchers: avi.BotmappingMappingRuleMatchIdentifierMatcherArray{
    						&avi.BotmappingMappingRuleMatchIdentifierMatcherArgs{
    							MatchCriteria: pulumi.String("string"),
    							MatchStrs: pulumi.StringArray{
    								pulumi.String("string"),
    							},
    							StringGroupRefs: pulumi.StringArray{
    								pulumi.String("string"),
    							},
    						},
    					},
    					Methods: avi.BotmappingMappingRuleMatchMethodArray{
    						&avi.BotmappingMappingRuleMatchMethodArgs{
    							MatchCriteria: pulumi.String("string"),
    							Methods: pulumi.StringArray{
    								pulumi.String("string"),
    							},
    						},
    					},
    					Paths: avi.BotmappingMappingRuleMatchPathArray{
    						&avi.BotmappingMappingRuleMatchPathArgs{
    							MatchCriteria:      pulumi.String("string"),
    							MatchCase:          pulumi.String("string"),
    							MatchDecodedString: pulumi.String("string"),
    							MatchStrs: pulumi.StringArray{
    								pulumi.String("string"),
    							},
    							StringGroupRefs: pulumi.StringArray{
    								pulumi.String("string"),
    							},
    						},
    					},
    					TypeMatchers: avi.BotmappingMappingRuleMatchTypeMatcherArray{
    						&avi.BotmappingMappingRuleMatchTypeMatcherArgs{
    							ClientTypes: pulumi.StringArray{
    								pulumi.String("string"),
    							},
    							Op: pulumi.String("string"),
    						},
    					},
    				},
    			},
    			Name: pulumi.String("string"),
    		},
    	},
    	Name:      pulumi.String("string"),
    	TenantRef: pulumi.String("string"),
    	Uuid:      pulumi.String("string"),
    })
    
    var botmappingResource = new Botmapping("botmappingResource", BotmappingArgs.builder()
        .botmappingId("string")
        .mappingRules(BotmappingMappingRuleArgs.builder()
            .classifications(BotmappingMappingRuleClassificationArgs.builder()
                .type("string")
                .userDefinedType("string")
                .build())
            .index("string")
            .matches(BotmappingMappingRuleMatchArgs.builder()
                .classMatchers(BotmappingMappingRuleMatchClassMatcherArgs.builder()
                    .clientClasses("string")
                    .op("string")
                    .build())
                .clientIps(BotmappingMappingRuleMatchClientIpArgs.builder()
                    .matchCriteria("string")
                    .addrs(BotmappingMappingRuleMatchClientIpAddrArgs.builder()
                        .addr("string")
                        .type("string")
                        .build())
                    .groupRefs("string")
                    .prefixes(BotmappingMappingRuleMatchClientIpPrefixArgs.builder()
                        .ipAddrs(BotmappingMappingRuleMatchClientIpPrefixIpAddrArgs.builder()
                            .addr("string")
                            .type("string")
                            .build())
                        .mask("string")
                        .build())
                    .ranges(BotmappingMappingRuleMatchClientIpRangeArgs.builder()
                        .begins(BotmappingMappingRuleMatchClientIpRangeBeginArgs.builder()
                            .addr("string")
                            .type("string")
                            .build())
                        .ends(BotmappingMappingRuleMatchClientIpRangeEndArgs.builder()
                            .addr("string")
                            .type("string")
                            .build())
                        .build())
                    .build())
                .componentMatcher("string")
                .hdrs(BotmappingMappingRuleMatchHdrArgs.builder()
                    .hdr("string")
                    .matchCriteria("string")
                    .matchCase("string")
                    .stringGroupRefs("string")
                    .values("string")
                    .build())
                .hostHdrs(BotmappingMappingRuleMatchHostHdrArgs.builder()
                    .matchCriteria("string")
                    .matchCase("string")
                    .values("string")
                    .build())
                .identifierMatchers(BotmappingMappingRuleMatchIdentifierMatcherArgs.builder()
                    .matchCriteria("string")
                    .matchStrs("string")
                    .stringGroupRefs("string")
                    .build())
                .methods(BotmappingMappingRuleMatchMethodArgs.builder()
                    .matchCriteria("string")
                    .methods("string")
                    .build())
                .paths(BotmappingMappingRuleMatchPathArgs.builder()
                    .matchCriteria("string")
                    .matchCase("string")
                    .matchDecodedString("string")
                    .matchStrs("string")
                    .stringGroupRefs("string")
                    .build())
                .typeMatchers(BotmappingMappingRuleMatchTypeMatcherArgs.builder()
                    .clientTypes("string")
                    .op("string")
                    .build())
                .build())
            .name("string")
            .build())
        .name("string")
        .tenantRef("string")
        .uuid("string")
        .build());
    
    botmapping_resource = avi.Botmapping("botmappingResource",
        botmapping_id="string",
        mapping_rules=[{
            "classifications": [{
                "type": "string",
                "user_defined_type": "string",
            }],
            "index": "string",
            "matches": [{
                "class_matchers": [{
                    "client_classes": ["string"],
                    "op": "string",
                }],
                "client_ips": [{
                    "match_criteria": "string",
                    "addrs": [{
                        "addr": "string",
                        "type": "string",
                    }],
                    "group_refs": ["string"],
                    "prefixes": [{
                        "ip_addrs": [{
                            "addr": "string",
                            "type": "string",
                        }],
                        "mask": "string",
                    }],
                    "ranges": [{
                        "begins": [{
                            "addr": "string",
                            "type": "string",
                        }],
                        "ends": [{
                            "addr": "string",
                            "type": "string",
                        }],
                    }],
                }],
                "component_matcher": "string",
                "hdrs": [{
                    "hdr": "string",
                    "match_criteria": "string",
                    "match_case": "string",
                    "string_group_refs": ["string"],
                    "values": ["string"],
                }],
                "host_hdrs": [{
                    "match_criteria": "string",
                    "match_case": "string",
                    "values": ["string"],
                }],
                "identifier_matchers": [{
                    "match_criteria": "string",
                    "match_strs": ["string"],
                    "string_group_refs": ["string"],
                }],
                "methods": [{
                    "match_criteria": "string",
                    "methods": ["string"],
                }],
                "paths": [{
                    "match_criteria": "string",
                    "match_case": "string",
                    "match_decoded_string": "string",
                    "match_strs": ["string"],
                    "string_group_refs": ["string"],
                }],
                "type_matchers": [{
                    "client_types": ["string"],
                    "op": "string",
                }],
            }],
            "name": "string",
        }],
        name="string",
        tenant_ref="string",
        uuid="string")
    
    const botmappingResource = new avi.Botmapping("botmappingResource", {
        botmappingId: "string",
        mappingRules: [{
            classifications: [{
                type: "string",
                userDefinedType: "string",
            }],
            index: "string",
            matches: [{
                classMatchers: [{
                    clientClasses: ["string"],
                    op: "string",
                }],
                clientIps: [{
                    matchCriteria: "string",
                    addrs: [{
                        addr: "string",
                        type: "string",
                    }],
                    groupRefs: ["string"],
                    prefixes: [{
                        ipAddrs: [{
                            addr: "string",
                            type: "string",
                        }],
                        mask: "string",
                    }],
                    ranges: [{
                        begins: [{
                            addr: "string",
                            type: "string",
                        }],
                        ends: [{
                            addr: "string",
                            type: "string",
                        }],
                    }],
                }],
                componentMatcher: "string",
                hdrs: [{
                    hdr: "string",
                    matchCriteria: "string",
                    matchCase: "string",
                    stringGroupRefs: ["string"],
                    values: ["string"],
                }],
                hostHdrs: [{
                    matchCriteria: "string",
                    matchCase: "string",
                    values: ["string"],
                }],
                identifierMatchers: [{
                    matchCriteria: "string",
                    matchStrs: ["string"],
                    stringGroupRefs: ["string"],
                }],
                methods: [{
                    matchCriteria: "string",
                    methods: ["string"],
                }],
                paths: [{
                    matchCriteria: "string",
                    matchCase: "string",
                    matchDecodedString: "string",
                    matchStrs: ["string"],
                    stringGroupRefs: ["string"],
                }],
                typeMatchers: [{
                    clientTypes: ["string"],
                    op: "string",
                }],
            }],
            name: "string",
        }],
        name: "string",
        tenantRef: "string",
        uuid: "string",
    });
    
    type: avi:Botmapping
    properties:
        botmappingId: string
        mappingRules:
            - classifications:
                - type: string
                  userDefinedType: string
              index: string
              matches:
                - classMatchers:
                    - clientClasses:
                        - string
                      op: string
                  clientIps:
                    - addrs:
                        - addr: string
                          type: string
                      groupRefs:
                        - string
                      matchCriteria: string
                      prefixes:
                        - ipAddrs:
                            - addr: string
                              type: string
                          mask: string
                      ranges:
                        - begins:
                            - addr: string
                              type: string
                          ends:
                            - addr: string
                              type: string
                  componentMatcher: string
                  hdrs:
                    - hdr: string
                      matchCase: string
                      matchCriteria: string
                      stringGroupRefs:
                        - string
                      values:
                        - string
                  hostHdrs:
                    - matchCase: string
                      matchCriteria: string
                      values:
                        - string
                  identifierMatchers:
                    - matchCriteria: string
                      matchStrs:
                        - string
                      stringGroupRefs:
                        - string
                  methods:
                    - matchCriteria: string
                      methods:
                        - string
                  paths:
                    - matchCase: string
                      matchCriteria: string
                      matchDecodedString: string
                      matchStrs:
                        - string
                      stringGroupRefs:
                        - string
                  typeMatchers:
                    - clientTypes:
                        - string
                      op: string
              name: string
        name: string
        tenantRef: string
        uuid: string
    

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

    BotmappingId string
    MappingRules List<BotmappingMappingRule>
    Rules for bot classification. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Name string
    The name of this mapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    TenantRef string
    The unique identifier of the tenant to which this mapping belongs. It is a reference to an object of type tenant. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Uuid string
    A unique identifier for this mapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    BotmappingId string
    MappingRules []BotmappingMappingRuleArgs
    Rules for bot classification. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Name string
    The name of this mapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    TenantRef string
    The unique identifier of the tenant to which this mapping belongs. It is a reference to an object of type tenant. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Uuid string
    A unique identifier for this mapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    botmappingId String
    mappingRules List<BotmappingMappingRule>
    Rules for bot classification. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    name String
    The name of this mapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    tenantRef String
    The unique identifier of the tenant to which this mapping belongs. It is a reference to an object of type tenant. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    uuid String
    A unique identifier for this mapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    botmappingId string
    mappingRules BotmappingMappingRule[]
    Rules for bot classification. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    name string
    The name of this mapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    tenantRef string
    The unique identifier of the tenant to which this mapping belongs. It is a reference to an object of type tenant. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    uuid string
    A unique identifier for this mapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    botmapping_id str
    mapping_rules Sequence[BotmappingMappingRuleArgs]
    Rules for bot classification. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    name str
    The name of this mapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    tenant_ref str
    The unique identifier of the tenant to which this mapping belongs. It is a reference to an object of type tenant. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    uuid str
    A unique identifier for this mapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    botmappingId String
    mappingRules List<Property Map>
    Rules for bot classification. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    name String
    The name of this mapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    tenantRef String
    The unique identifier of the tenant to which this mapping belongs. It is a reference to an object of type tenant. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    uuid String
    A unique identifier for this mapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.

    Outputs

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

    Get an existing Botmapping 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?: BotmappingState, opts?: CustomResourceOptions): Botmapping
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            botmapping_id: Optional[str] = None,
            mapping_rules: Optional[Sequence[BotmappingMappingRuleArgs]] = None,
            name: Optional[str] = None,
            tenant_ref: Optional[str] = None,
            uuid: Optional[str] = None) -> Botmapping
    func GetBotmapping(ctx *Context, name string, id IDInput, state *BotmappingState, opts ...ResourceOption) (*Botmapping, error)
    public static Botmapping Get(string name, Input<string> id, BotmappingState? state, CustomResourceOptions? opts = null)
    public static Botmapping get(String name, Output<String> id, BotmappingState state, CustomResourceOptions options)
    resources:  _:    type: avi:Botmapping    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.
    The following state arguments are supported:
    BotmappingId string
    MappingRules List<BotmappingMappingRule>
    Rules for bot classification. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Name string
    The name of this mapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    TenantRef string
    The unique identifier of the tenant to which this mapping belongs. It is a reference to an object of type tenant. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Uuid string
    A unique identifier for this mapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    BotmappingId string
    MappingRules []BotmappingMappingRuleArgs
    Rules for bot classification. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Name string
    The name of this mapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    TenantRef string
    The unique identifier of the tenant to which this mapping belongs. It is a reference to an object of type tenant. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Uuid string
    A unique identifier for this mapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    botmappingId String
    mappingRules List<BotmappingMappingRule>
    Rules for bot classification. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    name String
    The name of this mapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    tenantRef String
    The unique identifier of the tenant to which this mapping belongs. It is a reference to an object of type tenant. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    uuid String
    A unique identifier for this mapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    botmappingId string
    mappingRules BotmappingMappingRule[]
    Rules for bot classification. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    name string
    The name of this mapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    tenantRef string
    The unique identifier of the tenant to which this mapping belongs. It is a reference to an object of type tenant. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    uuid string
    A unique identifier for this mapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    botmapping_id str
    mapping_rules Sequence[BotmappingMappingRuleArgs]
    Rules for bot classification. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    name str
    The name of this mapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    tenant_ref str
    The unique identifier of the tenant to which this mapping belongs. It is a reference to an object of type tenant. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    uuid str
    A unique identifier for this mapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    botmappingId String
    mappingRules List<Property Map>
    Rules for bot classification. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    name String
    The name of this mapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    tenantRef String
    The unique identifier of the tenant to which this mapping belongs. It is a reference to an object of type tenant. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    uuid String
    A unique identifier for this mapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.

    Supporting Types

    BotmappingMappingRule, BotmappingMappingRuleArgs

    Classifications List<BotmappingMappingRuleClassification>
    Index string
    Matches List<BotmappingMappingRuleMatch>
    Name string
    The name of this mapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Classifications []BotmappingMappingRuleClassification
    Index string
    Matches []BotmappingMappingRuleMatch
    Name string
    The name of this mapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    classifications List<BotmappingMappingRuleClassification>
    index String
    matches List<BotmappingMappingRuleMatch>
    name String
    The name of this mapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    classifications BotmappingMappingRuleClassification[]
    index string
    matches BotmappingMappingRuleMatch[]
    name string
    The name of this mapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    classifications Sequence[BotmappingMappingRuleClassification]
    index str
    matches Sequence[BotmappingMappingRuleMatch]
    name str
    The name of this mapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    classifications List<Property Map>
    index String
    matches List<Property Map>
    name String
    The name of this mapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.

    BotmappingMappingRuleClassification, BotmappingMappingRuleClassificationArgs

    Type string
    UserDefinedType string
    Type string
    UserDefinedType string
    type String
    userDefinedType String
    type string
    userDefinedType string
    type String
    userDefinedType String

    BotmappingMappingRuleMatch, BotmappingMappingRuleMatchArgs

    BotmappingMappingRuleMatchClassMatcher, BotmappingMappingRuleMatchClassMatcherArgs

    ClientClasses List<string>
    Op string
    ClientClasses []string
    Op string
    clientClasses List<String>
    op String
    clientClasses string[]
    op string
    client_classes Sequence[str]
    op str
    clientClasses List<String>
    op String

    BotmappingMappingRuleMatchClientIp, BotmappingMappingRuleMatchClientIpArgs

    BotmappingMappingRuleMatchClientIpAddr, BotmappingMappingRuleMatchClientIpAddrArgs

    Addr string
    Type string
    Addr string
    Type string
    addr String
    type String
    addr string
    type string
    addr str
    type str
    addr String
    type String

    BotmappingMappingRuleMatchClientIpPrefix, BotmappingMappingRuleMatchClientIpPrefixArgs

    BotmappingMappingRuleMatchClientIpPrefixIpAddr, BotmappingMappingRuleMatchClientIpPrefixIpAddrArgs

    Addr string
    Type string
    Addr string
    Type string
    addr String
    type String
    addr string
    type string
    addr str
    type str
    addr String
    type String

    BotmappingMappingRuleMatchClientIpRange, BotmappingMappingRuleMatchClientIpRangeArgs

    BotmappingMappingRuleMatchClientIpRangeBegin, BotmappingMappingRuleMatchClientIpRangeBeginArgs

    Addr string
    Type string
    Addr string
    Type string
    addr String
    type String
    addr string
    type string
    addr str
    type str
    addr String
    type String

    BotmappingMappingRuleMatchClientIpRangeEnd, BotmappingMappingRuleMatchClientIpRangeEndArgs

    Addr string
    Type string
    Addr string
    Type string
    addr String
    type String
    addr string
    type string
    addr str
    type str
    addr String
    type String

    BotmappingMappingRuleMatchHdr, BotmappingMappingRuleMatchHdrArgs

    Hdr string
    MatchCriteria string
    MatchCase string
    StringGroupRefs List<string>
    Values List<string>
    Hdr string
    MatchCriteria string
    MatchCase string
    StringGroupRefs []string
    Values []string
    hdr String
    matchCriteria String
    matchCase String
    stringGroupRefs List<String>
    values List<String>
    hdr string
    matchCriteria string
    matchCase string
    stringGroupRefs string[]
    values string[]
    hdr str
    match_criteria str
    match_case str
    string_group_refs Sequence[str]
    values Sequence[str]
    hdr String
    matchCriteria String
    matchCase String
    stringGroupRefs List<String>
    values List<String>

    BotmappingMappingRuleMatchHostHdr, BotmappingMappingRuleMatchHostHdrArgs

    MatchCriteria string
    MatchCase string
    Values List<string>
    MatchCriteria string
    MatchCase string
    Values []string
    matchCriteria String
    matchCase String
    values List<String>
    matchCriteria string
    matchCase string
    values string[]
    match_criteria str
    match_case str
    values Sequence[str]
    matchCriteria String
    matchCase String
    values List<String>

    BotmappingMappingRuleMatchIdentifierMatcher, BotmappingMappingRuleMatchIdentifierMatcherArgs

    MatchCriteria string
    MatchStrs List<string>
    StringGroupRefs List<string>
    MatchCriteria string
    MatchStrs []string
    StringGroupRefs []string
    matchCriteria String
    matchStrs List<String>
    stringGroupRefs List<String>
    matchCriteria string
    matchStrs string[]
    stringGroupRefs string[]
    match_criteria str
    match_strs Sequence[str]
    string_group_refs Sequence[str]
    matchCriteria String
    matchStrs List<String>
    stringGroupRefs List<String>

    BotmappingMappingRuleMatchMethod, BotmappingMappingRuleMatchMethodArgs

    MatchCriteria string
    Methods List<string>
    MatchCriteria string
    Methods []string
    matchCriteria String
    methods List<String>
    matchCriteria string
    methods string[]
    match_criteria str
    methods Sequence[str]
    matchCriteria String
    methods List<String>

    BotmappingMappingRuleMatchPath, BotmappingMappingRuleMatchPathArgs

    MatchCriteria string
    MatchCase string
    MatchDecodedString string
    MatchStrs List<string>
    StringGroupRefs List<string>
    matchCriteria String
    matchCase String
    matchDecodedString String
    matchStrs List<String>
    stringGroupRefs List<String>
    matchCriteria String
    matchCase String
    matchDecodedString String
    matchStrs List<String>
    stringGroupRefs List<String>

    BotmappingMappingRuleMatchTypeMatcher, BotmappingMappingRuleMatchTypeMatcherArgs

    ClientTypes List<string>
    Op string
    ClientTypes []string
    Op string
    clientTypes List<String>
    op String
    clientTypes string[]
    op string
    client_types Sequence[str]
    op str
    clientTypes List<String>
    op String

    Package Details

    Repository
    avi vmware/terraform-provider-avi
    License
    Notes
    This Pulumi package is based on the avi Terraform Provider.
    avi logo
    avi 31.1.1 published on Monday, Apr 14, 2025 by vmware