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.Transfer.Types.As2ConnectorConfig

Description

Synopsis

data As2ConnectorConfig = As2ConnectorConfig' {
- compression :: Maybe CompressionEnum
- encryptionAlgorithm :: Maybe EncryptionAlg
- localProfileId :: Maybe Text
- mdnResponse :: Maybe MdnResponse
- mdnSigningAlgorithm :: Maybe MdnSigningAlg
- messageSubject :: Maybe Text
- partnerProfileId :: Maybe Text
- signingAlgorithm :: Maybe SigningAlg
}
newAs2ConnectorConfig :: As2ConnectorConfig
as2ConnectorConfig_compression :: Lens' As2ConnectorConfig (Maybe CompressionEnum)
as2ConnectorConfig_encryptionAlgorithm :: Lens' As2ConnectorConfig (Maybe EncryptionAlg)
as2ConnectorConfig_localProfileId :: Lens' As2ConnectorConfig (Maybe Text)
as2ConnectorConfig_mdnResponse :: Lens' As2ConnectorConfig (Maybe MdnResponse)
as2ConnectorConfig_mdnSigningAlgorithm :: Lens' As2ConnectorConfig (Maybe MdnSigningAlg)
as2ConnectorConfig_messageSubject :: Lens' As2ConnectorConfig (Maybe Text)
as2ConnectorConfig_partnerProfileId :: Lens' As2ConnectorConfig (Maybe Text)
as2ConnectorConfig_signingAlgorithm :: Lens' As2ConnectorConfig (Maybe SigningAlg)

Documentation

data As2ConnectorConfig Source #

Contains the details for a connector object. The connector object is used for AS2 outbound processes, to connect the Transfer Family customer with the trading partner.

See: newAs2ConnectorConfig smart constructor.

Constructors

As2ConnectorConfig'

Fields

compression :: Maybe CompressionEnum
Specifies whether the AS2 file is compressed.
encryptionAlgorithm :: Maybe EncryptionAlg
The algorithm that is used to encrypt the file.
localProfileId :: Maybe Text
A unique identifier for the AS2 local profile.
mdnResponse :: Maybe MdnResponse
Used for outbound requests (from an Transfer Family server to a partner AS2 server) to determine whether the partner response for transfers is synchronous or asynchronous. Specify either of the following values:
- SYNC: The system expects a synchronous MDN response, confirming that the file was transferred successfully (or not).
- NONE: Specifies that no MDN response is required.
mdnSigningAlgorithm :: Maybe MdnSigningAlg
The signing algorithm for the MDN response.
If set to DEFAULT (or not set at all), the value for SigningAlogorithm is used.
messageSubject :: Maybe Text
Used as the Subject HTTP header attribute in AS2 messages that are being sent with the connector.
partnerProfileId :: Maybe Text
A unique identifier for the partner profile for the connector.
signingAlgorithm :: Maybe SigningAlg
The algorithm that is used to sign the AS2 messages sent with the connector.

Instances

Instances details

FromJSON As2ConnectorConfig Source #
Instance details Defined in Amazonka.Transfer.Types.As2ConnectorConfig Methods parseJSON :: Value -> Parser As2ConnectorConfig # parseJSONList :: Value -> Parser [As2ConnectorConfig] #
ToJSON As2ConnectorConfig Source #
Instance details Defined in Amazonka.Transfer.Types.As2ConnectorConfig Methods toJSON :: As2ConnectorConfig -> Value # toEncoding :: As2ConnectorConfig -> Encoding # toJSONList :: [As2ConnectorConfig] -> Value # toEncodingList :: [As2ConnectorConfig] -> Encoding #
Generic As2ConnectorConfig Source #
Instance details Defined in Amazonka.Transfer.Types.As2ConnectorConfig Associated Types type Rep As2ConnectorConfig :: Type -> Type # Methods from :: As2ConnectorConfig -> Rep As2ConnectorConfig x # to :: Rep As2ConnectorConfig x -> As2ConnectorConfig #
Read As2ConnectorConfig Source #
Instance details Defined in Amazonka.Transfer.Types.As2ConnectorConfig Methods readsPrec :: Int -> ReadS As2ConnectorConfig # readList :: ReadS [As2ConnectorConfig] # readPrec :: ReadPrec As2ConnectorConfig # readListPrec :: ReadPrec [As2ConnectorConfig] #
Show As2ConnectorConfig Source #
Instance details Defined in Amazonka.Transfer.Types.As2ConnectorConfig Methods showsPrec :: Int -> As2ConnectorConfig -> ShowS # show :: As2ConnectorConfig -> String # showList :: [As2ConnectorConfig] -> ShowS #
NFData As2ConnectorConfig Source #
Instance details Defined in Amazonka.Transfer.Types.As2ConnectorConfig Methods rnf :: As2ConnectorConfig -> () #
Eq As2ConnectorConfig Source #
Instance details Defined in Amazonka.Transfer.Types.As2ConnectorConfig Methods (==) :: As2ConnectorConfig -> As2ConnectorConfig -> Bool # (/=) :: As2ConnectorConfig -> As2ConnectorConfig -> Bool #
Hashable As2ConnectorConfig Source #
Instance details Defined in Amazonka.Transfer.Types.As2ConnectorConfig Methods hashWithSalt :: Int -> As2ConnectorConfig -> Int # hash :: As2ConnectorConfig -> Int #
type Rep As2ConnectorConfig Source #
Instance details Defined in Amazonka.Transfer.Types.As2ConnectorConfig type Rep As2ConnectorConfig = D1 ('MetaData "As2ConnectorConfig" "Amazonka.Transfer.Types.As2ConnectorConfig" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "As2ConnectorConfig'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "compression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CompressionEnum)) :: S1 ('MetaSel ('Just "encryptionAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionAlg))) :: (S1 ('MetaSel ('Just "localProfileId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "mdnResponse") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MdnResponse)))) :: ((S1 ('MetaSel ('Just "mdnSigningAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MdnSigningAlg)) :: S1 ('MetaSel ('Just "messageSubject") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "partnerProfileId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "signingAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SigningAlg))))))

newAs2ConnectorConfig :: As2ConnectorConfig Source #

Create a value of As2ConnectorConfig 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:compression:As2ConnectorConfig', as2ConnectorConfig_compression - Specifies whether the AS2 file is compressed.

$sel:encryptionAlgorithm:As2ConnectorConfig', as2ConnectorConfig_encryptionAlgorithm - The algorithm that is used to encrypt the file.

$sel:localProfileId:As2ConnectorConfig', as2ConnectorConfig_localProfileId - A unique identifier for the AS2 local profile.

$sel:mdnResponse:As2ConnectorConfig', as2ConnectorConfig_mdnResponse - Used for outbound requests (from an Transfer Family server to a partner AS2 server) to determine whether the partner response for transfers is synchronous or asynchronous. Specify either of the following values:

SYNC: The system expects a synchronous MDN response, confirming that the file was transferred successfully (or not).
NONE: Specifies that no MDN response is required.

$sel:mdnSigningAlgorithm:As2ConnectorConfig', as2ConnectorConfig_mdnSigningAlgorithm - The signing algorithm for the MDN response.

If set to DEFAULT (or not set at all), the value for SigningAlogorithm is used.

$sel:messageSubject:As2ConnectorConfig', as2ConnectorConfig_messageSubject - Used as the Subject HTTP header attribute in AS2 messages that are being sent with the connector.

$sel:partnerProfileId:As2ConnectorConfig', as2ConnectorConfig_partnerProfileId - A unique identifier for the partner profile for the connector.

$sel:signingAlgorithm:As2ConnectorConfig', as2ConnectorConfig_signingAlgorithm - The algorithm that is used to sign the AS2 messages sent with the connector.

as2ConnectorConfig_compression :: Lens' As2ConnectorConfig (Maybe CompressionEnum) Source #

Specifies whether the AS2 file is compressed.

as2ConnectorConfig_encryptionAlgorithm :: Lens' As2ConnectorConfig (Maybe EncryptionAlg) Source #

The algorithm that is used to encrypt the file.

as2ConnectorConfig_localProfileId :: Lens' As2ConnectorConfig (Maybe Text) Source #

A unique identifier for the AS2 local profile.

as2ConnectorConfig_mdnResponse :: Lens' As2ConnectorConfig (Maybe MdnResponse) Source #

Used for outbound requests (from an Transfer Family server to a partner AS2 server) to determine whether the partner response for transfers is synchronous or asynchronous. Specify either of the following values:

SYNC: The system expects a synchronous MDN response, confirming that the file was transferred successfully (or not).
NONE: Specifies that no MDN response is required.

as2ConnectorConfig_mdnSigningAlgorithm :: Lens' As2ConnectorConfig (Maybe MdnSigningAlg) Source #

The signing algorithm for the MDN response.

If set to DEFAULT (or not set at all), the value for SigningAlogorithm is used.

as2ConnectorConfig_messageSubject :: Lens' As2ConnectorConfig (Maybe Text) Source #

Used as the Subject HTTP header attribute in AS2 messages that are being sent with the connector.

as2ConnectorConfig_partnerProfileId :: Lens' As2ConnectorConfig (Maybe Text) Source #

A unique identifier for the partner profile for the connector.

as2ConnectorConfig_signingAlgorithm :: Lens' As2ConnectorConfig (Maybe SigningAlg) Source #

The algorithm that is used to sign the AS2 messages sent with the connector.