Class: Aws::Partitions::Service

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#dualstack_regions ⇒ Set<String> (readonly)

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

Returns:

  • (Set<String>) —

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



42
43
44
 
# File 'gems/aws-partitions/lib/aws-partitions/service.rb', line 42

def dualstack_regions
  @dualstack_regions
end

#fips_regions ⇒ Set<String> (readonly)

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

Returns:

  • (Set<String>) —

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



38
39
40
 
# File 'gems/aws-partitions/lib/aws-partitions/service.rb', line 38

def fips_regions
  @fips_regions
end

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



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

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



30
31
32
 
# File 'gems/aws-partitions/lib/aws-partitions/service.rb', line 30

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.



46
47
48
 
# File 'gems/aws-partitions/lib/aws-partitions/service.rb', line 46

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.



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

def regions
  @regions
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 multiple regions.

Some services have both a partition endpoint and regional endpoints.

Returns:

  • (Boolean) 


55
56
57
 
# File 'gems/aws-partitions/lib/aws-partitions/service.rb', line 55

def regionalized?
  @regionalized
end