1. Packages
  2. Cisco Meraki
  3. API Docs
  4. networks
  5. ApplianceSettings
Cisco Meraki v0.2.0 published on Friday, May 24, 2024 by Pulumi

meraki.networks.ApplianceSettings

Explore with Pulumi AI

meraki logo
Cisco Meraki v0.2.0 published on Friday, May 24, 2024 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as meraki from "@pulumi/meraki";
    
    const example = new meraki.networks.ApplianceSettings("example", {
        clientTrackingMethod: "MAC address",
        deploymentMode: "routed",
        dynamicDns: {
            enabled: true,
            prefix: "test",
        },
        networkId: "string",
    });
    export const merakiNetworksApplianceSettingsExample = example;
    
    import pulumi
    import pulumi_meraki as meraki
    
    example = meraki.networks.ApplianceSettings("example",
        client_tracking_method="MAC address",
        deployment_mode="routed",
        dynamic_dns=meraki.networks.ApplianceSettingsDynamicDnsArgs(
            enabled=True,
            prefix="test",
        ),
        network_id="string")
    pulumi.export("merakiNetworksApplianceSettingsExample", example)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-meraki/sdk/go/meraki/networks"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := networks.NewApplianceSettings(ctx, "example", &networks.ApplianceSettingsArgs{
    			ClientTrackingMethod: pulumi.String("MAC address"),
    			DeploymentMode:       pulumi.String("routed"),
    			DynamicDns: &networks.ApplianceSettingsDynamicDnsArgs{
    				Enabled: pulumi.Bool(true),
    				Prefix:  pulumi.String("test"),
    			},
    			NetworkId: pulumi.String("string"),
    		})
    		if err != nil {
    			return err
    		}
    		ctx.Export("merakiNetworksApplianceSettingsExample", example)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Meraki = Pulumi.Meraki;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Meraki.Networks.ApplianceSettings("example", new()
        {
            ClientTrackingMethod = "MAC address",
            DeploymentMode = "routed",
            DynamicDns = new Meraki.Networks.Inputs.ApplianceSettingsDynamicDnsArgs
            {
                Enabled = true,
                Prefix = "test",
            },
            NetworkId = "string",
        });
    
        return new Dictionary<string, object?>
        {
            ["merakiNetworksApplianceSettingsExample"] = example,
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.meraki.networks.ApplianceSettings;
    import com.pulumi.meraki.networks.ApplianceSettingsArgs;
    import com.pulumi.meraki.networks.inputs.ApplianceSettingsDynamicDnsArgs;
    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 ApplianceSettings("example", ApplianceSettingsArgs.builder()
                .clientTrackingMethod("MAC address")
                .deploymentMode("routed")
                .dynamicDns(ApplianceSettingsDynamicDnsArgs.builder()
                    .enabled(true)
                    .prefix("test")
                    .build())
                .networkId("string")
                .build());
    
            ctx.export("merakiNetworksApplianceSettingsExample", example);
        }
    }
    
    resources:
      example:
        type: meraki:networks:ApplianceSettings
        properties:
          clientTrackingMethod: MAC address
          deploymentMode: routed
          dynamicDns:
            enabled: true
            prefix: test
          networkId: string
    outputs:
      merakiNetworksApplianceSettingsExample: ${example}
    

    Create ApplianceSettings Resource

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

    Constructor syntax

    new ApplianceSettings(name: string, args: ApplianceSettingsArgs, opts?: CustomResourceOptions);
    @overload
    def ApplianceSettings(resource_name: str,
                          args: ApplianceSettingsArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def ApplianceSettings(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          network_id: Optional[str] = None,
                          client_tracking_method: Optional[str] = None,
                          deployment_mode: Optional[str] = None,
                          dynamic_dns: Optional[ApplianceSettingsDynamicDnsArgs] = None)
    func NewApplianceSettings(ctx *Context, name string, args ApplianceSettingsArgs, opts ...ResourceOption) (*ApplianceSettings, error)
    public ApplianceSettings(string name, ApplianceSettingsArgs args, CustomResourceOptions? opts = null)
    public ApplianceSettings(String name, ApplianceSettingsArgs args)
    public ApplianceSettings(String name, ApplianceSettingsArgs args, CustomResourceOptions options)
    
    type: meraki:networks:ApplianceSettings
    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 ApplianceSettingsArgs
    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 ApplianceSettingsArgs
    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 ApplianceSettingsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApplianceSettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApplianceSettingsArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var applianceSettingsResource = new Meraki.Networks.ApplianceSettings("applianceSettingsResource", new()
    {
        NetworkId = "string",
        ClientTrackingMethod = "string",
        DeploymentMode = "string",
        DynamicDns = new Meraki.Networks.Inputs.ApplianceSettingsDynamicDnsArgs
        {
            Enabled = false,
            Prefix = "string",
            Url = "string",
        },
    });
    
    example, err := networks.NewApplianceSettings(ctx, "applianceSettingsResource", &networks.ApplianceSettingsArgs{
    	NetworkId:            pulumi.String("string"),
    	ClientTrackingMethod: pulumi.String("string"),
    	DeploymentMode:       pulumi.String("string"),
    	DynamicDns: &networks.ApplianceSettingsDynamicDnsArgs{
    		Enabled: pulumi.Bool(false),
    		Prefix:  pulumi.String("string"),
    		Url:     pulumi.String("string"),
    	},
    })
    
    var applianceSettingsResource = new ApplianceSettings("applianceSettingsResource", ApplianceSettingsArgs.builder()        
        .networkId("string")
        .clientTrackingMethod("string")
        .deploymentMode("string")
        .dynamicDns(ApplianceSettingsDynamicDnsArgs.builder()
            .enabled(false)
            .prefix("string")
            .url("string")
            .build())
        .build());
    
    appliance_settings_resource = meraki.networks.ApplianceSettings("applianceSettingsResource",
        network_id="string",
        client_tracking_method="string",
        deployment_mode="string",
        dynamic_dns=meraki.networks.ApplianceSettingsDynamicDnsArgs(
            enabled=False,
            prefix="string",
            url="string",
        ))
    
    const applianceSettingsResource = new meraki.networks.ApplianceSettings("applianceSettingsResource", {
        networkId: "string",
        clientTrackingMethod: "string",
        deploymentMode: "string",
        dynamicDns: {
            enabled: false,
            prefix: "string",
            url: "string",
        },
    });
    
    type: meraki:networks:ApplianceSettings
    properties:
        clientTrackingMethod: string
        deploymentMode: string
        dynamicDns:
            enabled: false
            prefix: string
            url: string
        networkId: string
    

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

    NetworkId string
    networkId path parameter. Network ID
    ClientTrackingMethod string
    Client tracking method of a network
    DeploymentMode string
    Deployment mode of a network
    DynamicDns ApplianceSettingsDynamicDns
    Dynamic DNS settings for a network
    NetworkId string
    networkId path parameter. Network ID
    ClientTrackingMethod string
    Client tracking method of a network
    DeploymentMode string
    Deployment mode of a network
    DynamicDns ApplianceSettingsDynamicDnsArgs
    Dynamic DNS settings for a network
    networkId String
    networkId path parameter. Network ID
    clientTrackingMethod String
    Client tracking method of a network
    deploymentMode String
    Deployment mode of a network
    dynamicDns ApplianceSettingsDynamicDns
    Dynamic DNS settings for a network
    networkId string
    networkId path parameter. Network ID
    clientTrackingMethod string
    Client tracking method of a network
    deploymentMode string
    Deployment mode of a network
    dynamicDns ApplianceSettingsDynamicDns
    Dynamic DNS settings for a network
    network_id str
    networkId path parameter. Network ID
    client_tracking_method str
    Client tracking method of a network
    deployment_mode str
    Deployment mode of a network
    dynamic_dns ApplianceSettingsDynamicDnsArgs
    Dynamic DNS settings for a network
    networkId String
    networkId path parameter. Network ID
    clientTrackingMethod String
    Client tracking method of a network
    deploymentMode String
    Deployment mode of a network
    dynamicDns Property Map
    Dynamic DNS settings for a network

    Outputs

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

    Get an existing ApplianceSettings 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?: ApplianceSettingsState, opts?: CustomResourceOptions): ApplianceSettings
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            client_tracking_method: Optional[str] = None,
            deployment_mode: Optional[str] = None,
            dynamic_dns: Optional[ApplianceSettingsDynamicDnsArgs] = None,
            network_id: Optional[str] = None) -> ApplianceSettings
    func GetApplianceSettings(ctx *Context, name string, id IDInput, state *ApplianceSettingsState, opts ...ResourceOption) (*ApplianceSettings, error)
    public static ApplianceSettings Get(string name, Input<string> id, ApplianceSettingsState? state, CustomResourceOptions? opts = null)
    public static ApplianceSettings get(String name, Output<String> id, ApplianceSettingsState 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:
    ClientTrackingMethod string
    Client tracking method of a network
    DeploymentMode string
    Deployment mode of a network
    DynamicDns ApplianceSettingsDynamicDns
    Dynamic DNS settings for a network
    NetworkId string
    networkId path parameter. Network ID
    ClientTrackingMethod string
    Client tracking method of a network
    DeploymentMode string
    Deployment mode of a network
    DynamicDns ApplianceSettingsDynamicDnsArgs
    Dynamic DNS settings for a network
    NetworkId string
    networkId path parameter. Network ID
    clientTrackingMethod String
    Client tracking method of a network
    deploymentMode String
    Deployment mode of a network
    dynamicDns ApplianceSettingsDynamicDns
    Dynamic DNS settings for a network
    networkId String
    networkId path parameter. Network ID
    clientTrackingMethod string
    Client tracking method of a network
    deploymentMode string
    Deployment mode of a network
    dynamicDns ApplianceSettingsDynamicDns
    Dynamic DNS settings for a network
    networkId string
    networkId path parameter. Network ID
    client_tracking_method str
    Client tracking method of a network
    deployment_mode str
    Deployment mode of a network
    dynamic_dns ApplianceSettingsDynamicDnsArgs
    Dynamic DNS settings for a network
    network_id str
    networkId path parameter. Network ID
    clientTrackingMethod String
    Client tracking method of a network
    deploymentMode String
    Deployment mode of a network
    dynamicDns Property Map
    Dynamic DNS settings for a network
    networkId String
    networkId path parameter. Network ID

    Supporting Types

    ApplianceSettingsDynamicDns, ApplianceSettingsDynamicDnsArgs

    Enabled bool
    Dynamic DNS enabled
    Prefix string
    Dynamic DNS url prefix. DDNS must be enabled to update
    Url string
    Dynamic DNS url. DDNS must be enabled to update
    Enabled bool
    Dynamic DNS enabled
    Prefix string
    Dynamic DNS url prefix. DDNS must be enabled to update
    Url string
    Dynamic DNS url. DDNS must be enabled to update
    enabled Boolean
    Dynamic DNS enabled
    prefix String
    Dynamic DNS url prefix. DDNS must be enabled to update
    url String
    Dynamic DNS url. DDNS must be enabled to update
    enabled boolean
    Dynamic DNS enabled
    prefix string
    Dynamic DNS url prefix. DDNS must be enabled to update
    url string
    Dynamic DNS url. DDNS must be enabled to update
    enabled bool
    Dynamic DNS enabled
    prefix str
    Dynamic DNS url prefix. DDNS must be enabled to update
    url str
    Dynamic DNS url. DDNS must be enabled to update
    enabled Boolean
    Dynamic DNS enabled
    prefix String
    Dynamic DNS url prefix. DDNS must be enabled to update
    url String
    Dynamic DNS url. DDNS must be enabled to update

    Import

    $ pulumi import meraki:networks/applianceSettings:ApplianceSettings example "network_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.2.0 published on Friday, May 24, 2024 by Pulumi