CfnAgreementPropsMixin

class aws_cdk.mixins_preview.aws_transfer.mixins.CfnAgreementPropsMixin(props, *, strategy=None)

Bases: 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 . .. epigraph:

Specify *either* ``BaseDirectory`` or ``CustomDirectories`` , but not both. Specifying both causes the command to fail.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html
CloudformationResource:: AWS::Transfer::Agreement
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

cfn_agreement_props_mixin = transfer_mixins.CfnAgreementPropsMixin(transfer_mixins.CfnAgreementMixinProps(
    access_role="accessRole",
    base_directory="baseDirectory",
    custom_directories=transfer_mixins.CfnAgreementPropsMixin.CustomDirectoriesProperty(
        failed_files_directory="failedFilesDirectory",
        mdn_files_directory="mdnFilesDirectory",
        payload_files_directory="payloadFilesDirectory",
        status_files_directory="statusFilesDirectory",
        temporary_files_directory="temporaryFilesDirectory"
    ),
    description="description",
    enforce_message_signing="enforceMessageSigning",
    local_profile_id="localProfileId",
    partner_profile_id="partnerProfileId",
    preserve_filename="preserveFilename",
    server_id="serverId",
    status="status",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnAgreementMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['accessRole', 'baseDirectory', 'customDirectories', 'description', 'enforceMessageSigning', 'localProfileId', 'partnerProfileId', 'preserveFilename', 'serverId', 'status', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

CustomDirectoriesProperty

class CfnAgreementPropsMixin.CustomDirectoriesProperty(*, failed_files_directory=None, mdn_files_directory=None, payload_files_directory=None, status_files_directory=None, temporary_files_directory=None)

Bases: object

Specifies a separate directory for each type of file to store for an AS2 message.

Parameters:

failed_files_directory (Optional[str]) – Specifies a location to store the failed files for an AS2 message.
mdn_files_directory (Optional[str]) – Specifies a location to store the MDN file for an AS2 message.
payload_files_directory (Optional[str]) – Specifies a location to store the payload file for an AS2 message.
status_files_directory (Optional[str]) – Specifies a location to store the status file for an AS2 message.
temporary_files_directory (Optional[str]) – Specifies a location to store the temporary processing file for an AS2 message.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

custom_directories_property = transfer_mixins.CfnAgreementPropsMixin.CustomDirectoriesProperty(
    failed_files_directory="failedFilesDirectory",
    mdn_files_directory="mdnFilesDirectory",
    payload_files_directory="payloadFilesDirectory",
    status_files_directory="statusFilesDirectory",
    temporary_files_directory="temporaryFilesDirectory"
)