Docs Packages
  1. Packages
  2. Cisco Catalyst SD-WAN
  3. API Docs
  4. MirrorPolicyObject
Cisco Catalyst SD-WAN v0.1.1 published on Friday, May 31, 2024 by Pulumi
pulumi/pulumi-sdwan

sdwan.MirrorPolicyObject

Explore with Pulumi AI

sdwan logo
Cisco Catalyst SD-WAN v0.1.1 published on Friday, May 31, 2024 by Pulumi
pulumi/pulumi-sdwan

    This resource can manage a Mirror Policy Object .

    Example Usage

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

const example = new sdwan.MirrorPolicyObject("example", {
    name: "Example",
    remoteDestinationIp: "10.1.1.1",
    sourceIp: "10.2.1.1",
});

    import pulumi
import pulumi_sdwan as sdwan

example = sdwan.MirrorPolicyObject("example",
    name="Example",
    remote_destination_ip="10.1.1.1",
    source_ip="10.2.1.1")

    package main

import (
	"github.com/pulumi/pulumi-sdwan/sdk/go/sdwan"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sdwan.NewMirrorPolicyObject(ctx, "example", &sdwan.MirrorPolicyObjectArgs{
			Name:                pulumi.String("Example"),
			RemoteDestinationIp: pulumi.String("10.1.1.1"),
			SourceIp:            pulumi.String("10.2.1.1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Sdwan.MirrorPolicyObject("example", new()
    {
        Name = "Example",
        RemoteDestinationIp = "10.1.1.1",
        SourceIp = "10.2.1.1",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sdwan.MirrorPolicyObject;
import com.pulumi.sdwan.MirrorPolicyObjectArgs;
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 MirrorPolicyObject("example", MirrorPolicyObjectArgs.builder()        
            .name("Example")
            .remoteDestinationIp("10.1.1.1")
            .sourceIp("10.2.1.1")
            .build());

    }
}

    resources:
  example:
    type: sdwan:MirrorPolicyObject
    properties:
      name: Example
      remoteDestinationIp: 10.1.1.1
      sourceIp: 10.2.1.1

    Create MirrorPolicyObject Resource

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

    Constructor syntax

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

@overload
def MirrorPolicyObject(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       remote_destination_ip: Optional[str] = None,
                       source_ip: Optional[str] = None,
                       name: Optional[str] = None)
    func NewMirrorPolicyObject(ctx *Context, name string, args MirrorPolicyObjectArgs, opts ...ResourceOption) (*MirrorPolicyObject, error)
    public MirrorPolicyObject(string name, MirrorPolicyObjectArgs args, CustomResourceOptions? opts = null)
    public MirrorPolicyObject(String name, MirrorPolicyObjectArgs args)
public MirrorPolicyObject(String name, MirrorPolicyObjectArgs args, CustomResourceOptions options)

    type: sdwan:MirrorPolicyObject
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 MirrorPolicyObjectArgs
    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 MirrorPolicyObjectArgs
    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 MirrorPolicyObjectArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MirrorPolicyObjectArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MirrorPolicyObjectArgs
    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 mirrorPolicyObjectResource = new Sdwan.MirrorPolicyObject("mirrorPolicyObjectResource", new()
{
    RemoteDestinationIp = "string",
    SourceIp = "string",
    Name = "string",
});

    example, err := sdwan.NewMirrorPolicyObject(ctx, "mirrorPolicyObjectResource", &sdwan.MirrorPolicyObjectArgs{
	RemoteDestinationIp: pulumi.String("string"),
	SourceIp:            pulumi.String("string"),
	Name:                pulumi.String("string"),
})

    var mirrorPolicyObjectResource = new MirrorPolicyObject("mirrorPolicyObjectResource", MirrorPolicyObjectArgs.builder()
    .remoteDestinationIp("string")
    .sourceIp("string")
    .name("string")
    .build());

    mirror_policy_object_resource = sdwan.MirrorPolicyObject("mirrorPolicyObjectResource",
    remote_destination_ip="string",
    source_ip="string",
    name="string")

    const mirrorPolicyObjectResource = new sdwan.MirrorPolicyObject("mirrorPolicyObjectResource", {
    remoteDestinationIp: "string",
    sourceIp: "string",
    name: "string",
});

    type: sdwan:MirrorPolicyObject
properties:
    name: string
    remoteDestinationIp: string
    sourceIp: string

    MirrorPolicyObject Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The MirrorPolicyObject resource accepts the following input properties:

    RemoteDestinationIp string
    Remote destination IP
    SourceIp string
    Source IP
    Name string
    The name of the policy object
    RemoteDestinationIp string
    Remote destination IP
    SourceIp string
    Source IP
    Name string
    The name of the policy object
    remoteDestinationIp String
    Remote destination IP
    sourceIp String
    Source IP
    name String
    The name of the policy object
    remoteDestinationIp string
    Remote destination IP
    sourceIp string
    Source IP
    name string
    The name of the policy object
    remote_destination_ip str
    Remote destination IP
    source_ip str
    Source IP
    name str
    The name of the policy object
    remoteDestinationIp String
    Remote destination IP
    sourceIp String
    Source IP
    name String
    The name of the policy object

    Outputs

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

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

    Look up Existing MirrorPolicyObject Resource

    Get an existing MirrorPolicyObject 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?: MirrorPolicyObjectState, opts?: CustomResourceOptions): MirrorPolicyObject
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        name: Optional[str] = None,
        remote_destination_ip: Optional[str] = None,
        source_ip: Optional[str] = None,
        version: Optional[int] = None) -> MirrorPolicyObject
    func GetMirrorPolicyObject(ctx *Context, name string, id IDInput, state *MirrorPolicyObjectState, opts ...ResourceOption) (*MirrorPolicyObject, error)
    public static MirrorPolicyObject Get(string name, Input<string> id, MirrorPolicyObjectState? state, CustomResourceOptions? opts = null)
    public static MirrorPolicyObject get(String name, Output<String> id, MirrorPolicyObjectState 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:
    Name string
    The name of the policy object
    RemoteDestinationIp string
    Remote destination IP
    SourceIp string
    Source IP
    Version int
    The version of the object
    Name string
    The name of the policy object
    RemoteDestinationIp string
    Remote destination IP
    SourceIp string
    Source IP
    Version int
    The version of the object
    name String
    The name of the policy object
    remoteDestinationIp String
    Remote destination IP
    sourceIp String
    Source IP
    version Integer
    The version of the object
    name string
    The name of the policy object
    remoteDestinationIp string
    Remote destination IP
    sourceIp string
    Source IP
    version number
    The version of the object
    name str
    The name of the policy object
    remote_destination_ip str
    Remote destination IP
    source_ip str
    Source IP
    version int
    The version of the object
    name String
    The name of the policy object
    remoteDestinationIp String
    Remote destination IP
    sourceIp String
    Source IP
    version Number
    The version of the object

    Import

    $ pulumi import sdwan:index/mirrorPolicyObject:MirrorPolicyObject example "f6b2c44c-693c-4763-b010-895aa3d236bd"

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

    Package Details

    Repository
    sdwan pulumi/pulumi-sdwan
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the sdwan Terraform Provider.
    sdwan logo
    Cisco Catalyst SD-WAN v0.1.1 published on Friday, May 31, 2024 by Pulumi
    pulumi/pulumi-sdwan