Package software.amazon.awscdk.services.location.alpha

Class GeofenceCollection

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.location.alpha.GeofenceCollection

All Implemented Interfaces:

IResource, IGeofenceCollection, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-04T00:39:41.999Z")
@Stability(Experimental)
public class GeofenceCollection
extends Resource
implements IGeofenceCollection

(experimental) A Geofence Collection.

Example:

 Key key;
 GeofenceCollection.Builder.create(this, "GeofenceCollection")
         .geofenceCollectionName("MyGeofenceCollection") // optional, defaults to a generated name
         .kmsKey(key)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	GeofenceCollection.Builder	(experimental) A fluent builder for GeofenceCollection.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.location.alpha.IGeofenceCollection

IGeofenceCollection.Jsii$Default, IGeofenceCollection.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GeofenceCollection(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	GeofenceCollection(software.amazon.jsii.JsiiObjectRef objRef)
	GeofenceCollection(software.constructs.Construct scope, String id)
	GeofenceCollection(software.constructs.Construct scope, String id, GeofenceCollectionProps props)

Method Summary

Modifier and Type	Method	Description
static IGeofenceCollection	fromGeofenceCollectionArn(software.constructs.Construct scope, String id, String geofenceCollectionArn)	(experimental) Use an existing geofence collection by ARN.
static IGeofenceCollection	fromGeofenceCollectionName(software.constructs.Construct scope, String id, String geofenceCollectionName)	(experimental) Use an existing geofence collection by name.
String	getGeofenceCollectionArn()	(experimental) The Amazon Resource Name (ARN) of the geofence collection resource.
String	getGeofenceCollectionCreateTime()	(experimental) The timestamp for when the geofence collection resource was created in ISO 8601 format.
String	getGeofenceCollectionName()	(experimental) The name of the geofence collection.
String	getGeofenceCollectionUpdateTime()	(experimental) The timestamp for when the geofence collection resource was last updated in ISO 8601 format.
Grant	grant(IGrantable grantee, @NotNull String... actions)	(experimental) Grant the given principal identity permissions to perform the actions on this geofence collection.
Grant	grantRead(IGrantable grantee)	(experimental) Grant the given identity permissions to read this geofence collection.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

GeofenceCollection

protected GeofenceCollection(software.amazon.jsii.JsiiObjectRef objRef)

GeofenceCollection

protected GeofenceCollection(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

GeofenceCollection

@Stability(Experimental)
public GeofenceCollection(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 GeofenceCollectionProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

GeofenceCollection

@Stability(Experimental)
public GeofenceCollection(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Details

fromGeofenceCollectionArn

@Stability(Experimental)
@NotNull
public static IGeofenceCollection fromGeofenceCollectionArn(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String geofenceCollectionArn)

(experimental) Use an existing geofence collection by ARN.

Parameters:

scope - This parameter is required.

id - This parameter is required.

geofenceCollectionArn - This parameter is required.

fromGeofenceCollectionName

@Stability(Experimental)
@NotNull
public static IGeofenceCollection fromGeofenceCollectionName(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String geofenceCollectionName)

(experimental) Use an existing geofence collection by name.

Parameters:

scope - This parameter is required.

id - This parameter is required.

geofenceCollectionName - This parameter is required.

grant

@Stability(Experimental)
@NotNull
public Grant grant(@NotNull
 IGrantable grantee,
 @NotNull
 @NotNull String... actions)

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

Parameters:

grantee - This parameter is required.

actions - This parameter is required.

grantRead

@Stability(Experimental)
@NotNull
public Grant grantRead(@NotNull
 IGrantable grantee)

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

Parameters:

grantee - This parameter is required.

See Also:

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

getGeofenceCollectionArn

@Stability(Experimental)
@NotNull
public String getGeofenceCollectionArn()

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

Specified by:

getGeofenceCollectionArn in interface IGeofenceCollection

getGeofenceCollectionCreateTime

@Stability(Experimental)
@NotNull
public String getGeofenceCollectionCreateTime()

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

getGeofenceCollectionName

@Stability(Experimental)
@NotNull
public String getGeofenceCollectionName()

(experimental) The name of the geofence collection.

Specified by:

getGeofenceCollectionName in interface IGeofenceCollection

getGeofenceCollectionUpdateTime

@Stability(Experimental)
@NotNull
public String getGeofenceCollectionUpdateTime()

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