interface CfnProfileProps

Language	Type name
.NET	Amazon.CDK.AWS.Transfer.CfnProfileProps
Java	software.amazon.awscdk.services.transfer.CfnProfileProps
Python	aws_cdk.aws_transfer.CfnProfileProps
TypeScript	@aws-cdk/aws-transfer » CfnProfileProps

Properties for defining a CfnProfile.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as transfer from '@aws-cdk/aws-transfer';
const cfnProfileProps: transfer.CfnProfileProps = {
  as2Id: 'as2Id',
  profileType: 'profileType',

  // the properties below are optional
  certificateIds: ['certificateIds'],
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
as2Id	string	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.
profileType	string	Indicates whether to list only LOCAL type profiles or only PARTNER type profiles.
certificateIds?	string[]	An array of identifiers for the imported certificates.
tags?	CfnTag[]	Key-value pairs that can be used to group and search for profiles.

---

as2Id

Type: string

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.

---

profileType

Type: string

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.

---

certificateIds?

Type: string[] (optional)

An array of identifiers for the imported certificates.

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

---

tags?

Type: CfnTag[] (optional)

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