CfnAgreementProps

class aws_cdk.aws_transfer.CfnAgreementProps(*, access_role, base_directory, local_profile_id, partner_profile_id, server_id, description=None, status=None, tags=None)

Bases: object

Properties for defining a CfnAgreement.

Parameters
  • access_role (str) – With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths . 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 .

  • base_directory (str) – The landing directory (folder) for files that are transferred by using the AS2 protocol.

  • local_profile_id (str) – A unique identifier for the AS2 local profile.

  • partner_profile_id (str) – A unique identifier for the partner profile used in the agreement.

  • server_id (str) – A system-assigned unique identifier for a server instance. This identifier indicates the specific server that the agreement uses.

  • description (Optional[str]) – The name or short description that’s used to identify the agreement.

  • status (Optional[str]) – The current status of the agreement, either ACTIVE or INACTIVE .

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Key-value pairs that can be used to group and search for agreements.

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_transfer as transfer

cfn_agreement_props = transfer.CfnAgreementProps(
    access_role="accessRole",
    base_directory="baseDirectory",
    local_profile_id="localProfileId",
    partner_profile_id="partnerProfileId",
    server_id="serverId",

    # the properties below are optional
    description="description",
    status="status",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

access_role

With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths .

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 .

Link

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

base_directory

The landing directory (folder) for files that are transferred by using the AS2 protocol.

Link

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

description

The name or short description that’s used to identify the agreement.

Link

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

local_profile_id

A unique identifier for the AS2 local profile.

Link

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

partner_profile_id

A unique identifier for the partner profile used in the agreement.

Link

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

server_id

A system-assigned unique identifier for a server instance.

This identifier indicates the specific server that the agreement uses.

Link

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

status

The current status of the agreement, either ACTIVE or INACTIVE .

Link

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

tags

Key-value pairs that can be used to group and search for agreements.

Link

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