Interface PartitionMetadata

All Known Implementing Classes:
AwsCnPartitionMetadata, AwsEuscPartitionMetadata, AwsIsoBPartitionMetadata, AwsIsoEPartitionMetadata, AwsIsoFPartitionMetadata, AwsIsoPartitionMetadata, AwsPartitionMetadata, AwsUsGovPartitionMetadata
@SdkPublicApi 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
    Description
    default String
    dnsSuffix()
    Returns the DNS suffix, such as amazonaws.com for this partition.
    default String
    dnsSuffix(PartitionEndpointKey key)
    Returns the DNS suffix, such as amazonaws.com for this partition.
    default String
    hostname()
    Returns the hostname pattern, such as {service}.{region}.{dnsSuffix} for this partition.
    default String
    hostname(PartitionEndpointKey key)
    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(String partition)
    Retrieves the partition metadata for a given partition.
    static PartitionMetadata
    of(Region region)
    Retrieves the partition metadata for a given region.
    String
    regionRegex()
    Returns the region regex used for pattern matching for this partition.

  • Method Details

    • dnsSuffix

      default String dnsSuffix()
      Returns the DNS suffix, such as amazonaws.com for this partition. This is the DNS suffix with no EndpointTags.
      Returns:
      The DNS suffix for this partition with no endpoint tags.
      See Also:

    • dnsSuffix

      default String dnsSuffix(PartitionEndpointKey key)
      Returns the DNS suffix, such as amazonaws.com for this partition. This returns the DNS suffix associated with the tags in the provided PartitionEndpointKey.
      Returns:
      The DNS suffix for this partition with the endpoint tags specified in the endpoint key, or null if one is not known.

    • hostname

      default String hostname()
      Returns the hostname pattern, such as {service}.{region}.{dnsSuffix} for this partition. This is the hostname pattern with no EndpointTags.
      Returns:
      The hostname pattern for this partition with no endpoint tags.
      See Also:

    • hostname

      default String hostname(PartitionEndpointKey key)
      Returns the hostname pattern, such as {service}.{region}.{dnsSuffix} for this partition. This returns the hostname associated with the tags in the provided PartitionEndpointKey.
      Returns:
      The hostname pattern for this partition with the endpoint tags specified in the endpoint key, or null if one is not known.

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