Class CfnConnectorPropsMixin.As2ConfigProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnConnectorPropsMixin.As2ConfigProperty>
- Enclosing interface:
CfnConnectorPropsMixin.As2ConfigProperty
CfnConnectorPropsMixin.As2ConfigProperty-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionasyncMdnConfig(CfnConnectorPropsMixin.ConnectorAsyncMdnConfigProperty asyncMdnConfig) Sets the value ofCfnConnectorPropsMixin.As2ConfigProperty.getAsyncMdnConfig()asyncMdnConfig(IResolvable asyncMdnConfig) Sets the value ofCfnConnectorPropsMixin.As2ConfigProperty.getAsyncMdnConfig()basicAuthSecretId(String basicAuthSecretId) Sets the value ofCfnConnectorPropsMixin.As2ConfigProperty.getBasicAuthSecretId()build()Builds the configured instance.compression(String compression) Sets the value ofCfnConnectorPropsMixin.As2ConfigProperty.getCompression()encryptionAlgorithm(String encryptionAlgorithm) Sets the value ofCfnConnectorPropsMixin.As2ConfigProperty.getEncryptionAlgorithm()localProfileId(String localProfileId) Sets the value ofCfnConnectorPropsMixin.As2ConfigProperty.getLocalProfileId()mdnResponse(String mdnResponse) Sets the value ofCfnConnectorPropsMixin.As2ConfigProperty.getMdnResponse()mdnSigningAlgorithm(String mdnSigningAlgorithm) Sets the value ofCfnConnectorPropsMixin.As2ConfigProperty.getMdnSigningAlgorithm()messageSubject(String messageSubject) Sets the value ofCfnConnectorPropsMixin.As2ConfigProperty.getMessageSubject()partnerProfileId(String partnerProfileId) Sets the value ofCfnConnectorPropsMixin.As2ConfigProperty.getPartnerProfileId()preserveContentType(String preserveContentType) Sets the value ofCfnConnectorPropsMixin.As2ConfigProperty.getPreserveContentType()signingAlgorithm(String signingAlgorithm) Sets the value ofCfnConnectorPropsMixin.As2ConfigProperty.getSigningAlgorithm()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
asyncMdnConfig
@Stability(Stable) public CfnConnectorPropsMixin.As2ConfigProperty.Builder asyncMdnConfig(IResolvable asyncMdnConfig) Sets the value ofCfnConnectorPropsMixin.As2ConfigProperty.getAsyncMdnConfig()- Parameters:
asyncMdnConfig- the value to be set.- Returns:
this
-
asyncMdnConfig
@Stability(Stable) public CfnConnectorPropsMixin.As2ConfigProperty.Builder asyncMdnConfig(CfnConnectorPropsMixin.ConnectorAsyncMdnConfigProperty asyncMdnConfig) Sets the value ofCfnConnectorPropsMixin.As2ConfigProperty.getAsyncMdnConfig()- Parameters:
asyncMdnConfig- the value to be set.- Returns:
this
-
basicAuthSecretId
@Stability(Stable) public CfnConnectorPropsMixin.As2ConfigProperty.Builder basicAuthSecretId(String basicAuthSecretId) Sets the value ofCfnConnectorPropsMixin.As2ConfigProperty.getBasicAuthSecretId()- Parameters:
basicAuthSecretId- Provides Basic authentication support to the AS2 Connectors API. To use Basic authentication, you must provide the name or Amazon Resource Name (ARN) of a secret in AWS Secrets Manager .The default value for this parameter is
null, which indicates that Basic authentication is not enabled for the connector.If the connector should use Basic authentication, the secret needs to be in the following format:
{ "Username": "user-name", "Password": "user-password" }Replace
user-nameanduser-passwordwith the credentials for the actual user that is being authenticated.Note the following:
- You are storing these credentials in Secrets Manager, not passing them directly into this API.
- If you are using the API, SDKs, or CloudFormation to configure your connector, then you must create the secret before you can enable Basic authentication. However, if you are using the AWS management console, you can have the system create the secret for you.
If you have previously enabled Basic authentication for a connector, you can disable it by using the
UpdateConnectorAPI call. For example, if you are using the CLI, you can run the following command to remove Basic authentication:update-connector --connector-id my-connector-id --as2-config 'BasicAuthSecretId=""'- Returns:
this
-
compression
@Stability(Stable) public CfnConnectorPropsMixin.As2ConfigProperty.Builder compression(String compression) Sets the value ofCfnConnectorPropsMixin.As2ConfigProperty.getCompression()- Parameters:
compression- Specifies whether the AS2 file is compressed.- Returns:
this
-
encryptionAlgorithm
@Stability(Stable) public CfnConnectorPropsMixin.As2ConfigProperty.Builder encryptionAlgorithm(String encryptionAlgorithm) Sets the value ofCfnConnectorPropsMixin.As2ConfigProperty.getEncryptionAlgorithm()- Parameters:
encryptionAlgorithm- The algorithm that is used to encrypt the file. Note the following:- Do not use the
DES_EDE3_CBCalgorithm unless you must support a legacy client that requires it, as it is a weak encryption algorithm. - You can only specify
NONEif the URL for your connector uses HTTPS. Using HTTPS ensures that no traffic is sent in clear text.
- Do not use the
- Returns:
this
-
localProfileId
@Stability(Stable) public CfnConnectorPropsMixin.As2ConfigProperty.Builder localProfileId(String localProfileId) Sets the value ofCfnConnectorPropsMixin.As2ConfigProperty.getLocalProfileId()- Parameters:
localProfileId- A unique identifier for the AS2 local profile.- Returns:
this
-
mdnResponse
@Stability(Stable) public CfnConnectorPropsMixin.As2ConfigProperty.Builder mdnResponse(String mdnResponse) Sets the value ofCfnConnectorPropsMixin.As2ConfigProperty.getMdnResponse()- Parameters:
mdnResponse- Used for outbound requests (from an AWS Transfer Family connector 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.
- Returns:
this
-
mdnSigningAlgorithm
@Stability(Stable) public CfnConnectorPropsMixin.As2ConfigProperty.Builder mdnSigningAlgorithm(String mdnSigningAlgorithm) Sets the value ofCfnConnectorPropsMixin.As2ConfigProperty.getMdnSigningAlgorithm()- Parameters:
mdnSigningAlgorithm- The signing algorithm for the MDN response.If set to DEFAULT (or not set at all), the value for
SigningAlgorithmis used.- Returns:
this
-
messageSubject
@Stability(Stable) public CfnConnectorPropsMixin.As2ConfigProperty.Builder messageSubject(String messageSubject) Sets the value ofCfnConnectorPropsMixin.As2ConfigProperty.getMessageSubject()- Parameters:
messageSubject- Used as theSubjectHTTP header attribute in AS2 messages that are being sent with the connector.- Returns:
this
-
partnerProfileId
@Stability(Stable) public CfnConnectorPropsMixin.As2ConfigProperty.Builder partnerProfileId(String partnerProfileId) Sets the value ofCfnConnectorPropsMixin.As2ConfigProperty.getPartnerProfileId()- Parameters:
partnerProfileId- A unique identifier for the partner profile for the connector.- Returns:
this
-
preserveContentType
@Stability(Stable) public CfnConnectorPropsMixin.As2ConfigProperty.Builder preserveContentType(String preserveContentType) Sets the value ofCfnConnectorPropsMixin.As2ConfigProperty.getPreserveContentType()- Parameters:
preserveContentType- Specifies whether to use the AWS S3 object content-type as the content-type for the AS2 message.- Returns:
this
-
signingAlgorithm
@Stability(Stable) public CfnConnectorPropsMixin.As2ConfigProperty.Builder signingAlgorithm(String signingAlgorithm) Sets the value ofCfnConnectorPropsMixin.As2ConfigProperty.getSigningAlgorithm()- Parameters:
signingAlgorithm- The algorithm that is used to sign the AS2 messages sent with the connector.- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnConnectorPropsMixin.As2ConfigProperty>- Returns:
- a new instance of
CfnConnectorPropsMixin.As2ConfigProperty - Throws:
NullPointerException- if any required attribute was not provided
-