Class: Aws::Partitions::Region

Inherits:
Object
  • Object
show all
Defined in:
lib/aws-partitions/region.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Region

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Region.

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :name (required, String)
  • :description (required, String)
  • :partition_name (required, String)
  • :services (required, Set<String>) 


14
15
16
17
18
19
 
# File 'lib/aws-partitions/region.rb', line 14

def initialize(options = {})
  @name = options[:name]
  @description = options[:description]
  @partition_name = options[:partition_name]
  @services = options[:services]
end

Instance Attribute Details

#description ⇒ String (readonly)

Returns A short description of this region.

Returns:

  • (String) —

    A short description of this region.



25
26
27
 
# File 'lib/aws-partitions/region.rb', line 25

def description
  @description
end

#name ⇒ String (readonly)

Returns The name of this region, e.g. “us-east-1”.

Returns:

  • (String) —

    The name of this region, e.g. “us-east-1”.



22
23
24
 
# File 'lib/aws-partitions/region.rb', line 22

def name
  @name
end

#partition_name ⇒ String (readonly)

Returns The partition this region exists in, e.g. “aws”, “aws-cn”, “aws-us-gov”.

Returns:

  • (String) —

    The partition this region exists in, e.g. “aws”, “aws-cn”, “aws-us-gov”.



29
30
31
 
# File 'lib/aws-partitions/region.rb', line 29

def partition_name
  @partition_name
end

#services ⇒ Set<String> (readonly)

Returns The list of services available in this region. Service names are the module names as used by the AWS SDK for Ruby.

Returns:

  • (Set<String>) —

    The list of services available in this region. Service names are the module names as used by the AWS SDK for Ruby.



34
35
36
 
# File 'lib/aws-partitions/region.rb', line 34

def services
  @services
end

Class Method Details

.build(region_name, region, partition) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



39
40
41
42
43
44
45
46
 
# File 'lib/aws-partitions/region.rb', line 39

def build(region_name, region, partition)
  Region.new(
    name: region_name,
    description: region['description'],
    partition_name: partition['partition'],
    services: region_services(region_name, partition)
  )
end