Class: Aws::Partitions::Service

Inherits:
Object
  • Object
show all
Defined in:
lib/aws-sdk-core/partitions/service.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Service

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

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :name (required, String)
  • :partition_name (required, String)
  • :region_name (required, Set<String>)
  • :regionalized (required, Boolean)
  • :partition_region (String) 


13
14
15
16
17
18
19
20
 
# File 'lib/aws-sdk-core/partitions/service.rb', line 13

def initialize(options = {})
  @name = options[:name]
  @partition_name = options[:partition_name]
  @regions = options[:regions]
  @regionalized = options[:regionalized]
  @partition_region = options[:partition_region]
  @regions << @partition_region if !@regionalized
end

Instance Attribute Details

#name ⇒ String (readonly)

Returns The name of this service. The name is the module name as used by the AWS SDK for Ruby.

Returns:

  • (String) —

    The name of this service. The name is the module name as used by the AWS SDK for Ruby.



24
25
26
 
# File 'lib/aws-sdk-core/partitions/service.rb', line 24

def name
  @name
end

#partition_name ⇒ String (readonly)

Returns The partition name, e.g “aws”, “aws-cn”, “aws-us-gov”.

Returns:

  • (String) —

    The partition name, e.g “aws”, “aws-cn”, “aws-us-gov”.



27
28
29
 
# File 'lib/aws-sdk-core/partitions/service.rb', line 27

def partition_name
  @partition_name
end

#partition_region ⇒ String? (readonly)

Returns The global patition endpoint for this service. May be ‘nil`.

Returns:

  • (String, nil) —

    The global patition endpoint for this service. May be ‘nil`.



35
36
37
 
# File 'lib/aws-sdk-core/partitions/service.rb', line 35

def partition_region
  @partition_region
end

#regions ⇒ Set<String> (readonly)

Returns The regions this service is available in. Regions are scoped to the partition.

Returns:

  • (Set<String>) —

    The regions this service is available in. Regions are scoped to the partition.



31
32
33
 
# File 'lib/aws-sdk-core/partitions/service.rb', line 31

def regions
  @regions
end

Class Method Details

.build(service_name, service, 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. 



51
52
53
54
55
56
57
58
59
 
# File 'lib/aws-sdk-core/partitions/service.rb', line 51

def build(service_name, service, partition)
  Service.new(
    name: service_name,
    partition_name: partition['partition'],
    regions: regions(service, partition),
    regionalized: service['isRegionalized'] != false,
    partition_region: partition_region(service)
  )
end

Instance Method Details

#regionalized? ⇒ Boolean

Returns ‘false` if the service operates with a single global endpoint for the current partition, returns `true` if the service is available in mutliple regions.

Some services have both a partition endpoint and regional endpoints.

Returns:

  • (Boolean) 


44
45
46
 
# File 'lib/aws-sdk-core/partitions/service.rb', line 44

def regionalized?
  @regionalized
end