Class: AWSCDK::Transfer::CfnConnector::As2ConfigProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
transfer/cfn_connector.rb

Overview

A structure that contains the parameters for an AS2 connector object.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(async_mdn_config: nil, basic_auth_secret_id: nil, compression: nil, encryption_algorithm: nil, local_profile_id: nil, mdn_response: nil, mdn_signing_algorithm: nil, message_subject: nil, partner_profile_id: nil, preserve_content_type: nil, signing_algorithm: nil) ⇒ As2ConfigProperty

Returns a new instance of As2ConfigProperty.

Parameters:

  • async_mdn_config (AWSCDK::IResolvable, AWSCDK::Transfer::CfnConnector::ConnectorAsyncMdnConfigProperty, nil) (defaults to: nil)
  • basic_auth_secret_id (String, nil) (defaults to: nil) —

    Provides Basic authentication support to the AS2 Connectors API.

  • compression (String, nil) (defaults to: nil) —

    Specifies whether the AS2 file is compressed.

  • encryption_algorithm (String, nil) (defaults to: nil) —

    The algorithm that is used to encrypt the file.

  • local_profile_id (String, nil) (defaults to: nil) —

    A unique identifier for the AS2 local profile.

  • mdn_response (String, nil) (defaults to: nil) —

    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.

  • mdn_signing_algorithm (String, nil) (defaults to: nil) —

    The signing algorithm for the MDN response.

  • message_subject (String, nil) (defaults to: nil) —

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

  • partner_profile_id (String, nil) (defaults to: nil) —

    A unique identifier for the partner profile for the connector.

  • preserve_content_type (String, nil) (defaults to: nil) —

    Specifies whether to use the AWS S3 object content-type as the content-type for the AS2 message.

  • signing_algorithm (String, nil) (defaults to: nil) —

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



714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
 
# File 'transfer/cfn_connector.rb', line 714

def initialize(async_mdn_config: nil, basic_auth_secret_id: nil, compression: nil, encryption_algorithm: nil, local_profile_id: nil, mdn_response: nil, mdn_signing_algorithm: nil, message_subject: nil, partner_profile_id: nil, preserve_content_type: nil, signing_algorithm: nil)
  @async_mdn_config = async_mdn_config.is_a?(Hash) ? ::AWSCDK::Transfer::CfnConnector::ConnectorAsyncMdnConfigProperty.new(**async_mdn_config.transform_keys(&:to_sym)) : async_mdn_config
  Jsii::Type.check_type(@async_mdn_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c190cmFuc2Zlci5DZm5Db25uZWN0b3IuQ29ubmVjdG9yQXN5bmNNZG5Db25maWdQcm9wZXJ0eSJ9XX19")), "asyncMdnConfig") unless @async_mdn_config.nil?
  @basic_auth_secret_id = basic_auth_secret_id
  Jsii::Type.check_type(@basic_auth_secret_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "basicAuthSecretId") unless @basic_auth_secret_id.nil?
  @compression = compression
  Jsii::Type.check_type(@compression, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "compression") unless @compression.nil?
  @encryption_algorithm = encryption_algorithm
  Jsii::Type.check_type(@encryption_algorithm, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "encryptionAlgorithm") unless @encryption_algorithm.nil?
  @local_profile_id = local_profile_id
  Jsii::Type.check_type(@local_profile_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "localProfileId") unless @local_profile_id.nil?
  @mdn_response = mdn_response
  Jsii::Type.check_type(@mdn_response, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "mdnResponse") unless @mdn_response.nil?
  @mdn_signing_algorithm = mdn_signing_algorithm
  Jsii::Type.check_type(@mdn_signing_algorithm, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "mdnSigningAlgorithm") unless @mdn_signing_algorithm.nil?
  @message_subject = message_subject
  Jsii::Type.check_type(@message_subject, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "messageSubject") unless @message_subject.nil?
  @partner_profile_id = partner_profile_id
  Jsii::Type.check_type(@partner_profile_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "partnerProfileId") unless @partner_profile_id.nil?
  @preserve_content_type = preserve_content_type
  Jsii::Type.check_type(@preserve_content_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "preserveContentType") unless @preserve_content_type.nil?
  @signing_algorithm = signing_algorithm
  Jsii::Type.check_type(@signing_algorithm, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "signingAlgorithm") unless @signing_algorithm.nil?
end

Instance Attribute Details

#async_mdn_config ⇒ AWSCDK::IResolvable, ... (readonly)

Returns:

See Also:



741
742
743
 
# File 'transfer/cfn_connector.rb', line 741

def async_mdn_config
  @async_mdn_config
end

#basic_auth_secret_id ⇒ String? (readonly)

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-name and user-password with 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 UpdateConnector API 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:

  • (String, nil)

See Also:



765
766
767
 
# File 'transfer/cfn_connector.rb', line 765

def basic_auth_secret_id
  @basic_auth_secret_id
end

#compression ⇒ String? (readonly)

Specifies whether the AS2 file is compressed.

Returns:

  • (String, nil)

See Also:



770
771
772
 
# File 'transfer/cfn_connector.rb', line 770

def compression
  @compression
end

#encryption_algorithm ⇒ String? (readonly)

The algorithm that is used to encrypt the file.

Note the following:

  • Do not use the DES_EDE3_CBC algorithm unless you must support a legacy client that requires it, as it is a weak encryption algorithm.
  • You can only specify NONE if the URL for your connector uses HTTPS. Using HTTPS ensures that no traffic is sent in clear text.

Returns:

  • (String, nil)

See Also:



780
781
782
 
# File 'transfer/cfn_connector.rb', line 780

def encryption_algorithm
  @encryption_algorithm
end

#local_profile_id ⇒ String? (readonly)

A unique identifier for the AS2 local profile.

Returns:

  • (String, nil)

See Also:



785
786
787
 
# File 'transfer/cfn_connector.rb', line 785

def local_profile_id
  @local_profile_id
end

#mdn_response ⇒ String? (readonly)

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:

  • (String, nil)

See Also:



795
796
797
 
# File 'transfer/cfn_connector.rb', line 795

def mdn_response
  @mdn_response
end

#mdn_signing_algorithm ⇒ String? (readonly)

The signing algorithm for the MDN response.

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

Returns:

  • (String, nil)

See Also:



802
803
804
 
# File 'transfer/cfn_connector.rb', line 802

def mdn_signing_algorithm
  @mdn_signing_algorithm
end

#message_subject ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



807
808
809
 
# File 'transfer/cfn_connector.rb', line 807

def message_subject
  @message_subject
end

#partner_profile_id ⇒ String? (readonly)

A unique identifier for the partner profile for the connector.

Returns:

  • (String, nil)

See Also:



812
813
814
 
# File 'transfer/cfn_connector.rb', line 812

def partner_profile_id
  @partner_profile_id
end

#preserve_content_type ⇒ String? (readonly)

Specifies whether to use the AWS S3 object content-type as the content-type for the AS2 message.

Returns:

  • (String, nil)

See Also:



817
818
819
 
# File 'transfer/cfn_connector.rb', line 817

def preserve_content_type
  @preserve_content_type
end

#signing_algorithm ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



822
823
824
 
# File 'transfer/cfn_connector.rb', line 822

def signing_algorithm
  @signing_algorithm
end

Class Method Details

.jsii_properties ⇒ Object 



824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
 
# File 'transfer/cfn_connector.rb', line 824

def self.jsii_properties
  {
    :async_mdn_config => "asyncMdnConfig",
    :basic_auth_secret_id => "basicAuthSecretId",
    :compression => "compression",
    :encryption_algorithm => "encryptionAlgorithm",
    :local_profile_id => "localProfileId",
    :mdn_response => "mdnResponse",
    :mdn_signing_algorithm => "mdnSigningAlgorithm",
    :message_subject => "messageSubject",
    :partner_profile_id => "partnerProfileId",
    :preserve_content_type => "preserveContentType",
    :signing_algorithm => "signingAlgorithm",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
 
# File 'transfer/cfn_connector.rb', line 840

def to_jsii
  result = {}
  result.merge!({
    "asyncMdnConfig" => @async_mdn_config,
    "basicAuthSecretId" => @basic_auth_secret_id,
    "compression" => @compression,
    "encryptionAlgorithm" => @encryption_algorithm,
    "localProfileId" => @local_profile_id,
    "mdnResponse" => @mdn_response,
    "mdnSigningAlgorithm" => @mdn_signing_algorithm,
    "messageSubject" => @message_subject,
    "partnerProfileId" => @partner_profile_id,
    "preserveContentType" => @preserve_content_type,
    "signingAlgorithm" => @signing_algorithm,
  })
  result.compact
end