CfnPlaceIndexPropsMixin

class aws_cdk.mixins_preview.aws_location.mixins.CfnPlaceIndexPropsMixin(props, *, strategy=None)

Bases: 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. .. epigraph:

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 <https://docs.aws.amazon.com/service-terms>`_ for more details.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-placeindex.html
CloudformationResource:: AWS::Location::PlaceIndex
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_location import mixins as location_mixins

cfn_place_index_props_mixin = location_mixins.CfnPlaceIndexPropsMixin(location_mixins.CfnPlaceIndexMixinProps(
    data_source="dataSource",
    data_source_configuration=location_mixins.CfnPlaceIndexPropsMixin.DataSourceConfigurationProperty(
        intended_use="intendedUse"
    ),
    description="description",
    index_name="indexName",
    pricing_plan="pricingPlan",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnPlaceIndexMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['dataSource', 'dataSourceConfiguration', 'description', 'indexName', 'pricingPlan', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

DataSourceConfigurationProperty

class CfnPlaceIndexPropsMixin.DataSourceConfigurationProperty(*, intended_use=None)

Bases: object

Specifies the data storage option requesting Places.

Parameters:: intended_use (Optional[str]) – Specifies how the results of an operation will be stored by the caller. Valid values include: - SingleUse specifies that the results won’t be stored. - Storage specifies that the result can be cached or stored in a database. Default value: SingleUse
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-location-placeindex-datasourceconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_location import mixins as location_mixins

data_source_configuration_property = location_mixins.CfnPlaceIndexPropsMixin.DataSourceConfigurationProperty(
    intended_use="intendedUse"
)

Attributes

intended_use

Specifies how the results of an operation will be stored by the caller.

Valid values include:

SingleUse specifies that the results won’t be stored.
Storage specifies that the result can be cached or stored in a database.

Default value: SingleUse

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-location-placeindex-datasourceconfiguration.html#cfn-location-placeindex-datasourceconfiguration-intendeduse