PlaceIndex
- class aws_cdk.aws_location_alpha.PlaceIndex(scope, id, *, data_source=None, description=None, intended_use=None, place_index_name=None)
Bases:
Resource
(experimental) A Place Index.
- See:
https://docs.aws.amazon.com/location/latest/developerguide/places-concepts.html
- Stability:
experimental
- ExampleMetadata:
infused
Example:
location.PlaceIndex(self, "PlaceIndex", place_index_name="MyPlaceIndex", # optional, defaults to a generated name data_source=location.DataSource.HERE )
- Parameters:
scope (
Construct
) –id (
str
) –data_source (
Optional
[DataSource
]) – (experimental) Data source for the place index. Default: DataSource.ESRIdescription (
Optional
[str
]) – (experimental) A description for the place index. Default: - no descriptionintended_use (
Optional
[IntendedUse
]) – (experimental) Intend use for the results of an operation. Default: IntendedUse.SINGLE_USEplace_index_name (
Optional
[str
]) – (experimental) A name for the place index. Must be between 1 and 100 characters and contain only alphanumeric characters, hyphens, periods and underscores. Default: - A name is automatically generated
- Stability:
experimental
Methods
- apply_removal_policy(policy)
Apply the given removal policy to this resource.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
).- Parameters:
policy (
RemovalPolicy
) –- Return type:
None
- grant(grantee, *actions)
(experimental) Grant the given principal identity permissions to perform the actions on this place index.
- Parameters:
grantee (
IGrantable
) –actions (
str
) –
- Stability:
experimental
- Return type:
- grant_search(grantee)
(experimental) Grant the given identity permissions to search using this index.
- Parameters:
grantee (
IGrantable
) –- Stability:
experimental
- Return type:
- to_string()
Returns a string representation of this construct.
- Return type:
str
Attributes
- env
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
- node
The tree node.
- place_index_arn
(experimental) The Amazon Resource Name (ARN) of the place index resource.
- Stability:
experimental
- place_index_create_time
(experimental) The timestamp for when the place index resource was created in ISO 8601 format.
- Stability:
experimental
- Attribute:
true
- place_index_name
(experimental) The name of the place index.
- Stability:
experimental
- place_index_update_time
(experimental) The timestamp for when the place index resource was last updated in ISO 8601 format.
- Stability:
experimental
- Attribute:
true
- stack
The stack in which this resource is defined.
Static Methods
- classmethod from_place_index_arn(scope, id, place_index_arn)
(experimental) Use an existing place index by ARN.
- Parameters:
scope (
Construct
) –id (
str
) –place_index_arn (
str
) –
- Stability:
experimental
- Return type:
- classmethod from_place_index_name(scope, id, place_index_name)
(experimental) Use an existing place index by name.
- Parameters:
scope (
Construct
) –id (
str
) –place_index_name (
str
) –
- Stability:
experimental
- Return type:
- classmethod is_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructs
library on disk are seen as independent, completely different libraries. As a consequence, the classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
the other class.npm install
will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
x (
Any
) – Any object.- Return type:
bool
- Returns:
true if
x
is an object created from a class which extendsConstruct
.
- classmethod is_owned_resource(construct)
Returns true if the construct was created by CDK, and false otherwise.
- Parameters:
construct (
IConstruct
) –- Return type:
bool
- classmethod is_resource(construct)
Check whether the given construct is a Resource.
- Parameters:
construct (
IConstruct
) –- Return type:
bool