com.pulumi.meraki.devices.Base Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of meraki Show documentation
Show all versions of meraki Show documentation
A Pulumi package for creating and managing Cisco Meraki resources
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.meraki.devices;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import com.pulumi.meraki.Utilities;
import com.pulumi.meraki.devices.BaseArgs;
import com.pulumi.meraki.devices.inputs.BaseState;
import com.pulumi.meraki.devices.outputs.BaseDetail;
import java.lang.Boolean;
import java.lang.Double;
import java.lang.String;
import java.util.List;
import javax.annotation.Nullable;
/**
* ## Example Usage
*
* <!--Start PulumiCodeChooser -->
* <!--End PulumiCodeChooser -->
*
* ## Import
*
* ```sh
* $ pulumi import meraki:devices/base:base example "organization_id,serial"
* ```
*
*/
@ResourceType(type="meraki:devices/base:base")
public class Base extends com.pulumi.resources.CustomResource {
/**
* Physical address of the device
*
*/
@Export(name="address", refs={String.class}, tree="[0]")
private Output address;
/**
* @return Physical address of the device
*
*/
public Output address() {
return this.address;
}
/**
* Additional device information
*
*/
@Export(name="details", refs={List.class,BaseDetail.class}, tree="[0,1]")
private Output> details;
/**
* @return Additional device information
*
*/
public Output> details() {
return this.details;
}
/**
* Firmware version of the device
*
*/
@Export(name="firmware", refs={String.class}, tree="[0]")
private Output firmware;
/**
* @return Firmware version of the device
*
*/
public Output firmware() {
return this.firmware;
}
/**
* The floor plan to associate to this device. null disassociates the device from the floorplan.
*
*/
@Export(name="floorPlanId", refs={String.class}, tree="[0]")
private Output floorPlanId;
/**
* @return The floor plan to associate to this device. null disassociates the device from the floorplan.
*
*/
public Output floorPlanId() {
return this.floorPlanId;
}
/**
* IMEI of the device, if applicable
*
*/
@Export(name="imei", refs={String.class}, tree="[0]")
private Output imei;
/**
* @return IMEI of the device, if applicable
*
*/
public Output imei() {
return this.imei;
}
/**
* LAN IP address of the device
*
*/
@Export(name="lanIp", refs={String.class}, tree="[0]")
private Output lanIp;
/**
* @return LAN IP address of the device
*
*/
public Output lanIp() {
return this.lanIp;
}
/**
* Latitude of the device
*
*/
@Export(name="lat", refs={Double.class}, tree="[0]")
private Output lat;
/**
* @return Latitude of the device
*
*/
public Output lat() {
return this.lat;
}
/**
* Longitude of the device
*
*/
@Export(name="lng", refs={Double.class}, tree="[0]")
private Output lng;
/**
* @return Longitude of the device
*
*/
public Output lng() {
return this.lng;
}
/**
* MAC address of the device
*
*/
@Export(name="mac", refs={String.class}, tree="[0]")
private Output mac;
/**
* @return MAC address of the device
*
*/
public Output mac() {
return this.mac;
}
/**
* Model of the device
*
*/
@Export(name="model", refs={String.class}, tree="[0]")
private Output model;
/**
* @return Model of the device
*
*/
public Output model() {
return this.model;
}
/**
* Whether or not to set the latitude and longitude of a device based on the new address. Only applies when lat and lng are not specified.
*
*/
@Export(name="moveMapMarker", refs={Boolean.class}, tree="[0]")
private Output moveMapMarker;
/**
* @return Whether or not to set the latitude and longitude of a device based on the new address. Only applies when lat and lng are not specified.
*
*/
public Output moveMapMarker() {
return this.moveMapMarker;
}
/**
* Name of the device
*
*/
@Export(name="name", refs={String.class}, tree="[0]")
private Output name;
/**
* @return Name of the device
*
*/
public Output name() {
return this.name;
}
/**
* ID of the network the device belongs to
*
*/
@Export(name="networkId", refs={String.class}, tree="[0]")
private Output networkId;
/**
* @return ID of the network the device belongs to
*
*/
public Output networkId() {
return this.networkId;
}
/**
* Notes for the device, limited to 255 characters
*
*/
@Export(name="notes", refs={String.class}, tree="[0]")
private Output notes;
/**
* @return Notes for the device, limited to 255 characters
*
*/
public Output notes() {
return this.notes;
}
/**
* Product type of the device
*
*/
@Export(name="productType", refs={String.class}, tree="[0]")
private Output productType;
/**
* @return Product type of the device
*
*/
public Output productType() {
return this.productType;
}
/**
* Serial number of the device
*
*/
@Export(name="serial", refs={String.class}, tree="[0]")
private Output serial;
/**
* @return Serial number of the device
*
*/
public Output serial() {
return this.serial;
}
/**
* The ID of a switch template to bind to the device (for available switch templates, see the 'Switch Templates' endpoint). Use null to unbind the switch device from the current profile. For a device to be bindable to a switch template, it must (1) be a switch, and (2) belong to a network that is bound to a configuration template.
*
*/
@Export(name="switchProfileId", refs={String.class}, tree="[0]")
private Output switchProfileId;
/**
* @return The ID of a switch template to bind to the device (for available switch templates, see the 'Switch Templates' endpoint). Use null to unbind the switch device from the current profile. For a device to be bindable to a switch template, it must (1) be a switch, and (2) belong to a network that is bound to a configuration template.
*
*/
public Output switchProfileId() {
return this.switchProfileId;
}
/**
* List of tags assigned to the device
*
*/
@Export(name="tags", refs={List.class,String.class}, tree="[0,1]")
private Output> tags;
/**
* @return List of tags assigned to the device
*
*/
public Output> tags() {
return this.tags;
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public Base(java.lang.String name) {
this(name, BaseArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public Base(java.lang.String name, BaseArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public Base(java.lang.String name, BaseArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("meraki:devices/base:base", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private Base(java.lang.String name, Output id, @Nullable BaseState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("meraki:devices/base:base", name, state, makeResourceOptions(options, id), false);
}
private static BaseArgs makeArgs(BaseArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? BaseArgs.Empty : args;
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state
* @param options Optional settings to control the behavior of the CustomResource.
*/
public static Base get(java.lang.String name, Output id, @Nullable BaseState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new Base(name, id, state, options);
}
}