Class: AWSCDK::GameLift::CfnLocationProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
game_lift/cfn_location_props.rb

Overview

Properties for defining a CfnLocation.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(location_name:, tags: nil) ⇒ CfnLocationProps

Returns a new instance of CfnLocationProps.

Parameters:

  • location_name (String) —

    A descriptive name for the custom location.

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

    A list of labels to assign to the new resource.



11
12
13
14
15
16
 
# File 'game_lift/cfn_location_props.rb', line 11

def initialize(location_name:, tags: nil)
  @location_name = location_name
  Jsii::Type.check_type(@location_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "locationName")
  @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

#location_name ⇒ String (readonly)

A descriptive name for the custom location.

Returns:

  • (String)

See Also:



22
23
24
 
# File 'game_lift/cfn_location_props.rb', line 22

def location_name
  @location_name
end

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

A list of labels to assign to the new resource.

Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management, and cost allocation. For more information, see Tagging AWS Resources in the AWS General Rareference .

Returns:

See Also:



29
30
31
 
# File 'game_lift/cfn_location_props.rb', line 29

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



31
32
33
34
35
36
 
# File 'game_lift/cfn_location_props.rb', line 31

def self.jsii_properties
  {
    :location_name => "locationName",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



38
39
40
41
42
43
44
45
 
# File 'game_lift/cfn_location_props.rb', line 38

def to_jsii
  result = {}
  result.merge!({
    "locationName" => @location_name,
    "tags" => @tags,
  })
  result.compact
end