software.amazon.awssdk.http.auth.aws.signer

Class RegionSet

java.lang.Object

software.amazon.awssdk.http.auth.aws.signer.RegionSet

@Immutable
public final class RegionSet
extends Object

This class represents the concept of a set of regions.

A region-set can contain one or more comma-separated AWS regions, or a single wildcard to represent all regions ("global"). Whitespace is trimmed from entries of the set.

Examples of region-sets:

• '*' - Represents all regions, global
• 'eu-west-1' - Represents a single region, eu-west-1
• 'us-west-2,us-east-1' - Represents 2 regions, us-west-2 and us-east-1

Field Summary

Fields

Modifier and Type	Field and Description
static RegionSet	GLOBAL The "Global" region, which is represented with a single wildcard character: "*".

Method Summary

Modifier and Type	Method and Description
Set<String>	asSet() Gets the set of strings that represent this RegionSet.
String	asString() Gets the string representation of this RegionSet.
static RegionSet	create(Collection<String> regions) Creates a RegionSet from the supplied collection.
static RegionSet	create(String value) Creates a RegionSet with the supplied region-set string.
boolean	equals(Object o)
int	hashCode()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

GLOBAL

public static final RegionSet GLOBAL

The "Global" region, which is represented with a single wildcard character: "*".

Method Detail

asString

public String asString()

Gets the string representation of this RegionSet.

asSet

public Set<String> asSet()

Gets the set of strings that represent this RegionSet.

create

public static RegionSet create(String value)

Creates a RegionSet with the supplied region-set string.

Parameters:

value - See class documentation RegionSet for the expected format.

create

public static RegionSet create(Collection<String> regions)

Creates a RegionSet from the supplied collection.

Parameters:

regions - A collection of regions.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object