Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data ConnectorConfiguration = ConnectorConfiguration' {
- authenticationConfig :: Maybe AuthenticationConfig
- canUseAsDestination :: Maybe Bool
- canUseAsSource :: Maybe Bool
- connectorArn :: Maybe Text
- connectorDescription :: Maybe Text
- connectorLabel :: Maybe Text
- connectorMetadata :: Maybe ConnectorMetadata
- connectorModes :: Maybe [Text]
- connectorName :: Maybe Text
- connectorOwner :: Maybe Text
- connectorProvisioningConfig :: Maybe ConnectorProvisioningConfig
- connectorProvisioningType :: Maybe ConnectorProvisioningType
- connectorRuntimeSettings :: Maybe [ConnectorRuntimeSetting]
- connectorType :: Maybe ConnectorType
- connectorVersion :: Maybe Text
- isPrivateLinkEnabled :: Maybe Bool
- isPrivateLinkEndpointUrlRequired :: Maybe Bool
- logoURL :: Maybe Text
- registeredAt :: Maybe POSIX
- registeredBy :: Maybe Text
- supportedApiVersions :: Maybe [Text]
- supportedDestinationConnectors :: Maybe [ConnectorType]
- supportedOperators :: Maybe [Operators]
- supportedSchedulingFrequencies :: Maybe [ScheduleFrequencyType]
- supportedTriggerTypes :: Maybe [TriggerType]
- supportedWriteOperations :: Maybe [WriteOperationType]
- newConnectorConfiguration :: ConnectorConfiguration
- connectorConfiguration_authenticationConfig :: Lens' ConnectorConfiguration (Maybe AuthenticationConfig)
- connectorConfiguration_canUseAsDestination :: Lens' ConnectorConfiguration (Maybe Bool)
- connectorConfiguration_canUseAsSource :: Lens' ConnectorConfiguration (Maybe Bool)
- connectorConfiguration_connectorArn :: Lens' ConnectorConfiguration (Maybe Text)
- connectorConfiguration_connectorDescription :: Lens' ConnectorConfiguration (Maybe Text)
- connectorConfiguration_connectorLabel :: Lens' ConnectorConfiguration (Maybe Text)
- connectorConfiguration_connectorMetadata :: Lens' ConnectorConfiguration (Maybe ConnectorMetadata)
- connectorConfiguration_connectorModes :: Lens' ConnectorConfiguration (Maybe [Text])
- connectorConfiguration_connectorName :: Lens' ConnectorConfiguration (Maybe Text)
- connectorConfiguration_connectorOwner :: Lens' ConnectorConfiguration (Maybe Text)
- connectorConfiguration_connectorProvisioningConfig :: Lens' ConnectorConfiguration (Maybe ConnectorProvisioningConfig)
- connectorConfiguration_connectorProvisioningType :: Lens' ConnectorConfiguration (Maybe ConnectorProvisioningType)
- connectorConfiguration_connectorRuntimeSettings :: Lens' ConnectorConfiguration (Maybe [ConnectorRuntimeSetting])
- connectorConfiguration_connectorType :: Lens' ConnectorConfiguration (Maybe ConnectorType)
- connectorConfiguration_connectorVersion :: Lens' ConnectorConfiguration (Maybe Text)
- connectorConfiguration_isPrivateLinkEnabled :: Lens' ConnectorConfiguration (Maybe Bool)
- connectorConfiguration_isPrivateLinkEndpointUrlRequired :: Lens' ConnectorConfiguration (Maybe Bool)
- connectorConfiguration_logoURL :: Lens' ConnectorConfiguration (Maybe Text)
- connectorConfiguration_registeredAt :: Lens' ConnectorConfiguration (Maybe UTCTime)
- connectorConfiguration_registeredBy :: Lens' ConnectorConfiguration (Maybe Text)
- connectorConfiguration_supportedApiVersions :: Lens' ConnectorConfiguration (Maybe [Text])
- connectorConfiguration_supportedDestinationConnectors :: Lens' ConnectorConfiguration (Maybe [ConnectorType])
- connectorConfiguration_supportedOperators :: Lens' ConnectorConfiguration (Maybe [Operators])
- connectorConfiguration_supportedSchedulingFrequencies :: Lens' ConnectorConfiguration (Maybe [ScheduleFrequencyType])
- connectorConfiguration_supportedTriggerTypes :: Lens' ConnectorConfiguration (Maybe [TriggerType])
- connectorConfiguration_supportedWriteOperations :: Lens' ConnectorConfiguration (Maybe [WriteOperationType])
Documentation
data ConnectorConfiguration Source #
The configuration settings related to a given connector.
See: newConnectorConfiguration
smart constructor.
ConnectorConfiguration' | |
|
Instances
newConnectorConfiguration :: ConnectorConfiguration Source #
Create a value of ConnectorConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:authenticationConfig:ConnectorConfiguration'
, connectorConfiguration_authenticationConfig
- The authentication config required for the connector.
$sel:canUseAsDestination:ConnectorConfiguration'
, connectorConfiguration_canUseAsDestination
- Specifies whether the connector can be used as a destination.
$sel:canUseAsSource:ConnectorConfiguration'
, connectorConfiguration_canUseAsSource
- Specifies whether the connector can be used as a source.
$sel:connectorArn:ConnectorConfiguration'
, connectorConfiguration_connectorArn
- The Amazon Resource Name (ARN) for the registered connector.
$sel:connectorDescription:ConnectorConfiguration'
, connectorConfiguration_connectorDescription
- A description about the connector.
$sel:connectorLabel:ConnectorConfiguration'
, connectorConfiguration_connectorLabel
- The label used for registering the connector.
$sel:connectorMetadata:ConnectorConfiguration'
, connectorConfiguration_connectorMetadata
- Specifies connector-specific metadata such as oAuthScopes
,
supportedRegions
, privateLinkServiceUrl
, and so on.
$sel:connectorModes:ConnectorConfiguration'
, connectorConfiguration_connectorModes
- The connection modes that the connector supports.
$sel:connectorName:ConnectorConfiguration'
, connectorConfiguration_connectorName
- The connector name.
$sel:connectorOwner:ConnectorConfiguration'
, connectorConfiguration_connectorOwner
- The owner who developed the connector.
$sel:connectorProvisioningConfig:ConnectorConfiguration'
, connectorConfiguration_connectorProvisioningConfig
- The configuration required for registering the connector.
$sel:connectorProvisioningType:ConnectorConfiguration'
, connectorConfiguration_connectorProvisioningType
- The provisioning type used to register the connector.
$sel:connectorRuntimeSettings:ConnectorConfiguration'
, connectorConfiguration_connectorRuntimeSettings
- The required connector runtime settings.
$sel:connectorType:ConnectorConfiguration'
, connectorConfiguration_connectorType
- The connector type.
$sel:connectorVersion:ConnectorConfiguration'
, connectorConfiguration_connectorVersion
- The connector version.
$sel:isPrivateLinkEnabled:ConnectorConfiguration'
, connectorConfiguration_isPrivateLinkEnabled
- Specifies if PrivateLink is enabled for that connector.
$sel:isPrivateLinkEndpointUrlRequired:ConnectorConfiguration'
, connectorConfiguration_isPrivateLinkEndpointUrlRequired
- Specifies if a PrivateLink endpoint URL is required.
$sel:logoURL:ConnectorConfiguration'
, connectorConfiguration_logoURL
- Logo URL of the connector.
$sel:registeredAt:ConnectorConfiguration'
, connectorConfiguration_registeredAt
- The date on which the connector was registered.
$sel:registeredBy:ConnectorConfiguration'
, connectorConfiguration_registeredBy
- Information about who registered the connector.
$sel:supportedApiVersions:ConnectorConfiguration'
, connectorConfiguration_supportedApiVersions
- A list of API versions that are supported by the connector.
$sel:supportedDestinationConnectors:ConnectorConfiguration'
, connectorConfiguration_supportedDestinationConnectors
- Lists the connectors that are available for use as destinations.
$sel:supportedOperators:ConnectorConfiguration'
, connectorConfiguration_supportedOperators
- A list of operators supported by the connector.
$sel:supportedSchedulingFrequencies:ConnectorConfiguration'
, connectorConfiguration_supportedSchedulingFrequencies
- Specifies the supported flow frequency for that connector.
$sel:supportedTriggerTypes:ConnectorConfiguration'
, connectorConfiguration_supportedTriggerTypes
- Specifies the supported trigger types for the flow.
$sel:supportedWriteOperations:ConnectorConfiguration'
, connectorConfiguration_supportedWriteOperations
- A list of write operations supported by the connector.
connectorConfiguration_authenticationConfig :: Lens' ConnectorConfiguration (Maybe AuthenticationConfig) Source #
The authentication config required for the connector.
connectorConfiguration_canUseAsDestination :: Lens' ConnectorConfiguration (Maybe Bool) Source #
Specifies whether the connector can be used as a destination.
connectorConfiguration_canUseAsSource :: Lens' ConnectorConfiguration (Maybe Bool) Source #
Specifies whether the connector can be used as a source.
connectorConfiguration_connectorArn :: Lens' ConnectorConfiguration (Maybe Text) Source #
The Amazon Resource Name (ARN) for the registered connector.
connectorConfiguration_connectorDescription :: Lens' ConnectorConfiguration (Maybe Text) Source #
A description about the connector.
connectorConfiguration_connectorLabel :: Lens' ConnectorConfiguration (Maybe Text) Source #
The label used for registering the connector.
connectorConfiguration_connectorMetadata :: Lens' ConnectorConfiguration (Maybe ConnectorMetadata) Source #
Specifies connector-specific metadata such as oAuthScopes
,
supportedRegions
, privateLinkServiceUrl
, and so on.
connectorConfiguration_connectorModes :: Lens' ConnectorConfiguration (Maybe [Text]) Source #
The connection modes that the connector supports.
connectorConfiguration_connectorName :: Lens' ConnectorConfiguration (Maybe Text) Source #
The connector name.
connectorConfiguration_connectorOwner :: Lens' ConnectorConfiguration (Maybe Text) Source #
The owner who developed the connector.
connectorConfiguration_connectorProvisioningConfig :: Lens' ConnectorConfiguration (Maybe ConnectorProvisioningConfig) Source #
The configuration required for registering the connector.
connectorConfiguration_connectorProvisioningType :: Lens' ConnectorConfiguration (Maybe ConnectorProvisioningType) Source #
The provisioning type used to register the connector.
connectorConfiguration_connectorRuntimeSettings :: Lens' ConnectorConfiguration (Maybe [ConnectorRuntimeSetting]) Source #
The required connector runtime settings.
connectorConfiguration_connectorType :: Lens' ConnectorConfiguration (Maybe ConnectorType) Source #
The connector type.
connectorConfiguration_connectorVersion :: Lens' ConnectorConfiguration (Maybe Text) Source #
The connector version.
connectorConfiguration_isPrivateLinkEnabled :: Lens' ConnectorConfiguration (Maybe Bool) Source #
Specifies if PrivateLink is enabled for that connector.
connectorConfiguration_isPrivateLinkEndpointUrlRequired :: Lens' ConnectorConfiguration (Maybe Bool) Source #
Specifies if a PrivateLink endpoint URL is required.
connectorConfiguration_logoURL :: Lens' ConnectorConfiguration (Maybe Text) Source #
Logo URL of the connector.
connectorConfiguration_registeredAt :: Lens' ConnectorConfiguration (Maybe UTCTime) Source #
The date on which the connector was registered.
connectorConfiguration_registeredBy :: Lens' ConnectorConfiguration (Maybe Text) Source #
Information about who registered the connector.
connectorConfiguration_supportedApiVersions :: Lens' ConnectorConfiguration (Maybe [Text]) Source #
A list of API versions that are supported by the connector.
connectorConfiguration_supportedDestinationConnectors :: Lens' ConnectorConfiguration (Maybe [ConnectorType]) Source #
Lists the connectors that are available for use as destinations.
connectorConfiguration_supportedOperators :: Lens' ConnectorConfiguration (Maybe [Operators]) Source #
A list of operators supported by the connector.
connectorConfiguration_supportedSchedulingFrequencies :: Lens' ConnectorConfiguration (Maybe [ScheduleFrequencyType]) Source #
Specifies the supported flow frequency for that connector.
connectorConfiguration_supportedTriggerTypes :: Lens' ConnectorConfiguration (Maybe [TriggerType]) Source #
Specifies the supported trigger types for the flow.
connectorConfiguration_supportedWriteOperations :: Lens' ConnectorConfiguration (Maybe [WriteOperationType]) Source #
A list of write operations supported by the connector.