software.amazon.awscdk.services.location

Class CfnMap

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.location.CfnMap

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.673Z")
 @Stability(value=Stable)
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnMap(software.constructs.Construct scope, 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
String	getAttrArn() The Amazon Resource Name (ARN) for the map resource.
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` .
String	getAttrDataSource() The data provider for the associated map tiles.
String	getAttrMapArn() Synonym for `Arn` .
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 Map<String,Object>	getCfnProperties()
Object	getConfiguration() Specifies the map style selected from an available data provider.
String	getDescription() An optional description for the map resource.
String	getMapName() The name for the map resource.
String	getPricingPlan() No longer used.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setConfiguration(CfnMap.MapConfigurationProperty value) Specifies the map style selected from an available data provider.
void	setConfiguration(IResolvable value) Specifies the map style selected from an available data provider.
void	setDescription(String value) An optional description for the map resource.
void	setMapName(String value) The name for the map resource.
void	setPricingPlan(String value) No longer used.

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnMap(@NotNull
                                       software.constructs.Construct scope,
                                       @NotNull
                                       String id,
                                       @NotNull
                                       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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
 @NotNull
public String getAttrDataSource()

The data provider for the associated map tiles.

getAttrMapArn

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getConfiguration

@Stability(value=Stable)
 @NotNull
public Object getConfiguration()

Specifies the map style selected from an available data provider.

setConfiguration

@Stability(value=Stable)
public void setConfiguration(@NotNull
                                                      CfnMap.MapConfigurationProperty value)

Specifies the map style selected from an available data provider.

setConfiguration

@Stability(value=Stable)
public void setConfiguration(@NotNull
                                                      IResolvable value)

Specifies the map style selected from an available data provider.

getMapName

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
public void setMapName(@NotNull
                                                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

@Stability(value=Stable)
 @Nullable
public String getDescription()

An optional description for the map resource.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

An optional description for the map resource.

getPricingPlan

@Stability(value=Stable)
 @Nullable
public String getPricingPlan()

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

Allowed Values : RequestBasedUsage

setPricingPlan

@Stability(value=Stable)
public void setPricingPlan(@Nullable
                                                    String value)

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

Allowed Values : RequestBasedUsage