2.2.1 SDK credentials configuration
In order to make calls to the Amazon Web Service the credentials must be configured for the the Amazon SDK. Spring Cloud AWS
provides support to configure an application context specific credentials that are used for each service call for requests done
-by Spring Cloud AWS components. Therefore there must be exactly one configuration of the credentials for an entire application
-context.
![[Tip]](images/tip.png) | Tip |
|---|
The com.amazonaws.auth.DefaultAWSCredentialsProviderChain is used by all the clients if there is no dedicated credentials
- provider defined. This will essentially use the following authentication information - use the environment variables
AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY - use the system properties
aws.accessKeyId and aws.secretKey - use the user specific profile credentials file
- use the instance profile credentials (see below)
|
Based on the overall credentials policy there are different options to configure the credentials. The possible ones are described in
+by Spring Cloud AWS components, with the exception of the Parameter Store Configuration.
+Therefore there must be exactly one configuration of the credentials for an entire application context.
| Tip |
|---|
The com.amazonaws.auth.DefaultAWSCredentialsProviderChain is used by all the clients if there is no dedicated credentials
+ provider defined. This will essentially use the following authentication information - use the environment variables
AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY - use the system properties
aws.accessKeyId and aws.secretKey - use the user specific profile credentials file
- use ECS credentials if the
AWS_CONTAINER_CREDENTIALS_RELATIVE_URI environment variable is set - use the instance profile credentials (see below)
|
Based on the overall credentials policy there are different options to configure the credentials. The possible ones are described in
the following sub-chapters.
Simple credentials configuration
Credentials for the Amazon SDK consist of an access key (which might be shared) and a secret key (which must not be shared). Both
security attributes can be configured using the XML namespaces for each Amazon SDK service created by the Spring Cloud AWS
module. The overall configuration looks like this
<beans ...>
@@ -62,7 +62,13 @@ EC2 (e.g. on a test server) and locally for testing. The next snippet shows a co
<aws-context:simple-credentials access-key="${accessKey:}" secret-key="${secretKey:}"/>
</aws-context:context-credentials>
</beans> | Tip |
|---|
The access-key and secret-key are defined using a placeholder expressions along with a default value to avoid bootstrap
-errors if the properties are not configured at all. |
Parameter Store Configuration credentials and region configuration
The Parameter Store Configuration support uses a bootstrap context to configure a default AWSSimpleSystemsManagement
+client, which uses a com.amazonaws.auth.DefaultAWSCredentialsProviderChain and com.amazonaws.regions.DefaultAwsRegionProviderChain.
+If you want to override this, then you need to
+define your own Spring Cloud bootstrap configuration class
+with a bean of type AWSSimpleSystemsManagement that’s configured to use your chosen credentials and/or region provider.
+Because this context is created when your Spring Cloud Bootstrap context is created, you can’t simply override the bean
+in a regular @Configuration class.
2.2.2 Region configuration
Amazon Web services are available in different regions. Based
on the custom requirements, the user can host the application on different Amazon regions. The spring-cloud-aws-context
module provides a way to define the region for the entire application context.
Explicit region configuration
The region can be explicitly configured using an XML element. This is particularly useful if the region can not be automatically
derived because the application is not hosted on a EC2 instance (e.g. local testing) or the region must be manually overridden.
<beans ...>
diff --git a/spring-cloud-aws/2.0.0.RC2/multi/multi__cloud_environment.html b/spring-cloud-aws/2.0.0.RC2/multi/multi__cloud_environment.html
index 4c31963a..61a3e4a3 100644
--- a/spring-cloud-aws/2.0.0.RC2/multi/multi__cloud_environment.html
+++ b/spring-cloud-aws/2.0.0.RC2/multi/multi__cloud_environment.html
@@ -135,4 +135,18 @@ the specified region and security credentials. Application developers can inject
public ApplicationService(AmazonEC2 amazonEc2) {
this.amazonEc2 = amazonEc2;
}
-}