Package software.amazon.awscdk.cfnpropertymixins.services.transfer

Class CfnAgreementPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.transfer.CfnAgreementPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:05.851Z")
@Stability(Stable)
public class CfnAgreementPropsMixin
extends Mixin
implements software.constructs.IMixin

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.cfnpropertymixins.services.transfer.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnAgreementPropsMixin cfnAgreementPropsMixin = CfnAgreementPropsMixin.Builder.create(CfnAgreementMixinProps.builder()
         .accessRole("accessRole")
         .baseDirectory("baseDirectory")
         .customDirectories(CustomDirectoriesProperty.builder()
                 .failedFilesDirectory("failedFilesDirectory")
                 .mdnFilesDirectory("mdnFilesDirectory")
                 .payloadFilesDirectory("payloadFilesDirectory")
                 .statusFilesDirectory("statusFilesDirectory")
                 .temporaryFilesDirectory("temporaryFilesDirectory")
                 .build())
         .description("description")
         .enforceMessageSigning("enforceMessageSigning")
         .localProfileId("localProfileId")
         .partnerProfileId("partnerProfileId")
         .preserveFilename("preserveFilename")
         .serverId("serverId")
         .status("status")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnAgreementPropsMixin.Builder	A fluent builder for CfnAgreementPropsMixin.
static interface	CfnAgreementPropsMixin.CustomDirectoriesProperty	Specifies a separate directory for each type of file to store for an AS2 message.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnAgreementPropsMixin(CfnAgreementMixinProps props)	Create a mixin to apply properties to AWS::Transfer::Agreement.
	CfnAgreementPropsMixin(CfnAgreementMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::Transfer::Agreement.
protected	CfnAgreementPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAgreementPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnAgreementMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnAgreementPropsMixin

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

CfnAgreementPropsMixin

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

CfnAgreementPropsMixin

@Stability(Stable)
public CfnAgreementPropsMixin(@NotNull
 CfnAgreementMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::Transfer::Agreement.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnAgreementPropsMixin

@Stability(Stable)
public CfnAgreementPropsMixin(@NotNull
 CfnAgreementMixinProps props)

Create a mixin to apply properties to AWS::Transfer::Agreement.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnAgreementMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()