AWS Classic

v5.16.0 published on Saturday, Sep 24, 2022 by Pulumi

Device

Creates a device in a global network. If you specify both a site ID and a location, the location of the site is used for visualization in the Network Manager console.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.NetworkManager.Device("example", new()
    {
        GlobalNetworkId = aws_networkmanager_global_network.Example.Id,
        SiteId = aws_networkmanager_site.Example.Id,
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/networkmanager"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := networkmanager.NewDevice(ctx, "example", &networkmanager.DeviceArgs{
			GlobalNetworkId: pulumi.Any(aws_networkmanager_global_network.Example.Id),
			SiteId:          pulumi.Any(aws_networkmanager_site.Example.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.networkmanager.Device;
import com.pulumi.aws.networkmanager.DeviceArgs;
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 Device("example", DeviceArgs.builder()        
            .globalNetworkId(aws_networkmanager_global_network.example().id())
            .siteId(aws_networkmanager_site.example().id())
            .build());

    }
}
import pulumi
import pulumi_aws as aws

example = aws.networkmanager.Device("example",
    global_network_id=aws_networkmanager_global_network["example"]["id"],
    site_id=aws_networkmanager_site["example"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.networkmanager.Device("example", {
    globalNetworkId: aws_networkmanager_global_network.example.id,
    siteId: aws_networkmanager_site.example.id,
});
resources:
  example:
    type: aws:networkmanager:Device
    properties:
      globalNetworkId: ${aws_networkmanager_global_network.example.id}
      siteId: ${aws_networkmanager_site.example.id}

Create a Device Resource

new Device(name: string, args: DeviceArgs, opts?: CustomResourceOptions);
@overload
def Device(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           aws_location: Optional[DeviceAwsLocationArgs] = None,
           description: Optional[str] = None,
           global_network_id: Optional[str] = None,
           location: Optional[DeviceLocationArgs] = None,
           model: Optional[str] = None,
           serial_number: Optional[str] = None,
           site_id: Optional[str] = None,
           tags: Optional[Mapping[str, str]] = None,
           type: Optional[str] = None,
           vendor: Optional[str] = None)
@overload
def Device(resource_name: str,
           args: DeviceArgs,
           opts: Optional[ResourceOptions] = None)
func NewDevice(ctx *Context, name string, args DeviceArgs, opts ...ResourceOption) (*Device, error)
public Device(string name, DeviceArgs args, CustomResourceOptions? opts = null)
public Device(String name, DeviceArgs args)
public Device(String name, DeviceArgs args, CustomResourceOptions options)
type: aws:networkmanager:Device
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args DeviceArgs
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 DeviceArgs
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 DeviceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DeviceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args DeviceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

GlobalNetworkId string

The ID of the global network.

AwsLocation DeviceAwsLocationArgs

The AWS location of the device. Documented below.

Description string

A description of the device.

Location DeviceLocationArgs

The location of the device. Documented below.

Model string

The model of device.

SerialNumber string

The serial number of the device.

SiteId string

The ID of the site.

Tags Dictionary<string, string>
Type string

The type of device.

Vendor string

The vendor of the device.

GlobalNetworkId string

The ID of the global network.

AwsLocation DeviceAwsLocationArgs

The AWS location of the device. Documented below.

Description string

A description of the device.

Location DeviceLocationArgs

The location of the device. Documented below.

Model string

The model of device.

SerialNumber string

The serial number of the device.

SiteId string

The ID of the site.

Tags map[string]string
Type string

The type of device.

Vendor string

The vendor of the device.

globalNetworkId String

The ID of the global network.

awsLocation DeviceAwsLocationArgs

The AWS location of the device. Documented below.

description String

A description of the device.

location DeviceLocationArgs

The location of the device. Documented below.

model String

The model of device.

serialNumber String

The serial number of the device.

siteId String

The ID of the site.

tags Map<String,String>
type String

The type of device.

vendor String

The vendor of the device.

globalNetworkId string

The ID of the global network.

awsLocation DeviceAwsLocationArgs

The AWS location of the device. Documented below.

description string

A description of the device.

location DeviceLocationArgs

The location of the device. Documented below.

model string

The model of device.

serialNumber string

The serial number of the device.

siteId string

The ID of the site.

tags {[key: string]: string}
type string

The type of device.

vendor string

The vendor of the device.

global_network_id str

The ID of the global network.

aws_location DeviceAwsLocationArgs

The AWS location of the device. Documented below.

description str

A description of the device.

location DeviceLocationArgs

The location of the device. Documented below.

model str

The model of device.

serial_number str

The serial number of the device.

site_id str

The ID of the site.

tags Mapping[str, str]
type str

The type of device.

vendor str

The vendor of the device.

globalNetworkId String

The ID of the global network.

awsLocation Property Map

The AWS location of the device. Documented below.

description String

A description of the device.

location Property Map

The location of the device. Documented below.

model String

The model of device.

serialNumber String

The serial number of the device.

siteId String

The ID of the site.

tags Map<String>
type String

The type of device.

vendor String

The vendor of the device.

Outputs

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

Arn string

The Amazon Resource Name (ARN) of the device.

Id string

The provider-assigned unique ID for this managed resource.

TagsAll Dictionary<string, string>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Arn string

The Amazon Resource Name (ARN) of the device.

Id string

The provider-assigned unique ID for this managed resource.

TagsAll map[string]string

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String

The Amazon Resource Name (ARN) of the device.

id String

The provider-assigned unique ID for this managed resource.

tagsAll Map<String,String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn string

The Amazon Resource Name (ARN) of the device.

id string

The provider-assigned unique ID for this managed resource.

tagsAll {[key: string]: string}

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn str

The Amazon Resource Name (ARN) of the device.

id str

The provider-assigned unique ID for this managed resource.

tags_all Mapping[str, str]

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String

The Amazon Resource Name (ARN) of the device.

id String

The provider-assigned unique ID for this managed resource.

tagsAll Map<String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Look up an Existing Device Resource

Get an existing Device 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?: DeviceState, opts?: CustomResourceOptions): Device
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        aws_location: Optional[DeviceAwsLocationArgs] = None,
        description: Optional[str] = None,
        global_network_id: Optional[str] = None,
        location: Optional[DeviceLocationArgs] = None,
        model: Optional[str] = None,
        serial_number: Optional[str] = None,
        site_id: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        type: Optional[str] = None,
        vendor: Optional[str] = None) -> Device
func GetDevice(ctx *Context, name string, id IDInput, state *DeviceState, opts ...ResourceOption) (*Device, error)
public static Device Get(string name, Input<string> id, DeviceState? state, CustomResourceOptions? opts = null)
public static Device get(String name, Output<String> id, DeviceState 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:
Arn string

The Amazon Resource Name (ARN) of the device.

AwsLocation DeviceAwsLocationArgs

The AWS location of the device. Documented below.

Description string

A description of the device.

GlobalNetworkId string

The ID of the global network.

Location DeviceLocationArgs

The location of the device. Documented below.

Model string

The model of device.

SerialNumber string

The serial number of the device.

SiteId string

The ID of the site.

Tags Dictionary<string, string>
TagsAll Dictionary<string, string>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Type string

The type of device.

Vendor string

The vendor of the device.

Arn string

The Amazon Resource Name (ARN) of the device.

AwsLocation DeviceAwsLocationArgs

The AWS location of the device. Documented below.

Description string

A description of the device.

GlobalNetworkId string

The ID of the global network.

Location DeviceLocationArgs

The location of the device. Documented below.

Model string

The model of device.

SerialNumber string

The serial number of the device.

SiteId string

The ID of the site.

Tags map[string]string
TagsAll map[string]string

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Type string

The type of device.

Vendor string

The vendor of the device.

arn String

The Amazon Resource Name (ARN) of the device.

awsLocation DeviceAwsLocationArgs

The AWS location of the device. Documented below.

description String

A description of the device.

globalNetworkId String

The ID of the global network.

location DeviceLocationArgs

The location of the device. Documented below.

model String

The model of device.

serialNumber String

The serial number of the device.

siteId String

The ID of the site.

tags Map<String,String>
tagsAll Map<String,String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

type String

The type of device.

vendor String

The vendor of the device.

arn string

The Amazon Resource Name (ARN) of the device.

awsLocation DeviceAwsLocationArgs

The AWS location of the device. Documented below.

description string

A description of the device.

globalNetworkId string

The ID of the global network.

location DeviceLocationArgs

The location of the device. Documented below.

model string

The model of device.

serialNumber string

The serial number of the device.

siteId string

The ID of the site.

tags {[key: string]: string}
tagsAll {[key: string]: string}

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

type string

The type of device.

vendor string

The vendor of the device.

arn str

The Amazon Resource Name (ARN) of the device.

aws_location DeviceAwsLocationArgs

The AWS location of the device. Documented below.

description str

A description of the device.

global_network_id str

The ID of the global network.

location DeviceLocationArgs

The location of the device. Documented below.

model str

The model of device.

serial_number str

The serial number of the device.

site_id str

The ID of the site.

tags Mapping[str, str]
tags_all Mapping[str, str]

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

type str

The type of device.

vendor str

The vendor of the device.

arn String

The Amazon Resource Name (ARN) of the device.

awsLocation Property Map

The AWS location of the device. Documented below.

description String

A description of the device.

globalNetworkId String

The ID of the global network.

location Property Map

The location of the device. Documented below.

model String

The model of device.

serialNumber String

The serial number of the device.

siteId String

The ID of the site.

tags Map<String>
tagsAll Map<String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

type String

The type of device.

vendor String

The vendor of the device.

Supporting Types

DeviceAwsLocation

SubnetArn string

The Amazon Resource Name (ARN) of the subnet that the device is located in.

Zone string

The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.

SubnetArn string

The Amazon Resource Name (ARN) of the subnet that the device is located in.

Zone string

The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.

subnetArn String

The Amazon Resource Name (ARN) of the subnet that the device is located in.

zone String

The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.

subnetArn string

The Amazon Resource Name (ARN) of the subnet that the device is located in.

zone string

The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.

subnet_arn str

The Amazon Resource Name (ARN) of the subnet that the device is located in.

zone str

The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.

subnetArn String

The Amazon Resource Name (ARN) of the subnet that the device is located in.

zone String

The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.

DeviceLocation

Address string

The physical address.

Latitude string

The latitude.

Longitude string

The longitude.

Address string

The physical address.

Latitude string

The latitude.

Longitude string

The longitude.

address String

The physical address.

latitude String

The latitude.

longitude String

The longitude.

address string

The physical address.

latitude string

The latitude.

longitude string

The longitude.

address str

The physical address.

latitude str

The latitude.

longitude str

The longitude.

address String

The physical address.

latitude String

The latitude.

longitude String

The longitude.

Import

aws_networkmanager_device can be imported using the device ARN, e.g.

 $ pulumi import aws:networkmanager/device:Device example arn:aws:networkmanager::123456789012:device/global-network-0d47f6t230mz46dy4/device-07f6fd08867abc123

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.