CfnProfileProps

class aws_cdk.aws_transfer.CfnProfileProps(*, as2_id, profile_type, certificate_ids=None, tags=None)

Bases: object

Properties for defining a CfnProfile.

Parameters:

  • as2_id (str) – The As2Id is the AS2-name , as defined in the RFC 4130 . For inbound transfers, this is the AS2-From header for the AS2 messages sent from the partner. For outbound connectors, this is the AS2-To header for the AS2 messages sent to the partner using the StartFileTransfer API operation. This ID cannot include spaces.

  • profile_type (str) – Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. If not supplied in the request, the command lists all types of profiles.

  • certificate_ids (Optional[Sequence[str]]) – An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

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

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-profile.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_profile_props = transfer.CfnProfileProps(
    as2_id="as2Id",
    profile_type="profileType",

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

Attributes

as2_id

The As2Id is the AS2-name , as defined in the RFC 4130 . For inbound transfers, this is the AS2-From header for the AS2 messages sent from the partner. For outbound connectors, this is the AS2-To header for the AS2 messages sent to the partner using the StartFileTransfer API operation. This ID cannot include spaces.

Link:

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

certificate_ids

An array of identifiers for the imported certificates.

You use this identifier for working with profiles and partner profiles.

Link:

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

profile_type

Indicates whether to list only LOCAL type profiles or only PARTNER type profiles.

If not supplied in the request, the command lists all types of profiles.

Link:

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

tags

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

Link:

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