AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.9.1 published on Tuesday, Jun 21, 2022 by Pulumi

getMap

Retrieve information about a Location Service Map.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Aws.Location.GetMap.InvokeAsync(new Aws.Location.GetMapArgs
        {
            MapName = "example",
        }));
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := location.LookupMap(ctx, &location.LookupMapArgs{
			MapName: "example",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = Output.of(LocationFunctions.getMap(GetMapArgs.builder()
            .mapName("example")
            .build()));

    }
}
import pulumi
import pulumi_aws as aws

example = aws.location.get_map(map_name="example")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = pulumi.output(aws.location.getMap({
    mapName: "example",
}));
variables:
  example:
    Fn::Invoke:
      Function: aws:location:getMap
      Arguments:
        mapName: example

Using getMap

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 getMap(args: GetMapArgs, opts?: InvokeOptions): Promise<GetMapResult>
function getMapOutput(args: GetMapOutputArgs, opts?: InvokeOptions): Output<GetMapResult>
def get_map(map_name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            opts: Optional[InvokeOptions] = None) -> GetMapResult
def get_map_output(map_name: Optional[pulumi.Input[str]] = None,
            tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetMapResult]
func LookupMap(ctx *Context, args *LookupMapArgs, opts ...InvokeOption) (*LookupMapResult, error)
func LookupMapOutput(ctx *Context, args *LookupMapOutputArgs, opts ...InvokeOption) LookupMapResultOutput

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

public static class GetMap 
{
    public static Task<GetMapResult> InvokeAsync(GetMapArgs args, InvokeOptions? opts = null)
    public static Output<GetMapResult> Invoke(GetMapInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetMapResult> getMap(GetMapArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: aws:location/getMap:getMap
  Arguments:
    # Arguments dictionary

The following arguments are supported:

MapName string

The name of the map resource.

Tags Dictionary<string, string>

Key-value map of resource tags for the map.

MapName string

The name of the map resource.

Tags map[string]string

Key-value map of resource tags for the map.

mapName String

The name of the map resource.

tags Map<String,String>

Key-value map of resource tags for the map.

mapName string

The name of the map resource.

tags {[key: string]: string}

Key-value map of resource tags for the map.

map_name str

The name of the map resource.

tags Mapping[str, str]

Key-value map of resource tags for the map.

mapName String

The name of the map resource.

tags Map<String>

Key-value map of resource tags for the map.

getMap Result

The following output properties are available:

Configurations List<GetMapConfiguration>

List of configurations that specify the map tile style selected from a partner data provider.

CreateTime string

The timestamp for when the map resource was created in ISO 8601 format.

Description string

The optional description for the map resource.

Id string

The provider-assigned unique ID for this managed resource.

MapArn string

The Amazon Resource Name (ARN) for the map resource.

MapName string
Tags Dictionary<string, string>

Key-value map of resource tags for the map.

UpdateTime string

The timestamp for when the map resource was last updated in ISO 8601.

Configurations []GetMapConfiguration

List of configurations that specify the map tile style selected from a partner data provider.

CreateTime string

The timestamp for when the map resource was created in ISO 8601 format.

Description string

The optional description for the map resource.

Id string

The provider-assigned unique ID for this managed resource.

MapArn string

The Amazon Resource Name (ARN) for the map resource.

MapName string
Tags map[string]string

Key-value map of resource tags for the map.

UpdateTime string

The timestamp for when the map resource was last updated in ISO 8601.

configurations List<GetMapConfiguration>

List of configurations that specify the map tile style selected from a partner data provider.

createTime String

The timestamp for when the map resource was created in ISO 8601 format.

description String

The optional description for the map resource.

id String

The provider-assigned unique ID for this managed resource.

mapArn String

The Amazon Resource Name (ARN) for the map resource.

mapName String
tags Map<String,String>

Key-value map of resource tags for the map.

updateTime String

The timestamp for when the map resource was last updated in ISO 8601.

configurations GetMapConfiguration[]

List of configurations that specify the map tile style selected from a partner data provider.

createTime string

The timestamp for when the map resource was created in ISO 8601 format.

description string

The optional description for the map resource.

id string

The provider-assigned unique ID for this managed resource.

mapArn string

The Amazon Resource Name (ARN) for the map resource.

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

Key-value map of resource tags for the map.

updateTime string

The timestamp for when the map resource was last updated in ISO 8601.

configurations Sequence[GetMapConfiguration]

List of configurations that specify the map tile style selected from a partner data provider.

create_time str

The timestamp for when the map resource was created in ISO 8601 format.

description str

The optional description for the map resource.

id str

The provider-assigned unique ID for this managed resource.

map_arn str

The Amazon Resource Name (ARN) for the map resource.

map_name str
tags Mapping[str, str]

Key-value map of resource tags for the map.

update_time str

The timestamp for when the map resource was last updated in ISO 8601.

configurations List<Property Map>

List of configurations that specify the map tile style selected from a partner data provider.

createTime String

The timestamp for when the map resource was created in ISO 8601 format.

description String

The optional description for the map resource.

id String

The provider-assigned unique ID for this managed resource.

mapArn String

The Amazon Resource Name (ARN) for the map resource.

mapName String
tags Map<String>

Key-value map of resource tags for the map.

updateTime String

The timestamp for when the map resource was last updated in ISO 8601.

Supporting Types

GetMapConfiguration

Style string

The map style selected from an available data provider.

Style string

The map style selected from an available data provider.

style String

The map style selected from an available data provider.

style string

The map style selected from an available data provider.

style str

The map style selected from an available data provider.

style String

The map style selected from an available data provider.

Package Details

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

This Pulumi package is based on the aws Terraform Provider.