Class: Aws::LocationService::Types::CreateGeofenceCollectionRequest

Inherits:

Struct

• Object
• Struct
• Aws::LocationService::Types::CreateGeofenceCollectionRequest

Includes:

Structure

Defined in:

lib/aws-sdk-locationservice/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #collection_name ⇒ String

  A custom name for the geofence collection.

• #description ⇒ String

  An optional description for the geofence collection.

• #kms_key_id ⇒ String

  A key identifier for an [Amazon Web Services KMS customer managed key].

• #pricing_plan ⇒ String

  No longer used.

• #pricing_plan_data_source ⇒ String

  This parameter is no longer used.

• #tags ⇒ Hash<String,String>

  Applies one or more tags to the geofence collection.

Instance Attribute Details

#collection_name ⇒ String

A custom name for the geofence collection.

Requirements:

• Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).

• Must be a unique geofence collection name.

• No spaces allowed. For example, ‘ExampleGeofenceCollection`.

Returns:

• (String)

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

class CreateGeofenceCollectionRequest < Struct.new(
  :collection_name,
  :pricing_plan,
  :pricing_plan_data_source,
  :description,
  :tags,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

An optional description for the geofence collection.

Returns:

• (String)

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

class CreateGeofenceCollectionRequest < Struct.new(
  :collection_name,
  :pricing_plan,
  :pricing_plan_data_source,
  :description,
  :tags,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

A key identifier for an [Amazon Web Services KMS customer managed key]. Enter a key ID, key ARN, alias name, or alias ARN.

[1]: docs.aws.amazon.com/kms/latest/developerguide/create-keys.html

Returns:

• (String)

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

class CreateGeofenceCollectionRequest < Struct.new(
  :collection_name,
  :pricing_plan,
  :pricing_plan_data_source,
  :description,
  :tags,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#pricing_plan ⇒ String

No longer used. If included, the only allowed value is ‘RequestBasedUsage`.

Returns:

• (String)

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

class CreateGeofenceCollectionRequest < Struct.new(
  :collection_name,
  :pricing_plan,
  :pricing_plan_data_source,
  :description,
  :tags,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#pricing_plan_data_source ⇒ String

This parameter is no longer used.

Returns:

• (String)

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

class CreateGeofenceCollectionRequest < Struct.new(
  :collection_name,
  :pricing_plan,
  :pricing_plan_data_source,
  :description,
  :tags,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Applies one or more tags to the geofence collection. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

Format: ‘“key” : “value”`

Restrictions:

• Maximum 50 tags per resource

• Each resource tag must be unique with a maximum of one value.

• Maximum key length: 128 Unicode characters in UTF-8

• Maximum value length: 256 Unicode characters in UTF-8

• Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

• Cannot use “aws:” as a prefix for a key.

Returns:

• (Hash<String,String>)

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

class CreateGeofenceCollectionRequest < Struct.new(
  :collection_name,
  :pricing_plan,
  :pricing_plan_data_source,
  :description,
  :tags,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end