Package software.amazon.awscdk.services.appflow

Interface CfnFlow.CustomConnectorSourcePropertiesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFlow.CustomConnectorSourcePropertiesProperty.Jsii$Proxy

Enclosing class:

CfnFlow

@Stability(Stable)
public static interface CfnFlow.CustomConnectorSourcePropertiesProperty
extends software.amazon.jsii.JsiiSerializable

The properties that are applied when the custom connector is being used as a source.

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.*;
 CustomConnectorSourcePropertiesProperty customConnectorSourcePropertiesProperty = CustomConnectorSourcePropertiesProperty.builder()
         .entityName("entityName")
         // the properties below are optional
         .customProperties(Map.of(
                 "customPropertiesKey", "customProperties"))
         .dataTransferApi(DataTransferApiProperty.builder()
                 .name("name")
                 .type("type")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-customconnectorsourceproperties.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnFlow.CustomConnectorSourcePropertiesProperty.Builder	builder()
default Object	getCustomProperties()	Custom properties that are required to use the custom connector as a source.
default Object	getDataTransferApi()	The API of the connector application that Amazon AppFlow uses to transfer your data.
String	getEntityName()	The entity specified in the custom connector as a source in the flow.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEntityName

@Stability(Stable)
@NotNull
String getEntityName()

The entity specified in the custom connector as a source in the flow.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-customconnectorsourceproperties.html#cfn-appflow-flow-customconnectorsourceproperties-entityname

getCustomProperties

@Stability(Stable)
@Nullable
default Object getCustomProperties()

Custom properties that are required to use the custom connector as a source.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-customconnectorsourceproperties.html#cfn-appflow-flow-customconnectorsourceproperties-customproperties

getDataTransferApi

@Stability(Stable)
@Nullable
default Object getDataTransferApi()

The API of the connector application that Amazon AppFlow uses to transfer your data.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-customconnectorsourceproperties.html#cfn-appflow-flow-customconnectorsourceproperties-datatransferapi

builder

@Stability(Stable)
static CfnFlow.CustomConnectorSourcePropertiesProperty.Builder builder()

Returns:

a CfnFlow.CustomConnectorSourcePropertiesProperty.Builder of CfnFlow.CustomConnectorSourcePropertiesProperty