Skip to content
v2.278.0

CustomConnectorSourcePropertiesProperty Struct ​

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

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appflow as appflow } from 'aws-cdk-lib';
const customConnectorSourcePropertiesProperty: appflow.CfnFlow.CustomConnectorSourcePropertiesProperty = {
  entityName: 'entityName',

  // the properties below are optional
  customProperties: {
    customPropertiesKey: 'customProperties',
  },
  dataTransferApi: {
    name: 'name',
    type: 'type',
  },
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_appflow as appflow

custom_connector_source_properties_property = appflow.CfnFlow.CustomConnectorSourcePropertiesProperty(
    entity_name="entityName",

    # the properties below are optional
    custom_properties={
        "custom_properties_key": "customProperties"
    },
    data_transfer_api=appflow.CfnFlow.DataTransferApiProperty(
        name="name",
        type="type"
    )
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppFlow;

var customConnectorSourcePropertiesProperty = new CustomConnectorSourcePropertiesProperty {
    EntityName = "entityName",

    // the properties below are optional
    CustomProperties = new Dictionary<string, string> {
        { "customPropertiesKey", "customProperties" }
    },
    DataTransferApi = new DataTransferApiProperty {
        Name = "name",
        Type = "type"
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

customConnectorSourcePropertiesProperty := &CustomConnectorSourcePropertiesProperty{
	EntityName: jsii.String("entityName"),

	// the properties below are optional
	CustomProperties: map[string]*string{
		"customPropertiesKey": jsii.String("customProperties"),
	},
	DataTransferApi: &DataTransferApiProperty{
		Name: jsii.String("name"),
		Type: jsii.String("type"),
	},
}

Properties ​

customPropertiesoptionalIResolvable | { [key: string]: string }custom_propertiesoptionaltyping.Union[IResolvable, typing.Mapping[str, str]]customPropertiesoptionalIResolvableCustomPropertiesoptionalIResolvableCustomPropertiesoptionalinterface{} #
Custom properties that are required to use the custom connector as a source.
dataTransferApioptionalIResolvable | CfnFlow.DataTransferApiPropertydata_transfer_apioptionaltyping.Union[IResolvable, DataTransferApiProperty]dataTransferApioptionalIResolvableDataTransferApioptionalIResolvableDataTransferApioptionalinterface{} #
The API of the connector application that Amazon AppFlow uses to transfer your data.
entityNamestringentity_namestrentityNameStringEntityNamestringEntityName*string required #
The entity specified in the custom connector as a source in the flow.