Package software.amazon.awscdk.services.appflow

Class CfnConnector

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.appflow.CfnConnector
All Implemented Interfaces:
IInspectable, IConnectorRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:30.746Z") @Stability(Stable) public class CfnConnector extends CfnResource implements IInspectable, IConnectorRef
Creates a new connector profile associated with your AWS account .

There is a soft quota of 100 connector profiles per AWS account . If you need more connector profiles than this quota allows, you can submit a request to the Amazon AppFlow team through the Amazon AppFlow support channel. In each connector profile that you create, you can provide the credentials and properties for only one connector.

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.appflow.*;
 CfnConnector cfnConnector = CfnConnector.Builder.create(this, "MyCfnConnector")
         .connectorProvisioningConfig(ConnectorProvisioningConfigProperty.builder()
                 .lambda(LambdaConnectorProvisioningConfigProperty.builder()
                         .lambdaArn("lambdaArn")
                         .build())
                 .build())
         .connectorProvisioningType("connectorProvisioningType")
         // the properties below are optional
         .connectorLabel("connectorLabel")
         .description("description")
         .build();

See Also:

  • 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

    • CfnConnector

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

    • CfnConnector

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

    • CfnConnector

      @Stability(Stable) public CfnConnector(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnConnectorProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • fromConnectorArn

      @Stability(Stable) @NotNull public static IConnectorRef fromConnectorArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IConnectorRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromConnectorLabel

      @Stability(Stable) @NotNull public static IConnectorRef fromConnectorLabel(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String connectorLabel)
      Creates a new IConnectorRef from a connectorLabel.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      connectorLabel - This parameter is required.

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

    • getAttrConnectorArn

      @Stability(Stable) @NotNull public String getAttrConnectorArn()
      The arn of the connector.

      The arn is unique for each ConnectorRegistration in your AWS account.

    • getCfnProperties

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

    • getConnectorRef

      @Stability(Stable) @NotNull public ConnectorReference getConnectorRef()
      A reference to a Connector resource.
      Specified by:
      getConnectorRef in interface IConnectorRef

    • getConnectorProvisioningConfig

      @Stability(Stable) @NotNull public Object getConnectorProvisioningConfig()
      The configuration required for registering the connector.

      Returns union: either IResolvable or CfnConnector.ConnectorProvisioningConfigProperty

    • setConnectorProvisioningConfig

      @Stability(Stable) public void setConnectorProvisioningConfig(@NotNull IResolvable value)
      The configuration required for registering the connector.

    • setConnectorProvisioningConfig

      @Stability(Stable) public void setConnectorProvisioningConfig(@NotNull CfnConnector.ConnectorProvisioningConfigProperty value)
      The configuration required for registering the connector.

    • getConnectorProvisioningType

      @Stability(Stable) @NotNull public String getConnectorProvisioningType()
      The provisioning type used to register the connector.

    • setConnectorProvisioningType

      @Stability(Stable) public void setConnectorProvisioningType(@NotNull String value)
      The provisioning type used to register the connector.

    • getConnectorLabel

      @Stability(Stable) @Nullable public String getConnectorLabel()
      The label used for registering the connector.

    • setConnectorLabel

      @Stability(Stable) public void setConnectorLabel(@Nullable String value)
      The label used for registering the connector.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description about the connector runtime setting.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description about the connector runtime setting.