Class: AWSCDK::Location::CfnGeofenceCollectionProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
location/cfn_geofence_collection_props.rb

Overview

Properties for defining a CfnGeofenceCollection.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(collection_name:, description: nil, kms_key_id: nil, pricing_plan: nil, pricing_plan_data_source: nil, tags: nil) ⇒ CfnGeofenceCollectionProps

Returns a new instance of CfnGeofenceCollectionProps.

Parameters:

  • collection_name (String) —

    A custom name for the geofence collection.

  • description (String, nil) (defaults to: nil) —

    An optional description for the geofence collection.

  • kms_key_id (String, nil) (defaults to: nil) —

    A key identifier for an AWS KMS customer managed key . Enter a key ID, key ARN, alias name, or alias ARN.

  • pricing_plan (String, nil) (defaults to: nil)
  • pricing_plan_data_source (String, nil) (defaults to: nil) —

    This shape is deprecated since 2022-02-01: Deprecated.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    Applies one or more tags to the geofence collection.



15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'location/cfn_geofence_collection_props.rb', line 15

def initialize(collection_name:, description: nil, kms_key_id: nil, pricing_plan: nil, pricing_plan_data_source: nil, tags: nil)
  @collection_name = collection_name
  Jsii::Type.check_type(@collection_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "collectionName")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @kms_key_id = kms_key_id
  Jsii::Type.check_type(@kms_key_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKeyId") unless @kms_key_id.nil?
  @pricing_plan = pricing_plan
  Jsii::Type.check_type(@pricing_plan, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "pricingPlan") unless @pricing_plan.nil?
  @pricing_plan_data_source = pricing_plan_data_source
  Jsii::Type.check_type(@pricing_plan_data_source, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "pricingPlanDataSource") unless @pricing_plan_data_source.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#collection_name ⇒ String (readonly)

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)

See Also:



40
41
42
 
# File 'location/cfn_geofence_collection_props.rb', line 40

def collection_name
  @collection_name
end

#description ⇒ String? (readonly)

An optional description for the geofence collection.

Returns:

  • (String, nil)

See Also:



45
46
47
 
# File 'location/cfn_geofence_collection_props.rb', line 45

def description
  @description
end

#kms_key_id ⇒ String? (readonly)

A key identifier for an AWS KMS customer managed key . Enter a key ID, key ARN, alias name, or alias ARN.

Returns:

  • (String, nil)

See Also:



50
51
52
 
# File 'location/cfn_geofence_collection_props.rb', line 50

def kms_key_id
  @kms_key_id
end

#pricing_plan ⇒ String? (readonly)

Deprecated.

this property has been deprecated

Returns:

  • (String, nil)

See Also:



54
55
56
 
# File 'location/cfn_geofence_collection_props.rb', line 54

def pricing_plan
  @pricing_plan
end

#pricing_plan_data_source ⇒ String? (readonly)

Deprecated.

this property has been deprecated

This shape is deprecated since 2022-02-01: Deprecated.

No longer allowed.

Returns:

  • (String, nil)

See Also:



62
63
64
 
# File 'location/cfn_geofence_collection_props.rb', line 62

def pricing_plan_data_source
  @pricing_plan_data_source
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

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: + - = . _ : /

Returns:

See Also:



79
80
81
 
# File 'location/cfn_geofence_collection_props.rb', line 79

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



81
82
83
84
85
86
87
88
89
90
 
# File 'location/cfn_geofence_collection_props.rb', line 81

def self.jsii_properties
  {
    :collection_name => "collectionName",
    :description => "description",
    :kms_key_id => "kmsKeyId",
    :pricing_plan => "pricingPlan",
    :pricing_plan_data_source => "pricingPlanDataSource",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'location/cfn_geofence_collection_props.rb', line 92

def to_jsii
  result = {}
  result.merge!({
    "collectionName" => @collection_name,
    "description" => @description,
    "kmsKeyId" => @kms_key_id,
    "pricingPlan" => @pricing_plan,
    "pricingPlanDataSource" => @pricing_plan_data_source,
    "tags" => @tags,
  })
  result.compact
end