Package software.amazon.awscdk.cfnpropertymixins.services.location

Class CfnPlaceIndexPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.location.CfnPlaceIndexPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:01.142Z")
@Stability(Stable)
public class CfnPlaceIndexPropsMixin
extends Mixin
implements software.constructs.IMixin

Specifies a place index resource in your AWS account.

Use a place index resource to geocode addresses and other text queries by using the SearchPlaceIndexForText operation, and reverse geocode coordinates by using the SearchPlaceIndexForPosition operation, and enable autosuggestions by using the SearchPlaceIndexForSuggestions operation.

If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you must not use Esri as your geolocation provider. See section 82 of the AWS service terms for more details.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.location.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnPlaceIndexPropsMixin cfnPlaceIndexPropsMixin = CfnPlaceIndexPropsMixin.Builder.create(CfnPlaceIndexMixinProps.builder()
         .dataSource("dataSource")
         .dataSourceConfiguration(DataSourceConfigurationProperty.builder()
                 .intendedUse("intendedUse")
                 .build())
         .description("description")
         .indexName("indexName")
         .pricingPlan("pricingPlan")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-placeindex.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnPlaceIndexPropsMixin.Builder	A fluent builder for CfnPlaceIndexPropsMixin.
static interface	CfnPlaceIndexPropsMixin.DataSourceConfigurationProperty	Specifies the data storage option requesting Places.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnPlaceIndexPropsMixin(CfnPlaceIndexMixinProps props)	Create a mixin to apply properties to AWS::Location::PlaceIndex.
	CfnPlaceIndexPropsMixin(CfnPlaceIndexMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::Location::PlaceIndex.
protected	CfnPlaceIndexPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPlaceIndexPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnPlaceIndexMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnPlaceIndexPropsMixin

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

CfnPlaceIndexPropsMixin

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

CfnPlaceIndexPropsMixin

@Stability(Stable)
public CfnPlaceIndexPropsMixin(@NotNull
 CfnPlaceIndexMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::Location::PlaceIndex.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnPlaceIndexPropsMixin

@Stability(Stable)
public CfnPlaceIndexPropsMixin(@NotNull
 CfnPlaceIndexMixinProps props)

Create a mixin to apply properties to AWS::Location::PlaceIndex.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnPlaceIndexMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()