awsappflow

package
v1.145.0-devpreview Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 19, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnConnectorProfile_CFN_RESOURCE_TYPE_NAME 

func CfnConnectorProfile_CFN_RESOURCE_TYPE_NAME() *string

func CfnConnectorProfile_IsCfnElement 

func CfnConnectorProfile_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnConnectorProfile_IsCfnResource 

func CfnConnectorProfile_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnConnectorProfile_IsConstruct 

func CfnConnectorProfile_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnFlow_CFN_RESOURCE_TYPE_NAME 

func CfnFlow_CFN_RESOURCE_TYPE_NAME() *string

func CfnFlow_IsCfnElement 

func CfnFlow_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnFlow_IsCfnResource 

func CfnFlow_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnFlow_IsConstruct 

func CfnFlow_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func NewCfnConnectorProfile_Override 

func NewCfnConnectorProfile_Override(c CfnConnectorProfile, scope awscdk.Construct, id *string, props *CfnConnectorProfileProps)

Create a new `AWS::AppFlow::ConnectorProfile`.

func NewCfnFlow_Override 

func NewCfnFlow_Override(c CfnFlow, scope awscdk.Construct, id *string, props *CfnFlowProps)

Create a new `AWS::AppFlow::Flow`.

Types

type CfnConnectorProfile 

type CfnConnectorProfile interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrConnectorProfileArn() *string
	AttrCredentialsArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	ConnectionMode() *string
	SetConnectionMode(val *string)
	ConnectorProfileConfig() interface{}
	SetConnectorProfileConfig(val interface{})
	ConnectorProfileName() *string
	SetConnectorProfileName(val *string)
	ConnectorType() *string
	SetConnectorType(val *string)
	CreationStack() *[]*string
	KmsArn() *string
	SetKmsArn(val *string)
	LogicalId() *string
	Node() awscdk.ConstructNode
	Ref() *string
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::AppFlow::ConnectorProfile`.

The `AWS::AppFlow::ConnectorProfile` resource is an Amazon AppFlow resource type that specifies the configuration profile for an instance of a connector. This includes the provided name, credentials ARN, connection-mode, and so on. The fields that are common to all types of connector profiles are explicitly specified under the `Properties` field. The rest of the connector-specific properties are specified under `Properties/ConnectorProfileConfig` .

> If you want to use AWS CloudFormation to create a connector profile for connectors that implement OAuth (such as Salesforce, Slack, Zendesk, and Google Analytics), you must fetch the access and refresh tokens. You can do this by implementing your own UI for OAuth, or by retrieving the tokens from elsewhere. Alternatively, you can use the Amazon AppFlow console to create the connector profile, and then use that connector profile in the flow creation CloudFormation template.

TODO: EXAMPLE

func NewCfnConnectorProfile 

func NewCfnConnectorProfile(scope awscdk.Construct, id *string, props *CfnConnectorProfileProps) CfnConnectorProfile

Create a new `AWS::AppFlow::ConnectorProfile`.

type CfnConnectorProfileProps 

type CfnConnectorProfileProps struct {
	// Indicates the connection mode and if it is public or private.
	ConnectionMode *string `json:"connectionMode" yaml:"connectionMode"`
	// The name of the connector profile.
	//
	// The name is unique for each `ConnectorProfile` in the AWS account .
	ConnectorProfileName *string `json:"connectorProfileName" yaml:"connectorProfileName"`
	// The type of connector, such as Salesforce, Amplitude, and so on.
	ConnectorType *string `json:"connectorType" yaml:"connectorType"`
	// Defines the connector-specific configuration and credentials.
	ConnectorProfileConfig interface{} `json:"connectorProfileConfig" yaml:"connectorProfileConfig"`
	// The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.
	//
	// This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.
	KmsArn *string `json:"kmsArn" yaml:"kmsArn"`
}

Properties for defining a `CfnConnectorProfile`.

TODO: EXAMPLE

type CfnConnectorProfile_AmplitudeConnectorProfileCredentialsProperty 

type CfnConnectorProfile_AmplitudeConnectorProfileCredentialsProperty struct {
	// A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.
	ApiKey *string `json:"apiKey" yaml:"apiKey"`
	// The Secret Access Key portion of the credentials.
	SecretKey *string `json:"secretKey" yaml:"secretKey"`
}

The `AmplitudeConnectorProfileCredentials` property type specifies the connector-specific credentials required when using Amplitude.

TODO: EXAMPLE

type CfnConnectorProfile_ConnectorOAuthRequestProperty 

type CfnConnectorProfile_ConnectorOAuthRequestProperty struct {
	// The code provided by the connector when it has been authenticated via the connected app.
	AuthCode *string `json:"authCode" yaml:"authCode"`
	// The URL to which the authentication server redirects the browser after authorization has been granted.
	RedirectUri *string `json:"redirectUri" yaml:"redirectUri"`
}

The `ConnectorOAuthRequest` property type specifies the select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.

TODO: EXAMPLE

type CfnConnectorProfile_ConnectorProfileConfigProperty 

type CfnConnectorProfile_ConnectorProfileConfigProperty struct {
	// The connector-specific credentials required by each connector.
	ConnectorProfileCredentials interface{} `json:"connectorProfileCredentials" yaml:"connectorProfileCredentials"`
	// The connector-specific properties of the profile configuration.
	ConnectorProfileProperties interface{} `json:"connectorProfileProperties" yaml:"connectorProfileProperties"`
}

Defines the connector-specific configuration and credentials for the connector profile.

TODO: EXAMPLE

type CfnConnectorProfile_ConnectorProfileCredentialsProperty 

type CfnConnectorProfile_ConnectorProfileCredentialsProperty struct {
	// The connector-specific credentials required when using Amplitude.
	Amplitude interface{} `json:"amplitude" yaml:"amplitude"`
	// The connector-specific credentials required when using Datadog.
	Datadog interface{} `json:"datadog" yaml:"datadog"`
	// The connector-specific credentials required when using Dynatrace.
	Dynatrace interface{} `json:"dynatrace" yaml:"dynatrace"`
	// The connector-specific credentials required when using Google Analytics.
	GoogleAnalytics interface{} `json:"googleAnalytics" yaml:"googleAnalytics"`
	// The connector-specific credentials required when using Infor Nexus.
	InforNexus interface{} `json:"inforNexus" yaml:"inforNexus"`
	// The connector-specific credentials required when using Marketo.
	Marketo interface{} `json:"marketo" yaml:"marketo"`
	// The connector-specific credentials required when using Amazon Redshift.
	Redshift interface{} `json:"redshift" yaml:"redshift"`
	// The connector-specific credentials required when using Salesforce.
	Salesforce interface{} `json:"salesforce" yaml:"salesforce"`
	// `CfnConnectorProfile.ConnectorProfileCredentialsProperty.SAPOData`.
	SapoData interface{} `json:"sapoData" yaml:"sapoData"`
	// The connector-specific credentials required when using ServiceNow.
	ServiceNow interface{} `json:"serviceNow" yaml:"serviceNow"`
	// The connector-specific credentials required when using Singular.
	Singular interface{} `json:"singular" yaml:"singular"`
	// The connector-specific credentials required when using Slack.
	Slack interface{} `json:"slack" yaml:"slack"`
	// The connector-specific credentials required when using Snowflake.
	Snowflake interface{} `json:"snowflake" yaml:"snowflake"`
	// The connector-specific credentials required when using Trend Micro.
	Trendmicro interface{} `json:"trendmicro" yaml:"trendmicro"`
	// The connector-specific credentials required when using Veeva.
	Veeva interface{} `json:"veeva" yaml:"veeva"`
	// The connector-specific credentials required when using Zendesk.
	Zendesk interface{} `json:"zendesk" yaml:"zendesk"`
}

The `ConnectorProfileCredentials` property type specifies the connector-specific credentials required by a given connector.

TODO: EXAMPLE

type CfnConnectorProfile_ConnectorProfilePropertiesProperty 

type CfnConnectorProfile_ConnectorProfilePropertiesProperty struct {
	// The connector-specific properties required by Datadog.
	Datadog interface{} `json:"datadog" yaml:"datadog"`
	// The connector-specific properties required by Dynatrace.
	Dynatrace interface{} `json:"dynatrace" yaml:"dynatrace"`
	// The connector-specific properties required by Infor Nexus.
	InforNexus interface{} `json:"inforNexus" yaml:"inforNexus"`
	// The connector-specific properties required by Marketo.
	Marketo interface{} `json:"marketo" yaml:"marketo"`
	// The connector-specific properties required by Amazon Redshift.
	Redshift interface{} `json:"redshift" yaml:"redshift"`
	// The connector-specific properties required by Salesforce.
	Salesforce interface{} `json:"salesforce" yaml:"salesforce"`
	// `CfnConnectorProfile.ConnectorProfilePropertiesProperty.SAPOData`.
	SapoData interface{} `json:"sapoData" yaml:"sapoData"`
	// The connector-specific properties required by serviceNow.
	ServiceNow interface{} `json:"serviceNow" yaml:"serviceNow"`
	// The connector-specific properties required by Slack.
	Slack interface{} `json:"slack" yaml:"slack"`
	// The connector-specific properties required by Snowflake.
	Snowflake interface{} `json:"snowflake" yaml:"snowflake"`
	// The connector-specific properties required by Veeva.
	Veeva interface{} `json:"veeva" yaml:"veeva"`
	// The connector-specific properties required by Zendesk.
	Zendesk interface{} `json:"zendesk" yaml:"zendesk"`
}

The `ConnectorProfileProperties` property type specifies the connector-specific profile properties required by each connector.

TODO: EXAMPLE

type CfnConnectorProfile_DatadogConnectorProfileCredentialsProperty 

type CfnConnectorProfile_DatadogConnectorProfileCredentialsProperty struct {
	// A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.
	ApiKey *string `json:"apiKey" yaml:"apiKey"`
	// Application keys, in conjunction with your API key, give you full access to Datadog’s programmatic API.
	//
	// Application keys are associated with the user account that created them. The application key is used to log all requests made to the API.
	ApplicationKey *string `json:"applicationKey" yaml:"applicationKey"`
}

The `DatadogConnectorProfileCredentials` property type specifies the connector-specific credentials required by Datadog.

TODO: EXAMPLE

type CfnConnectorProfile_DatadogConnectorProfilePropertiesProperty 

type CfnConnectorProfile_DatadogConnectorProfilePropertiesProperty struct {
	// The location of the Datadog resource.
	InstanceUrl *string `json:"instanceUrl" yaml:"instanceUrl"`
}

The `DatadogConnectorProfileProperties` property type specifies the connector-specific profile properties required by Datadog.

TODO: EXAMPLE

type CfnConnectorProfile_DynatraceConnectorProfileCredentialsProperty 

type CfnConnectorProfile_DynatraceConnectorProfileCredentialsProperty struct {
	// The API tokens used by Dynatrace API to authenticate various API calls.
	ApiToken *string `json:"apiToken" yaml:"apiToken"`
}

The `DynatraceConnectorProfileCredentials` property type specifies the connector-specific profile credentials required by Dynatrace.

TODO: EXAMPLE

type CfnConnectorProfile_DynatraceConnectorProfilePropertiesProperty 

type CfnConnectorProfile_DynatraceConnectorProfilePropertiesProperty struct {
	// The location of the Dynatrace resource.
	InstanceUrl *string `json:"instanceUrl" yaml:"instanceUrl"`
}

The `DynatraceConnectorProfileProperties` property type specifies the connector-specific profile properties required by Dynatrace.

TODO: EXAMPLE

type CfnConnectorProfile_GoogleAnalyticsConnectorProfileCredentialsProperty 

type CfnConnectorProfile_GoogleAnalyticsConnectorProfileCredentialsProperty struct {
	// The identifier for the desired client.
	ClientId *string `json:"clientId" yaml:"clientId"`
	// The client secret used by the OAuth client to authenticate to the authorization server.
	ClientSecret *string `json:"clientSecret" yaml:"clientSecret"`
	// The credentials used to access protected Google Analytics resources.
	AccessToken *string `json:"accessToken" yaml:"accessToken"`
	// Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.
	ConnectorOAuthRequest interface{} `json:"connectorOAuthRequest" yaml:"connectorOAuthRequest"`
	// The credentials used to acquire new access tokens.
	//
	// This is required only for OAuth2 access tokens, and is not required for OAuth1 access tokens.
	RefreshToken *string `json:"refreshToken" yaml:"refreshToken"`
}

The `GoogleAnalyticsConnectorProfileCredentials` property type specifies the connector-specific profile credentials required by Google Analytics.

TODO: EXAMPLE

type CfnConnectorProfile_InforNexusConnectorProfileCredentialsProperty 

type CfnConnectorProfile_InforNexusConnectorProfileCredentialsProperty struct {
	// The Access Key portion of the credentials.
	AccessKeyId *string `json:"accessKeyId" yaml:"accessKeyId"`
	// The encryption keys used to encrypt data.
	Datakey *string `json:"datakey" yaml:"datakey"`
	// The secret key used to sign requests.
	SecretAccessKey *string `json:"secretAccessKey" yaml:"secretAccessKey"`
	// The identifier for the user.
	UserId *string `json:"userId" yaml:"userId"`
}

The `InforNexusConnectorProfileCredentials` property type specifies the connector-specific profile credentials required by Infor Nexus.

TODO: EXAMPLE

type CfnConnectorProfile_InforNexusConnectorProfilePropertiesProperty 

type CfnConnectorProfile_InforNexusConnectorProfilePropertiesProperty struct {
	// The location of the Infor Nexus resource.
	InstanceUrl *string `json:"instanceUrl" yaml:"instanceUrl"`
}

The `InforNexusConnectorProfileProperties` property type specifies the connector-specific profile properties required by Infor Nexus.

TODO: EXAMPLE

type CfnConnectorProfile_MarketoConnectorProfileCredentialsProperty 

type CfnConnectorProfile_MarketoConnectorProfileCredentialsProperty struct {
	// The identifier for the desired client.
	ClientId *string `json:"clientId" yaml:"clientId"`
	// The client secret used by the OAuth client to authenticate to the authorization server.
	ClientSecret *string `json:"clientSecret" yaml:"clientSecret"`
	// The credentials used to access protected Marketo resources.
	AccessToken *string `json:"accessToken" yaml:"accessToken"`
	// Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.
	ConnectorOAuthRequest interface{} `json:"connectorOAuthRequest" yaml:"connectorOAuthRequest"`
}

The `MarketoConnectorProfileCredentials` property type specifies the connector-specific profile credentials required by Marketo.

TODO: EXAMPLE

type CfnConnectorProfile_MarketoConnectorProfilePropertiesProperty 

type CfnConnectorProfile_MarketoConnectorProfilePropertiesProperty struct {
	// The location of the Marketo resource.
	InstanceUrl *string `json:"instanceUrl" yaml:"instanceUrl"`
}

The `MarketoConnectorProfileProperties` property type specifies the connector-specific profile properties required when using Marketo.

TODO: EXAMPLE

type CfnConnectorProfile_OAuthPropertiesProperty 

type CfnConnectorProfile_OAuthPropertiesProperty struct {
	// `CfnConnectorProfile.OAuthPropertiesProperty.AuthCodeUrl`.
	AuthCodeUrl *string `json:"authCodeUrl" yaml:"authCodeUrl"`
	// `CfnConnectorProfile.OAuthPropertiesProperty.OAuthScopes`.
	OAuthScopes *[]*string `json:"oAuthScopes" yaml:"oAuthScopes"`
	// `CfnConnectorProfile.OAuthPropertiesProperty.TokenUrl`.
	TokenUrl *string `json:"tokenUrl" yaml:"tokenUrl"`
}

TODO: EXAMPLE

type CfnConnectorProfile_RedshiftConnectorProfileCredentialsProperty 

type CfnConnectorProfile_RedshiftConnectorProfileCredentialsProperty struct {
	// The password that corresponds to the user name.
	Password *string `json:"password" yaml:"password"`
	// The name of the user.
	Username *string `json:"username" yaml:"username"`
}

The `RedshiftConnectorProfileCredentials` property type specifies the connector-specific profile credentials required when using Amazon Redshift.

TODO: EXAMPLE

type CfnConnectorProfile_RedshiftConnectorProfilePropertiesProperty 

type CfnConnectorProfile_RedshiftConnectorProfilePropertiesProperty struct {
	// A name for the associated Amazon S3 bucket.
	BucketName *string `json:"bucketName" yaml:"bucketName"`
	// The JDBC URL of the Amazon Redshift cluster.
	DatabaseUrl *string `json:"databaseUrl" yaml:"databaseUrl"`
	// The Amazon Resource Name (ARN) of the IAM role.
	RoleArn *string `json:"roleArn" yaml:"roleArn"`
	// The object key for the destination bucket in which Amazon AppFlow places the files.
	BucketPrefix *string `json:"bucketPrefix" yaml:"bucketPrefix"`
}

The `RedshiftConnectorProfileProperties` property type specifies the connector-specific profile properties when using Amazon Redshift.

TODO: EXAMPLE

type CfnConnectorProfile_SAPODataConnectorProfileCredentialsProperty 

type CfnConnectorProfile_SAPODataConnectorProfileCredentialsProperty struct {
	// `CfnConnectorProfile.SAPODataConnectorProfileCredentialsProperty.BasicAuthCredentials`.
	BasicAuthCredentials interface{} `json:"basicAuthCredentials" yaml:"basicAuthCredentials"`
	// `CfnConnectorProfile.SAPODataConnectorProfileCredentialsProperty.OAuthCredentials`.
	OAuthCredentials interface{} `json:"oAuthCredentials" yaml:"oAuthCredentials"`
}

TODO: EXAMPLE

type CfnConnectorProfile_SAPODataConnectorProfilePropertiesProperty 

type CfnConnectorProfile_SAPODataConnectorProfilePropertiesProperty struct {
	// `CfnConnectorProfile.SAPODataConnectorProfilePropertiesProperty.ApplicationHostUrl`.
	ApplicationHostUrl *string `json:"applicationHostUrl" yaml:"applicationHostUrl"`
	// `CfnConnectorProfile.SAPODataConnectorProfilePropertiesProperty.ApplicationServicePath`.
	ApplicationServicePath *string `json:"applicationServicePath" yaml:"applicationServicePath"`
	// `CfnConnectorProfile.SAPODataConnectorProfilePropertiesProperty.ClientNumber`.
	ClientNumber *string `json:"clientNumber" yaml:"clientNumber"`
	// `CfnConnectorProfile.SAPODataConnectorProfilePropertiesProperty.LogonLanguage`.
	LogonLanguage *string `json:"logonLanguage" yaml:"logonLanguage"`
	// `CfnConnectorProfile.SAPODataConnectorProfilePropertiesProperty.OAuthProperties`.
	OAuthProperties interface{} `json:"oAuthProperties" yaml:"oAuthProperties"`
	// `CfnConnectorProfile.SAPODataConnectorProfilePropertiesProperty.PortNumber`.
	PortNumber *float64 `json:"portNumber" yaml:"portNumber"`
	// `CfnConnectorProfile.SAPODataConnectorProfilePropertiesProperty.PrivateLinkServiceName`.
	PrivateLinkServiceName *string `json:"privateLinkServiceName" yaml:"privateLinkServiceName"`
}

TODO: EXAMPLE

type CfnConnectorProfile_SalesforceConnectorProfileCredentialsProperty 

type CfnConnectorProfile_SalesforceConnectorProfileCredentialsProperty struct {
	// The credentials used to access protected Salesforce resources.
	AccessToken *string `json:"accessToken" yaml:"accessToken"`
	// The secret manager ARN, which contains the client ID and client secret of the connected app.
	ClientCredentialsArn *string `json:"clientCredentialsArn" yaml:"clientCredentialsArn"`
	// Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.
	ConnectorOAuthRequest interface{} `json:"connectorOAuthRequest" yaml:"connectorOAuthRequest"`
	// The credentials used to acquire new access tokens.
	RefreshToken *string `json:"refreshToken" yaml:"refreshToken"`
}

The `SalesforceConnectorProfileCredentials` property type specifies the connector-specific profile credentials required when using Salesforce.

TODO: EXAMPLE

type CfnConnectorProfile_SalesforceConnectorProfilePropertiesProperty 

type CfnConnectorProfile_SalesforceConnectorProfilePropertiesProperty struct {
	// The location of the Salesforce resource.
	InstanceUrl *string `json:"instanceUrl" yaml:"instanceUrl"`
	// Indicates whether the connector profile applies to a sandbox or production environment.
	IsSandboxEnvironment interface{} `json:"isSandboxEnvironment" yaml:"isSandboxEnvironment"`
}

The `SalesforceConnectorProfileProperties` property type specifies the connector-specific profile properties required when using Salesforce.

TODO: EXAMPLE

type CfnConnectorProfile_ServiceNowConnectorProfileCredentialsProperty 

type CfnConnectorProfile_ServiceNowConnectorProfileCredentialsProperty struct {
	// The password that corresponds to the user name.
	Password *string `json:"password" yaml:"password"`
	// The name of the user.
	Username *string `json:"username" yaml:"username"`
}

The `ServiceNowConnectorProfileCredentials` property type specifies the connector-specific profile credentials required when using ServiceNow.

TODO: EXAMPLE

type CfnConnectorProfile_ServiceNowConnectorProfilePropertiesProperty 

type CfnConnectorProfile_ServiceNowConnectorProfilePropertiesProperty struct {
	// The location of the ServiceNow resource.
	InstanceUrl *string `json:"instanceUrl" yaml:"instanceUrl"`
}

The `ServiceNowConnectorProfileProperties` property type specifies the connector-specific profile properties required when using ServiceNow.

TODO: EXAMPLE

type CfnConnectorProfile_SingularConnectorProfileCredentialsProperty 

type CfnConnectorProfile_SingularConnectorProfileCredentialsProperty struct {
	// A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.
	ApiKey *string `json:"apiKey" yaml:"apiKey"`
}

The `SingularConnectorProfileCredentials` property type specifies the connector-specific profile credentials required when using Singular.

TODO: EXAMPLE

type CfnConnectorProfile_SlackConnectorProfileCredentialsProperty 

type CfnConnectorProfile_SlackConnectorProfileCredentialsProperty struct {
	// The identifier for the client.
	ClientId *string `json:"clientId" yaml:"clientId"`
	// The client secret used by the OAuth client to authenticate to the authorization server.
	ClientSecret *string `json:"clientSecret" yaml:"clientSecret"`
	// The credentials used to access protected Slack resources.
	AccessToken *string `json:"accessToken" yaml:"accessToken"`
	// Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.
	ConnectorOAuthRequest interface{} `json:"connectorOAuthRequest" yaml:"connectorOAuthRequest"`
}

The `SlackConnectorProfileCredentials` property type specifies the connector-specific profile credentials required when using Slack.

TODO: EXAMPLE

type CfnConnectorProfile_SlackConnectorProfilePropertiesProperty 

type CfnConnectorProfile_SlackConnectorProfilePropertiesProperty struct {
	// The location of the Slack resource.
	InstanceUrl *string `json:"instanceUrl" yaml:"instanceUrl"`
}

The `SlackConnectorProfileProperties` property type specifies the connector-specific profile properties required when using Slack.

TODO: EXAMPLE

type CfnConnectorProfile_SnowflakeConnectorProfileCredentialsProperty 

type CfnConnectorProfile_SnowflakeConnectorProfileCredentialsProperty struct {
	// The password that corresponds to the user name.
	Password *string `json:"password" yaml:"password"`
	// The name of the user.
	Username *string `json:"username" yaml:"username"`
}

The `SnowflakeConnectorProfileCredentials` property type specifies the connector-specific profile credentials required when using Snowflake.

TODO: EXAMPLE

type CfnConnectorProfile_SnowflakeConnectorProfilePropertiesProperty 

type CfnConnectorProfile_SnowflakeConnectorProfilePropertiesProperty struct {
	// The name of the Amazon S3 bucket associated with Snowflake.
	BucketName *string `json:"bucketName" yaml:"bucketName"`
	// The name of the Amazon S3 stage that was created while setting up an Amazon S3 stage in the Snowflake account.
	//
	// This is written in the following format: < Database>< Schema><Stage Name>.
	Stage *string `json:"stage" yaml:"stage"`
	// The name of the Snowflake warehouse.
	Warehouse *string `json:"warehouse" yaml:"warehouse"`
	// The name of the account.
	AccountName *string `json:"accountName" yaml:"accountName"`
	// The bucket path that refers to the Amazon S3 bucket associated with Snowflake.
	BucketPrefix *string `json:"bucketPrefix" yaml:"bucketPrefix"`
	// The Snowflake Private Link service name to be used for private data transfers.
	PrivateLinkServiceName *string `json:"privateLinkServiceName" yaml:"privateLinkServiceName"`
	// The AWS Region of the Snowflake account.
	Region *string `json:"region" yaml:"region"`
}

The `SnowflakeConnectorProfileProperties` property type specifies the connector-specific profile properties required when using Snowflake.

TODO: EXAMPLE

type CfnConnectorProfile_TrendmicroConnectorProfileCredentialsProperty 

type CfnConnectorProfile_TrendmicroConnectorProfileCredentialsProperty struct {
	// The Secret Access Key portion of the credentials.
	ApiSecretKey *string `json:"apiSecretKey" yaml:"apiSecretKey"`
}

The `TrendmicroConnectorProfileCredentials` property type specifies the connector-specific profile credentials required when using Trend Micro.

TODO: EXAMPLE

type CfnConnectorProfile_VeevaConnectorProfileCredentialsProperty 

type CfnConnectorProfile_VeevaConnectorProfileCredentialsProperty struct {
	// The password that corresponds to the user name.
	Password *string `json:"password" yaml:"password"`
	// The name of the user.
	Username *string `json:"username" yaml:"username"`
}

The `VeevaConnectorProfileCredentials` property type specifies the connector-specific profile credentials required when using Veeva.

TODO: EXAMPLE

type CfnConnectorProfile_VeevaConnectorProfilePropertiesProperty 

type CfnConnectorProfile_VeevaConnectorProfilePropertiesProperty struct {
	// The location of the Veeva resource.
	InstanceUrl *string `json:"instanceUrl" yaml:"instanceUrl"`
}

The `VeevaConnectorProfileProperties` property type specifies the connector-specific profile properties required when using Veeva.

TODO: EXAMPLE

type CfnConnectorProfile_ZendeskConnectorProfileCredentialsProperty 

type CfnConnectorProfile_ZendeskConnectorProfileCredentialsProperty struct {
	// The identifier for the desired client.
	ClientId *string `json:"clientId" yaml:"clientId"`
	// The client secret used by the OAuth client to authenticate to the authorization server.
	ClientSecret *string `json:"clientSecret" yaml:"clientSecret"`
	// The credentials used to access protected Zendesk resources.
	AccessToken *string `json:"accessToken" yaml:"accessToken"`
	// Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.
	ConnectorOAuthRequest interface{} `json:"connectorOAuthRequest" yaml:"connectorOAuthRequest"`
}

The `ZendeskConnectorProfileCredentials` property type specifies the connector-specific profile credentials required when using Zendesk.

TODO: EXAMPLE

type CfnConnectorProfile_ZendeskConnectorProfilePropertiesProperty 

type CfnConnectorProfile_ZendeskConnectorProfilePropertiesProperty struct {
	// The location of the Zendesk resource.
	InstanceUrl *string `json:"instanceUrl" yaml:"instanceUrl"`
}

The `ZendeskConnectorProfileProperties` property type specifies the connector-specific profile properties required when using Zendesk.

TODO: EXAMPLE

type CfnFlow 

type CfnFlow interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrFlowArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	DestinationFlowConfigList() interface{}
	SetDestinationFlowConfigList(val interface{})
	FlowName() *string
	SetFlowName(val *string)
	KmsArn() *string
	SetKmsArn(val *string)
	LogicalId() *string
	Node() awscdk.ConstructNode
	Ref() *string
	SourceFlowConfig() interface{}
	SetSourceFlowConfig(val interface{})
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	Tasks() interface{}
	SetTasks(val interface{})
	TriggerConfig() interface{}
	SetTriggerConfig(val interface{})
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::AppFlow::Flow`.

The `AWS::AppFlow::Flow` resource is an Amazon AppFlow resource type that specifies a new flow.

> If you want to use AWS CloudFormation to create a connector profile for connectors that implement OAuth (such as Salesforce, Slack, Zendesk, and Google Analytics), you must fetch the access and refresh tokens. You can do this by implementing your own UI for OAuth, or by retrieving the tokens from elsewhere. Alternatively, you can use the Amazon AppFlow console to create the connector profile, and then use that connector profile in the flow creation CloudFormation template.

TODO: EXAMPLE

func NewCfnFlow 

func NewCfnFlow(scope awscdk.Construct, id *string, props *CfnFlowProps) CfnFlow

Create a new `AWS::AppFlow::Flow`.

type CfnFlowProps 

type CfnFlowProps struct {
	// The configuration that controls how Amazon AppFlow places data in the destination connector.
	DestinationFlowConfigList interface{} `json:"destinationFlowConfigList" yaml:"destinationFlowConfigList"`
	// The specified name of the flow.
	//
	// Spaces are not allowed. Use underscores (_) or hyphens (-) only.
	FlowName *string `json:"flowName" yaml:"flowName"`
	// Contains information about the configuration of the source connector used in the flow.
	SourceFlowConfig interface{} `json:"sourceFlowConfig" yaml:"sourceFlowConfig"`
	// A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
	Tasks interface{} `json:"tasks" yaml:"tasks"`
	// The trigger settings that determine how and when Amazon AppFlow runs the specified flow.
	TriggerConfig interface{} `json:"triggerConfig" yaml:"triggerConfig"`
	// A user-entered description of the flow.
	Description *string `json:"description" yaml:"description"`
	// The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.
	//
	// This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.
	KmsArn *string `json:"kmsArn" yaml:"kmsArn"`
	// The tags used to organize, track, or control access for your flow.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnFlow`.

TODO: EXAMPLE

type CfnFlow_AggregationConfigProperty 

type CfnFlow_AggregationConfigProperty struct {
	// Specifies whether Amazon AppFlow aggregates the flow records into a single file, or leave them unaggregated.
	AggregationType *string `json:"aggregationType" yaml:"aggregationType"`
}

The aggregation settings that you can use to customize the output format of your flow data.

TODO: EXAMPLE

type CfnFlow_AmplitudeSourcePropertiesProperty 

type CfnFlow_AmplitudeSourcePropertiesProperty struct {
	// The object specified in the Amplitude flow source.
	Object *string `json:"object" yaml:"object"`
}

The properties that are applied when Amplitude is being used as a source.

TODO: EXAMPLE

type CfnFlow_ConnectorOperatorProperty 

type CfnFlow_ConnectorOperatorProperty struct {
	// The operation to be performed on the provided Amplitude source fields.
	Amplitude *string `json:"amplitude" yaml:"amplitude"`
	// The operation to be performed on the provided Datadog source fields.
	Datadog *string `json:"datadog" yaml:"datadog"`
	// The operation to be performed on the provided Dynatrace source fields.
	Dynatrace *string `json:"dynatrace" yaml:"dynatrace"`
	// The operation to be performed on the provided Google Analytics source fields.
	GoogleAnalytics *string `json:"googleAnalytics" yaml:"googleAnalytics"`
	// The operation to be performed on the provided Infor Nexus source fields.
	InforNexus *string `json:"inforNexus" yaml:"inforNexus"`
	// The operation to be performed on the provided Marketo source fields.
	Marketo *string `json:"marketo" yaml:"marketo"`
	// The operation to be performed on the provided Amazon S3 source fields.
	S3 *string `json:"s3" yaml:"s3"`
	// The operation to be performed on the provided Salesforce source fields.
	Salesforce *string `json:"salesforce" yaml:"salesforce"`
	// `CfnFlow.ConnectorOperatorProperty.SAPOData`.
	SapoData *string `json:"sapoData" yaml:"sapoData"`
	// The operation to be performed on the provided ServiceNow source fields.
	ServiceNow *string `json:"serviceNow" yaml:"serviceNow"`
	// The operation to be performed on the provided Singular source fields.
	Singular *string `json:"singular" yaml:"singular"`
	// The operation to be performed on the provided Slack source fields.
	Slack *string `json:"slack" yaml:"slack"`
	// The operation to be performed on the provided Trend Micro source fields.
	Trendmicro *string `json:"trendmicro" yaml:"trendmicro"`
	// The operation to be performed on the provided Veeva source fields.
	Veeva *string `json:"veeva" yaml:"veeva"`
	// The operation to be performed on the provided Zendesk source fields.
	Zendesk *string `json:"zendesk" yaml:"zendesk"`
}

The operation to be performed on the provided source fields.

TODO: EXAMPLE

type CfnFlow_DatadogSourcePropertiesProperty 

type CfnFlow_DatadogSourcePropertiesProperty struct {
	// The object specified in the Datadog flow source.
	Object *string `json:"object" yaml:"object"`
}

The properties that are applied when Datadog is being used as a source.

TODO: EXAMPLE

type CfnFlow_DestinationConnectorPropertiesProperty 

type CfnFlow_DestinationConnectorPropertiesProperty struct {
	// The properties required to query Amazon EventBridge.
	EventBridge interface{} `json:"eventBridge" yaml:"eventBridge"`
	// The properties required to query Amazon Lookout for Metrics.
	LookoutMetrics interface{} `json:"lookoutMetrics" yaml:"lookoutMetrics"`
	// The properties required to query Amazon Redshift.
	Redshift interface{} `json:"redshift" yaml:"redshift"`
	// The properties required to query Amazon S3.
	S3 interface{} `json:"s3" yaml:"s3"`
	// The properties required to query Salesforce.
	Salesforce interface{} `json:"salesforce" yaml:"salesforce"`
	// The properties required to query Snowflake.
	Snowflake interface{} `json:"snowflake" yaml:"snowflake"`
	// The properties required to query Upsolver.
	Upsolver interface{} `json:"upsolver" yaml:"upsolver"`
	// `CfnFlow.DestinationConnectorPropertiesProperty.Zendesk`.
	Zendesk interface{} `json:"zendesk" yaml:"zendesk"`
}

This stores the information that is required to query a particular connector.

TODO: EXAMPLE

type CfnFlow_DestinationFlowConfigProperty 

type CfnFlow_DestinationFlowConfigProperty struct {
	// The type of destination connector, such as Sales force, Amazon S3, and so on.
	//
	// *Allowed Values* : `EventBridge | Redshift | S3 | Salesforce | Snowflake`
	ConnectorType *string `json:"connectorType" yaml:"connectorType"`
	// This stores the information that is required to query a particular connector.
	DestinationConnectorProperties interface{} `json:"destinationConnectorProperties" yaml:"destinationConnectorProperties"`
	// The name of the connector profile.
	//
	// This name must be unique for each connector profile in the AWS account .
	ConnectorProfileName *string `json:"connectorProfileName" yaml:"connectorProfileName"`
}

The `DestinationFlowConfig` property type specifies information about the configuration of destination connectors present in the flow.

TODO: EXAMPLE

type CfnFlow_DynatraceSourcePropertiesProperty 

type CfnFlow_DynatraceSourcePropertiesProperty struct {
	// The object specified in the Dynatrace flow source.
	Object *string `json:"object" yaml:"object"`
}

The properties that are applied when Dynatrace is being used as a source.

TODO: EXAMPLE

type CfnFlow_ErrorHandlingConfigProperty 

type CfnFlow_ErrorHandlingConfigProperty struct {
	// Specifies the name of the Amazon S3 bucket.
	BucketName *string `json:"bucketName" yaml:"bucketName"`
	// Specifies the Amazon S3 bucket prefix.
	BucketPrefix *string `json:"bucketPrefix" yaml:"bucketPrefix"`
	// Specifies if the flow should fail after the first instance of a failure when attempting to place data in the destination.
	FailOnFirstError interface{} `json:"failOnFirstError" yaml:"failOnFirstError"`
}

The settings that determine how Amazon AppFlow handles an error when placing data in the destination.

For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. `ErrorHandlingConfig` is a part of the destination connector details.

TODO: EXAMPLE

type CfnFlow_EventBridgeDestinationPropertiesProperty 

type CfnFlow_EventBridgeDestinationPropertiesProperty struct {
	// The object specified in the Amazon EventBridge flow destination.
	Object *string `json:"object" yaml:"object"`
	// The object specified in the Amplitude flow source.
	ErrorHandlingConfig interface{} `json:"errorHandlingConfig" yaml:"errorHandlingConfig"`
}

The properties that are applied when Amazon EventBridge is being used as a destination.

TODO: EXAMPLE

type CfnFlow_GoogleAnalyticsSourcePropertiesProperty 

type CfnFlow_GoogleAnalyticsSourcePropertiesProperty struct {
	// The object specified in the Google Analytics flow source.
	Object *string `json:"object" yaml:"object"`
}

The properties that are applied when Google Analytics is being used as a source.

TODO: EXAMPLE

type CfnFlow_IncrementalPullConfigProperty 

type CfnFlow_IncrementalPullConfigProperty struct {
	// A field that specifies the date time or timestamp field as the criteria to use when importing incremental records from the source.
	DatetimeTypeFieldName *string `json:"datetimeTypeFieldName" yaml:"datetimeTypeFieldName"`
}

Specifies the configuration used when importing incremental records from the source.

TODO: EXAMPLE

type CfnFlow_InforNexusSourcePropertiesProperty 

type CfnFlow_InforNexusSourcePropertiesProperty struct {
	// The object specified in the Infor Nexus flow source.
	Object *string `json:"object" yaml:"object"`
}

The properties that are applied when Infor Nexus is being used as a source.

TODO: EXAMPLE

type CfnFlow_LookoutMetricsDestinationPropertiesProperty 

type CfnFlow_LookoutMetricsDestinationPropertiesProperty struct {
	// The object specified in the Amazon Lookout for Metrics flow destination.
	Object *string `json:"object" yaml:"object"`
}

The properties that are applied when Amazon Lookout for Metrics is used as a destination.

TODO: EXAMPLE

type CfnFlow_MarketoSourcePropertiesProperty 

type CfnFlow_MarketoSourcePropertiesProperty struct {
	// The object specified in the Marketo flow source.
	Object *string `json:"object" yaml:"object"`
}

The properties that are applied when Marketo is being used as a source.

TODO: EXAMPLE

type CfnFlow_PrefixConfigProperty 

type CfnFlow_PrefixConfigProperty struct {
	// Determines the level of granularity that's included in the prefix.
	PrefixFormat *string `json:"prefixFormat" yaml:"prefixFormat"`
	// Determines the format of the prefix, and whether it applies to the file name, file path, or both.
	PrefixType *string `json:"prefixType" yaml:"prefixType"`
}

Determines the prefix that Amazon AppFlow applies to the destination folder name.

You can name your destination folders according to the flow frequency and date.

TODO: EXAMPLE

type CfnFlow_RedshiftDestinationPropertiesProperty 

type CfnFlow_RedshiftDestinationPropertiesProperty struct {
	// The intermediate bucket that Amazon AppFlow uses when moving data into Amazon Redshift.
	IntermediateBucketName *string `json:"intermediateBucketName" yaml:"intermediateBucketName"`
	// The object specified in the Amazon Redshift flow destination.
	Object *string `json:"object" yaml:"object"`
	// The object key for the bucket in which Amazon AppFlow places the destination files.
	BucketPrefix *string `json:"bucketPrefix" yaml:"bucketPrefix"`
	// The settings that determine how Amazon AppFlow handles an error when placing data in the Amazon Redshift destination.
	//
	// For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. `ErrorHandlingConfig` is a part of the destination connector details.
	ErrorHandlingConfig interface{} `json:"errorHandlingConfig" yaml:"errorHandlingConfig"`
}

The properties that are applied when Amazon Redshift is being used as a destination.

TODO: EXAMPLE

type CfnFlow_S3DestinationPropertiesProperty 

type CfnFlow_S3DestinationPropertiesProperty struct {
	// The Amazon S3 bucket name in which Amazon AppFlow places the transferred data.
	BucketName *string `json:"bucketName" yaml:"bucketName"`
	// The object key for the destination bucket in which Amazon AppFlow places the files.
	BucketPrefix *string `json:"bucketPrefix" yaml:"bucketPrefix"`
	// The configuration that determines how Amazon AppFlow should format the flow output data when Amazon S3 is used as the destination.
	S3OutputFormatConfig interface{} `json:"s3OutputFormatConfig" yaml:"s3OutputFormatConfig"`
}

The properties that are applied when Amazon S3 is used as a destination.

TODO: EXAMPLE

type CfnFlow_S3InputFormatConfigProperty 

type CfnFlow_S3InputFormatConfigProperty struct {
	// `CfnFlow.S3InputFormatConfigProperty.S3InputFileType`.
	S3InputFileType *string `json:"s3InputFileType" yaml:"s3InputFileType"`
}

TODO: EXAMPLE

type CfnFlow_S3OutputFormatConfigProperty 

type CfnFlow_S3OutputFormatConfigProperty struct {
	// The aggregation settings that you can use to customize the output format of your flow data.
	AggregationConfig interface{} `json:"aggregationConfig" yaml:"aggregationConfig"`
	// Indicates the file type that Amazon AppFlow places in the Amazon S3 bucket.
	FileType *string `json:"fileType" yaml:"fileType"`
	// Determines the prefix that Amazon AppFlow applies to the folder name in the Amazon S3 bucket.
	//
	// You can name folders according to the flow frequency and date.
	PrefixConfig interface{} `json:"prefixConfig" yaml:"prefixConfig"`
}

The configuration that determines how Amazon AppFlow should format the flow output data when Amazon S3 is used as the destination.

TODO: EXAMPLE

type CfnFlow_S3SourcePropertiesProperty 

type CfnFlow_S3SourcePropertiesProperty struct {
	// The Amazon S3 bucket name where the source files are stored.
	BucketName *string `json:"bucketName" yaml:"bucketName"`
	// The object key for the Amazon S3 bucket in which the source files are stored.
	BucketPrefix *string `json:"bucketPrefix" yaml:"bucketPrefix"`
	// `CfnFlow.S3SourcePropertiesProperty.S3InputFormatConfig`.
	S3InputFormatConfig interface{} `json:"s3InputFormatConfig" yaml:"s3InputFormatConfig"`
}

The properties that are applied when Amazon S3 is being used as the flow source.

TODO: EXAMPLE

type CfnFlow_SAPODataSourcePropertiesProperty 

type CfnFlow_SAPODataSourcePropertiesProperty struct {
	// `CfnFlow.SAPODataSourcePropertiesProperty.ObjectPath`.
	ObjectPath *string `json:"objectPath" yaml:"objectPath"`
}

TODO: EXAMPLE

type CfnFlow_SalesforceDestinationPropertiesProperty 

type CfnFlow_SalesforceDestinationPropertiesProperty struct {
	// The object specified in the Salesforce flow destination.
	Object *string `json:"object" yaml:"object"`
	// The settings that determine how Amazon AppFlow handles an error when placing data in the Salesforce destination.
	//
	// For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. `ErrorHandlingConfig` is a part of the destination connector details.
	ErrorHandlingConfig interface{} `json:"errorHandlingConfig" yaml:"errorHandlingConfig"`
	// The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update or delete.
	IdFieldNames *[]*string `json:"idFieldNames" yaml:"idFieldNames"`
	// This specifies the type of write operation to be performed in Salesforce.
	//
	// When the value is `UPSERT` , then `idFieldNames` is required.
	WriteOperationType *string `json:"writeOperationType" yaml:"writeOperationType"`
}

The properties that are applied when Salesforce is being used as a destination.

TODO: EXAMPLE

type CfnFlow_SalesforceSourcePropertiesProperty 

type CfnFlow_SalesforceSourcePropertiesProperty struct {
	// The object specified in the Salesforce flow source.
	Object *string `json:"object" yaml:"object"`
	// The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow.
	EnableDynamicFieldUpdate interface{} `json:"enableDynamicFieldUpdate" yaml:"enableDynamicFieldUpdate"`
	// Indicates whether Amazon AppFlow includes deleted files in the flow run.
	IncludeDeletedRecords interface{} `json:"includeDeletedRecords" yaml:"includeDeletedRecords"`
}

The properties that are applied when Salesforce is being used as a source.

TODO: EXAMPLE

type CfnFlow_ScheduledTriggerPropertiesProperty 

type CfnFlow_ScheduledTriggerPropertiesProperty struct {
	// The scheduling expression that determines the rate at which the scheduled flow will run, for example: `rate(5minutes)` .
	ScheduleExpression *string `json:"scheduleExpression" yaml:"scheduleExpression"`
	// Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.
	DataPullMode *string `json:"dataPullMode" yaml:"dataPullMode"`
	// Specifies the scheduled end time for a schedule-triggered flow.
	ScheduleEndTime *float64 `json:"scheduleEndTime" yaml:"scheduleEndTime"`
	// Specifies the optional offset that is added to the time interval for a schedule-triggered flow.
	ScheduleOffset *float64 `json:"scheduleOffset" yaml:"scheduleOffset"`
	// Specifies the scheduled start time for a schedule-triggered flow.
	ScheduleStartTime *float64 `json:"scheduleStartTime" yaml:"scheduleStartTime"`
	// Specifies the time zone used when referring to the date and time of a scheduled-triggered flow, such as `America/New_York` .
	TimeZone *string `json:"timeZone" yaml:"timeZone"`
}

Specifies the configuration details of a schedule-triggered flow as defined by the user.

Currently, these settings only apply to the `Scheduled` trigger type.

TODO: EXAMPLE

type CfnFlow_ServiceNowSourcePropertiesProperty 

type CfnFlow_ServiceNowSourcePropertiesProperty struct {
	// The object specified in the ServiceNow flow source.
	Object *string `json:"object" yaml:"object"`
}

The properties that are applied when ServiceNow is being used as a source.

TODO: EXAMPLE

type CfnFlow_SingularSourcePropertiesProperty 

type CfnFlow_SingularSourcePropertiesProperty struct {
	// The object specified in the Singular flow source.
	Object *string `json:"object" yaml:"object"`
}

The properties that are applied when Singular is being used as a source.

TODO: EXAMPLE

type CfnFlow_SlackSourcePropertiesProperty 

type CfnFlow_SlackSourcePropertiesProperty struct {
	// The object specified in the Slack flow source.
	Object *string `json:"object" yaml:"object"`
}

The properties that are applied when Slack is being used as a source.

TODO: EXAMPLE

type CfnFlow_SnowflakeDestinationPropertiesProperty 

type CfnFlow_SnowflakeDestinationPropertiesProperty struct {
	// The intermediate bucket that Amazon AppFlow uses when moving data into Snowflake.
	IntermediateBucketName *string `json:"intermediateBucketName" yaml:"intermediateBucketName"`
	// The object specified in the Snowflake flow destination.
	Object *string `json:"object" yaml:"object"`
	// The object key for the destination bucket in which Amazon AppFlow places the files.
	BucketPrefix *string `json:"bucketPrefix" yaml:"bucketPrefix"`
	// The settings that determine how Amazon AppFlow handles an error when placing data in the Snowflake destination.
	//
	// For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. `ErrorHandlingConfig` is a part of the destination connector details.
	ErrorHandlingConfig interface{} `json:"errorHandlingConfig" yaml:"errorHandlingConfig"`
}

The properties that are applied when Snowflake is being used as a destination.

TODO: EXAMPLE

type CfnFlow_SourceConnectorPropertiesProperty 

type CfnFlow_SourceConnectorPropertiesProperty struct {
	// Specifies the information that is required for querying Amplitude.
	Amplitude interface{} `json:"amplitude" yaml:"amplitude"`
	// Specifies the information that is required for querying Datadog.
	Datadog interface{} `json:"datadog" yaml:"datadog"`
	// Specifies the information that is required for querying Dynatrace.
	Dynatrace interface{} `json:"dynatrace" yaml:"dynatrace"`
	// Specifies the information that is required for querying Google Analytics.
	GoogleAnalytics interface{} `json:"googleAnalytics" yaml:"googleAnalytics"`
	// Specifies the information that is required for querying Infor Nexus.
	InforNexus interface{} `json:"inforNexus" yaml:"inforNexus"`
	// Specifies the information that is required for querying Marketo.
	Marketo interface{} `json:"marketo" yaml:"marketo"`
	// Specifies the information that is required for querying Amazon S3.
	S3 interface{} `json:"s3" yaml:"s3"`
	// Specifies the information that is required for querying Salesforce.
	Salesforce interface{} `json:"salesforce" yaml:"salesforce"`
	// `CfnFlow.SourceConnectorPropertiesProperty.SAPOData`.
	SapoData interface{} `json:"sapoData" yaml:"sapoData"`
	// Specifies the information that is required for querying ServiceNow.
	ServiceNow interface{} `json:"serviceNow" yaml:"serviceNow"`
	// Specifies the information that is required for querying Singular.
	Singular interface{} `json:"singular" yaml:"singular"`
	// Specifies the information that is required for querying Slack.
	Slack interface{} `json:"slack" yaml:"slack"`
	// Specifies the information that is required for querying Trend Micro.
	Trendmicro interface{} `json:"trendmicro" yaml:"trendmicro"`
	// Specifies the information that is required for querying Veeva.
	Veeva interface{} `json:"veeva" yaml:"veeva"`
	// Specifies the information that is required for querying Zendesk.
	Zendesk interface{} `json:"zendesk" yaml:"zendesk"`
}

Specifies the information that is required to query a particular connector.

TODO: EXAMPLE

type CfnFlow_SourceFlowConfigProperty 

type CfnFlow_SourceFlowConfigProperty struct {
	// The type of source connector, such as Salesforce, Amplitude, and so on.
	//
	// *Allowed Values* : S3 | Amplitude | Datadog | Dynatrace | Googleanalytics | Infornexus | Salesforce | Servicenow | Singular | Slack | Trendmicro | Veeva | Zendesk
	ConnectorType *string `json:"connectorType" yaml:"connectorType"`
	// Specifies the information that is required to query a particular source connector.
	SourceConnectorProperties interface{} `json:"sourceConnectorProperties" yaml:"sourceConnectorProperties"`
	// The name of the connector profile.
	//
	// This name must be unique for each connector profile in the AWS account .
	ConnectorProfileName *string `json:"connectorProfileName" yaml:"connectorProfileName"`
	// Defines the configuration for a scheduled incremental data pull.
	//
	// If a valid configuration is provided, the fields specified in the configuration are used when querying for the incremental data pull.
	IncrementalPullConfig interface{} `json:"incrementalPullConfig" yaml:"incrementalPullConfig"`
}

Contains information about the configuration of the source connector used in the flow.

TODO: EXAMPLE

type CfnFlow_TaskPropertiesObjectProperty 

type CfnFlow_TaskPropertiesObjectProperty struct {
	// The task property key.
	//
	// *Allowed Values* : `VALUE | VALUES | DATA_TYPE | UPPER_BOUND | LOWER_BOUND | SOURCE_DATA_TYPE | DESTINATION_DATA_TYPE | VALIDATION_ACTION | MASK_VALUE | MASK_LENGTH | TRUNCATE_LENGTH | MATH_OPERATION_FIELDS_ORDER | CONCAT_FORMAT | SUBFIELD_CATEGORY_MAP` | `EXCLUDE_SOURCE_FIELDS_LIST`
	Key *string `json:"key" yaml:"key"`
	// The task property value.
	Value *string `json:"value" yaml:"value"`
}

A map used to store task-related information.

The execution service looks for particular information based on the `TaskType` .

TODO: EXAMPLE

type CfnFlow_TaskProperty 

type CfnFlow_TaskProperty struct {
	// The source fields to which a particular task is applied.
	SourceFields *[]*string `json:"sourceFields" yaml:"sourceFields"`
	// Specifies the particular task implementation that Amazon AppFlow performs.
	//
	// *Allowed values* : `Arithmetic` | `Filter` | `Map` | `Map_all` | `Mask` | `Merge` | `Truncate` | `Validate`
	TaskType *string `json:"taskType" yaml:"taskType"`
	// The operation to be performed on the provided source fields.
	ConnectorOperator interface{} `json:"connectorOperator" yaml:"connectorOperator"`
	// A field in a destination connector, or a field value against which Amazon AppFlow validates a source field.
	DestinationField *string `json:"destinationField" yaml:"destinationField"`
	// A map used to store task-related information.
	//
	// The execution service looks for particular information based on the `TaskType` .
	TaskProperties interface{} `json:"taskProperties" yaml:"taskProperties"`
}

The `Task` property type specifies the class for modeling different type of tasks.

Task implementation varies based on the `TaskType` .

TODO: EXAMPLE

type CfnFlow_TrendmicroSourcePropertiesProperty 

type CfnFlow_TrendmicroSourcePropertiesProperty struct {
	// The object specified in the Trend Micro flow source.
	Object *string `json:"object" yaml:"object"`
}

The properties that are applied when using Trend Micro as a flow source.

TODO: EXAMPLE

type CfnFlow_TriggerConfigProperty 

type CfnFlow_TriggerConfigProperty struct {
	// Specifies the type of flow trigger.
	//
	// This can be `OnDemand` , `Scheduled` , or `Event` .
	TriggerType *string `json:"triggerType" yaml:"triggerType"`
	// Specifies the configuration details of a schedule-triggered flow as defined by the user.
	//
	// Currently, these settings only apply to the `Scheduled` trigger type.
	TriggerProperties interface{} `json:"triggerProperties" yaml:"triggerProperties"`
}

The trigger settings that determine how and when Amazon AppFlow runs the specified flow.

TODO: EXAMPLE

type CfnFlow_UpsolverDestinationPropertiesProperty 

type CfnFlow_UpsolverDestinationPropertiesProperty struct {
	// The Upsolver Amazon S3 bucket name in which Amazon AppFlow places the transferred data.
	BucketName *string `json:"bucketName" yaml:"bucketName"`
	// The configuration that determines how data is formatted when Upsolver is used as the flow destination.
	S3OutputFormatConfig interface{} `json:"s3OutputFormatConfig" yaml:"s3OutputFormatConfig"`
	// The object key for the destination Upsolver Amazon S3 bucket in which Amazon AppFlow places the files.
	BucketPrefix *string `json:"bucketPrefix" yaml:"bucketPrefix"`
}

The properties that are applied when Upsolver is used as a destination.

TODO: EXAMPLE

type CfnFlow_UpsolverS3OutputFormatConfigProperty 

type CfnFlow_UpsolverS3OutputFormatConfigProperty struct {
	// Determines the prefix that Amazon AppFlow applies to the destination folder name.
	//
	// You can name your destination folders according to the flow frequency and date.
	PrefixConfig interface{} `json:"prefixConfig" yaml:"prefixConfig"`
	// The aggregation settings that you can use to customize the output format of your flow data.
	AggregationConfig interface{} `json:"aggregationConfig" yaml:"aggregationConfig"`
	// Indicates the file type that Amazon AppFlow places in the Upsolver Amazon S3 bucket.
	FileType *string `json:"fileType" yaml:"fileType"`
}

The configuration that determines how Amazon AppFlow formats the flow output data when Upsolver is used as the destination.

TODO: EXAMPLE

type CfnFlow_VeevaSourcePropertiesProperty 

type CfnFlow_VeevaSourcePropertiesProperty struct {
	// The object specified in the Veeva flow source.
	Object *string `json:"object" yaml:"object"`
	// `CfnFlow.VeevaSourcePropertiesProperty.DocumentType`.
	DocumentType *string `json:"documentType" yaml:"documentType"`
	// `CfnFlow.VeevaSourcePropertiesProperty.IncludeAllVersions`.
	IncludeAllVersions interface{} `json:"includeAllVersions" yaml:"includeAllVersions"`
	// `CfnFlow.VeevaSourcePropertiesProperty.IncludeRenditions`.
	IncludeRenditions interface{} `json:"includeRenditions" yaml:"includeRenditions"`
	// `CfnFlow.VeevaSourcePropertiesProperty.IncludeSourceFiles`.
	IncludeSourceFiles interface{} `json:"includeSourceFiles" yaml:"includeSourceFiles"`
}

The properties that are applied when using Veeva as a flow source.

TODO: EXAMPLE

type CfnFlow_ZendeskDestinationPropertiesProperty 

type CfnFlow_ZendeskDestinationPropertiesProperty struct {
	// `CfnFlow.ZendeskDestinationPropertiesProperty.Object`.
	Object *string `json:"object" yaml:"object"`
	// `CfnFlow.ZendeskDestinationPropertiesProperty.ErrorHandlingConfig`.
	ErrorHandlingConfig interface{} `json:"errorHandlingConfig" yaml:"errorHandlingConfig"`
	// `CfnFlow.ZendeskDestinationPropertiesProperty.IdFieldNames`.
	IdFieldNames *[]*string `json:"idFieldNames" yaml:"idFieldNames"`
	// `CfnFlow.ZendeskDestinationPropertiesProperty.WriteOperationType`.
	WriteOperationType *string `json:"writeOperationType" yaml:"writeOperationType"`
}

TODO: EXAMPLE

type CfnFlow_ZendeskSourcePropertiesProperty 

type CfnFlow_ZendeskSourcePropertiesProperty struct {
	// The object specified in the Zendesk flow source.
	Object *string `json:"object" yaml:"object"`
}

The properties that are applied when using Zendesk as a flow source.

TODO: EXAMPLE

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.