class CfnPlaceIndexPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Location.Mixins.CfnPlaceIndexPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awslocation/mixins#CfnPlaceIndexPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.location.mixins.CfnPlaceIndexPropsMixin
Python	aws_cdk.mixins_preview.aws_location.mixins.CfnPlaceIndexPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_location » mixins » CfnPlaceIndexPropsMixin

Implements IMixin

Extends Mixin

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.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as location_mixins } from '@aws-cdk/mixins-preview/aws-location';
const cfnPlaceIndexPropsMixin = new location_mixins.CfnPlaceIndexPropsMixin({
  dataSource: 'dataSource',
  dataSourceConfiguration: {
    intendedUse: 'intendedUse',
  },
  description: 'description',
  indexName: 'indexName',
  pricingPlan: 'pricingPlan',
  tags: [{
    key: 'key',
    value: 'value',
  }],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnPlaceIndexPropsMixin(props: CfnPlaceIndexMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnPlaceIndexMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

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

Properties

Name	Type	Description
props	CfnPlaceIndexMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnPlaceIndexMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.