org.springframework.cloud.aws.context.config.annotation

Annotation Type EnableContextRegion

@Retention(value=RUNTIME)
 @Target(value=TYPE)
 @Import(value=ContextRegionConfigurationRegistrar.class)
public @interface EnableContextRegion

Configures a RegionProvider instance for the application context. The region provider will be used for all Amazon Web Service clients that are created inside the application context (by the Spring Cloud AWS classes). A region can be either manually configured region() with a constant expression, dynamic expression (using a SpEL expression) or a place holder. If the application context is running inside a EC2 instance The region can also be dynamically retrieved from the EC2 instance meta-data by enabling the autoDetect() attribute or from the default AWS SDK AwsRegionProviderChain by enabling autoDetect() and useDefaultAwsRegionChain().

Author:

Agim Emruli, Maciej Walkowiak

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	autoDetect Configures the auto-detection of a region that should be fetched from the EC2 meta-data.
String	region Configures the region as a String value.
boolean	useDefaultAwsRegionChain Whether default AWS SDK region provider chain should be used when auto is set to true.

Element Detail

region

public abstract String region

Configures the region as a String value. The value must match to an enum defined in Regions. This attribute is a String value allowing expressions and placeholders to be used for the region configuration.

Returns:

- the region a constant definition, SpEL expression or placeholder definition

Default:

""

autoDetect

public abstract boolean autoDetect

Configures the auto-detection of a region that should be fetched from the EC2 meta-data. Disabled by default.

Returns:

- configures if the region should be fetched by the EC2 meta-data. Must be false if a region is configured in the region() attribute.

Default:

false

useDefaultAwsRegionChain

public abstract boolean useDefaultAwsRegionChain

Whether default AWS SDK region provider chain should be used when auto is set to true.

Returns:

- if default AWS SDK region provider chain should be used for region resolution.

Default:

false