aws-cdk-lib.aws_transfer.CfnProfileProps

CfnProfileProps Struct

Properties for defining a CfnProfile.

CfnProfileProps

used as props by

• CfnProfile

Source

Generated code

Type last changed

v2.46.0 · 13 Oct 2022

Example

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

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

Properties

as2Idstringas2_idstras2IdStringAs2IdstringAs2Id*stringrequired#

The `As2Id` is the *AS2-name* , as defined in the [RFC 4130](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc4130) . 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.

certificateIds?optionalstring[]certificate_ids?optionaltyping.List[str]certificateIds?optionalList<String>CertificateIds?optionalstring[]CertificateIds?optional*[]*string#

An array of identifiers for the imported certificates.

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

profileTypestringprofile_typestrprofileTypeStringProfileTypestringProfileType*stringrequired#

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.

tags?optionalCfnTag[]tags?optionaltyping.List[CfnTag]tags?optionalList<CfnTag>Tags?optionalCfnTag[]Tags?optional*[]CfnTag#

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