class CfnAgreementPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Transfer.Mixins.CfnAgreementPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awstransfer/mixins#CfnAgreementPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.transfer.mixins.CfnAgreementPropsMixin
Python	aws_cdk.mixins_preview.aws_transfer.mixins.CfnAgreementPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_transfer » mixins » CfnAgreementPropsMixin

Implements IMixin

Extends 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.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as transfer_mixins } from '@aws-cdk/mixins-preview/aws-transfer';
const cfnAgreementPropsMixin = new transfer_mixins.CfnAgreementPropsMixin({
  accessRole: 'accessRole',
  baseDirectory: 'baseDirectory',
  customDirectories: {
    failedFilesDirectory: 'failedFilesDirectory',
    mdnFilesDirectory: 'mdnFilesDirectory',
    payloadFilesDirectory: 'payloadFilesDirectory',
    statusFilesDirectory: 'statusFilesDirectory',
    temporaryFilesDirectory: 'temporaryFilesDirectory',
  },
  description: 'description',
  enforceMessageSigning: 'enforceMessageSigning',
  localProfileId: 'localProfileId',
  partnerProfileId: 'partnerProfileId',
  preserveFilename: 'preserveFilename',
  serverId: 'serverId',
  status: 'status',
  tags: [{
    key: 'key',
    value: 'value',
  }],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnAgreementPropsMixin(props: CfnAgreementMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnAgreementMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

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

Properties

Name	Type	Description
props	CfnAgreementMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnAgreementMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.