1. Packages
  2. Cisco Meraki Provider
  3. API Docs
  4. networks
  5. Bind
Cisco Meraki v0.4.1 published on Saturday, Mar 15, 2025 by Pulumi

meraki.networks.Bind

Explore with Pulumi AI

~>Warning: This resource does not represent a real-world entity in Meraki Dashboard, therefore changing or deleting this resource on its own has no immediate effect. Instead, it is a task part of a Meraki Dashboard workflow. It is executed in Meraki without any additional verification. It does not check if it was executed before or if a similar configuration or action already existed previously.

Example Usage

Coming soon!
Coming soon!
Coming soon!
Coming soon!
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.meraki.networks.Bind;
import com.pulumi.meraki.networks.BindArgs;
import com.pulumi.meraki.networks.inputs.BindParametersArgs;
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 Bind("example", BindArgs.builder()
            .networkId("string")
            .parameters(BindParametersArgs.builder()
                .auto_bind(false)
                .config_template_id("N_23952905")
                .build())
            .build());

        ctx.export("merakiNetworksBindExample", example);
    }
}
Copy
resources:
  example:
    type: meraki:networks:Bind
    properties:
      networkId: string
      parameters:
        auto_bind: false
        config_template_id: N_23952905
outputs:
  merakiNetworksBindExample: ${example}
Copy

Create Bind Resource

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

Constructor syntax

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

@overload
def Bind(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         network_id: Optional[str] = None,
         parameters: Optional[BindParametersArgs] = None)
func NewBind(ctx *Context, name string, args BindArgs, opts ...ResourceOption) (*Bind, error)
public Bind(string name, BindArgs args, CustomResourceOptions? opts = null)
public Bind(String name, BindArgs args)
public Bind(String name, BindArgs args, CustomResourceOptions options)
type: meraki:networks:Bind
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. BindArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. BindArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. BindArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. BindArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. BindArgs
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 bindResource = new Meraki.Networks.Bind("bindResource", new()
{
    NetworkId = "string",
    Parameters = new Meraki.Networks.Inputs.BindParametersArgs
    {
        AutoBind = false,
        ConfigTemplateId = "string",
    },
});
Copy
example, err := networks.NewBind(ctx, "bindResource", &networks.BindArgs{
	NetworkId: pulumi.String("string"),
	Parameters: &networks.BindParametersArgs{
		AutoBind:         pulumi.Bool(false),
		ConfigTemplateId: pulumi.String("string"),
	},
})
Copy
var bindResource = new Bind("bindResource", BindArgs.builder()
    .networkId("string")
    .parameters(BindParametersArgs.builder()
        .autoBind(false)
        .configTemplateId("string")
        .build())
    .build());
Copy
bind_resource = meraki.networks.Bind("bindResource",
    network_id="string",
    parameters={
        "auto_bind": False,
        "config_template_id": "string",
    })
Copy
const bindResource = new meraki.networks.Bind("bindResource", {
    networkId: "string",
    parameters: {
        autoBind: false,
        configTemplateId: "string",
    },
});
Copy
type: meraki:networks:Bind
properties:
    networkId: string
    parameters:
        autoBind: false
        configTemplateId: string
Copy

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

NetworkId This property is required. string
networkId path parameter. Network ID
Parameters This property is required. BindParameters
NetworkId This property is required. string
networkId path parameter. Network ID
Parameters This property is required. BindParametersArgs
networkId This property is required. String
networkId path parameter. Network ID
parameters This property is required. BindParameters
networkId This property is required. string
networkId path parameter. Network ID
parameters This property is required. BindParameters
network_id This property is required. str
networkId path parameter. Network ID
parameters This property is required. BindParametersArgs
networkId This property is required. String
networkId path parameter. Network ID
parameters This property is required. Property Map

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Item BindItem
Id string
The provider-assigned unique ID for this managed resource.
Item BindItem
id String
The provider-assigned unique ID for this managed resource.
item BindItem
id string
The provider-assigned unique ID for this managed resource.
item BindItem
id str
The provider-assigned unique ID for this managed resource.
item BindItem
id String
The provider-assigned unique ID for this managed resource.
item Property Map

Look up Existing Bind Resource

Get an existing Bind 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?: BindState, opts?: CustomResourceOptions): Bind
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        item: Optional[BindItemArgs] = None,
        network_id: Optional[str] = None,
        parameters: Optional[BindParametersArgs] = None) -> Bind
func GetBind(ctx *Context, name string, id IDInput, state *BindState, opts ...ResourceOption) (*Bind, error)
public static Bind Get(string name, Input<string> id, BindState? state, CustomResourceOptions? opts = null)
public static Bind get(String name, Output<String> id, BindState state, CustomResourceOptions options)
resources:  _:    type: meraki:networks:Bind    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Item BindItem
NetworkId string
networkId path parameter. Network ID
Parameters BindParameters
Item BindItemArgs
NetworkId string
networkId path parameter. Network ID
Parameters BindParametersArgs
item BindItem
networkId String
networkId path parameter. Network ID
parameters BindParameters
item BindItem
networkId string
networkId path parameter. Network ID
parameters BindParameters
item BindItemArgs
network_id str
networkId path parameter. Network ID
parameters BindParametersArgs
item Property Map
networkId String
networkId path parameter. Network ID
parameters Property Map

Supporting Types

BindItem
, BindItemArgs

ConfigTemplateId string
ID of the config template the network is being bound to
EnrollmentString string
Enrollment string for the network
Id string
Network ID
IsBoundToConfigTemplate bool
If the network is bound to a config template
Name string
Network name
Notes string
Notes for the network
OrganizationId string
Organization ID
ProductTypes List<string>
List of the product types that the network supports
Tags List<string>
Network tags
TimeZone string
Timezone of the network
Url string
URL to the network Dashboard UI
ConfigTemplateId string
ID of the config template the network is being bound to
EnrollmentString string
Enrollment string for the network
Id string
Network ID
IsBoundToConfigTemplate bool
If the network is bound to a config template
Name string
Network name
Notes string
Notes for the network
OrganizationId string
Organization ID
ProductTypes []string
List of the product types that the network supports
Tags []string
Network tags
TimeZone string
Timezone of the network
Url string
URL to the network Dashboard UI
configTemplateId String
ID of the config template the network is being bound to
enrollmentString String
Enrollment string for the network
id String
Network ID
isBoundToConfigTemplate Boolean
If the network is bound to a config template
name String
Network name
notes String
Notes for the network
organizationId String
Organization ID
productTypes List<String>
List of the product types that the network supports
tags List<String>
Network tags
timeZone String
Timezone of the network
url String
URL to the network Dashboard UI
configTemplateId string
ID of the config template the network is being bound to
enrollmentString string
Enrollment string for the network
id string
Network ID
isBoundToConfigTemplate boolean
If the network is bound to a config template
name string
Network name
notes string
Notes for the network
organizationId string
Organization ID
productTypes string[]
List of the product types that the network supports
tags string[]
Network tags
timeZone string
Timezone of the network
url string
URL to the network Dashboard UI
config_template_id str
ID of the config template the network is being bound to
enrollment_string str
Enrollment string for the network
id str
Network ID
is_bound_to_config_template bool
If the network is bound to a config template
name str
Network name
notes str
Notes for the network
organization_id str
Organization ID
product_types Sequence[str]
List of the product types that the network supports
tags Sequence[str]
Network tags
time_zone str
Timezone of the network
url str
URL to the network Dashboard UI
configTemplateId String
ID of the config template the network is being bound to
enrollmentString String
Enrollment string for the network
id String
Network ID
isBoundToConfigTemplate Boolean
If the network is bound to a config template
name String
Network name
notes String
Notes for the network
organizationId String
Organization ID
productTypes List<String>
List of the product types that the network supports
tags List<String>
Network tags
timeZone String
Timezone of the network
url String
URL to the network Dashboard UI

BindParameters
, BindParametersArgs

AutoBind bool
Optional boolean indicating whether the network's switches should automatically bind to profiles of the same model. Defaults to false if left unspecified. This option only affects switch networks and switch templates. Auto-bind is not valid unless the switch template has at least one profile and has at most one profile per switch model.
ConfigTemplateId string
The ID of the template to which the network should be bound.
AutoBind bool
Optional boolean indicating whether the network's switches should automatically bind to profiles of the same model. Defaults to false if left unspecified. This option only affects switch networks and switch templates. Auto-bind is not valid unless the switch template has at least one profile and has at most one profile per switch model.
ConfigTemplateId string
The ID of the template to which the network should be bound.
autoBind Boolean
Optional boolean indicating whether the network's switches should automatically bind to profiles of the same model. Defaults to false if left unspecified. This option only affects switch networks and switch templates. Auto-bind is not valid unless the switch template has at least one profile and has at most one profile per switch model.
configTemplateId String
The ID of the template to which the network should be bound.
autoBind boolean
Optional boolean indicating whether the network's switches should automatically bind to profiles of the same model. Defaults to false if left unspecified. This option only affects switch networks and switch templates. Auto-bind is not valid unless the switch template has at least one profile and has at most one profile per switch model.
configTemplateId string
The ID of the template to which the network should be bound.
auto_bind bool
Optional boolean indicating whether the network's switches should automatically bind to profiles of the same model. Defaults to false if left unspecified. This option only affects switch networks and switch templates. Auto-bind is not valid unless the switch template has at least one profile and has at most one profile per switch model.
config_template_id str
The ID of the template to which the network should be bound.
autoBind Boolean
Optional boolean indicating whether the network's switches should automatically bind to profiles of the same model. Defaults to false if left unspecified. This option only affects switch networks and switch templates. Auto-bind is not valid unless the switch template has at least one profile and has at most one profile per switch model.
configTemplateId String
The ID of the template to which the network should be bound.

Package Details

Repository
meraki pulumi/pulumi-meraki
License
Apache-2.0
Notes
This Pulumi package is based on the meraki Terraform Provider.