Class CfnConnector.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnConnector>
- Enclosing class:
CfnConnector
CfnConnector
.-
Method Summary
Modifier and TypeMethodDescriptionaccessRole
(String accessRole) Connectors are used to send files using either the AS2 or SFTP protocol.A structure that contains the parameters for an AS2 connector object.build()
static CfnConnector.Builder
loggingRole
(String loggingRole) 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.securityPolicyName
(String securityPolicyName) The text name of the security policy for the specified connector.sftpConfig
(IResolvable sftpConfig) A structure that contains the parameters for an SFTP connector object.sftpConfig
(CfnConnector.SftpConfigProperty sftpConfig) A structure that contains the parameters for an SFTP connector object.Key-value pairs that can be used to group and search for connectors.The URL of the partner's AS2 or SFTP endpoint.
-
Method Details
-
create
@Stability(Stable) public static CfnConnector.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.- Returns:
- a new instance of
CfnConnector.Builder
.
-
accessRole
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 .- Parameters:
accessRole
- Connectors are used to send files using either the AS2 or SFTP protocol. This parameter is required.- Returns:
this
- See Also:
-
url
The URL of the partner's AS2 or SFTP endpoint.- Parameters:
url
- The URL of the partner's AS2 or SFTP endpoint. This parameter is required.- Returns:
this
- See Also:
-
as2Config
A structure that contains the parameters for an AS2 connector object.- Parameters:
as2Config
- A structure that contains the parameters for an AS2 connector object. This parameter is required.- Returns:
this
- See Also:
-
loggingRole
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.
- Parameters:
loggingRole
- 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. This parameter is required.- Returns:
this
- See Also:
-
securityPolicyName
The text name of the security policy for the specified connector.- Parameters:
securityPolicyName
- The text name of the security policy for the specified connector. This parameter is required.- Returns:
this
- See Also:
-
sftpConfig
A structure that contains the parameters for an SFTP connector object.- Parameters:
sftpConfig
- A structure that contains the parameters for an SFTP connector object. This parameter is required.- Returns:
this
- See Also:
-
sftpConfig
@Stability(Stable) public CfnConnector.Builder sftpConfig(CfnConnector.SftpConfigProperty sftpConfig) A structure that contains the parameters for an SFTP connector object.- Parameters:
sftpConfig
- A structure that contains the parameters for an SFTP connector object. This parameter is required.- Returns:
this
- See Also:
-
tags
Key-value pairs that can be used to group and search for connectors.- Parameters:
tags
- Key-value pairs that can be used to group and search for connectors. This parameter is required.- Returns:
this
- See Also:
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnConnector>
- Returns:
- a newly built instance of
CfnConnector
.
-