Class: Aws::LocationService::Types::PutGeofenceRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:geofence_properties]

Instance Attribute Summary collapse

Instance Attribute Details

#collection_name ⇒ String

The geofence collection to store the geofence in.

Returns:

  • (String) 


5531
5532
5533
5534
5535
5536
5537
5538
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 5531

class PutGeofenceRequest < Struct.new(
  :collection_name,
  :geofence_id,
  :geometry,
  :geofence_properties)
  SENSITIVE = [:geofence_properties]
  include Aws::Structure
end

#geofence_id ⇒ String

An identifier for the geofence. For example, ExampleGeofence-1.

Returns:

  • (String) 


5531
5532
5533
5534
5535
5536
5537
5538
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 5531

class PutGeofenceRequest < Struct.new(
  :collection_name,
  :geofence_id,
  :geometry,
  :geofence_properties)
  SENSITIVE = [:geofence_properties]
  include Aws::Structure
end

#geofence_properties ⇒ Hash<String,String>

Associates one of more properties with the geofence. A property is a key-value pair stored with the geofence and added to any geofence event triggered with that geofence.

Format: "key" : "value"

Returns:

  • (Hash<String,String>) 


5531
5532
5533
5534
5535
5536
5537
5538
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 5531

class PutGeofenceRequest < Struct.new(
  :collection_name,
  :geofence_id,
  :geometry,
  :geofence_properties)
  SENSITIVE = [:geofence_properties]
  include Aws::Structure
end

#geometry ⇒ Types::GeofenceGeometry

Contains the details to specify the position of the geofence. Can be a circle, a polygon, or a multipolygon. Polygon and MultiPolygon geometries can be defined using their respective parameters, or encoded in Geobuf format using the Geobuf parameter. Including multiple geometry types in the same request will return a validation error.

The geofence Polygon and MultiPolygon formats support a maximum of 1,000 total vertices. The Geobuf format supports a maximum of 100,000 vertices.

Returns:



5531
5532
5533
5534
5535
5536
5537
5538
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 5531

class PutGeofenceRequest < Struct.new(
  :collection_name,
  :geofence_id,
  :geometry,
  :geofence_properties)
  SENSITIVE = [:geofence_properties]
  include Aws::Structure
end