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") .as2Config(as2Config) .url("url") // the properties below are optional .loggingRole("loggingRole") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnConnectorProps
static final class
An implementation forCfnConnectorProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnConnectorProps.Builder
builder()
With AS2, you can send files by callingStartFileTransfer
and specifying the file paths in the request parameter,SendFilePaths
.A structure that contains the parameters for a 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.getTags()
Key-value pairs that can be used to group and search for connectors.getUrl()
The URL of the partner's AS2 endpoint.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAccessRole
With AS2, you can send files by callingStartFileTransfer
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
. -
getAs2Config
A structure that contains the parameters for a connector object. -
getUrl
The URL of the partner's AS2 endpoint. -
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.
-
getTags
Key-value pairs that can be used to group and search for connectors. -
builder
- Returns:
- a
CfnConnectorProps.Builder
ofCfnConnectorProps
-