Package software.amazon.awscdk.services.transfer

Class CfnAgreement

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.transfer.CfnAgreement
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IAgreementRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:47.005Z") @Stability(Stable) public class CfnAgreement extends CfnResource implements IInspectable, IAgreementRef, ITaggable
Creates an agreement.

An agreement is a bilateral trading partner agreement, or partnership, between an AWS Transfer Family server and an AS2 process. The agreement defines the file and message transfer relationship between the server and the AS2 process. To define an agreement, Transfer Family combines a server, local profile, partner profile, certificate, and other attributes.

The partner is identified with the PartnerProfileId , and the AS2 process is identified with the LocalProfileId .

Specify either BaseDirectory or CustomDirectories , but not both. Specifying both causes the command to fail.

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.*;
 CfnAgreement cfnAgreement = CfnAgreement.Builder.create(this, "MyCfnAgreement")
         .accessRole("accessRole")
         .localProfileId("localProfileId")
         .partnerProfileId("partnerProfileId")
         .serverId("serverId")
         // the properties below are optional
         .baseDirectory("baseDirectory")
         .customDirectories(CustomDirectoriesProperty.builder()
                 .failedFilesDirectory("failedFilesDirectory")
                 .mdnFilesDirectory("mdnFilesDirectory")
                 .payloadFilesDirectory("payloadFilesDirectory")
                 .statusFilesDirectory("statusFilesDirectory")
                 .temporaryFilesDirectory("temporaryFilesDirectory")
                 .build())
         .description("description")
         .enforceMessageSigning("enforceMessageSigning")
         .preserveFilename("preserveFilename")
         .status("status")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnAgreement

      protected CfnAgreement(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnAgreement

      protected CfnAgreement(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnAgreement

      @Stability(Stable) public CfnAgreement(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnAgreementProps props)
      Create a new AWS::Transfer::Agreement.

      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.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForAgreement

      @Stability(Stable) @NotNull public static String arnForAgreement(@NotNull IAgreementRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnAgreement

      @Stability(Stable) @NotNull public static Boolean isCfnAgreement(@NotNull Object x)
      Checks whether the given object is a CfnAgreement.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAgreementRef

      @Stability(Stable) @NotNull public AgreementReference getAgreementRef()
      A reference to a Agreement resource.
      Specified by:
      getAgreementRef in interface IAgreementRef

    • getAttrAgreementId

      @Stability(Stable) @NotNull public String getAttrAgreementId()
      The unique identifier for the AS2 agreement, returned after the API call succeeds.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      Specifies the unique Amazon Resource Name (ARN) for the agreement.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getAccessRole

      @Stability(Stable) @NotNull public String getAccessRole()
      Connectors are used to send files using either the AS2 or SFTP protocol.

    • setAccessRole

      @Stability(Stable) public void setAccessRole(@NotNull String value)
      Connectors are used to send files using either the AS2 or SFTP protocol.

    • getLocalProfileId

      @Stability(Stable) @NotNull public String getLocalProfileId()
      A unique identifier for the AS2 local profile.

    • setLocalProfileId

      @Stability(Stable) public void setLocalProfileId(@NotNull String value)
      A unique identifier for the AS2 local profile.

    • getPartnerProfileId

      @Stability(Stable) @NotNull public String getPartnerProfileId()
      A unique identifier for the partner profile used in the agreement.

    • setPartnerProfileId

      @Stability(Stable) public void setPartnerProfileId(@NotNull String value)
      A unique identifier for the partner profile used in the agreement.

    • getServerId

      @Stability(Stable) @NotNull public String getServerId()
      A system-assigned unique identifier for a server instance.

    • setServerId

      @Stability(Stable) public void setServerId(@NotNull String value)
      A system-assigned unique identifier for a server instance.

    • getBaseDirectory

      @Stability(Stable) @Nullable public String getBaseDirectory()
      The landing directory (folder) for files that are transferred by using the AS2 protocol.

    • setBaseDirectory

      @Stability(Stable) public void setBaseDirectory(@Nullable String value)
      The landing directory (folder) for files that are transferred by using the AS2 protocol.

    • getCustomDirectories

      @Stability(Stable) @Nullable public Object getCustomDirectories()
      A CustomDirectoriesType structure.

      Returns union: either IResolvable or CfnAgreement.CustomDirectoriesProperty

    • setCustomDirectories

      @Stability(Stable) public void setCustomDirectories(@Nullable IResolvable value)
      A CustomDirectoriesType structure.

    • setCustomDirectories

      @Stability(Stable) public void setCustomDirectories(@Nullable CfnAgreement.CustomDirectoriesProperty value)
      A CustomDirectoriesType structure.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The name or short description that's used to identify the agreement.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The name or short description that's used to identify the agreement.

    • getEnforceMessageSigning

      @Stability(Stable) @Nullable public String getEnforceMessageSigning()
      Determines whether or not unsigned messages from your trading partners will be accepted.

    • setEnforceMessageSigning

      @Stability(Stable) public void setEnforceMessageSigning(@Nullable String value)
      Determines whether or not unsigned messages from your trading partners will be accepted.

    • getPreserveFilename

      @Stability(Stable) @Nullable public String getPreserveFilename()
      Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload filename when saving it.

    • setPreserveFilename

      @Stability(Stable) public void setPreserveFilename(@Nullable String value)
      Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload filename when saving it.

    • getStatus

      @Stability(Stable) @Nullable public String getStatus()
      The current status of the agreement, either ACTIVE or INACTIVE .

    • setStatus

      @Stability(Stable) public void setStatus(@Nullable String value)
      The current status of the agreement, either ACTIVE or INACTIVE .

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      Key-value pairs that can be used to group and search for agreements.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      Key-value pairs that can be used to group and search for agreements.