interface CfnConnectorMixinProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.Mixins.Preview.AWS.Transfer.Mixins.CfnConnectorMixinProps |
 Go | github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awstransfer/mixins#CfnConnectorMixinProps |
 Java | software.amazon.awscdk.mixins.preview.services.transfer.mixins.CfnConnectorMixinProps |
 Python | aws_cdk.mixins_preview.aws_transfer.mixins.CfnConnectorMixinProps |
 TypeScript | @aws-cdk/mixins-preview » aws_transfer » mixins » CfnConnectorMixinProps |
Properties for CfnConnectorPropsMixin.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-connector.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as transfer_mixins } from '@aws-cdk/mixins-preview/aws-transfer';
declare const as2Config: any;
const cfnConnectorMixinProps: transfer_mixins.CfnConnectorMixinProps = {
accessRole: 'accessRole',
as2Config: as2Config,
egressConfig: {
vpcLattice: {
portNumber: 123,
resourceConfigurationArn: 'resourceConfigurationArn',
},
},
egressType: 'egressType',
loggingRole: 'loggingRole',
securityPolicyName: 'securityPolicyName',
sftpConfig: {
maxConcurrentConnections: 123,
trustedHostKeys: ['trustedHostKeys'],
userSecretId: 'userSecretId',
},
tags: [{
key: 'key',
value: 'value',
}],
url: 'url',
};
Properties
| Name | Type | Description |
|---|---|---|
| access | string | Connectors are used to send files using either the AS2 or SFTP protocol. |
| as2 | any | A structure that contains the parameters for an AS2 connector object. |
| egress | IResolvable | Connector | Current egress configuration of the connector, showing how traffic is routed to the SFTP server. |
| egress | string | Type of egress configuration for the connector. |
| logging | string | The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. |
| security | string | The text name of the security policy for the specified connector. |
| sftp | IResolvable | Sftp | A structure that contains the parameters for an SFTP connector object. |
| tags? | Cfn[] | Key-value pairs that can be used to group and search for connectors. |
| url? | string | The URL of the partner's AS2 or SFTP endpoint. |
accessRole?
Type:
string
(optional)
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 AWS 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 AWS 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 AWS Secrets Manager .
as2Config?
Type:
any
(optional)
A structure that contains the parameters for an AS2 connector object.
egressConfig?
Type:
IResolvable | Connector
(optional)
Current egress configuration of the connector, showing how traffic is routed to the SFTP server.
Contains VPC Lattice settings when using VPC_LATTICE egress type.
When using the VPC_LATTICE egress type, AWS Transfer Family uses a managed Service Network to simplify the resource sharing process.
egressType?
Type:
string
(optional)
Type of egress configuration for the connector.
SERVICE_MANAGED uses Transfer Family managed NAT gateways, while VPC_LATTICE routes traffic through customer VPCs using VPC Lattice.
loggingRole?
Type:
string
(optional)
The Amazon Resource Name (ARN) of the AWS 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.
securityPolicyName?
Type:
string
(optional)
The text name of the security policy for the specified connector.
sftpConfig?
Type:
IResolvable | Sftp
(optional)
A structure that contains the parameters for an SFTP connector object.
tags?
Type:
Cfn[]
(optional)
Key-value pairs that can be used to group and search for connectors.
url?
Type:
string
(optional)
The URL of the partner's AS2 or SFTP endpoint.
When creating AS2 connectors or service-managed SFTP connectors (connectors without egress configuration), you must provide a URL to specify the remote server endpoint. For VPC Lattice type connectors, the URL must be null.