| Column Name | Column Data Type |
|---|
connector_id Required Input Column
The unique identifier for the connector. | VARCHAR |
_aws_profile Input Column
The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role. | STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
) |
Show child fields- _aws_profile.account_id
The AWS account id - _aws_profile.assumed_role_arn
The ARN of the assumed role - _aws_profile.name
The unique name of the profile. - _aws_profile.organization
Information about this profile's membership in the AWS organization. Show child fields- _aws_profile.organization.account_name
The name of account speciifed by the organization - _aws_profile.organization.id
The organization id - _aws_profile.organization.master_account
Show child fields- _aws_profile.organization.master_account.email
The organization master account email address - _aws_profile.organization.master_account.id
The organization master account id
- _aws_profile.organization.parents[]
Show child fields- _aws_profile.organization.parents[].id
The id of the parent - _aws_profile.organization.parents[].name
The name of the parent - _aws_profile.organization.parents[].tags[]
Show child fields- _aws_profile.organization.parents[].tags[].key
- _aws_profile.organization.parents[].tags[].value
- _aws_profile.organization.parents[].type
The type of parent can be an organization unit or a root
- _aws_profile.organization.tags[]
Show child fields- _aws_profile.organization.tags[].key
- _aws_profile.organization.tags[].value
- _aws_profile.type
The type of profile, either 'credentials' or 'assumed_role' - _aws_profile.via_profile_name
This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.
|
_aws_region Input Column
The AWS region to use. | VARCHAR |
connector
The structure that contains the details of the connector. | STRUCT(
"arn" VARCHAR,
"connector_id" VARCHAR,
"url" VARCHAR,
"as2_config" STRUCT(
"local_profile_id" VARCHAR,
"partner_profile_id" VARCHAR,
"message_subject" VARCHAR,
"compression" VARCHAR,
"encryption_algorithm" VARCHAR,
"signing_algorithm" VARCHAR,
"mdn_signing_algorithm" VARCHAR,
"mdn_response" VARCHAR,
"basic_auth_secret_id" VARCHAR
),
"access_role" VARCHAR,
"logging_role" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"sftp_config" STRUCT(
"user_secret_id" VARCHAR,
"trusted_host_keys" VARCHAR[]
),
"service_managed_egress_ip_addresses" VARCHAR[],
"security_policy_name" VARCHAR
) |
Show child fields- connector.access_role
Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use. For AS2 connectors With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We use the file’s parent directory (for example, for --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer. If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key. For SFTP connectors Make sure that the access role provides read and write access to the parent directory of the file location that's used in the StartFileTransfer request. Additionally, make sure that the role provides secretsmanager:GetSecretValue permission to Secrets Manager. - connector.arn
The unique Amazon Resource Name (ARN) for the connector. - connector.as2_config
A structure that contains the parameters for an AS2 connector object. Show child fields- connector.as2_config.basic_auth_secret_id
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 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 Amazon Web Services 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=""' - connector.as2_config.compression
Specifies whether the AS2 file is compressed. - connector.as2_config.encryption_algorithm
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. - connector.as2_config.local_profile_id
A unique identifier for the AS2 local profile. - connector.as2_config.mdn_response
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. - connector.as2_config.mdn_signing_algorithm
The signing algorithm for the MDN response. If set to DEFAULT (or not set at all), the value for SigningAlgorithm is used. - connector.as2_config.message_subject
Used as the Subject HTTP header attribute in AS2 messages that are being sent with the connector. - connector.as2_config.partner_profile_id
A unique identifier for the partner profile for the connector. - connector.as2_config.signing_algorithm
The algorithm that is used to sign the AS2 messages sent with the connector.
- connector.connector_id
The unique identifier for the connector. - connector.logging_role
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs. - connector.security_policy_name
The text name of the security policy for the specified connector. - connector.service_managed_egress_ip_addresses[]
- connector.sftp_config
A structure that contains the parameters for an SFTP connector object. Show child fields- connector.sftp_config.trusted_host_keys[]
- connector.sftp_config.user_secret_id
The identifier for the secret (in Amazon Web Services Secrets Manager) that contains the SFTP user's private key, password, or both. The identifier must be the Amazon Resource Name (ARN) of the secret.
- connector.tags[]
Show child fields- connector.tags[].key
The name assigned to the tag that you create. - connector.tags[].value
Contains one or more values that you assigned to the key name you create.
- connector.url
The URL of the partner's AS2 or SFTP endpoint.
|