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

Interface GeofenceCollectionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

GeofenceCollectionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
           date="2025-05-22T23:40:01.849Z")
@Stability(Experimental)
public interface GeofenceCollectionProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties for a geofence collection.

Example:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	GeofenceCollectionProps.Builder	A builder for GeofenceCollectionProps
static final class	GeofenceCollectionProps.Jsii$Proxy	An implementation for GeofenceCollectionProps

Method Summary

Modifier and Type	Method	Description
static GeofenceCollectionProps.Builder	builder()
default String	getDescription()	(experimental) A description for the geofence collection.
default String	getGeofenceCollectionName()	(experimental) A name for the geofence collection.
default IKey	getKmsKey()	(experimental) The customer managed to encrypt your data.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDescription

@Stability(Experimental)
@Nullable
default String getDescription()

(experimental) A description for the geofence collection.

Default: - no description

getGeofenceCollectionName

@Stability(Experimental)
@Nullable
default String getGeofenceCollectionName()

(experimental) A name for the geofence collection.

Must be between 1 and 100 characters and contain only alphanumeric characters, hyphens, periods and underscores.

Default: - A name is automatically generated

getKmsKey

@Stability(Experimental)
@Nullable
default IKey getKmsKey()

(experimental) The customer managed to encrypt your data.

Default: - Use an AWS managed key

See Also:

• https://docs.aws.amazon.com/location/latest/developerguide/encryption-at-rest.html

builder

@Stability(Experimental)
static GeofenceCollectionProps.Builder builder()

Returns:

a GeofenceCollectionProps.Builder of GeofenceCollectionProps