AWS Classic

v5.23.0 published on Monday, Dec 5, 2022 by Pulumi

getDevice

Retrieve information about a device.

Example Usage

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.networkmanager.NetworkmanagerFunctions;
import com.pulumi.aws.networkmanager.inputs.GetDeviceArgs;
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) {
        final var example = NetworkmanagerFunctions.getDevice(GetDeviceArgs.builder()
            .globalNetworkIdId(var_.global_network_id())
            .deviceId(var_.device_id())
            .build());

    }
}

Coming soon!

variables:
  example:
    fn::invoke:
      Function: aws:networkmanager:getDevice
      Arguments:
        globalNetworkIdId: ${var.global_network_id}
        deviceId: ${var.device_id}

Using getDevice

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDevice(args: GetDeviceArgs, opts?: InvokeOptions): Promise<GetDeviceResult>
function getDeviceOutput(args: GetDeviceOutputArgs, opts?: InvokeOptions): Output<GetDeviceResult>

def get_device(device_id: Optional[str] = None,
               global_network_id: Optional[str] = None,
               tags: Optional[Mapping[str, str]] = None,
               opts: Optional[InvokeOptions] = None) -> GetDeviceResult
def get_device_output(device_id: Optional[pulumi.Input[str]] = None,
               global_network_id: Optional[pulumi.Input[str]] = None,
               tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetDeviceResult]

func LookupDevice(ctx *Context, args *LookupDeviceArgs, opts ...InvokeOption) (*LookupDeviceResult, error)
func LookupDeviceOutput(ctx *Context, args *LookupDeviceOutputArgs, opts ...InvokeOption) LookupDeviceResultOutput

> Note: This function is named LookupDevice in the Go SDK.

public static class GetDevice 
{
    public static Task<GetDeviceResult> InvokeAsync(GetDeviceArgs args, InvokeOptions? opts = null)
    public static Output<GetDeviceResult> Invoke(GetDeviceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDeviceResult> getDevice(GetDeviceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws:networkmanager/getDevice:getDevice
  arguments:
    # arguments dictionary

The following arguments are supported:

DeviceId string: ID of the device.
GlobalNetworkId string: ID of the global network.
Tags Dictionary<string, string>: Key-value tags for the device.

DeviceId string: ID of the device.
GlobalNetworkId string: ID of the global network.
Tags map[string]string: Key-value tags for the device.

deviceId String: ID of the device.
globalNetworkId String: ID of the global network.
tags Map<String,String>: Key-value tags for the device.

deviceId string: ID of the device.
globalNetworkId string: ID of the global network.
tags {[key: string]: string}: Key-value tags for the device.

device_id str: ID of the device.
global_network_id str: ID of the global network.
tags Mapping[str, str]: Key-value tags for the device.

deviceId String: ID of the device.
globalNetworkId String: ID of the global network.
tags Map<String>: Key-value tags for the device.

getDevice Result

The following output properties are available:

Arn string: ARN of the device.
AwsLocations List<GetDeviceAwsLocation>: AWS location of the device. Documented below.
Description string: Description of the device.
DeviceId string
GlobalNetworkId string
Id string: The provider-assigned unique ID for this managed resource.
Locations List<GetDeviceLocation>: Location of the device. Documented below.
Model string: Model of device.
SerialNumber string: Serial number of the device.
SiteId string: ID of the site.
Tags Dictionary<string, string>: Key-value tags for the device.
Type string: Type of device.
Vendor string: Vendor of the device.

Arn string: ARN of the device.
AwsLocations []GetDeviceAwsLocation: AWS location of the device. Documented below.
Description string: Description of the device.
DeviceId string
GlobalNetworkId string
Id string: The provider-assigned unique ID for this managed resource.
Locations []GetDeviceLocation: Location of the device. Documented below.
Model string: Model of device.
SerialNumber string: Serial number of the device.
SiteId string: ID of the site.
Tags map[string]string: Key-value tags for the device.
Type string: Type of device.
Vendor string: Vendor of the device.

arn String: ARN of the device.
awsLocations List<GetDeviceAwsLocation>: AWS location of the device. Documented below.
description String: Description of the device.
deviceId String
globalNetworkId String
id String: The provider-assigned unique ID for this managed resource.
locations List<GetDeviceLocation>: Location of the device. Documented below.
model String: Model of device.
serialNumber String: Serial number of the device.
siteId String: ID of the site.
tags Map<String,String>: Key-value tags for the device.
type String: Type of device.
vendor String: Vendor of the device.

arn string: ARN of the device.
awsLocations GetDeviceAwsLocation[]: AWS location of the device. Documented below.
description string: Description of the device.
deviceId string
globalNetworkId string
id string: The provider-assigned unique ID for this managed resource.
locations GetDeviceLocation[]: Location of the device. Documented below.
model string: Model of device.
serialNumber string: Serial number of the device.
siteId string: ID of the site.
tags {[key: string]: string}: Key-value tags for the device.
type string: Type of device.
vendor string: Vendor of the device.

arn str: ARN of the device.
aws_locations Sequence[GetDeviceAwsLocation]: AWS location of the device. Documented below.
description str: Description of the device.
device_id str
global_network_id str
id str: The provider-assigned unique ID for this managed resource.
locations Sequence[GetDeviceLocation]: Location of the device. Documented below.
model str: Model of device.
serial_number str: Serial number of the device.
site_id str: ID of the site.
tags Mapping[str, str]: Key-value tags for the device.
type str: Type of device.
vendor str: Vendor of the device.

arn String: ARN of the device.
awsLocations List<Property Map>: AWS location of the device. Documented below.
description String: Description of the device.
deviceId String
globalNetworkId String
id String: The provider-assigned unique ID for this managed resource.
locations List<Property Map>: Location of the device. Documented below.
model String: Model of device.
serialNumber String: Serial number of the device.
siteId String: ID of the site.
tags Map<String>: Key-value tags for the device.
type String: Type of device.
vendor String: Vendor of the device.

Supporting Types

GetDeviceAwsLocation

SubnetArn string: ARN of the subnet that the device is located in.
Zone string: Zone that the device is located in.

SubnetArn string: ARN of the subnet that the device is located in.
Zone string: Zone that the device is located in.

subnetArn String: ARN of the subnet that the device is located in.
zone String: Zone that the device is located in.

subnetArn string: ARN of the subnet that the device is located in.
zone string: Zone that the device is located in.

subnet_arn str: ARN of the subnet that the device is located in.
zone str: Zone that the device is located in.

subnetArn String: ARN of the subnet that the device is located in.
zone String: Zone that the device is located in.

GetDeviceLocation

Address string: Physical address.
Latitude string: Latitude.
Longitude string: Longitude.

Address string: Physical address.
Latitude string: Latitude.
Longitude string: Longitude.

address String: Physical address.
latitude String: Latitude.
longitude String: Longitude.

address string: Physical address.
latitude string: Latitude.
longitude string: Longitude.

address str: Physical address.
latitude str: Latitude.
longitude str: Longitude.

address String: Physical address.
latitude String: Latitude.
longitude String: Longitude.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.