1. Packages
  2. Meraki Provider
  3. API Docs
  4. organizations
  5. PolicyObjects
Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 by Pulumi

meraki.organizations.PolicyObjects

Explore with Pulumi AI

meraki logo
Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as meraki from "@pulumi/meraki";
    
    const example = new meraki.organizations.PolicyObjects("example", {
        category: "network",
        cidr: "10.0.0.0/24",
        fqdn: "example.com",
        groupIds: ["8"],
        ip: "1.2.3.4",
        mask: "255.255.0.0",
        name: "Web Servers - Datacenter 10",
        organizationId: "string",
        type: "cidr",
    });
    export const merakiOrganizationsPolicyObjectsExample = example;
    
    import pulumi
    import pulumi_meraki as meraki
    
    example = meraki.organizations.PolicyObjects("example",
        category="network",
        cidr="10.0.0.0/24",
        fqdn="example.com",
        group_ids=["8"],
        ip="1.2.3.4",
        mask="255.255.0.0",
        name="Web Servers - Datacenter 10",
        organization_id="string",
        type="cidr")
    pulumi.export("merakiOrganizationsPolicyObjectsExample", example)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-meraki/sdk/go/meraki/organizations"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := organizations.NewPolicyObjects(ctx, "example", &organizations.PolicyObjectsArgs{
    			Category: pulumi.String("network"),
    			Cidr:     pulumi.String("10.0.0.0/24"),
    			Fqdn:     pulumi.String("example.com"),
    			GroupIds: pulumi.StringArray{
    				pulumi.String("8"),
    			},
    			Ip:             pulumi.String("1.2.3.4"),
    			Mask:           pulumi.String("255.255.0.0"),
    			Name:           pulumi.String("Web Servers - Datacenter 10"),
    			OrganizationId: pulumi.String("string"),
    			Type:           pulumi.String("cidr"),
    		})
    		if err != nil {
    			return err
    		}
    		ctx.Export("merakiOrganizationsPolicyObjectsExample", example)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Meraki = Pulumi.Meraki;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Meraki.Organizations.PolicyObjects("example", new()
        {
            Category = "network",
            Cidr = "10.0.0.0/24",
            Fqdn = "example.com",
            GroupIds = new[]
            {
                "8",
            },
            Ip = "1.2.3.4",
            Mask = "255.255.0.0",
            Name = "Web Servers - Datacenter 10",
            OrganizationId = "string",
            Type = "cidr",
        });
    
        return new Dictionary<string, object?>
        {
            ["merakiOrganizationsPolicyObjectsExample"] = example,
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.meraki.organizations.PolicyObjects;
    import com.pulumi.meraki.organizations.PolicyObjectsArgs;
    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 PolicyObjects("example", PolicyObjectsArgs.builder()
                .category("network")
                .cidr("10.0.0.0/24")
                .fqdn("example.com")
                .groupIds("8")
                .ip("1.2.3.4")
                .mask("255.255.0.0")
                .name("Web Servers - Datacenter 10")
                .organizationId("string")
                .type("cidr")
                .build());
    
            ctx.export("merakiOrganizationsPolicyObjectsExample", example);
        }
    }
    
    resources:
      example:
        type: meraki:organizations:PolicyObjects
        properties:
          category: network
          cidr: 10.0.0.0/24
          fqdn: example.com
          groupIds:
            - '8'
          ip: 1.2.3.4
          mask: 255.255.0.0
          name: Web Servers - Datacenter 10
          organizationId: string
          type: cidr
    outputs:
      merakiOrganizationsPolicyObjectsExample: ${example}
    

    Create PolicyObjects Resource

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

    Constructor syntax

    new PolicyObjects(name: string, args: PolicyObjectsArgs, opts?: CustomResourceOptions);
    @overload
    def PolicyObjects(resource_name: str,
                      args: PolicyObjectsArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def PolicyObjects(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      organization_id: Optional[str] = None,
                      category: Optional[str] = None,
                      cidr: Optional[str] = None,
                      fqdn: Optional[str] = None,
                      group_ids: Optional[Sequence[str]] = None,
                      ip: Optional[str] = None,
                      mask: Optional[str] = None,
                      name: Optional[str] = None,
                      policy_object_id: Optional[str] = None,
                      type: Optional[str] = None)
    func NewPolicyObjects(ctx *Context, name string, args PolicyObjectsArgs, opts ...ResourceOption) (*PolicyObjects, error)
    public PolicyObjects(string name, PolicyObjectsArgs args, CustomResourceOptions? opts = null)
    public PolicyObjects(String name, PolicyObjectsArgs args)
    public PolicyObjects(String name, PolicyObjectsArgs args, CustomResourceOptions options)
    
    type: meraki:organizations:PolicyObjects
    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 PolicyObjectsArgs
    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 PolicyObjectsArgs
    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 PolicyObjectsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyObjectsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyObjectsArgs
    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 policyObjectsResource = new Meraki.Organizations.PolicyObjects("policyObjectsResource", new()
    {
        OrganizationId = "string",
        Category = "string",
        Cidr = "string",
        Fqdn = "string",
        GroupIds = new[]
        {
            "string",
        },
        Ip = "string",
        Mask = "string",
        Name = "string",
        PolicyObjectId = "string",
        Type = "string",
    });
    
    example, err := organizations.NewPolicyObjects(ctx, "policyObjectsResource", &organizations.PolicyObjectsArgs{
    	OrganizationId: pulumi.String("string"),
    	Category:       pulumi.String("string"),
    	Cidr:           pulumi.String("string"),
    	Fqdn:           pulumi.String("string"),
    	GroupIds: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Ip:             pulumi.String("string"),
    	Mask:           pulumi.String("string"),
    	Name:           pulumi.String("string"),
    	PolicyObjectId: pulumi.String("string"),
    	Type:           pulumi.String("string"),
    })
    
    var policyObjectsResource = new PolicyObjects("policyObjectsResource", PolicyObjectsArgs.builder()
        .organizationId("string")
        .category("string")
        .cidr("string")
        .fqdn("string")
        .groupIds("string")
        .ip("string")
        .mask("string")
        .name("string")
        .policyObjectId("string")
        .type("string")
        .build());
    
    policy_objects_resource = meraki.organizations.PolicyObjects("policyObjectsResource",
        organization_id="string",
        category="string",
        cidr="string",
        fqdn="string",
        group_ids=["string"],
        ip="string",
        mask="string",
        name="string",
        policy_object_id="string",
        type="string")
    
    const policyObjectsResource = new meraki.organizations.PolicyObjects("policyObjectsResource", {
        organizationId: "string",
        category: "string",
        cidr: "string",
        fqdn: "string",
        groupIds: ["string"],
        ip: "string",
        mask: "string",
        name: "string",
        policyObjectId: "string",
        type: "string",
    });
    
    type: meraki:organizations:PolicyObjects
    properties:
        category: string
        cidr: string
        fqdn: string
        groupIds:
            - string
        ip: string
        mask: string
        name: string
        organizationId: string
        policyObjectId: string
        type: string
    

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

    OrganizationId string
    organizationId path parameter. Organization ID
    Category string
    Category of a policy object (one of: adaptivePolicy, network)
    Cidr string
    CIDR Value of a policy object (e.g. 10.11.12.1/24")
    Fqdn string
    Fully qualified domain name of policy object (e.g. "example.com")
    GroupIds List<string>
    The IDs of policy object groups the policy object belongs to
    Ip string
    IP Address of a policy object (e.g. "1.2.3.4")
    Mask string
    Mask of a policy object (e.g. "255.255.0.0")
    Name string
    Name of a policy object, unique within the organization (alphanumeric, space, dash, or underscore characters only)
    PolicyObjectId string
    policyObjectId path parameter. Policy object ID
    Type string
    Type of a policy object (one of: adaptivePolicyIpv4Cidr, cidr, fqdn, ipAndMask)
    OrganizationId string
    organizationId path parameter. Organization ID
    Category string
    Category of a policy object (one of: adaptivePolicy, network)
    Cidr string
    CIDR Value of a policy object (e.g. 10.11.12.1/24")
    Fqdn string
    Fully qualified domain name of policy object (e.g. "example.com")
    GroupIds []string
    The IDs of policy object groups the policy object belongs to
    Ip string
    IP Address of a policy object (e.g. "1.2.3.4")
    Mask string
    Mask of a policy object (e.g. "255.255.0.0")
    Name string
    Name of a policy object, unique within the organization (alphanumeric, space, dash, or underscore characters only)
    PolicyObjectId string
    policyObjectId path parameter. Policy object ID
    Type string
    Type of a policy object (one of: adaptivePolicyIpv4Cidr, cidr, fqdn, ipAndMask)
    organizationId String
    organizationId path parameter. Organization ID
    category String
    Category of a policy object (one of: adaptivePolicy, network)
    cidr String
    CIDR Value of a policy object (e.g. 10.11.12.1/24")
    fqdn String
    Fully qualified domain name of policy object (e.g. "example.com")
    groupIds List<String>
    The IDs of policy object groups the policy object belongs to
    ip String
    IP Address of a policy object (e.g. "1.2.3.4")
    mask String
    Mask of a policy object (e.g. "255.255.0.0")
    name String
    Name of a policy object, unique within the organization (alphanumeric, space, dash, or underscore characters only)
    policyObjectId String
    policyObjectId path parameter. Policy object ID
    type String
    Type of a policy object (one of: adaptivePolicyIpv4Cidr, cidr, fqdn, ipAndMask)
    organizationId string
    organizationId path parameter. Organization ID
    category string
    Category of a policy object (one of: adaptivePolicy, network)
    cidr string
    CIDR Value of a policy object (e.g. 10.11.12.1/24")
    fqdn string
    Fully qualified domain name of policy object (e.g. "example.com")
    groupIds string[]
    The IDs of policy object groups the policy object belongs to
    ip string
    IP Address of a policy object (e.g. "1.2.3.4")
    mask string
    Mask of a policy object (e.g. "255.255.0.0")
    name string
    Name of a policy object, unique within the organization (alphanumeric, space, dash, or underscore characters only)
    policyObjectId string
    policyObjectId path parameter. Policy object ID
    type string
    Type of a policy object (one of: adaptivePolicyIpv4Cidr, cidr, fqdn, ipAndMask)
    organization_id str
    organizationId path parameter. Organization ID
    category str
    Category of a policy object (one of: adaptivePolicy, network)
    cidr str
    CIDR Value of a policy object (e.g. 10.11.12.1/24")
    fqdn str
    Fully qualified domain name of policy object (e.g. "example.com")
    group_ids Sequence[str]
    The IDs of policy object groups the policy object belongs to
    ip str
    IP Address of a policy object (e.g. "1.2.3.4")
    mask str
    Mask of a policy object (e.g. "255.255.0.0")
    name str
    Name of a policy object, unique within the organization (alphanumeric, space, dash, or underscore characters only)
    policy_object_id str
    policyObjectId path parameter. Policy object ID
    type str
    Type of a policy object (one of: adaptivePolicyIpv4Cidr, cidr, fqdn, ipAndMask)
    organizationId String
    organizationId path parameter. Organization ID
    category String
    Category of a policy object (one of: adaptivePolicy, network)
    cidr String
    CIDR Value of a policy object (e.g. 10.11.12.1/24")
    fqdn String
    Fully qualified domain name of policy object (e.g. "example.com")
    groupIds List<String>
    The IDs of policy object groups the policy object belongs to
    ip String
    IP Address of a policy object (e.g. "1.2.3.4")
    mask String
    Mask of a policy object (e.g. "255.255.0.0")
    name String
    Name of a policy object, unique within the organization (alphanumeric, space, dash, or underscore characters only)
    policyObjectId String
    policyObjectId path parameter. Policy object ID
    type String
    Type of a policy object (one of: adaptivePolicyIpv4Cidr, cidr, fqdn, ipAndMask)

    Outputs

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

    CreatedAt string
    Id string
    The provider-assigned unique ID for this managed resource.
    NetworkIds List<string>
    UpdatedAt string
    CreatedAt string
    Id string
    The provider-assigned unique ID for this managed resource.
    NetworkIds []string
    UpdatedAt string
    createdAt String
    id String
    The provider-assigned unique ID for this managed resource.
    networkIds List<String>
    updatedAt String
    createdAt string
    id string
    The provider-assigned unique ID for this managed resource.
    networkIds string[]
    updatedAt string
    created_at str
    id str
    The provider-assigned unique ID for this managed resource.
    network_ids Sequence[str]
    updated_at str
    createdAt String
    id String
    The provider-assigned unique ID for this managed resource.
    networkIds List<String>
    updatedAt String

    Look up Existing PolicyObjects Resource

    Get an existing PolicyObjects 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?: PolicyObjectsState, opts?: CustomResourceOptions): PolicyObjects
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            category: Optional[str] = None,
            cidr: Optional[str] = None,
            created_at: Optional[str] = None,
            fqdn: Optional[str] = None,
            group_ids: Optional[Sequence[str]] = None,
            ip: Optional[str] = None,
            mask: Optional[str] = None,
            name: Optional[str] = None,
            network_ids: Optional[Sequence[str]] = None,
            organization_id: Optional[str] = None,
            policy_object_id: Optional[str] = None,
            type: Optional[str] = None,
            updated_at: Optional[str] = None) -> PolicyObjects
    func GetPolicyObjects(ctx *Context, name string, id IDInput, state *PolicyObjectsState, opts ...ResourceOption) (*PolicyObjects, error)
    public static PolicyObjects Get(string name, Input<string> id, PolicyObjectsState? state, CustomResourceOptions? opts = null)
    public static PolicyObjects get(String name, Output<String> id, PolicyObjectsState 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:
    Category string
    Category of a policy object (one of: adaptivePolicy, network)
    Cidr string
    CIDR Value of a policy object (e.g. 10.11.12.1/24")
    CreatedAt string
    Fqdn string
    Fully qualified domain name of policy object (e.g. "example.com")
    GroupIds List<string>
    The IDs of policy object groups the policy object belongs to
    Ip string
    IP Address of a policy object (e.g. "1.2.3.4")
    Mask string
    Mask of a policy object (e.g. "255.255.0.0")
    Name string
    Name of a policy object, unique within the organization (alphanumeric, space, dash, or underscore characters only)
    NetworkIds List<string>
    OrganizationId string
    organizationId path parameter. Organization ID
    PolicyObjectId string
    policyObjectId path parameter. Policy object ID
    Type string
    Type of a policy object (one of: adaptivePolicyIpv4Cidr, cidr, fqdn, ipAndMask)
    UpdatedAt string
    Category string
    Category of a policy object (one of: adaptivePolicy, network)
    Cidr string
    CIDR Value of a policy object (e.g. 10.11.12.1/24")
    CreatedAt string
    Fqdn string
    Fully qualified domain name of policy object (e.g. "example.com")
    GroupIds []string
    The IDs of policy object groups the policy object belongs to
    Ip string
    IP Address of a policy object (e.g. "1.2.3.4")
    Mask string
    Mask of a policy object (e.g. "255.255.0.0")
    Name string
    Name of a policy object, unique within the organization (alphanumeric, space, dash, or underscore characters only)
    NetworkIds []string
    OrganizationId string
    organizationId path parameter. Organization ID
    PolicyObjectId string
    policyObjectId path parameter. Policy object ID
    Type string
    Type of a policy object (one of: adaptivePolicyIpv4Cidr, cidr, fqdn, ipAndMask)
    UpdatedAt string
    category String
    Category of a policy object (one of: adaptivePolicy, network)
    cidr String
    CIDR Value of a policy object (e.g. 10.11.12.1/24")
    createdAt String
    fqdn String
    Fully qualified domain name of policy object (e.g. "example.com")
    groupIds List<String>
    The IDs of policy object groups the policy object belongs to
    ip String
    IP Address of a policy object (e.g. "1.2.3.4")
    mask String
    Mask of a policy object (e.g. "255.255.0.0")
    name String
    Name of a policy object, unique within the organization (alphanumeric, space, dash, or underscore characters only)
    networkIds List<String>
    organizationId String
    organizationId path parameter. Organization ID
    policyObjectId String
    policyObjectId path parameter. Policy object ID
    type String
    Type of a policy object (one of: adaptivePolicyIpv4Cidr, cidr, fqdn, ipAndMask)
    updatedAt String
    category string
    Category of a policy object (one of: adaptivePolicy, network)
    cidr string
    CIDR Value of a policy object (e.g. 10.11.12.1/24")
    createdAt string
    fqdn string
    Fully qualified domain name of policy object (e.g. "example.com")
    groupIds string[]
    The IDs of policy object groups the policy object belongs to
    ip string
    IP Address of a policy object (e.g. "1.2.3.4")
    mask string
    Mask of a policy object (e.g. "255.255.0.0")
    name string
    Name of a policy object, unique within the organization (alphanumeric, space, dash, or underscore characters only)
    networkIds string[]
    organizationId string
    organizationId path parameter. Organization ID
    policyObjectId string
    policyObjectId path parameter. Policy object ID
    type string
    Type of a policy object (one of: adaptivePolicyIpv4Cidr, cidr, fqdn, ipAndMask)
    updatedAt string
    category str
    Category of a policy object (one of: adaptivePolicy, network)
    cidr str
    CIDR Value of a policy object (e.g. 10.11.12.1/24")
    created_at str
    fqdn str
    Fully qualified domain name of policy object (e.g. "example.com")
    group_ids Sequence[str]
    The IDs of policy object groups the policy object belongs to
    ip str
    IP Address of a policy object (e.g. "1.2.3.4")
    mask str
    Mask of a policy object (e.g. "255.255.0.0")
    name str
    Name of a policy object, unique within the organization (alphanumeric, space, dash, or underscore characters only)
    network_ids Sequence[str]
    organization_id str
    organizationId path parameter. Organization ID
    policy_object_id str
    policyObjectId path parameter. Policy object ID
    type str
    Type of a policy object (one of: adaptivePolicyIpv4Cidr, cidr, fqdn, ipAndMask)
    updated_at str
    category String
    Category of a policy object (one of: adaptivePolicy, network)
    cidr String
    CIDR Value of a policy object (e.g. 10.11.12.1/24")
    createdAt String
    fqdn String
    Fully qualified domain name of policy object (e.g. "example.com")
    groupIds List<String>
    The IDs of policy object groups the policy object belongs to
    ip String
    IP Address of a policy object (e.g. "1.2.3.4")
    mask String
    Mask of a policy object (e.g. "255.255.0.0")
    name String
    Name of a policy object, unique within the organization (alphanumeric, space, dash, or underscore characters only)
    networkIds List<String>
    organizationId String
    organizationId path parameter. Organization ID
    policyObjectId String
    policyObjectId path parameter. Policy object ID
    type String
    Type of a policy object (one of: adaptivePolicyIpv4Cidr, cidr, fqdn, ipAndMask)
    updatedAt String

    Import

    $ pulumi import meraki:organizations/policyObjects:PolicyObjects example "organization_id,policy_object_id"
    

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

    Package Details

    Repository
    meraki pulumi/pulumi-meraki
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the meraki Terraform Provider.
    meraki logo
    Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 by Pulumi