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

Inherits:

Struct

• Object
• Struct
• Aws::LocationService::Types::PutGeofenceRequest

Includes:

Structure

Defined in:

lib/aws-sdk-locationservice/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:geofence_properties]

Instance Attribute Summary

• #collection_name ⇒ String

  The geofence collection to store the geofence in.

• #geofence_id ⇒ String

  An identifier for the geofence.

• #geofence_properties ⇒ Hash<String,String>

  Associates one of more properties with the geofence.

• #geometry ⇒ Types::GeofenceGeometry

  Contains the details to specify the position of the geofence.

Instance Attribute Details

#collection_name ⇒ String

The geofence collection to store the geofence in.

# File 'lib/aws-sdk-locationservice/types.rb', line 5582

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`.

# File 'lib/aws-sdk-locationservice/types.rb', line 5582

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”`

# File 'lib/aws-sdk-locationservice/types.rb', line 5582

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.

<note markdown=“1”> The geofence ‘Polygon` and `MultiPolygon` formats support a maximum of 1,000 total vertices. The `Geobuf` format supports a maximum of 100,000 vertices.

</note>

# File 'lib/aws-sdk-locationservice/types.rb', line 5582

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