import { Value } from '../../cloudformation/Value';
import { Tag } from '../Tag';
import { Attribute } from '../../cloudformation/Attribute';
import { AwsResource } from '../../cloudformation/resources/AwsResource';
export type AgreementAttributes = {
    AgreementId: Attribute<string>;
    Arn: Attribute<string>;
};
export type Agreement = AwsResource<'AWS::Transfer::Agreement', AgreementProperties, AgreementAttributes>;
/**
  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.
  For full documentation go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html">the AWS Docs</a>
*/
export declare function agreement(agreementProps: AgreementProperties): Agreement;
/**
  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.
  For full documentation go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html">the AWS Docs</a>
*/
export interface AgreementProperties {
    /** <code>Status</code>  <a name="cfn-transfer-agreement-status"></a>
  The current status of the agreement, either <code>ACTIVE</code> or <code>INACTIVE</code>.<br />
  
  Required: No<br />
  
  Allowed values: <code>ACTIVE | INACTIVE</code><br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    status?: Value<'ACTIVE' | 'INACTIVE'>;
    /** <code>Description</code>  <a name="cfn-transfer-agreement-description"></a>
  The name or short description that’s used to identify the agreement.<br />
  
  Required: No<br />
  
  Minimum: <code>1</code><br />
  
  Maximum: <code>200</code><br />
  
  Pattern: <code>^[\p{Graph}]+</code><br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    description?: Value<string>;
    /** <code>ServerId</code>  <a name="cfn-transfer-agreement-serverid"></a>
  A system-assigned unique identifier for a server instance. This identifier indicates the specific server that the agreement uses.<br />
  
  Required: Yes<br />
  
  Minimum: <code>19</code><br />
  
  Maximum: <code>19</code><br />
  
  Pattern: <code>^s-([0-9a-f]{17})$</code><br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement">Replacement</a> */
    serverId: Value<string>;
    /** <code>BaseDirectory</code>  <a name="cfn-transfer-agreement-basedirectory"></a>
  The landing directory (folder) for files that are transferred by using the AS2 protocol.<br />
  
  Required: Yes<br />
  
  Maximum: <code>1024</code><br />
  
  Pattern: <code>^$|/.*</code><br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    baseDirectory: Value<string>;
    /** <code>AccessRole</code>  <a name="cfn-transfer-agreement-accessrole"></a>
  Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the AWS Identity and Access Management role to use.<br />
  <strong>For AS2 connectors</strong><br />
  With AS2, you can send files by calling <code>StartFileTransfer</code> and specifying the file paths in the request parameter, <code>SendFilePaths</code>. We use the file’s parent directory (for example, for <code>--send-file-paths /bucket/dir/file.txt</code>, parent directory is <code>/bucket/dir/</code>) 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 <code>AccessRole</code> needs to provide read and write access to the parent directory of the file location used in the <code>StartFileTransfer</code> request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with <code>StartFileTransfer</code>.<br />
  If you are using Basic authentication for your AS2 connector, the access role requires the <code>secretsmanager:GetSecretValue</code> permission for the secret. If the secret is encrypted using a customer-managed key instead of the AWS managed key in Secrets Manager, then the role also needs the <code>kms:Decrypt</code> permission for that key.<br />
  <strong>For SFTP connectors</strong><br />
  Make sure that the access role provides read and write access to the parent directory of the file location that’s used in the <code>StartFileTransfer</code> request. Additionally, make sure that the role provides <code>secretsmanager:GetSecretValue</code> permission to AWS Secrets Manager.<br />
  
  Required: Yes<br />
  
  Minimum: <code>20</code><br />
  
  Maximum: <code>2048</code><br />
  
  Pattern: <code>arn:.*role/.*</code><br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    accessRole: Value<string>;
    /** <code>PartnerProfileId</code>  <a name="cfn-transfer-agreement-partnerprofileid"></a>
  A unique identifier for the partner profile used in the agreement.<br />
  
  Required: Yes<br />
  
  Minimum: <code>19</code><br />
  
  Maximum: <code>19</code><br />
  
  Pattern: <code>^p-([0-9a-f]{17})$</code><br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    partnerProfileId: Value<string>;
    /** <code>LocalProfileId</code>  <a name="cfn-transfer-agreement-localprofileid"></a>
  A unique identifier for the AS2 local profile.<br />
  
  Required: Yes<br />
  
  Minimum: <code>19</code><br />
  
  Maximum: <code>19</code><br />
  
  Pattern: <code>^p-([0-9a-f]{17})$</code><br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    localProfileId: Value<string>;
    /** <code>Tags</code>  <a name="cfn-transfer-agreement-tags"></a>
  Key-value pairs that can be used to group and search for agreements.<br />
  
  Required: No<br />
  
  Maximum: <code>50</code><br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    tags?: Tag[];
}
