Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. location
  5. Map

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

aws.location.Map

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

    Provides a Location Service Map.

    Example Usage

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

const example = new aws.location.Map("example", {
    configuration: {
        style: "VectorHereBerlin",
    },
    mapName: "example",
});

    import pulumi
import pulumi_aws as aws

example = aws.location.Map("example",
    configuration={
        "style": "VectorHereBerlin",
    },
    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.NewMap(ctx, "example", &location.MapArgs{
			Configuration: &location.MapConfigurationArgs{
				Style: pulumi.String("VectorHereBerlin"),
			},
			MapName: pulumi.String("example"),
		})
		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 = new Aws.Location.Map("example", new()
    {
        Configuration = new Aws.Location.Inputs.MapConfigurationArgs
        {
            Style = "VectorHereBerlin",
        },
        MapName = "example",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.location.Map;
import com.pulumi.aws.location.MapArgs;
import com.pulumi.aws.location.inputs.MapConfigurationArgs;
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 Map("example", MapArgs.builder()
            .configuration(MapConfigurationArgs.builder()
                .style("VectorHereBerlin")
                .build())
            .mapName("example")
            .build());

    }
}

    resources:
  example:
    type: aws:location:Map
    properties:
      configuration:
        style: VectorHereBerlin
      mapName: example

    Create Map Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Map(name: string, args: MapArgs, opts?: CustomResourceOptions);
    @overload
def Map(resource_name: str,
        args: MapArgs,
        opts: Optional[ResourceOptions] = None)

@overload
def Map(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[MapConfigurationArgs] = None,
        map_name: Optional[str] = None,
        description: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None)
    func NewMap(ctx *Context, name string, args MapArgs, opts ...ResourceOption) (*Map, error)
    public Map(string name, MapArgs args, CustomResourceOptions? opts = null)
    public Map(String name, MapArgs args)
public Map(String name, MapArgs args, CustomResourceOptions options)

    type: aws:location:Map
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

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

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var mapResource = new Aws.Location.Map("mapResource", new()
{
    Configuration = new Aws.Location.Inputs.MapConfigurationArgs
    {
        Style = "string",
    },
    MapName = "string",
    Description = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := location.NewMap(ctx, "mapResource", &location.MapArgs{
	Configuration: &location.MapConfigurationArgs{
		Style: pulumi.String("string"),
	},
	MapName:     pulumi.String("string"),
	Description: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var mapResource = new Map("mapResource", MapArgs.builder()
    .configuration(MapConfigurationArgs.builder()
        .style("string")
        .build())
    .mapName("string")
    .description("string")
    .tags(Map.of("string", "string"))
    .build());

    map_resource = aws.location.Map("mapResource",
    configuration={
        "style": "string",
    },
    map_name="string",
    description="string",
    tags={
        "string": "string",
    })

    const mapResource = new aws.location.Map("mapResource", {
    configuration: {
        style: "string",
    },
    mapName: "string",
    description: "string",
    tags: {
        string: "string",
    },
});

    type: aws:location:Map
properties:
    configuration:
        style: string
    description: string
    mapName: string
    tags:
        string: string

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

    Configuration MapConfiguration
    Configuration block with the map style selected from an available data provider. Detailed below.
    MapName string

    The name for the map resource.

    The following arguments are optional:

    Description string
    An optional description for the map resource.
    Tags Dictionary<string, string>
    Key-value tags for the map. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Configuration MapConfigurationArgs
    Configuration block with the map style selected from an available data provider. Detailed below.
    MapName string

    The name for the map resource.

    The following arguments are optional:

    Description string
    An optional description for the map resource.
    Tags map[string]string
    Key-value tags for the map. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    configuration MapConfiguration
    Configuration block with the map style selected from an available data provider. Detailed below.
    mapName String

    The name for the map resource.

    The following arguments are optional:

    description String
    An optional description for the map resource.
    tags Map<String,String>
    Key-value tags for the map. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    configuration MapConfiguration
    Configuration block with the map style selected from an available data provider. Detailed below.
    mapName string

    The name for the map resource.

    The following arguments are optional:

    description string
    An optional description for the map resource.
    tags {[key: string]: string}
    Key-value tags for the map. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    configuration MapConfigurationArgs
    Configuration block with the map style selected from an available data provider. Detailed below.
    map_name str

    The name for the map resource.

    The following arguments are optional:

    description str
    An optional description for the map resource.
    tags Mapping[str, str]
    Key-value tags for the map. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    configuration Property Map
    Configuration block with the map style selected from an available data provider. Detailed below.
    mapName String

    The name for the map resource.

    The following arguments are optional:

    description String
    An optional description for the map resource.
    tags Map<String>
    Key-value tags for the map. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

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

    CreateTime string
    The timestamp for when the map resource was created in ISO 8601 format.
    Id string
    The provider-assigned unique ID for this managed resource.
    MapArn string
    The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    UpdateTime string
    The timestamp for when the map resource was last updated in ISO 8601 format.
    CreateTime string
    The timestamp for when the map resource was created in ISO 8601 format.
    Id string
    The provider-assigned unique ID for this managed resource.
    MapArn string
    The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    UpdateTime string
    The timestamp for when the map resource was last updated in ISO 8601 format.
    createTime String
    The timestamp for when the map resource was created in ISO 8601 format.
    id String
    The provider-assigned unique ID for this managed resource.
    mapArn String
    The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    updateTime String
    The timestamp for when the map resource was last updated in ISO 8601 format.
    createTime string
    The timestamp for when the map resource was created in ISO 8601 format.
    id string
    The provider-assigned unique ID for this managed resource.
    mapArn string
    The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    updateTime string
    The timestamp for when the map resource was last updated in ISO 8601 format.
    create_time str
    The timestamp for when the map resource was created in ISO 8601 format.
    id str
    The provider-assigned unique ID for this managed resource.
    map_arn str
    The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    update_time str
    The timestamp for when the map resource was last updated in ISO 8601 format.
    createTime String
    The timestamp for when the map resource was created in ISO 8601 format.
    id String
    The provider-assigned unique ID for this managed resource.
    mapArn String
    The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

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

    Look up Existing Map Resource

    Get an existing Map 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?: MapState, opts?: CustomResourceOptions): Map
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[MapConfigurationArgs] = None,
        create_time: Optional[str] = None,
        description: Optional[str] = None,
        map_arn: Optional[str] = None,
        map_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        update_time: Optional[str] = None) -> Map
    func GetMap(ctx *Context, name string, id IDInput, state *MapState, opts ...ResourceOption) (*Map, error)
    public static Map Get(string name, Input<string> id, MapState? state, CustomResourceOptions? opts = null)
    public static Map get(String name, Output<String> id, MapState 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:
    Configuration MapConfiguration
    Configuration block with the map style selected from an available data provider. Detailed below.
    CreateTime string
    The timestamp for when the map resource was created in ISO 8601 format.
    Description string
    An optional description for the map resource.
    MapArn string
    The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS.
    MapName string

    The name for the map resource.

    The following arguments are optional:

    Tags Dictionary<string, string>
    Key-value tags for the map. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    UpdateTime string
    The timestamp for when the map resource was last updated in ISO 8601 format.
    Configuration MapConfigurationArgs
    Configuration block with the map style selected from an available data provider. Detailed below.
    CreateTime string
    The timestamp for when the map resource was created in ISO 8601 format.
    Description string
    An optional description for the map resource.
    MapArn string
    The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS.
    MapName string

    The name for the map resource.

    The following arguments are optional:

    Tags map[string]string
    Key-value tags for the map. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    UpdateTime string
    The timestamp for when the map resource was last updated in ISO 8601 format.
    configuration MapConfiguration
    Configuration block with the map style selected from an available data provider. Detailed below.
    createTime String
    The timestamp for when the map resource was created in ISO 8601 format.
    description String
    An optional description for the map resource.
    mapArn String
    The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS.
    mapName String

    The name for the map resource.

    The following arguments are optional:

    tags Map<String,String>
    Key-value tags for the map. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    updateTime String
    The timestamp for when the map resource was last updated in ISO 8601 format.
    configuration MapConfiguration
    Configuration block with the map style selected from an available data provider. Detailed below.
    createTime string
    The timestamp for when the map resource was created in ISO 8601 format.
    description string
    An optional description for the map resource.
    mapArn string
    The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS.
    mapName string

    The name for the map resource.

    The following arguments are optional:

    tags {[key: string]: string}
    Key-value tags for the map. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    updateTime string
    The timestamp for when the map resource was last updated in ISO 8601 format.
    configuration MapConfigurationArgs
    Configuration block with the map style selected from an available data provider. Detailed below.
    create_time str
    The timestamp for when the map resource was created in ISO 8601 format.
    description str
    An optional description for the map resource.
    map_arn str
    The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS.
    map_name str

    The name for the map resource.

    The following arguments are optional:

    tags Mapping[str, str]
    Key-value tags for the map. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    update_time str
    The timestamp for when the map resource was last updated in ISO 8601 format.
    configuration Property Map
    Configuration block with the map style selected from an available data provider. Detailed below.
    createTime String
    The timestamp for when the map resource was created in ISO 8601 format.
    description String
    An optional description for the map resource.
    mapArn String
    The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS.
    mapName String

    The name for the map resource.

    The following arguments are optional:

    tags Map<String>
    Key-value tags for the map. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

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

    Supporting Types

    MapConfiguration, MapConfigurationArgs

    Style string
    Specifies the map style selected from an available data provider. Valid values can be found in the Location Service CreateMap API Reference.
    Style string
    Specifies the map style selected from an available data provider. Valid values can be found in the Location Service CreateMap API Reference.
    style String
    Specifies the map style selected from an available data provider. Valid values can be found in the Location Service CreateMap API Reference.
    style string
    Specifies the map style selected from an available data provider. Valid values can be found in the Location Service CreateMap API Reference.
    style str
    Specifies the map style selected from an available data provider. Valid values can be found in the Location Service CreateMap API Reference.
    style String
    Specifies the map style selected from an available data provider. Valid values can be found in the Location Service CreateMap API Reference.

    Import

    Using pulumi import, import aws_location_map resources using the map name. For example:

    $ pulumi import aws:location/map:Map example example

    To learn more about importing existing cloud resources, see Importing resources.

    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

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws