org.apache.flink.statefun.sdk.kinesis.auth

Class AwsRegion

java.lang.Object

org.apache.flink.statefun.sdk.kinesis.auth.AwsRegion

Direct Known Subclasses:

AwsRegion.CustomEndpointAwsRegion, AwsRegion.DefaultAwsRegion, AwsRegion.SpecificIdAwsRegion

public abstract class AwsRegion
extends java.lang.Object

AWS region to use for connecting to AWS Kinesis.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AwsRegion.CustomEndpointAwsRegion
static class	AwsRegion.DefaultAwsRegion
static class	AwsRegion.SpecificIdAwsRegion

Method Summary

Modifier and Type	Method and Description
AwsRegion.CustomEndpointAwsRegion	asCustomEndpoint() Returns this region as a AwsRegion.CustomEndpointAwsRegion.
AwsRegion.SpecificIdAwsRegion	asId() Returns this region as a AwsRegion.SpecificIdAwsRegion.
static AwsRegion	fromDefaultProviderChain() Consults AWS's default provider chain to determine the AWS region.
boolean	isCustomEndpoint() Checks whether the region is specified with a custom non-standard AWS service endpoint.
boolean	isDefault() Checks whether the region is configured to be obtained from AWS's default provider chain.
boolean	isId() Checks whether the region is specified with the region's unique id.
static AwsRegion	ofCustomEndpoint(java.lang.String serviceEndpoint, java.lang.String regionId) Connects to an AWS region through a non-standard AWS service endpoint.
static AwsRegion	ofId(java.lang.String id) Specifies an AWS region using the region's unique id.

Methods inherited from class java.lang.Object

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

Method Detail

fromDefaultProviderChain

public static AwsRegion fromDefaultProviderChain()

Consults AWS's default provider chain to determine the AWS region.

ofId

public static AwsRegion ofId(java.lang.String id)

Specifies an AWS region using the region's unique id.

ofCustomEndpoint

public static AwsRegion ofCustomEndpoint(java.lang.String serviceEndpoint,
                                         java.lang.String regionId)

Connects to an AWS region through a non-standard AWS service endpoint. This is typically used only for development and testing purposes.

isDefault

public boolean isDefault()

Checks whether the region is configured to be obtained from AWS's default provider chain.

isId

public boolean isId()

Checks whether the region is specified with the region's unique id.

isCustomEndpoint

public boolean isCustomEndpoint()

Checks whether the region is specified with a custom non-standard AWS service endpoint.

asId

public AwsRegion.SpecificIdAwsRegion asId()

Returns this region as a AwsRegion.SpecificIdAwsRegion.

asCustomEndpoint

public AwsRegion.CustomEndpointAwsRegion asCustomEndpoint()

Returns this region as a AwsRegion.CustomEndpointAwsRegion.