Class CfnAgreement.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnAgreement>
- Enclosing class:
CfnAgreement
CfnAgreement
.-
Method Summary
Modifier and TypeMethodDescriptionaccessRole
(String accessRole) Connectors are used to send files using either the AS2 or SFTP protocol.baseDirectory
(String baseDirectory) The landing directory (folder) for files that are transferred by using the AS2 protocol.build()
static CfnAgreement.Builder
description
(String description) The name or short description that's used to identify the agreement.localProfileId
(String localProfileId) A unique identifier for the AS2 local profile.partnerProfileId
(String partnerProfileId) A unique identifier for the partner profile used in the agreement.A system-assigned unique identifier for a server instance.The current status of the agreement, eitherACTIVE
orINACTIVE
.Key-value pairs that can be used to group and search for agreements.
-
Method Details
-
create
@Stability(Stable) public static CfnAgreement.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
CfnAgreement.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:
-
baseDirectory
The landing directory (folder) for files that are transferred by using the AS2 protocol.- Parameters:
baseDirectory
- The landing directory (folder) for files that are transferred by using the AS2 protocol. This parameter is required.- Returns:
this
- See Also:
-
localProfileId
A unique identifier for the AS2 local profile.- Parameters:
localProfileId
- A unique identifier for the AS2 local profile. This parameter is required.- Returns:
this
- See Also:
-
partnerProfileId
A unique identifier for the partner profile used in the agreement.- Parameters:
partnerProfileId
- A unique identifier for the partner profile used in the agreement. This parameter is required.- Returns:
this
- See Also:
-
serverId
A system-assigned unique identifier for a server instance.This identifier indicates the specific server that the agreement uses.
- Parameters:
serverId
- A system-assigned unique identifier for a server instance. This parameter is required.- Returns:
this
- See Also:
-
description
The name or short description that's used to identify the agreement.- Parameters:
description
- The name or short description that's used to identify the agreement. This parameter is required.- Returns:
this
- See Also:
-
status
The current status of the agreement, eitherACTIVE
orINACTIVE
.- Parameters:
status
- The current status of the agreement, eitherACTIVE
orINACTIVE
. This parameter is required.- Returns:
this
- See Also:
-
tags
Key-value pairs that can be used to group and search for agreements.- Parameters:
tags
- Key-value pairs that can be used to group and search for agreements. This parameter is required.- Returns:
this
- See Also:
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnAgreement>
- Returns:
- a newly built instance of
CfnAgreement
.
-