Experimental

@aws-cdk/aws-location-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

Map L2 construct

The Amazon Location Service Map.

Stability: Experimental
Source: lib/map.ts

Example

new location.Map(this, 'Map', {
  mapName: 'my-map',
  style: location.Style.VECTOR_ESRI_NAVIGATION,
  customLayers: [location.CustomLayer.POI],
});

python

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

java

Map.Builder.create(this, "Map")
        .mapName("my-map")
        .style(Style.VECTOR_ESRI_NAVIGATION)
        .customLayers(List.of(CustomLayer.POI))
        .build();

csharp

// Install: dotnet add package Amazon.CDK.AWS.Location.Alpha
new Map(this, "Map", new MapProps {
    MapName = "my-map",
    Style = Style.VECTOR_ESRI_NAVIGATION,
    CustomLayers = new [] { CustomLayer.POI }
});

// Install: go get github.com/aws/aws-cdk-go/awscdklocationalpha/v2
location.NewMap(this, jsii.String("Map"), &MapProps{
	MapName: jsii.String("my-map"),
	Style: location.Style_VECTOR_ESRI_NAVIGATION,
	CustomLayers: []pOI{
		location.CustomLayer_*pOI,
	},
})

Initializer

new Map(scope: Construct, id: string, props: MapProps)

python

Map(scope: Construct, id: str, props: MapProps)

java

new Map(Construct scope, String id, MapProps props)

csharp

new Map(Construct scope, string id, MapProps props)

NewMap(Scope Construct, Id *string, Props MapProps)

Construct Props

customLayersCustomLayer[]custom_layerstyping.List[CustomLayer]customLayersList<CustomLayer>CustomLayersCustomLayer[]CustomLayers*[]CustomLayer#

Specifies the custom layers for the style.

Default: no custom layers

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#

A description for the map.

Default: no description

mapNamestringmap_namestrmapNameStringMapNamestringMapName*string#

A name for the map.

Default: A name is automatically generated

Must be between 1 and 100 characters and contain only alphanumeric characters, hyphens, periods and underscores.

politicalViewPoliticalViewpolitical_viewPoliticalViewpoliticalViewPoliticalViewPoliticalViewPoliticalViewPoliticalViewPoliticalView#

Specifies the map political view selected from an available data provider.

Default: no political view

notes

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.

styleStylestyleStylestyleStyleStyleStyleStyleStylerequired#

Specifies the map style selected from an available data provider.

Properties

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#

The environment this resource belongs to.

notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

mapArnstringmap_arnstrmapArnStringMapArnstringMapArn*stringrequired#

The Amazon Resource Name (ARN) of the Map.

mapCreateTimestringmap_create_timestrmapCreateTimeStringMapCreateTimestringMapCreateTime*stringrequired#

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

mapNamestringmap_namestrmapNameStringMapNamestringMapName*stringrequired#

The name of the map.

mapUpdateTimestringmap_update_timestrmapUpdateTimeStringMapUpdateTimestringMapUpdateTime*stringrequired#

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

nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#

The tree node.

PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#

Uniquely identifies this class.

stackStackstackStackstackStackStackStackStackStackrequired#

The stack in which this resource is defined.

Methods

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#

Override the cross-stack reference strength for this resource.

notes · 1 parameter

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters

strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#

Apply the given removal policy to this resource.

notes

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).

fromMapArn(scope: Construct, id: string, mapArn: string): IMap@staticmethod def from_map_arn(scope: Construct, id: str, map_arn: str) -> IMappublic static IMap fromMapArn(Construct scope, String id, String mapArn)public static IMap FromMapArn(Construct scope, string id, string mapArn)func FromMapArn(Scope Construct, Id *string, MapArn *string) IMapstatic#

Use an existing map by ARN.

fromMapName(scope: Construct, id: string, mapName: string): IMap@staticmethod def from_map_name(scope: Construct, id: str, map_name: str) -> IMappublic static IMap fromMapName(Construct scope, String id, String mapName)public static IMap FromMapName(Construct scope, string id, string mapName)func FromMapName(Scope Construct, Id *string, MapName *string) IMapstatic#

Use an existing map by name.

grant(grantee: IGrantable, ...actions: string[]): Grantdef grant(self, grantee: IGrantable, actions: str) -> Grantpublic Grant grant(IGrantable grantee, String actions)public Grant Grant(IGrantable grantee, string actions)func Grant(Grantee IGrantable, Actions *string) Grant#

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

[disable-awslint:no-grants]

grantRendering(grantee: IGrantable): Grantdef grant_rendering(self, grantee: IGrantable) -> Grantpublic Grant grantRendering(IGrantable grantee)public Grant GrantRendering(IGrantable grantee)func GrantRendering(Grantee IGrantable) Grant#

Grant the given identity permissions to rendering a map resource [disable-awslint:no-grants].

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

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

xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#

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

isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#

Check whether the given construct is a Resource.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Map L2 construct ​

Example ​

Initializer ​

Construct Props ​

Properties ​

Methods ​

Map L2 construct

Example

Initializer

Construct Props

Properties

Methods