software.amazon.awssdk.regions

Interface PartitionMetadata

All Known Implementing Classes:

AwsCnPartitionMetadata, AwsIsoBPartitionMetadata, AwsIsoPartitionMetadata, AwsPartitionMetadata, AwsUsGovPartitionMetadata

public interface PartitionMetadata

Metadata about a partition such as aws or aws-cn.

This is useful for building meta-functionality around AWS services. Partition metadata helps to provide data about regions which may not yet be in the endpoints.json file but have a specific prefix.

Method Summary

Modifier and Type	Method and Description
String	dnsSuffix() Returns the DNS suffix, such as amazonaws.com for this partition.
String	hostname() Returns the hostname pattern, such as {service}.{region}.{dnsSuffix} for this partition.
String	id() Returns the identifier for this partition, such as aws.
String	name() Returns the partition name for this partition, such as AWS Standard
static PartitionMetadata	of(Region region) Retrieves the partition metadata for a given region.
static PartitionMetadata	of(String partition) Retrieves the partition metadata for a given partition.
String	regionRegex() Returns the region regex used for pattern matching for this partition.

Method Detail

dnsSuffix

String dnsSuffix()

Returns the DNS suffix, such as amazonaws.com for this partition.

Returns:

The DNS suffix for this partition.

hostname

String hostname()

Returns the hostname pattern, such as {service}.{region}.{dnsSuffix} for this partition.

Returns:

The hostname pattern for this partition

id

String id()

Returns the identifier for this partition, such as aws.

Returns:

The identifier for this partition.

name

String name()

Returns the partition name for this partition, such as AWS Standard

Returns:

The name of this partition

regionRegex

String regionRegex()

Returns the region regex used for pattern matching for this partition.

Returns:

The region regex of this partition.

of

static PartitionMetadata of(String partition)

Retrieves the partition metadata for a given partition.

Parameters:

partition - The partition to get metadata for.

Returns:

PartitionMetadata for the given partition.

of

static PartitionMetadata of(Region region)

Retrieves the partition metadata for a given region.

Parameters:

region - The region to get the partition metadata for.

Returns:

PartitionMetadata for the given region.