AwsConnectionResolver

Helper class used to retrieve AWS connection and credential parameters, validate them and compose an AwsConnectionParams value.

Implements: IConfigurable, IReferenceable

Description

The AwsConnectionResolver class allows you to retrieve AWS connection and credential parameters, validate them and compose an 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

_connection_resolver

Connection resolver.

_connection_resolver: ConnectionResolver

_credential_resolver

Credential resolver.

_credential_resolver: CredentialResolver

Instance methods

configure

Configures a component by passing its configuration parameters.

configure(config: ConfigParams)

  • config: ConfigParams - configuration parameters to be set.

resolve

Resolves a connection and credential parameters and generates a single AWSConnectionParams value.

resolve(context: Optional[IContext]): AwsConnectionParams

  • context: IContext - (optional) a context to trace execution through a call chain.
  • returns: AwsConnectionParams - receives an AWSConnectionParams value or error.

set_references

Sets references to dependent components.

set_references(references: IReferences)

  • references: IReferences - references to locate the component’s dependencies.

Examples

config = ConfigParams.from_tuples(
    "connection.region", "us-east1",
    "connection.service", "s3",
    "connection.bucket", "mybucket",
    "credential.access_id", "XXXXXXXXXX",
    "credential.access_key", "XXXXXXXXXX"
)

connection_resolver = AwsConnectionResolver()
connection_resolver.configure(config)
connection_resolver.set_references(references)
connection_params = connection_resolver.resolve("123")

See also