Class GeofenceCollection

(experimental) A Geofence Collection.

Inheritance

object

Resource

GeofenceCollection

Implements

IGeofenceCollection

IResource

IConstruct

IDependable

IEnvironmentAware

Inherited Members

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(string, IArnComponents)

Resource.GetResourceNameAttribute(string)

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.Location.Alpha

Assembly: Amazon.CDK.AWS.Location.Alpha.dll

Syntax (csharp)

public class GeofenceCollection : Resource, IGeofenceCollection, IResource, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class GeofenceCollection Inherits Resource Implements IGeofenceCollection, IResource, IConstruct, IDependable, IEnvironmentAware

Remarks

Stability: Experimental

See: https://docs.aws.amazon.com/location/latest/developerguide/geofence-tracker-concepts.html#geofence-overview

ExampleMetadata: infused

Examples

Key key;


             new GeofenceCollection(this, "GeofenceCollection", new GeofenceCollectionProps {
                 GeofenceCollectionName = "MyGeofenceCollection",  // optional, defaults to a generated name
                 KmsKey = key
             });

Synopsis

Constructors

GeofenceCollection(Construct, string, IGeofenceCollectionProps?)

(experimental) A Geofence Collection.

Properties

GeofenceCollectionArn	(experimental) The Amazon Resource Name (ARN) of the geofence collection resource.
GeofenceCollectionCreateTime	(experimental) The timestamp for when the geofence collection resource was created in ISO 8601 format.
GeofenceCollectionName	(experimental) The name of the geofence collection.
GeofenceCollectionUpdateTime	(experimental) The timestamp for when the geofence collection resource was last updated in ISO 8601 format.
PROPERTY_INJECTION_ID	(experimental) Uniquely identifies this class.

Methods

FromGeofenceCollectionArn(Construct, string, string)	(experimental) Use an existing geofence collection by ARN.
FromGeofenceCollectionName(Construct, string, string)	(experimental) Use an existing geofence collection by name.
Grant(IGrantable, params string[])	(experimental) Grant the given principal identity permissions to perform the actions on this geofence collection.
GrantRead(IGrantable)	(experimental) Grant the given identity permissions to read this geofence collection.

Constructors

GeofenceCollection(Construct, string, IGeofenceCollectionProps?)

(experimental) A Geofence Collection.

public GeofenceCollection(Construct scope, string id, IGeofenceCollectionProps? props = null)

Parameters

scope Construct

id string

props IGeofenceCollectionProps

Remarks

Stability: Experimental

Properties

GeofenceCollectionArn

(experimental) The Amazon Resource Name (ARN) of the geofence collection resource.

public virtual string GeofenceCollectionArn { get; }

Property Value

string

Remarks

Stability: Experimental

GeofenceCollectionCreateTime

(experimental) The timestamp for when the geofence collection resource was created in ISO 8601 format.

public virtual string GeofenceCollectionCreateTime { get; }

Property Value

string

Remarks

Stability: Experimental

Attribute: true

GeofenceCollectionName

(experimental) The name of the geofence collection.

public virtual string GeofenceCollectionName { get; }

Property Value

string

Remarks

Stability: Experimental

GeofenceCollectionUpdateTime

(experimental) The timestamp for when the geofence collection resource was last updated in ISO 8601 format.

public virtual string GeofenceCollectionUpdateTime { get; }

Property Value

string

Remarks

Stability: Experimental

Attribute: true

PROPERTY_INJECTION_ID

(experimental) Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }

Property Value

string

Remarks

Stability: Experimental

Methods

FromGeofenceCollectionArn(Construct, string, string)

(experimental) Use an existing geofence collection by ARN.

public static IGeofenceCollection FromGeofenceCollectionArn(Construct scope, string id, string geofenceCollectionArn)

Parameters

scope Construct

id string

geofenceCollectionArn string

Returns

IGeofenceCollection

Remarks

Stability: Experimental

FromGeofenceCollectionName(Construct, string, string)

(experimental) Use an existing geofence collection by name.

public static IGeofenceCollection FromGeofenceCollectionName(Construct scope, string id, string geofenceCollectionName)

Parameters

scope Construct

id string

geofenceCollectionName string

Returns

IGeofenceCollection

Remarks

Stability: Experimental

Grant(IGrantable, params string[])

(experimental) Grant the given principal identity permissions to perform the actions on this geofence collection.

public virtual Grant Grant(IGrantable grantee, params string[] actions)

Parameters

grantee IGrantable

actions string[]

Returns

Grant

Remarks

Stability: Experimental

GrantRead(IGrantable)

(experimental) Grant the given identity permissions to read this geofence collection.

public virtual Grant GrantRead(IGrantable grantee)

Parameters

grantee IGrantable

Returns

Grant

Remarks

Stability: Experimental

See: https://docs.aws.amazon.com/location/latest/developerguide/security_iam_id-based-policy-examples.html#security_iam_id-based-policy-examples-read-only-geofences

Implements

IGeofenceCollection

IResource

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware