Skip to content
v2.274.0

CfnAgreementPropsMixin Mixin ​

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.

Initializer ​

ts
new CfnAgreementPropsMixin(props: CfnAgreementMixinProps, options?: CfnPropertyMixinOptions)
python
CfnAgreementPropsMixin(props: CfnAgreementMixinProps, options: typing.Optional[CfnPropertyMixinOptions] = None)
java
new CfnAgreementPropsMixin(CfnAgreementMixinProps props, CfnPropertyMixinOptions options)
csharp
new CfnAgreementPropsMixin(CfnAgreementMixinProps props, CfnPropertyMixinOptions? options = null)
go
NewCfnAgreementPropsMixin(Props CfnAgreementMixinProps, Options CfnPropertyMixinOptions)

Methods ​

applyTo(construct: IConstruct): voiddef apply_to(self, construct: IConstruct) -> Nonepublic void applyTo(IConstruct construct)public void ApplyTo(IConstruct construct)func ApplyTo(Construct IConstruct)#
Apply the mixin properties to the construct.
isMixin(x: any): boolean@staticmethod def is_mixin(x: Any) -> boolpublic static Boolean isMixin(Object x)public static bool IsMixin(object x)func IsMixin(X interface{}) *boolstatic#
Checks if `x` is a Mixin.
1 parameter · returns

Parameters

  • xxxxX — Any object.

Returns: true if x is an object created from a class which extends Mixin.

supports(construct: IConstruct): booleandef supports(self, construct: IConstruct) -> boolpublic Boolean supports(IConstruct construct)public bool Supports(IConstruct construct)func Supports(Construct IConstruct) *bool#
Check if this mixin supports the given construct.