Class CfnAgreementProps
Properties for defining a CfnAgreement
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Transfer
Assembly: Amazon.CDK.AWS.Transfer.dll
Syntax (csharp)
public class CfnAgreementProps : Object, ICfnAgreementProps
Syntax (vb)
Public Class CfnAgreementProps
Inherits Object
Implements ICfnAgreementProps
Remarks
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Transfer;
var cfnAgreementProps = new CfnAgreementProps {
AccessRole = "accessRole",
BaseDirectory = "baseDirectory",
LocalProfileId = "localProfileId",
PartnerProfileId = "partnerProfileId",
ServerId = "serverId",
// the properties below are optional
Description = "description",
Status = "status",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};
Synopsis
Constructors
CfnAgreementProps() |
Properties
AccessRole | With AS2, you can send files by calling |
BaseDirectory | The landing directory (folder) for files that are transferred by using the AS2 protocol. |
Description | The name or short description that's used to identify the agreement. |
LocalProfileId | A unique identifier for the AS2 local profile. |
PartnerProfileId | A unique identifier for the partner profile used in the agreement. |
ServerId | A system-assigned unique identifier for a server instance. |
Status | The current status of the agreement, either |
Tags | Key-value pairs that can be used to group and search for agreements. |
Constructors
CfnAgreementProps()
public CfnAgreementProps()
Properties
AccessRole
With AS2, you can send files by calling StartFileTransfer
and specifying the file paths in the request parameter, SendFilePaths
.
public string AccessRole { get; set; }
Property Value
System.String
Remarks
We use the file’s parent directory (for example, for --send-file-paths /bucket/dir/file.txt
, parent directory is /bucket/dir/
) 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 AccessRole
needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer
request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer
.
BaseDirectory
The landing directory (folder) for files that are transferred by using the AS2 protocol.
public string BaseDirectory { get; set; }
Property Value
System.String
Remarks
Description
The name or short description that's used to identify the agreement.
public string Description { get; set; }
Property Value
System.String
Remarks
LocalProfileId
A unique identifier for the AS2 local profile.
public string LocalProfileId { get; set; }
Property Value
System.String
Remarks
PartnerProfileId
A unique identifier for the partner profile used in the agreement.
public string PartnerProfileId { get; set; }
Property Value
System.String
Remarks
ServerId
A system-assigned unique identifier for a server instance.
public string ServerId { get; set; }
Property Value
System.String
Remarks
This identifier indicates the specific server that the agreement uses.
Status
The current status of the agreement, either ACTIVE
or INACTIVE
.
public string Status { get; set; }
Property Value
System.String
Remarks
Tags
Key-value pairs that can be used to group and search for agreements.
public ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]