Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fortimanager Provider
  3. API Docs
  4. ObjectRouterCommunitylist
fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager

fortimanager.ObjectRouterCommunitylist

Explore with Pulumi AI

fortimanager logo
fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager

    Configure community lists.

    The following variables have sub resource. Avoid using them together, otherwise conflicts and overwrites may occur.

    • rule: fortimanager.ObjectRouterCommunitylistRule

    Example Usage

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

const trname = new fortimanager.ObjectRouterCommunitylist("trname", {rules: [{
    action: "permit",
    id: 1,
}]});

    import pulumi
import pulumi_fortimanager as fortimanager

trname = fortimanager.ObjectRouterCommunitylist("trname", rules=[{
    "action": "permit",
    "id": 1,
}])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/fortimanager/fortimanager"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fortimanager.NewObjectRouterCommunitylist(ctx, "trname", &fortimanager.ObjectRouterCommunitylistArgs{
			Rules: fortimanager.ObjectRouterCommunitylistRuleTypeArray{
				&fortimanager.ObjectRouterCommunitylistRuleTypeArgs{
					Action: pulumi.String("permit"),
					Id:     pulumi.Float64(1),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var trname = new Fortimanager.ObjectRouterCommunitylist("trname", new()
    {
        Rules = new[]
        {
            new Fortimanager.Inputs.ObjectRouterCommunitylistRuleArgs
            {
                Action = "permit",
                Id = 1,
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortimanager.ObjectRouterCommunitylist;
import com.pulumi.fortimanager.ObjectRouterCommunitylistArgs;
import com.pulumi.fortimanager.inputs.ObjectRouterCommunitylistRuleArgs;
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 trname = new ObjectRouterCommunitylist("trname", ObjectRouterCommunitylistArgs.builder()
            .rules(ObjectRouterCommunitylistRuleArgs.builder()
                .action("permit")
                .id(1)
                .build())
            .build());

    }
}

    resources:
  trname:
    type: fortimanager:ObjectRouterCommunitylist
    properties:
      rules:
        - action: permit
          id: 1

    Create ObjectRouterCommunitylist Resource

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

    Constructor syntax

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

@overload
def ObjectRouterCommunitylist(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              adom: Optional[str] = None,
                              dynamic_sort_subtable: Optional[str] = None,
                              name: Optional[str] = None,
                              object_router_communitylist_id: Optional[str] = None,
                              rules: Optional[Sequence[ObjectRouterCommunitylistRuleArgs]] = None,
                              scopetype: Optional[str] = None,
                              type: Optional[str] = None)
    func NewObjectRouterCommunitylist(ctx *Context, name string, args *ObjectRouterCommunitylistArgs, opts ...ResourceOption) (*ObjectRouterCommunitylist, error)
    public ObjectRouterCommunitylist(string name, ObjectRouterCommunitylistArgs? args = null, CustomResourceOptions? opts = null)
    public ObjectRouterCommunitylist(String name, ObjectRouterCommunitylistArgs args)
public ObjectRouterCommunitylist(String name, ObjectRouterCommunitylistArgs args, CustomResourceOptions options)

    type: fortimanager:ObjectRouterCommunitylist
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 ObjectRouterCommunitylistArgs
    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 ObjectRouterCommunitylistArgs
    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 ObjectRouterCommunitylistArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ObjectRouterCommunitylistArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ObjectRouterCommunitylistArgs
    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 objectRouterCommunitylistResource = new Fortimanager.ObjectRouterCommunitylist("objectRouterCommunitylistResource", new()
{
    Adom = "string",
    DynamicSortSubtable = "string",
    Name = "string",
    ObjectRouterCommunitylistId = "string",
    Rules = new[]
    {
        new Fortimanager.Inputs.ObjectRouterCommunitylistRuleArgs
        {
            Action = "string",
            Id = 0,
            Match = "string",
            Regexp = "string",
        },
    },
    Scopetype = "string",
    Type = "string",
});

    example, err := fortimanager.NewObjectRouterCommunitylist(ctx, "objectRouterCommunitylistResource", &fortimanager.ObjectRouterCommunitylistArgs{
Adom: pulumi.String("string"),
DynamicSortSubtable: pulumi.String("string"),
Name: pulumi.String("string"),
ObjectRouterCommunitylistId: pulumi.String("string"),
Rules: .ObjectRouterCommunitylistRuleTypeArray{
&.ObjectRouterCommunitylistRuleTypeArgs{
Action: pulumi.String("string"),
Id: pulumi.Float64(0),
Match: pulumi.String("string"),
Regexp: pulumi.String("string"),
},
},
Scopetype: pulumi.String("string"),
Type: pulumi.String("string"),
})

    var objectRouterCommunitylistResource = new ObjectRouterCommunitylist("objectRouterCommunitylistResource", ObjectRouterCommunitylistArgs.builder()
    .adom("string")
    .dynamicSortSubtable("string")
    .name("string")
    .objectRouterCommunitylistId("string")
    .rules(ObjectRouterCommunitylistRuleArgs.builder()
        .action("string")
        .id(0)
        .match("string")
        .regexp("string")
        .build())
    .scopetype("string")
    .type("string")
    .build());

    object_router_communitylist_resource = fortimanager.ObjectRouterCommunitylist("objectRouterCommunitylistResource",
    adom="string",
    dynamic_sort_subtable="string",
    name="string",
    object_router_communitylist_id="string",
    rules=[{
        "action": "string",
        "id": 0,
        "match": "string",
        "regexp": "string",
    }],
    scopetype="string",
    type="string")

    const objectRouterCommunitylistResource = new fortimanager.ObjectRouterCommunitylist("objectRouterCommunitylistResource", {
    adom: "string",
    dynamicSortSubtable: "string",
    name: "string",
    objectRouterCommunitylistId: "string",
    rules: [{
        action: "string",
        id: 0,
        match: "string",
        regexp: "string",
    }],
    scopetype: "string",
    type: "string",
});

    type: fortimanager:ObjectRouterCommunitylist
properties:
    adom: string
    dynamicSortSubtable: string
    name: string
    objectRouterCommunitylistId: string
    rules:
        - action: string
          id: 0
          match: string
          regexp: string
    scopetype: string
    type: string

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

    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    DynamicSortSubtable string
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    Name string
    Community list name.
    ObjectRouterCommunitylistId string
    an identifier for the resource with format {{name}}.
    Rules List<ObjectRouterCommunitylistRule>
    Rule. The structure of rule block is documented below.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    Type string
    Community list type (standard or expanded). Valid values: standard, expanded.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    DynamicSortSubtable string
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    Name string
    Community list name.
    ObjectRouterCommunitylistId string
    an identifier for the resource with format {{name}}.
    Rules []ObjectRouterCommunitylistRuleTypeArgs
    Rule. The structure of rule block is documented below.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    Type string
    Community list type (standard or expanded). Valid values: standard, expanded.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    dynamicSortSubtable String
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    name String
    Community list name.
    objectRouterCommunitylistId String
    an identifier for the resource with format {{name}}.
    rules List<ObjectRouterCommunitylistRule>
    Rule. The structure of rule block is documented below.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    type String
    Community list type (standard or expanded). Valid values: standard, expanded.
    adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    dynamicSortSubtable string
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    name string
    Community list name.
    objectRouterCommunitylistId string
    an identifier for the resource with format {{name}}.
    rules ObjectRouterCommunitylistRule[]
    Rule. The structure of rule block is documented below.
    scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    type string
    Community list type (standard or expanded). Valid values: standard, expanded.
    adom str
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    dynamic_sort_subtable str
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    name str
    Community list name.
    object_router_communitylist_id str
    an identifier for the resource with format {{name}}.
    rules Sequence[ObjectRouterCommunitylistRuleArgs]
    Rule. The structure of rule block is documented below.
    scopetype str
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    type str
    Community list type (standard or expanded). Valid values: standard, expanded.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    dynamicSortSubtable String
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    name String
    Community list name.
    objectRouterCommunitylistId String
    an identifier for the resource with format {{name}}.
    rules List<Property Map>
    Rule. The structure of rule block is documented below.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    type String
    Community list type (standard or expanded). Valid values: standard, expanded.

    Outputs

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

    Get an existing ObjectRouterCommunitylist 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?: ObjectRouterCommunitylistState, opts?: CustomResourceOptions): ObjectRouterCommunitylist
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        adom: Optional[str] = None,
        dynamic_sort_subtable: Optional[str] = None,
        name: Optional[str] = None,
        object_router_communitylist_id: Optional[str] = None,
        rules: Optional[Sequence[ObjectRouterCommunitylistRuleArgs]] = None,
        scopetype: Optional[str] = None,
        type: Optional[str] = None) -> ObjectRouterCommunitylist
    func GetObjectRouterCommunitylist(ctx *Context, name string, id IDInput, state *ObjectRouterCommunitylistState, opts ...ResourceOption) (*ObjectRouterCommunitylist, error)
    public static ObjectRouterCommunitylist Get(string name, Input<string> id, ObjectRouterCommunitylistState? state, CustomResourceOptions? opts = null)
    public static ObjectRouterCommunitylist get(String name, Output<String> id, ObjectRouterCommunitylistState state, CustomResourceOptions options)
    resources:  _:    type: fortimanager:ObjectRouterCommunitylist    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:
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    DynamicSortSubtable string
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    Name string
    Community list name.
    ObjectRouterCommunitylistId string
    an identifier for the resource with format {{name}}.
    Rules List<ObjectRouterCommunitylistRule>
    Rule. The structure of rule block is documented below.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    Type string
    Community list type (standard or expanded). Valid values: standard, expanded.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    DynamicSortSubtable string
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    Name string
    Community list name.
    ObjectRouterCommunitylistId string
    an identifier for the resource with format {{name}}.
    Rules []ObjectRouterCommunitylistRuleTypeArgs
    Rule. The structure of rule block is documented below.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    Type string
    Community list type (standard or expanded). Valid values: standard, expanded.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    dynamicSortSubtable String
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    name String
    Community list name.
    objectRouterCommunitylistId String
    an identifier for the resource with format {{name}}.
    rules List<ObjectRouterCommunitylistRule>
    Rule. The structure of rule block is documented below.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    type String
    Community list type (standard or expanded). Valid values: standard, expanded.
    adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    dynamicSortSubtable string
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    name string
    Community list name.
    objectRouterCommunitylistId string
    an identifier for the resource with format {{name}}.
    rules ObjectRouterCommunitylistRule[]
    Rule. The structure of rule block is documented below.
    scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    type string
    Community list type (standard or expanded). Valid values: standard, expanded.
    adom str
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    dynamic_sort_subtable str
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    name str
    Community list name.
    object_router_communitylist_id str
    an identifier for the resource with format {{name}}.
    rules Sequence[ObjectRouterCommunitylistRuleArgs]
    Rule. The structure of rule block is documented below.
    scopetype str
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    type str
    Community list type (standard or expanded). Valid values: standard, expanded.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    dynamicSortSubtable String
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    name String
    Community list name.
    objectRouterCommunitylistId String
    an identifier for the resource with format {{name}}.
    rules List<Property Map>
    Rule. The structure of rule block is documented below.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    type String
    Community list type (standard or expanded). Valid values: standard, expanded.

    Supporting Types

    ObjectRouterCommunitylistRule, ObjectRouterCommunitylistRuleArgs

    Action string
    Permit or deny route-based operations, based on the route's COMMUNITY attribute. Valid values: deny, permit.
    Id double
    ID.
    Match string
    Community specifications for matching a reserved community.
    Regexp string
    Ordered list of COMMUNITY attributes as a regular expression.
    Action string
    Permit or deny route-based operations, based on the route's COMMUNITY attribute. Valid values: deny, permit.
    Id float64
    ID.
    Match string
    Community specifications for matching a reserved community.
    Regexp string
    Ordered list of COMMUNITY attributes as a regular expression.
    action String
    Permit or deny route-based operations, based on the route's COMMUNITY attribute. Valid values: deny, permit.
    id Double
    ID.
    match String
    Community specifications for matching a reserved community.
    regexp String
    Ordered list of COMMUNITY attributes as a regular expression.
    action string
    Permit or deny route-based operations, based on the route's COMMUNITY attribute. Valid values: deny, permit.
    id number
    ID.
    match string
    Community specifications for matching a reserved community.
    regexp string
    Ordered list of COMMUNITY attributes as a regular expression.
    action str
    Permit or deny route-based operations, based on the route's COMMUNITY attribute. Valid values: deny, permit.
    id float
    ID.
    match str
    Community specifications for matching a reserved community.
    regexp str
    Ordered list of COMMUNITY attributes as a regular expression.
    action String
    Permit or deny route-based operations, based on the route's COMMUNITY attribute. Valid values: deny, permit.
    id Number
    ID.
    match String
    Community specifications for matching a reserved community.
    regexp String
    Ordered list of COMMUNITY attributes as a regular expression.

    Import

    ObjectRouter CommunityList can be imported using any of these accepted formats:

    $ export “FORTIMANAGER_IMPORT_TABLE”=“true”

    $ pulumi import fortimanager:index/objectRouterCommunitylist:ObjectRouterCommunitylist labelname {{name}}

    $ unset “FORTIMANAGER_IMPORT_TABLE”

    -> Hint: The scopetype and adom for import will directly inherit the scopetype and adom configuration of the provider.

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

    Package Details

    Repository
    fortimanager fortinetdev/terraform-provider-fortimanager
    License
    Notes
    This Pulumi package is based on the fortimanager Terraform Provider.
    fortimanager logo
    fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
    fortinetdev/terraform-provider-fortimanager