Package software.amazon.awscdk.services.transfer

Class CfnProfile

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.transfer.CfnProfile
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:35.915Z") @Stability(Stable) public class CfnProfile extends CfnResource implements IInspectable
A CloudFormation AWS::Transfer::Profile.

Creates the local or partner profile to use for AS2 transfers.

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.*;
 CfnProfile cfnProfile = CfnProfile.Builder.create(this, "MyCfnProfile")
         .as2Id("as2Id")
         .profileType("profileType")
         // the properties below are optional
         .certificateIds(List.of("certificateIds"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnProfile

      protected CfnProfile(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnProfile

      protected CfnProfile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnProfile

      @Stability(Stable) public CfnProfile(@NotNull Construct scope, @NotNull String id, @NotNull CfnProfileProps props)
      Create a new AWS::Transfer::Profile.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name associated with the profile, in the form arn:aws:transfer:region:account-id:profile/profile-id/ .

    • getAttrProfileId

      @Stability(Stable) @NotNull public String getAttrProfileId()
      The unique identifier for the AS2 profile, returned after the API call succeeds.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Key-value pairs that can be used to group and search for profiles.

    • getAs2Id

      @Stability(Stable) @NotNull public 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.

    • setAs2Id

      @Stability(Stable) public void setAs2Id(@NotNull String value)
      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 public 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.

    • setProfileType

      @Stability(Stable) public void setProfileType(@NotNull String value)
      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 public List<String> getCertificateIds()
      An array of identifiers for the imported certificates.

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

    • setCertificateIds

      @Stability(Stable) public void setCertificateIds(@Nullable List<String> value)
      An array of identifiers for the imported certificates.

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