software.amazon.awscdk.services.location

Class CfnMap

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.location.CfnMap

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:36.887Z")
public class CfnMap
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Location::Map`.

The AWS::Location::Map resource specifies a map resource in your AWS account, which provides map tiles of different styles sourced from global location data providers.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.location.*;
 CfnMap cfnMap = CfnMap.Builder.create(this, "MyCfnMap")
         .configuration(MapConfigurationProperty.builder()
                 .style("style")
                 .build())
         .mapName("mapName")
         // the properties below are optional
         .description("description")
         .pricingPlan("pricingPlan")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnMap.Builder A fluent builder for CfnMap.
static interface	CfnMap.MapConfigurationProperty Specifies the map tile style selected from an available provider.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnMap(Construct scope, java.lang.String id, CfnMapProps props) Create a new `AWS::Location::Map`.
protected	CfnMap(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnMap(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrArn() The Amazon Resource Name (ARN) for the map resource.
java.lang.String	getAttrCreateTime() The timestamp for when the map resource was created in [ISO 8601](https://docs.aws.amazon.com/https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sssZ` .
java.lang.String	getAttrDataSource() The data provider for the associated map tiles.
java.lang.String	getAttrMapArn() Synonym for `Arn` .
java.lang.String	getAttrUpdateTime() The timestamp for when the map resource was last updated in [ISO 8601](https://docs.aws.amazon.com/https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sssZ` .
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.Object	getConfiguration() Specifies the `MapConfiguration` , including the map style, for the map resource that you create.
java.lang.String	getDescription() An optional description for the map resource.
java.lang.String	getMapName() The name for the map resource.
java.lang.String	getPricingPlan() No longer used.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setConfiguration(CfnMap.MapConfigurationProperty value) Specifies the `MapConfiguration` , including the map style, for the map resource that you create.
void	setConfiguration(IResolvable value) Specifies the `MapConfiguration` , including the map style, for the map resource that you create.
void	setDescription(java.lang.String value) An optional description for the map resource.
void	setMapName(java.lang.String value) The name for the map resource.
void	setPricingPlan(java.lang.String value) No longer used.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnMap

protected CfnMap(software.amazon.jsii.JsiiObjectRef objRef)

CfnMap

protected CfnMap(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnMap

public CfnMap(Construct scope,
              java.lang.String id,
              CfnMapProps props)

Create a new `AWS::Location::Map`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

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

getAttrCreateTime

public java.lang.String getAttrCreateTime()

The timestamp for when the map resource was created in [ISO 8601](https://docs.aws.amazon.com/https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sssZ` .

getAttrDataSource

public java.lang.String getAttrDataSource()

The data provider for the associated map tiles.

getAttrMapArn

public java.lang.String getAttrMapArn()

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

getAttrUpdateTime

public java.lang.String getAttrUpdateTime()

The timestamp for when the map resource was last updated in [ISO 8601](https://docs.aws.amazon.com/https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sssZ` .

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getConfiguration

public java.lang.Object getConfiguration()

Specifies the `MapConfiguration` , including the map style, for the map resource that you create.

The map style defines the look of maps and the data provider for your map resource.

setConfiguration

public void setConfiguration(CfnMap.MapConfigurationProperty value)

Specifies the `MapConfiguration` , including the map style, for the map resource that you create.

The map style defines the look of maps and the data provider for your map resource.

setConfiguration

public void setConfiguration(IResolvable value)

Specifies the `MapConfiguration` , including the map style, for the map resource that you create.

The map style defines the look of maps and the data provider for your map resource.

getMapName

public java.lang.String getMapName()

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 .

setMapName

public void setMapName(java.lang.String value)

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 .

getDescription

public java.lang.String getDescription()

An optional description for the map resource.

setDescription

public void setDescription(java.lang.String value)

An optional description for the map resource.

getPricingPlan

public java.lang.String getPricingPlan()

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

Allowed Values : RequestBasedUsage

setPricingPlan

public void setPricingPlan(java.lang.String value)

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

Allowed Values : RequestBasedUsage