Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Native
  3. API Docs
  4. location
  5. getMap

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.location.getMap

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

    Definition of AWS::Location::Map Resource Type

    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,
            opts: Optional[InvokeOptions] = None) -> GetMapResult
def get_map_output(map_name: Optional[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-native:location:getMap
  arguments:
    # arguments dictionary

    The following arguments are supported:

    MapName string

    The name for the map resource.

    Requirements:

    • Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
    • Must be a unique map resource name.
    • No spaces allowed. For example, ExampleMap .
    MapName string

    The name for the map resource.

    Requirements:

    • Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
    • Must be a unique map resource name.
    • No spaces allowed. For example, ExampleMap .
    mapName String

    The name for the map resource.

    Requirements:

    • Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
    • Must be a unique map resource name.
    • No spaces allowed. For example, ExampleMap .
    mapName string

    The name for the map resource.

    Requirements:

    • Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
    • Must be a unique map resource name.
    • No spaces allowed. For example, ExampleMap .
    map_name str

    The name for the map resource.

    Requirements:

    • Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
    • Must be a unique map resource name.
    • No spaces allowed. For example, ExampleMap .
    mapName String

    The name for the map resource.

    Requirements:

    • Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
    • Must be a unique map resource name.
    • No spaces allowed. For example, ExampleMap .

    getMap Result

    The following output properties are available:

    Arn string
    The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS .

    • Format example: arn:aws:geo:region:account-id:maps/ExampleMap
    CreateTime string
    The timestamp for when the map resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    Description string
    An optional description for the map resource.
    MapArn string
    Synonym for Arn . The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS .

    • Format example: arn:aws:geo:region:account-id:maps/ExampleMap
    PricingPlan Pulumi.AwsNative.Location.MapPricingPlan

    No longer used. If included, the only allowed value is RequestBasedUsage .

    Allowed Values : RequestBasedUsage

    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this resource.
    UpdateTime string
    The timestamp for when the map resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    Arn string
    The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS .

    • Format example: arn:aws:geo:region:account-id:maps/ExampleMap
    CreateTime string
    The timestamp for when the map resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    Description string
    An optional description for the map resource.
    MapArn string
    Synonym for Arn . The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS .

    • Format example: arn:aws:geo:region:account-id:maps/ExampleMap
    PricingPlan MapPricingPlan

    No longer used. If included, the only allowed value is RequestBasedUsage .

    Allowed Values : RequestBasedUsage

    Tags Tag
    An array of key-value pairs to apply to this resource.
    UpdateTime string
    The timestamp for when the map resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    arn String
    The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS .

    • Format example: arn:aws:geo:region:account-id:maps/ExampleMap
    createTime String
    The timestamp for when the map resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    description String
    An optional description for the map resource.
    mapArn String
    Synonym for Arn . The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS .

    • Format example: arn:aws:geo:region:account-id:maps/ExampleMap
    pricingPlan MapPricingPlan

    No longer used. If included, the only allowed value is RequestBasedUsage .

    Allowed Values : RequestBasedUsage

    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    updateTime String
    The timestamp for when the map resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    arn string
    The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS .

    • Format example: arn:aws:geo:region:account-id:maps/ExampleMap
    createTime string
    The timestamp for when the map resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    description string
    An optional description for the map resource.
    mapArn string
    Synonym for Arn . The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS .

    • Format example: arn:aws:geo:region:account-id:maps/ExampleMap
    pricingPlan MapPricingPlan

    No longer used. If included, the only allowed value is RequestBasedUsage .

    Allowed Values : RequestBasedUsage

    tags Tag[]
    An array of key-value pairs to apply to this resource.
    updateTime string
    The timestamp for when the map resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    arn str
    The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS .

    • Format example: arn:aws:geo:region:account-id:maps/ExampleMap
    create_time str
    The timestamp for when the map resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    description str
    An optional description for the map resource.
    map_arn str
    Synonym for Arn . The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS .

    • Format example: arn:aws:geo:region:account-id:maps/ExampleMap
    pricing_plan MapPricingPlan

    No longer used. If included, the only allowed value is RequestBasedUsage .

    Allowed Values : RequestBasedUsage

    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource.
    update_time str
    The timestamp for when the map resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    arn String
    The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS .

    • Format example: arn:aws:geo:region:account-id:maps/ExampleMap
    createTime String
    The timestamp for when the map resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    description String
    An optional description for the map resource.
    mapArn String
    Synonym for Arn . The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS .

    • Format example: arn:aws:geo:region:account-id:maps/ExampleMap
    pricingPlan "RequestBasedUsage"

    No longer used. If included, the only allowed value is RequestBasedUsage .

    Allowed Values : RequestBasedUsage

    tags List<Property Map>
    An array of key-value pairs to apply to this resource.
    updateTime String
    The timestamp for when the map resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

    Supporting Types

    MapPricingPlan

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
    pulumi/pulumi-aws-native