Helper class used to retrieve AWS connection and credential parameters, validate them and compose a AwsConnectionParams value.
Implements: IConfigurable, IReferenceable
Description
The AwsConnectionResolver class allows you to retrieve AWS connection and credential parameters, validate them and compose a AwsConnectionParams value.
Configuration parameters
- connections:
- discovery_key: (optional) key to retrieve the connection from IDiscovery
- region: (optional) AWS region
- partition: (optional) AWS partition
- service: (optional) AWS service
- resource_type: (optional) AWS resource type
- resource: (optional) AWS resource id
- arn: (optional) AWS resource ARN
- credentials:
- store_key: (optional) key to retrieve the credentials from ICredentialStore
- access_id: AWS access/client id
- access_key: AWS access/client key
References
- *:discovery:*:*:1.0 - (optional) IDiscovery services to resolve connection.
- *:credential-store:*:*:1.0 - (optional) credential stores to resolve credentials.
Fields
Instance methods
configure
Configures a component by passing its configuration parameters.
public
void configure(ConfigParams config)
- config: ConfigParams - configuration parameters to be set.
resolve
Resolves a connection and credential parameters and generates a single AWSConnectionParams value.
public
resolve(context: IContext): Promise<AwsConnectionParams> AwsConnectionParams resolve(IContext) context) throws ApplicationException
- context: IContext - (optional) a context to trace execution through a call chain.
- returns: AwsConnectionParams - receives an AWSConnectionParams value or error.
setReferences
Sets references to dependent components.
public
void setReferences(IReferences references)
- references: IReferences - references to locate the component’s dependencies.