Package software.amazon.awssdk.regions
Interface RegionMetadata
- All Known Implementing Classes:
AfSouth1
,ApEast1
,ApNortheast1
,ApNortheast2
,ApNortheast3
,ApSouth1
,ApSouth2
,ApSoutheast1
,ApSoutheast2
,ApSoutheast3
,ApSoutheast4
,CaCentral1
,CaWest1
,CnNorth1
,CnNorthwest1
,EuCentral1
,EuCentral2
,EuNorth1
,EuSouth1
,EuSouth2
,EuWest1
,EuWest2
,EuWest3
,IlCentral1
,MeCentral1
,MeSouth1
,SaEast1
,UsEast1
,UsEast2
,UsGovEast1
,UsGovWest1
,UsIsobEast1
,UsIsoEast1
,UsIsoWest1
,UsWest1
,UsWest2
public interface RegionMetadata
A collection of metadata about a region. This can be loaded using the
of(Region)
method.-
Method Summary
Modifier and TypeMethodDescriptionReturns the description of this region; ex: "US East (N.domain()
Deprecated.id()
The unique system ID for this region; ex: "us-east-1".static RegionMetadata
Returns the region metadata pertaining to the given region.Returns the metadata for this region's partition.
-
Method Details
-
id
String id()The unique system ID for this region; ex: "us-east-1".- Returns:
- The unique system ID for this region.
-
domain
Deprecated.This information does not consider any endpoint variant factors, likeEndpointTag
s. If those factors are important, useServiceMetadata.endpointFor(ServiceEndpointKey)
orPartitionMetadata.dnsSuffix(PartitionEndpointKey)
.Returns the default domain for this region; ex: "amazonaws.com", without considering anyEndpointTag
s or environment variables.- Returns:
- The domain for this region.
-
partition
PartitionMetadata partition()Returns the metadata for this region's partition. -
description
String description()Returns the description of this region; ex: "US East (N. Virginia)".- Returns:
- The description for this region
-
of
Returns the region metadata pertaining to the given region.- Parameters:
region
- The region to get the metadata for.- Returns:
- The metadata for that region.
-
EndpointTag
s.