com.amazonaws.appflow.custom.connector.model.settings

Interface ConnectorRuntimeSetting

All Known Implementing Classes:

ImmutableConnectorRuntimeSetting

@Value.Immutable
public interface ConnectorRuntimeSetting

Represents the setting that the connector needs at runtime and the input will be provided by the AppFlow user. For eg. instanceUrl, maxParallelism etc.

Method Summary

Modifier and Type	Method and Description
List<String>	connectorSuppliedValueOptions() Optional connector supplied value options (with matching data type) that the user can pick from as a value for this runtime setting.
ConnectorRuntimeSettingDataType	dataType() Data type for the connector runtime setting.
String	description() Description of the connector runtime setting.
String	key() Unique identifier for the connector runtime setting.
String	label() Label for the connector runtime setting.
boolean	required() Specifies if this setting is required or not.
ConnectorRuntimeSettingScope	scope() Scope of the runtime setting needed for CONNECTOR_PROFILE, SOURCE, DESTINATION etc.

Method Detail

key

String key()

Unique identifier for the connector runtime setting.

dataType

ConnectorRuntimeSettingDataType dataType()

Data type for the connector runtime setting.

required

boolean required()

Specifies if this setting is required or not.

label

String label()

Label for the connector runtime setting.

description

String description()

Description of the connector runtime setting.

scope

ConnectorRuntimeSettingScope scope()

Scope of the runtime setting needed for CONNECTOR_PROFILE, SOURCE, DESTINATION etc.

connectorSuppliedValueOptions

@Nullable
List<String> connectorSuppliedValueOptions()

Optional connector supplied value options (with matching data type) that the user can pick from as a value for this runtime setting.