Package software.amazon.awscdk.services.transfer

Interface CfnProfileProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnProfileProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:48.544Z")
@Stability(Stable)
public interface CfnProfileProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.transfer.*;
 CfnProfileProps cfnProfileProps = CfnProfileProps.builder()
         .as2Id("as2Id")
         .profileType("profileType")
         // the properties below are optional
         .certificateIds(List.of("certificateIds"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnProfileProps.Builder	A builder for CfnProfileProps
static final class	CfnProfileProps.Jsii$Proxy	An implementation for CfnProfileProps

Method Summary

Modifier and Type	Method	Description
static CfnProfileProps.Builder	builder()
String	getAs2Id()	The As2Id is the AS2-name , as defined in the RFC 4130 .
default List<String>	getCertificateIds()	An array of identifiers for the imported certificates.
String	getProfileType()	Indicates whether to list only LOCAL type profiles or only PARTNER type profiles.
default List<CfnTag>	getTags()	Key-value pairs that can be used to group and search for profiles.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAs2Id

@Stability(Stable)
@NotNull
String getAs2Id()

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.

See Also:

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

getProfileType

@Stability(Stable)
@NotNull
String getProfileType()

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.

See Also:

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

getCertificateIds

@Stability(Stable)
@Nullable
default List<String> getCertificateIds()

An array of identifiers for the imported certificates.

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

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

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

builder

@Stability(Stable)
static CfnProfileProps.Builder builder()

Returns:

a CfnProfileProps.Builder of CfnProfileProps