Interface CfnConnectorProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnConnectorProps.Jsii$Proxy
CfnConnector
.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.transfer.*; Object as2Config; CfnConnectorProps cfnConnectorProps = CfnConnectorProps.builder() .accessRole("accessRole") .url("url") // the properties below are optional .as2Config(as2Config) .loggingRole("loggingRole") .securityPolicyName("securityPolicyName") .sftpConfig(SftpConfigProperty.builder() .trustedHostKeys(List.of("trustedHostKeys")) .userSecretId("userSecretId") .build()) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnConnectorProps
static final class
An implementation forCfnConnectorProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnConnectorProps.Builder
builder()
Connectors are used to send files using either the AS2 or SFTP protocol.default Object
A structure that contains the parameters for an AS2 connector object.default 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.default String
The text name of the security policy for the specified connector.default Object
A structure that contains the parameters for an SFTP connector object.getTags()
Key-value pairs that can be used to group and search for connectors.getUrl()
The URL of the partner's AS2 or SFTP endpoint.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAccessRole
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, theAccessRole
needs to provide read and write access to the parent directory of the file location used in theStartFileTransfer
request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send withStartFileTransfer
.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 thekms: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 providessecretsmanager:GetSecretValue
permission to AWS Secrets Manager .- See Also:
-
getUrl
The URL of the partner's AS2 or SFTP endpoint.- See Also:
-
getAs2Config
A structure that contains the parameters for an AS2 connector object.- See Also:
-
getLoggingRole
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.
- See Also:
-
getSecurityPolicyName
The text name of the security policy for the specified connector.- See Also:
-
getSftpConfig
A structure that contains the parameters for an SFTP connector object.- See Also:
-
getTags
Key-value pairs that can be used to group and search for connectors.- See Also:
-
builder
- Returns:
- a
CfnConnectorProps.Builder
ofCfnConnectorProps
-