Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. location
  5. getMap
AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-aws

aws.location.getMap

Explore with Pulumi AI

aws logo
AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-aws

    Retrieve information about a Location Service Map.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.location.getMap({
    mapName: "example",
});

    import pulumi
import pulumi_aws as aws

example = aws.location.get_map(map_name="example")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Aws.Location.GetMap.Invoke(new()
    {
        MapName = "example",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.location.LocationFunctions;
import com.pulumi.aws.location.inputs.GetMapArgs;
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 = LocationFunctions.getMap(GetMapArgs.builder()
            .mapName("example")
            .build());

    }
}

    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)
public static Output<GetMapResult> getMap(GetMapArgs args, InvokeOptions options)

    fn::invoke:
  function: aws:location/getMap:getMap
  arguments:
    # arguments dictionary

    The following arguments are supported:

    MapName string
    Name of the map resource.
    Tags Dictionary<string, string>
    Key-value map of resource tags for the map.
    MapName string
    Name of the map resource.
    Tags map[string]string
    Key-value map of resource tags for the map.
    mapName String
    Name of the map resource.
    tags Map<String,String>
    Key-value map of resource tags for the map.
    mapName string
    Name of the map resource.
    tags {[key: string]: string}
    Key-value map of resource tags for the map.
    map_name str
    Name of the map resource.
    tags Mapping[str, str]
    Key-value map of resource tags for the map.
    mapName String
    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
    Timestamp for when the map resource was created in ISO 8601 format.
    Description string
    Optional description for the map resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    MapArn string
    ARN for the map resource.
    MapName string
    Tags Dictionary<string, string>
    Key-value map of resource tags for the map.
    UpdateTime string
    Timestamp for when the map resource was last updated in ISO 8601 format.
    Configurations []GetMapConfiguration
    List of configurations that specify the map tile style selected from a partner data provider.
    CreateTime string
    Timestamp for when the map resource was created in ISO 8601 format.
    Description string
    Optional description for the map resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    MapArn string
    ARN for the map resource.
    MapName string
    Tags map[string]string
    Key-value map of resource tags for the map.
    UpdateTime string
    Timestamp for when the map resource was last updated in ISO 8601 format.
    configurations List<GetMapConfiguration>
    List of configurations that specify the map tile style selected from a partner data provider.
    createTime String
    Timestamp for when the map resource was created in ISO 8601 format.
    description String
    Optional description for the map resource.
    id String
    The provider-assigned unique ID for this managed resource.
    mapArn String
    ARN for the map resource.
    mapName String
    tags Map<String,String>
    Key-value map of resource tags for the map.
    updateTime String
    Timestamp for when the map resource was last updated in ISO 8601 format.
    configurations GetMapConfiguration[]
    List of configurations that specify the map tile style selected from a partner data provider.
    createTime string
    Timestamp for when the map resource was created in ISO 8601 format.
    description string
    Optional description for the map resource.
    id string
    The provider-assigned unique ID for this managed resource.
    mapArn string
    ARN for the map resource.
    mapName string
    tags {[key: string]: string}
    Key-value map of resource tags for the map.
    updateTime string
    Timestamp for when the map resource was last updated in ISO 8601 format.
    configurations Sequence[GetMapConfiguration]
    List of configurations that specify the map tile style selected from a partner data provider.
    create_time str
    Timestamp for when the map resource was created in ISO 8601 format.
    description str
    Optional description for the map resource.
    id str
    The provider-assigned unique ID for this managed resource.
    map_arn str
    ARN for the map resource.
    map_name str
    tags Mapping[str, str]
    Key-value map of resource tags for the map.
    update_time str
    Timestamp for when the map resource was last updated in ISO 8601 format.
    configurations List<Property Map>
    List of configurations that specify the map tile style selected from a partner data provider.
    createTime String
    Timestamp for when the map resource was created in ISO 8601 format.
    description String
    Optional description for the map resource.
    id String
    The provider-assigned unique ID for this managed resource.
    mapArn String
    ARN for the map resource.
    mapName String
    tags Map<String>
    Key-value map of resource tags for the map.
    updateTime String
    Timestamp for when the map resource was last updated in ISO 8601 format.

    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
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi
    pulumi/pulumi-aws