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

Amazonka.AppFlow.Types.ConnectorConfiguration

Description

Synopsis

Documentation

data ConnectorConfiguration Source #

The configuration settings related to a given connector.

See: newConnectorConfiguration smart constructor.

Constructors

ConnectorConfiguration'

Fields

authenticationConfig :: Maybe AuthenticationConfig
The authentication config required for the connector.
canUseAsDestination :: Maybe Bool
Specifies whether the connector can be used as a destination.
canUseAsSource :: Maybe Bool
Specifies whether the connector can be used as a source.
connectorArn :: Maybe Text
The Amazon Resource Name (ARN) for the registered connector.
connectorDescription :: Maybe Text
A description about the connector.
connectorLabel :: Maybe Text
The label used for registering the connector.
connectorMetadata :: Maybe ConnectorMetadata
Specifies connector-specific metadata such as oAuthScopes, supportedRegions, privateLinkServiceUrl, and so on.
connectorModes :: Maybe [Text]
The connection modes that the connector supports.
connectorName :: Maybe Text
The connector name.
connectorOwner :: Maybe Text
The owner who developed the connector.
connectorProvisioningConfig :: Maybe ConnectorProvisioningConfig
The configuration required for registering the connector.
connectorProvisioningType :: Maybe ConnectorProvisioningType
The provisioning type used to register the connector.
connectorRuntimeSettings :: Maybe [ConnectorRuntimeSetting]
The required connector runtime settings.
connectorType :: Maybe ConnectorType
The connector type.
connectorVersion :: Maybe Text
The connector version.
isPrivateLinkEnabled :: Maybe Bool
Specifies if PrivateLink is enabled for that connector.
isPrivateLinkEndpointUrlRequired :: Maybe Bool
Specifies if a PrivateLink endpoint URL is required.
logoURL :: Maybe Text
Logo URL of the connector.
registeredAt :: Maybe POSIX
The date on which the connector was registered.
registeredBy :: Maybe Text
Information about who registered the connector.
supportedApiVersions :: Maybe [Text]
A list of API versions that are supported by the connector.
supportedDestinationConnectors :: Maybe [ConnectorType]
Lists the connectors that are available for use as destinations.
supportedOperators :: Maybe [Operators]
A list of operators supported by the connector.
supportedSchedulingFrequencies :: Maybe [ScheduleFrequencyType]
Specifies the supported flow frequency for that connector.
supportedTriggerTypes :: Maybe [TriggerType]
Specifies the supported trigger types for the flow.
supportedWriteOperations :: Maybe [WriteOperationType]
A list of write operations supported by the connector.

Instances

Instances details

FromJSON ConnectorConfiguration Source #
Instance details Defined in Amazonka.AppFlow.Types.ConnectorConfiguration Methods parseJSON :: Value -> Parser ConnectorConfiguration # parseJSONList :: Value -> Parser [ConnectorConfiguration] #
Generic ConnectorConfiguration Source #
Instance details Defined in Amazonka.AppFlow.Types.ConnectorConfiguration Associated Types type Rep ConnectorConfiguration :: Type -> Type # Methods from :: ConnectorConfiguration -> Rep ConnectorConfiguration x # to :: Rep ConnectorConfiguration x -> ConnectorConfiguration #
Read ConnectorConfiguration Source #
Instance details Defined in Amazonka.AppFlow.Types.ConnectorConfiguration Methods readsPrec :: Int -> ReadS ConnectorConfiguration # readList :: ReadS [ConnectorConfiguration] # readPrec :: ReadPrec ConnectorConfiguration # readListPrec :: ReadPrec [ConnectorConfiguration] #
Show ConnectorConfiguration Source #
Instance details Defined in Amazonka.AppFlow.Types.ConnectorConfiguration Methods showsPrec :: Int -> ConnectorConfiguration -> ShowS # show :: ConnectorConfiguration -> String # showList :: [ConnectorConfiguration] -> ShowS #
NFData ConnectorConfiguration Source #
Instance details Defined in Amazonka.AppFlow.Types.ConnectorConfiguration Methods rnf :: ConnectorConfiguration -> () #
Eq ConnectorConfiguration Source #
Instance details Defined in Amazonka.AppFlow.Types.ConnectorConfiguration Methods (==) :: ConnectorConfiguration -> ConnectorConfiguration -> Bool # (/=) :: ConnectorConfiguration -> ConnectorConfiguration -> Bool #
Hashable ConnectorConfiguration Source #
Instance details Defined in Amazonka.AppFlow.Types.ConnectorConfiguration Methods hashWithSalt :: Int -> ConnectorConfiguration -> Int # hash :: ConnectorConfiguration -> Int #
type Rep ConnectorConfiguration Source #
Instance details Defined in Amazonka.AppFlow.Types.ConnectorConfiguration type Rep ConnectorConfiguration = D1 ('MetaData "ConnectorConfiguration" "Amazonka.AppFlow.Types.ConnectorConfiguration" "amazonka-appflow-2.0-3aJWKTszi6ZKDtrkFSqVAB" 'False) (C1 ('MetaCons "ConnectorConfiguration'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "authenticationConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthenticationConfig)) :: (S1 ('MetaSel ('Just "canUseAsDestination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "canUseAsSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: (S1 ('MetaSel ('Just "connectorArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "connectorDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "connectorLabel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "connectorMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConnectorMetadata)) :: (S1 ('MetaSel ('Just "connectorModes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "connectorName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "connectorOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "connectorProvisioningConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConnectorProvisioningConfig))) :: (S1 ('MetaSel ('Just "connectorProvisioningType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConnectorProvisioningType)) :: S1 ('MetaSel ('Just "connectorRuntimeSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ConnectorRuntimeSetting])))))) :: (((S1 ('MetaSel ('Just "connectorType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConnectorType)) :: (S1 ('MetaSel ('Just "connectorVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "isPrivateLinkEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: (S1 ('MetaSel ('Just "isPrivateLinkEndpointUrlRequired") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "logoURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "registeredAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :: ((S1 ('MetaSel ('Just "registeredBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "supportedApiVersions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "supportedDestinationConnectors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ConnectorType])))) :: ((S1 ('MetaSel ('Just "supportedOperators") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Operators])) :: S1 ('MetaSel ('Just "supportedSchedulingFrequencies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ScheduleFrequencyType]))) :: (S1 ('MetaSel ('Just "supportedTriggerTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TriggerType])) :*: S1 ('MetaSel ('Just "supportedWriteOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [WriteOperationType]))))))))

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.