You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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



23
24
25
# File 'gems/aws-partitions/lib/aws-partitions/service.rb', line 23

def name
  @name
end

#partition_nameString (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".



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

def partition_name
  @partition_name
end

#partition_regionString? (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.



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

def partition_region
  @partition_region
end

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



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

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 mutliple regions.

Some services have both a partition endpoint and regional endpoints.

Returns:

  • (Boolean)


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

def regionalized?
  @regionalized
end