Class PlaceIndex
(experimental) A Place Index.
Inherited Members
Namespace: Amazon.CDK.AWS.Location.Alpha
Assembly: Amazon.CDK.AWS.Location.Alpha.dll
Syntax (csharp)
public class PlaceIndex : Resource, IPlaceIndex, IResource
Syntax (vb)
Public Class PlaceIndex
Inherits Resource
Implements IPlaceIndex, IResource
Remarks
Stability: Experimental
See: https://docs.aws.amazon.com/location/latest/developerguide/places-concepts.html
ExampleMetadata: infused
Examples
new PlaceIndex(this, "PlaceIndex", new PlaceIndexProps {
PlaceIndexName = "MyPlaceIndex", // optional, defaults to a generated name
DataSource = DataSource.HERE
});
Synopsis
Constructors
PlaceIndex(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
PlaceIndex(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
PlaceIndex(Construct, String, IPlaceIndexProps) |
Properties
PlaceIndexArn | (experimental) The Amazon Resource Name (ARN) of the place index resource. |
PlaceIndexCreateTime | (experimental) The timestamp for when the place index resource was created in ISO 8601 forma. |
PlaceIndexName | (experimental) The name of the place index. |
PlaceIndexUpdateTime | (experimental) The timestamp for when the place index resource was last updated in ISO 8601 format. |
Methods
FromPlaceIndexArn(Construct, String, String) | (experimental) Use an existing place index by ARN. |
FromPlaceIndexName(Construct, String, String) | (experimental) Use an existing place index by name. |
Grant(IGrantable, String[]) | (experimental) Grant the given principal identity permissions to perform the actions on this place index. |
GrantSearch(IGrantable) | (experimental) Grant the given identity permissions to search using this index. |
Constructors
PlaceIndex(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected PlaceIndex(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
PlaceIndex(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected PlaceIndex(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
PlaceIndex(Construct, String, IPlaceIndexProps)
public PlaceIndex(Construct scope, string id, IPlaceIndexProps props = null)
Parameters
- scope Constructs.Construct
- id System.String
- props IPlaceIndexProps
Remarks
Stability: Experimental
Properties
PlaceIndexArn
(experimental) The Amazon Resource Name (ARN) of the place index resource.
public virtual string PlaceIndexArn { get; }
Property Value
System.String
Remarks
Stability: Experimental
PlaceIndexCreateTime
(experimental) The timestamp for when the place index resource was created in ISO 8601 forma.
public virtual string PlaceIndexCreateTime { get; }
Property Value
System.String
Remarks
Stability: Experimental
Attribute: true
PlaceIndexName
(experimental) The name of the place index.
public virtual string PlaceIndexName { get; }
Property Value
System.String
Remarks
Stability: Experimental
PlaceIndexUpdateTime
(experimental) The timestamp for when the place index resource was last updated in ISO 8601 format.
public virtual string PlaceIndexUpdateTime { get; }
Property Value
System.String
Remarks
Stability: Experimental
Attribute: true
Methods
FromPlaceIndexArn(Construct, String, String)
(experimental) Use an existing place index by ARN.
public static IPlaceIndex FromPlaceIndexArn(Construct scope, string id, string placeIndexArn)
Parameters
- scope Constructs.Construct
- id System.String
- placeIndexArn System.String
Returns
Remarks
Stability: Experimental
FromPlaceIndexName(Construct, String, String)
(experimental) Use an existing place index by name.
public static IPlaceIndex FromPlaceIndexName(Construct scope, string id, string placeIndexName)
Parameters
- scope Constructs.Construct
- id System.String
- placeIndexName System.String
Returns
Remarks
Stability: Experimental
Grant(IGrantable, String[])
(experimental) Grant the given principal identity permissions to perform the actions on this place index.
public virtual Grant Grant(IGrantable grantee, params string[] actions)
Parameters
- grantee IGrantable
- actions System.String[]
Returns
Remarks
Stability: Experimental
GrantSearch(IGrantable)
(experimental) Grant the given identity permissions to search using this index.
public virtual Grant GrantSearch(IGrantable grantee)
Parameters
- grantee IGrantable
Returns
Remarks
Stability: Experimental