software.amazon.awscdk.services.transfer

Interface CfnAgreementProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAgreementProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-25T18:29:00.712Z")
 @Stability(value=Stable)
public interface CfnAgreementProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnAgreement`.

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.*;
 CfnAgreementProps cfnAgreementProps = CfnAgreementProps.builder()
         .accessRole("accessRole")
         .baseDirectory("baseDirectory")
         .localProfileId("localProfileId")
         .partnerProfileId("partnerProfileId")
         .serverId("serverId")
         // the properties below are optional
         .description("description")
         .status("status")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnAgreementProps.Builder A builder for CfnAgreementProps
static class	CfnAgreementProps.Jsii$Proxy An implementation for CfnAgreementProps

Method Summary

Modifier and Type	Method and Description
static CfnAgreementProps.Builder	builder()
String	getAccessRole() With AS2, you can send files by calling `StartFileTransfer` and specifying the file paths in the request parameter, `SendFilePaths` .
String	getBaseDirectory() The landing directory (folder) for files that are transferred by using the AS2 protocol.
default String	getDescription() The name or short description that's used to identify the agreement.
String	getLocalProfileId() A unique identifier for the AS2 local profile.
String	getPartnerProfileId() A unique identifier for the partner profile used in the agreement.
String	getServerId() A system-assigned unique identifier for a server instance.
default String	getStatus() The current status of the agreement, either `ACTIVE` or `INACTIVE` .
default List<CfnTag>	getTags() Key-value pairs that can be used to group and search for agreements.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAccessRole

@Stability(value=Stable)
 @NotNull
String getAccessRole()

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 .

getBaseDirectory

@Stability(value=Stable)
 @NotNull
String getBaseDirectory()

The landing directory (folder) for files that are transferred by using the AS2 protocol.

getLocalProfileId

@Stability(value=Stable)
 @NotNull
String getLocalProfileId()

A unique identifier for the AS2 local profile.

getPartnerProfileId

@Stability(value=Stable)
 @NotNull
String getPartnerProfileId()

A unique identifier for the partner profile used in the agreement.

getServerId

@Stability(value=Stable)
 @NotNull
String getServerId()

A system-assigned unique identifier for a server instance.

This identifier indicates the specific server that the agreement uses.

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

The name or short description that's used to identify the agreement.

getStatus

@Stability(value=Stable)
 @Nullable
default String getStatus()

The current status of the agreement, either `ACTIVE` or `INACTIVE` .

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

Key-value pairs that can be used to group and search for agreements.

builder

@Stability(value=Stable)
static CfnAgreementProps.Builder builder()

Returns:

a CfnAgreementProps.Builder of CfnAgreementProps