1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. MagicNetworkMonitoringConfiguration
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

cloudflare.MagicNetworkMonitoringConfiguration

Explore with Pulumi AI

cloudflare logo
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

    Example Usage

    Create MagicNetworkMonitoringConfiguration Resource

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

    Constructor syntax

    new MagicNetworkMonitoringConfiguration(name: string, args: MagicNetworkMonitoringConfigurationArgs, opts?: CustomResourceOptions);
    @overload
    def MagicNetworkMonitoringConfiguration(resource_name: str,
                                            args: MagicNetworkMonitoringConfigurationArgs,
                                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def MagicNetworkMonitoringConfiguration(resource_name: str,
                                            opts: Optional[ResourceOptions] = None,
                                            account_id: Optional[str] = None,
                                            name: Optional[str] = None,
                                            default_sampling: Optional[float] = None,
                                            router_ips: Optional[Sequence[str]] = None,
                                            warp_devices: Optional[Sequence[MagicNetworkMonitoringConfigurationWarpDeviceArgs]] = None)
    func NewMagicNetworkMonitoringConfiguration(ctx *Context, name string, args MagicNetworkMonitoringConfigurationArgs, opts ...ResourceOption) (*MagicNetworkMonitoringConfiguration, error)
    public MagicNetworkMonitoringConfiguration(string name, MagicNetworkMonitoringConfigurationArgs args, CustomResourceOptions? opts = null)
    public MagicNetworkMonitoringConfiguration(String name, MagicNetworkMonitoringConfigurationArgs args)
    public MagicNetworkMonitoringConfiguration(String name, MagicNetworkMonitoringConfigurationArgs args, CustomResourceOptions options)
    
    type: cloudflare:MagicNetworkMonitoringConfiguration
    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 MagicNetworkMonitoringConfigurationArgs
    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 MagicNetworkMonitoringConfigurationArgs
    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 MagicNetworkMonitoringConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MagicNetworkMonitoringConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MagicNetworkMonitoringConfigurationArgs
    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 magicNetworkMonitoringConfigurationResource = new Cloudflare.MagicNetworkMonitoringConfiguration("magicNetworkMonitoringConfigurationResource", new()
    {
        AccountId = "string",
        Name = "string",
        DefaultSampling = 0,
        RouterIps = new[]
        {
            "string",
        },
        WarpDevices = new[]
        {
            new Cloudflare.Inputs.MagicNetworkMonitoringConfigurationWarpDeviceArgs
            {
                Id = "string",
                Name = "string",
                RouterIp = "string",
            },
        },
    });
    
    example, err := cloudflare.NewMagicNetworkMonitoringConfiguration(ctx, "magicNetworkMonitoringConfigurationResource", &cloudflare.MagicNetworkMonitoringConfigurationArgs{
    	AccountId:       pulumi.String("string"),
    	Name:            pulumi.String("string"),
    	DefaultSampling: pulumi.Float64(0),
    	RouterIps: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	WarpDevices: cloudflare.MagicNetworkMonitoringConfigurationWarpDeviceArray{
    		&cloudflare.MagicNetworkMonitoringConfigurationWarpDeviceArgs{
    			Id:       pulumi.String("string"),
    			Name:     pulumi.String("string"),
    			RouterIp: pulumi.String("string"),
    		},
    	},
    })
    
    var magicNetworkMonitoringConfigurationResource = new MagicNetworkMonitoringConfiguration("magicNetworkMonitoringConfigurationResource", MagicNetworkMonitoringConfigurationArgs.builder()
        .accountId("string")
        .name("string")
        .defaultSampling(0)
        .routerIps("string")
        .warpDevices(MagicNetworkMonitoringConfigurationWarpDeviceArgs.builder()
            .id("string")
            .name("string")
            .routerIp("string")
            .build())
        .build());
    
    magic_network_monitoring_configuration_resource = cloudflare.MagicNetworkMonitoringConfiguration("magicNetworkMonitoringConfigurationResource",
        account_id="string",
        name="string",
        default_sampling=0,
        router_ips=["string"],
        warp_devices=[{
            "id": "string",
            "name": "string",
            "router_ip": "string",
        }])
    
    const magicNetworkMonitoringConfigurationResource = new cloudflare.MagicNetworkMonitoringConfiguration("magicNetworkMonitoringConfigurationResource", {
        accountId: "string",
        name: "string",
        defaultSampling: 0,
        routerIps: ["string"],
        warpDevices: [{
            id: "string",
            name: "string",
            routerIp: "string",
        }],
    });
    
    type: cloudflare:MagicNetworkMonitoringConfiguration
    properties:
        accountId: string
        defaultSampling: 0
        name: string
        routerIps:
            - string
        warpDevices:
            - id: string
              name: string
              routerIp: string
    

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

    AccountId string
    Name string
    The account name.
    DefaultSampling double
    Fallback sampling rate of flow messages being sent in packets per second. This should match the packet sampling rate configured on the router.
    RouterIps List<string>
    WarpDevices List<MagicNetworkMonitoringConfigurationWarpDevice>
    AccountId string
    Name string
    The account name.
    DefaultSampling float64
    Fallback sampling rate of flow messages being sent in packets per second. This should match the packet sampling rate configured on the router.
    RouterIps []string
    WarpDevices []MagicNetworkMonitoringConfigurationWarpDeviceArgs
    accountId String
    name String
    The account name.
    defaultSampling Double
    Fallback sampling rate of flow messages being sent in packets per second. This should match the packet sampling rate configured on the router.
    routerIps List<String>
    warpDevices List<MagicNetworkMonitoringConfigurationWarpDevice>
    accountId string
    name string
    The account name.
    defaultSampling number
    Fallback sampling rate of flow messages being sent in packets per second. This should match the packet sampling rate configured on the router.
    routerIps string[]
    warpDevices MagicNetworkMonitoringConfigurationWarpDevice[]
    account_id str
    name str
    The account name.
    default_sampling float
    Fallback sampling rate of flow messages being sent in packets per second. This should match the packet sampling rate configured on the router.
    router_ips Sequence[str]
    warp_devices Sequence[MagicNetworkMonitoringConfigurationWarpDeviceArgs]
    accountId String
    name String
    The account name.
    defaultSampling Number
    Fallback sampling rate of flow messages being sent in packets per second. This should match the packet sampling rate configured on the router.
    routerIps List<String>
    warpDevices List<Property Map>

    Outputs

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

    Get an existing MagicNetworkMonitoringConfiguration 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?: MagicNetworkMonitoringConfigurationState, opts?: CustomResourceOptions): MagicNetworkMonitoringConfiguration
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_id: Optional[str] = None,
            default_sampling: Optional[float] = None,
            name: Optional[str] = None,
            router_ips: Optional[Sequence[str]] = None,
            warp_devices: Optional[Sequence[MagicNetworkMonitoringConfigurationWarpDeviceArgs]] = None) -> MagicNetworkMonitoringConfiguration
    func GetMagicNetworkMonitoringConfiguration(ctx *Context, name string, id IDInput, state *MagicNetworkMonitoringConfigurationState, opts ...ResourceOption) (*MagicNetworkMonitoringConfiguration, error)
    public static MagicNetworkMonitoringConfiguration Get(string name, Input<string> id, MagicNetworkMonitoringConfigurationState? state, CustomResourceOptions? opts = null)
    public static MagicNetworkMonitoringConfiguration get(String name, Output<String> id, MagicNetworkMonitoringConfigurationState state, CustomResourceOptions options)
    resources:  _:    type: cloudflare:MagicNetworkMonitoringConfiguration    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:
    AccountId string
    DefaultSampling double
    Fallback sampling rate of flow messages being sent in packets per second. This should match the packet sampling rate configured on the router.
    Name string
    The account name.
    RouterIps List<string>
    WarpDevices List<MagicNetworkMonitoringConfigurationWarpDevice>
    AccountId string
    DefaultSampling float64
    Fallback sampling rate of flow messages being sent in packets per second. This should match the packet sampling rate configured on the router.
    Name string
    The account name.
    RouterIps []string
    WarpDevices []MagicNetworkMonitoringConfigurationWarpDeviceArgs
    accountId String
    defaultSampling Double
    Fallback sampling rate of flow messages being sent in packets per second. This should match the packet sampling rate configured on the router.
    name String
    The account name.
    routerIps List<String>
    warpDevices List<MagicNetworkMonitoringConfigurationWarpDevice>
    accountId string
    defaultSampling number
    Fallback sampling rate of flow messages being sent in packets per second. This should match the packet sampling rate configured on the router.
    name string
    The account name.
    routerIps string[]
    warpDevices MagicNetworkMonitoringConfigurationWarpDevice[]
    account_id str
    default_sampling float
    Fallback sampling rate of flow messages being sent in packets per second. This should match the packet sampling rate configured on the router.
    name str
    The account name.
    router_ips Sequence[str]
    warp_devices Sequence[MagicNetworkMonitoringConfigurationWarpDeviceArgs]
    accountId String
    defaultSampling Number
    Fallback sampling rate of flow messages being sent in packets per second. This should match the packet sampling rate configured on the router.
    name String
    The account name.
    routerIps List<String>
    warpDevices List<Property Map>

    Supporting Types

    MagicNetworkMonitoringConfigurationWarpDevice, MagicNetworkMonitoringConfigurationWarpDeviceArgs

    Id string
    Unique identifier for the warp device.
    Name string
    Name of the warp device.
    RouterIp string
    IPv4 CIDR of the router sourcing flow data associated with this warp device. Only /32 addresses are currently supported.
    Id string
    Unique identifier for the warp device.
    Name string
    Name of the warp device.
    RouterIp string
    IPv4 CIDR of the router sourcing flow data associated with this warp device. Only /32 addresses are currently supported.
    id String
    Unique identifier for the warp device.
    name String
    Name of the warp device.
    routerIp String
    IPv4 CIDR of the router sourcing flow data associated with this warp device. Only /32 addresses are currently supported.
    id string
    Unique identifier for the warp device.
    name string
    Name of the warp device.
    routerIp string
    IPv4 CIDR of the router sourcing flow data associated with this warp device. Only /32 addresses are currently supported.
    id str
    Unique identifier for the warp device.
    name str
    Name of the warp device.
    router_ip str
    IPv4 CIDR of the router sourcing flow data associated with this warp device. Only /32 addresses are currently supported.
    id String
    Unique identifier for the warp device.
    name String
    Name of the warp device.
    routerIp String
    IPv4 CIDR of the router sourcing flow data associated with this warp device. Only /32 addresses are currently supported.

    Package Details

    Repository
    Cloudflare pulumi/pulumi-cloudflare
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudflare Terraform Provider.
    cloudflare logo
    Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi