Map

class aws_cdk.aws_location_alpha.Map(scope, id, *, style, custom_layers=None, description=None, map_name=None, political_view=None)

Bases: Resource

(experimental) The Amazon Location Service Map.

See:: https://docs.aws.amazon.com/location/latest/developerguide/map-concepts.html
Stability:: experimental
ExampleMetadata:: infused

Example:

location.Map(self, "Map",
    map_name="my-map",
    style=location.Style.VECTOR_ESRI_NAVIGATION,
    custom_layers=[location.CustomLayer.POI]
)

Parameters:

scope (Construct) –
id (str) –
style (Style) – (experimental) Specifies the map style selected from an available data provider.
custom_layers (Optional[Sequence[CustomLayer]]) – (experimental) Specifies the custom layers for the style. Default: - no custom layes
description (Optional[str]) – (experimental) A description for the map. Default: - no description
map_name (Optional[str]) – (experimental) A name for the map. Must be between 1 and 100 characters and contain only alphanumeric characters, hyphens, periods and underscores. Default: - A name is automatically generated
political_view (Optional[PoliticalView]) – (experimental) Specifies the map political view selected from an available data provider. The political view must be used in compliance with applicable laws, including those laws about mapping of the country or region where the maps, images, and other data and third-party content which you access through Amazon Location Service is made available. Default: - no political view

Stability:

experimental

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy (RemovalPolicy) –

Return type:

None

grant(grantee, *actions)

(experimental) Grant the given principal identity permissions to perform the actions on this map.

Parameters:

grantee (IGrantable) –
actions (str) –

Stability:

experimental

Return type:

Grant

grant_rendering(grantee)

(experimental) Grant the given identity permissions to rendering a map resource.

Parameters:

grantee (IGrantable) –

Stability:

experimental

See:

https://docs.aws.amazon.com/location/latest/developerguide/security_iam_id-based-policy-examples.html#security_iam_id-based-policy-examples-get-map-tiles

Return type:

Grant

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

map_arn

(experimental) The Amazon Resource Name (ARN) of the Map.

Stability:: experimental

map_create_time

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

Stability:: experimental
Attribute:: true

map_name

(experimental) The name of the map.

Stability:: experimental

map_update_time

(experimental) The timestamp for when the map resource was last updated in ISO 8601 format.

Stability:: experimental
Attribute:: true

node: The tree node.

stack: The stack in which this resource is defined.

Static Methods

classmethod from_map_arn(scope, id, map_arn)

(experimental) Use an existing map by ARN.

Parameters:

scope (Construct) –
id (str) –
map_arn (str) –

Stability:

experimental

Return type:

IMap

classmethod from_map_name(scope, id, map_name)

(experimental) Use an existing map by name.

Parameters:

scope (Construct) –
id (str) –
map_name (str) –

Stability:

experimental

Return type:

IMap

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool