Interface CfnProfileProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnProfileProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:35.916Z") @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();
 
  • 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.
    • 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.

    • 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.

    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      Key-value pairs that can be used to group and search for profiles.
    • builder

      @Stability(Stable) static CfnProfileProps.Builder builder()
      Returns:
      a CfnProfileProps.Builder of CfnProfileProps