com.amazonaws.appflow.custom.connector.model

Interface ConnectorContext

All Known Implementing Classes:

ImmutableConnectorContext

@Value.Immutable
public interface ConnectorContext

Represents the Connector Context which contains the connectorRuntimeSettings, credentials, apiVersion, entityMetadata.

Method Summary

Modifier and Type	Method and Description
String	apiVersion() API version to use.
String	connectorProfileLabel() Connector profile name to use for logging.
Map<String,String>	connectorRuntimeSettings() Connector settings required for API call.
Credentials	credentials() Credentials which will be used to make API call.
EntityDefinition	entityDefinition() Entity definition in compressed form.
String	executionId() Execution Id to use for logging.
String	flowName() Flow name to use for logging.

Method Detail

connectorRuntimeSettings

@Nullable
Map<String,String> connectorRuntimeSettings()

Connector settings required for API call. For example, for the Read API it will contains all the ConnectorSettingScope.SOURCE settings. Key will be ConnectorSetting.key() and value will be the input provided by user.

credentials

@Nullable
Credentials credentials()

Credentials which will be used to make API call.

apiVersion

String apiVersion()

API version to use. Value will be the API Version supported by Connector as part of Connector Configuration.

flowName

@Nullable
String flowName()

Flow name to use for logging.

Returns:

executionId

@Nullable
String executionId()

Execution Id to use for logging.

Returns:

connectorProfileLabel

@Nullable
String connectorProfileLabel()

Connector profile name to use for logging.

Returns:

entityDefinition

@Nullable
EntityDefinition entityDefinition()

Entity definition in compressed form. As it will be required by calling application as well as connector lambda to serialize/deserialize request/response payload.