CfnConnectorProfile¶
-
class
aws_cdk.aws_appflow.
CfnConnectorProfile
(scope, id, *, connection_mode, connector_profile_name, connector_type, connector_profile_config=None, kms_arn=None)¶ Bases:
aws_cdk.core.CfnResource
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 theProperties
field. The rest of the connector-specific properties are specified underProperties/ConnectorProfileConfig
. .. epigraph: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.
- CloudformationResource
AWS::AppFlow::ConnectorProfile
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appflow as appflow # basic_auth_credentials: Any # o_auth_credentials: Any cfn_connector_profile = appflow.CfnConnectorProfile(self, "MyCfnConnectorProfile", connection_mode="connectionMode", connector_profile_name="connectorProfileName", connector_type="connectorType", # the properties below are optional connector_profile_config=appflow.CfnConnectorProfile.ConnectorProfileConfigProperty( connector_profile_credentials=appflow.CfnConnectorProfile.ConnectorProfileCredentialsProperty( amplitude=appflow.CfnConnectorProfile.AmplitudeConnectorProfileCredentialsProperty( api_key="apiKey", secret_key="secretKey" ), datadog=appflow.CfnConnectorProfile.DatadogConnectorProfileCredentialsProperty( api_key="apiKey", application_key="applicationKey" ), dynatrace=appflow.CfnConnectorProfile.DynatraceConnectorProfileCredentialsProperty( api_token="apiToken" ), google_analytics=appflow.CfnConnectorProfile.GoogleAnalyticsConnectorProfileCredentialsProperty( client_id="clientId", client_secret="clientSecret", # the properties below are optional access_token="accessToken", connector_oAuth_request=appflow.CfnConnectorProfile.ConnectorOAuthRequestProperty( auth_code="authCode", redirect_uri="redirectUri" ), refresh_token="refreshToken" ), infor_nexus=appflow.CfnConnectorProfile.InforNexusConnectorProfileCredentialsProperty( access_key_id="accessKeyId", datakey="datakey", secret_access_key="secretAccessKey", user_id="userId" ), marketo=appflow.CfnConnectorProfile.MarketoConnectorProfileCredentialsProperty( client_id="clientId", client_secret="clientSecret", # the properties below are optional access_token="accessToken", connector_oAuth_request=appflow.CfnConnectorProfile.ConnectorOAuthRequestProperty( auth_code="authCode", redirect_uri="redirectUri" ) ), redshift=appflow.CfnConnectorProfile.RedshiftConnectorProfileCredentialsProperty( password="password", username="username" ), salesforce=appflow.CfnConnectorProfile.SalesforceConnectorProfileCredentialsProperty( access_token="accessToken", client_credentials_arn="clientCredentialsArn", connector_oAuth_request=appflow.CfnConnectorProfile.ConnectorOAuthRequestProperty( auth_code="authCode", redirect_uri="redirectUri" ), refresh_token="refreshToken" ), sapo_data=appflow.CfnConnectorProfile.SAPODataConnectorProfileCredentialsProperty( basic_auth_credentials=basic_auth_credentials, o_auth_credentials=o_auth_credentials ), service_now=appflow.CfnConnectorProfile.ServiceNowConnectorProfileCredentialsProperty( password="password", username="username" ), singular=appflow.CfnConnectorProfile.SingularConnectorProfileCredentialsProperty( api_key="apiKey" ), slack=appflow.CfnConnectorProfile.SlackConnectorProfileCredentialsProperty( client_id="clientId", client_secret="clientSecret", # the properties below are optional access_token="accessToken", connector_oAuth_request=appflow.CfnConnectorProfile.ConnectorOAuthRequestProperty( auth_code="authCode", redirect_uri="redirectUri" ) ), snowflake=appflow.CfnConnectorProfile.SnowflakeConnectorProfileCredentialsProperty( password="password", username="username" ), trendmicro=appflow.CfnConnectorProfile.TrendmicroConnectorProfileCredentialsProperty( api_secret_key="apiSecretKey" ), veeva=appflow.CfnConnectorProfile.VeevaConnectorProfileCredentialsProperty( password="password", username="username" ), zendesk=appflow.CfnConnectorProfile.ZendeskConnectorProfileCredentialsProperty( client_id="clientId", client_secret="clientSecret", # the properties below are optional access_token="accessToken", connector_oAuth_request=appflow.CfnConnectorProfile.ConnectorOAuthRequestProperty( auth_code="authCode", redirect_uri="redirectUri" ) ) ), # the properties below are optional connector_profile_properties=appflow.CfnConnectorProfile.ConnectorProfilePropertiesProperty( datadog=appflow.CfnConnectorProfile.DatadogConnectorProfilePropertiesProperty( instance_url="instanceUrl" ), dynatrace=appflow.CfnConnectorProfile.DynatraceConnectorProfilePropertiesProperty( instance_url="instanceUrl" ), infor_nexus=appflow.CfnConnectorProfile.InforNexusConnectorProfilePropertiesProperty( instance_url="instanceUrl" ), marketo=appflow.CfnConnectorProfile.MarketoConnectorProfilePropertiesProperty( instance_url="instanceUrl" ), redshift=appflow.CfnConnectorProfile.RedshiftConnectorProfilePropertiesProperty( bucket_name="bucketName", database_url="databaseUrl", role_arn="roleArn", # the properties below are optional bucket_prefix="bucketPrefix" ), salesforce=appflow.CfnConnectorProfile.SalesforceConnectorProfilePropertiesProperty( instance_url="instanceUrl", is_sandbox_environment=False ), sapo_data=appflow.CfnConnectorProfile.SAPODataConnectorProfilePropertiesProperty( application_host_url="applicationHostUrl", application_service_path="applicationServicePath", client_number="clientNumber", logon_language="logonLanguage", o_auth_properties=appflow.CfnConnectorProfile.OAuthPropertiesProperty( auth_code_url="authCodeUrl", o_auth_scopes=["oAuthScopes"], token_url="tokenUrl" ), port_number=123, private_link_service_name="privateLinkServiceName" ), service_now=appflow.CfnConnectorProfile.ServiceNowConnectorProfilePropertiesProperty( instance_url="instanceUrl" ), slack=appflow.CfnConnectorProfile.SlackConnectorProfilePropertiesProperty( instance_url="instanceUrl" ), snowflake=appflow.CfnConnectorProfile.SnowflakeConnectorProfilePropertiesProperty( bucket_name="bucketName", stage="stage", warehouse="warehouse", # the properties below are optional account_name="accountName", bucket_prefix="bucketPrefix", private_link_service_name="privateLinkServiceName", region="region" ), veeva=appflow.CfnConnectorProfile.VeevaConnectorProfilePropertiesProperty( instance_url="instanceUrl" ), zendesk=appflow.CfnConnectorProfile.ZendeskConnectorProfilePropertiesProperty( instance_url="instanceUrl" ) ) ), kms_arn="kmsArn" )
Create a new
AWS::AppFlow::ConnectorProfile
.- Parameters
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
connection_mode (
str
) – Indicates the connection mode and if it is public or private.connector_profile_name (
str
) – The name of the connector profile. The name is unique for eachConnectorProfile
in the AWS account .connector_type (
str
) – The type of connector, such as Salesforce, Amplitude, and so on.connector_profile_config (
Union
[ConnectorProfileConfigProperty
,IResolvable
,None
]) – Defines the connector-specific configuration and credentials.kms_arn (
Optional
[str
]) – 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.
Methods
-
add_deletion_override
(path)¶ Syntactic sugar for
addOverride(path, undefined)
.- Parameters
path (
str
) – The path of the value to delete.- Return type
None
-
add_depends_on
(target)¶ Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters
target (
CfnResource
) –- Return type
None
-
add_metadata
(key, value)¶ Add a value to the CloudFormation Resource Metadata.
- Parameters
key (
str
) –value (
Any
) –
- See
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- Return type
None
-
add_override
(path, value)¶ Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
with “Properties.” (i.e.Properties.TopicName
).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.
in the property name, prefix with a\
. In most programming languages you will need to write this as"\\."
because the\
itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type
None
-
add_property_deletion_override
(property_path)¶ Adds an override that deletes the value of a property from the resource definition.
- Parameters
property_path (
str
) – The path to the property.- Return type
None
-
add_property_override
(property_path, value)¶ Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type
None
-
apply_removal_policy
(policy=None, *, apply_to_update_replace_policy=None, default=None)¶ Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
).- Parameters
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.
- Return type
None
-
get_att
(attribute_name)¶ Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn
), but this can be used for future compatibility in case there is no generated attribute.- Parameters
attribute_name (
str
) – The name of the attribute.- Return type
-
get_metadata
(key)¶ Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters
key (
str
) –- See
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- Return type
Any
-
inspect
(inspector)¶ Examines the CloudFormation resource and discloses attributes.
- Parameters
inspector (
TreeInspector
) –tree inspector to collect and process attributes.
- Return type
None
-
override_logical_id
(new_logical_id)¶ Overrides the auto-generated logical ID with a specific ID.
- Parameters
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type
None
-
to_string
()¶ Returns a string representation of this construct.
- Return type
str
- Returns
a string representation of this resource
Attributes
-
CFN_RESOURCE_TYPE_NAME
= 'AWS::AppFlow::ConnectorProfile'¶
-
attr_connector_profile_arn
¶ The Amazon Resource Name (ARN) of the connector profile.
- CloudformationAttribute
ConnectorProfileArn
- Return type
str
-
attr_credentials_arn
¶ The Amazon Resource Name (ARN) of the connector profile credentials.
- CloudformationAttribute
CredentialsArn
- Return type
str
-
cfn_options
¶ Options for this resource, such as condition, update policy etc.
- Return type
-
cfn_resource_type
¶ AWS resource type.
- Return type
str
-
connection_mode
¶ Indicates the connection mode and if it is public or private.
-
connector_profile_config
¶ Defines the connector-specific configuration and credentials.
-
connector_profile_name
¶ The name of the connector profile.
The name is unique for each
ConnectorProfile
in the AWS account .
-
connector_type
¶ The type of connector, such as Salesforce, Amplitude, and so on.
-
creation_stack
¶ return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- Return type
List
[str
]
-
kms_arn
¶ 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.
-
logical_id
¶ The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId)
.- Return type
str
- Returns
the logical ID as a stringified token. This value will only get resolved during synthesis.
-
node
¶ The construct tree node associated with this construct.
- Return type
-
ref
¶ Return a string that will be resolved to a CloudFormation
{ Ref }
for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref })
.- Return type
str
-
stack
¶ The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- Return type
Static Methods
-
classmethod
is_cfn_element
(x)¶ 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.- Parameters
x (
Any
) –- Return type
bool
- Returns
The construct as a stack element or undefined if it is not a stack element.
-
classmethod
is_cfn_resource
(construct)¶ Check whether the given construct is a CfnResource.
- Parameters
construct (
IConstruct
) –- Return type
bool
-
classmethod
is_construct
(x)¶ Return whether the given object is a Construct.
- Parameters
x (
Any
) –- Return type
bool
AmplitudeConnectorProfileCredentialsProperty¶
-
class
CfnConnectorProfile.
AmplitudeConnectorProfileCredentialsProperty
(*, api_key, secret_key)¶ Bases:
object
The connector-specific credentials required when using Amplitude.
- Parameters
api_key (
str
) – A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.secret_key (
str
) – The Secret Access Key portion of the credentials.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appflow as appflow amplitude_connector_profile_credentials_property = appflow.CfnConnectorProfile.AmplitudeConnectorProfileCredentialsProperty( api_key="apiKey", secret_key="secretKey" )
Attributes
-
api_key
¶ A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.
-
secret_key
¶ The Secret Access Key portion of the credentials.
ConnectorOAuthRequestProperty¶
-
class
CfnConnectorProfile.
ConnectorOAuthRequestProperty
(*, auth_code=None, redirect_uri=None)¶ Bases:
object
Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.
- Parameters
auth_code (
Optional
[str
]) – The code provided by the connector when it has been authenticated via the connected app.redirect_uri (
Optional
[str
]) – The URL to which the authentication server redirects the browser after authorization has been granted.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appflow as appflow connector_oAuth_request_property = appflow.CfnConnectorProfile.ConnectorOAuthRequestProperty( auth_code="authCode", redirect_uri="redirectUri" )
Attributes
-
auth_code
¶ The code provided by the connector when it has been authenticated via the connected app.
-
redirect_uri
¶ The URL to which the authentication server redirects the browser after authorization has been granted.
ConnectorProfileConfigProperty¶
-
class
CfnConnectorProfile.
ConnectorProfileConfigProperty
(*, connector_profile_credentials, connector_profile_properties=None)¶ Bases:
object
Defines the connector-specific configuration and credentials for the connector profile.
- Parameters
connector_profile_credentials (
Union
[IResolvable
,ConnectorProfileCredentialsProperty
]) – The connector-specific credentials required by each connector.connector_profile_properties (
Union
[IResolvable
,ConnectorProfilePropertiesProperty
,None
]) – The connector-specific properties of the profile configuration.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appflow as appflow # basic_auth_credentials: Any # o_auth_credentials: Any connector_profile_config_property = appflow.CfnConnectorProfile.ConnectorProfileConfigProperty( connector_profile_credentials=appflow.CfnConnectorProfile.ConnectorProfileCredentialsProperty( amplitude=appflow.CfnConnectorProfile.AmplitudeConnectorProfileCredentialsProperty( api_key="apiKey", secret_key="secretKey" ), datadog=appflow.CfnConnectorProfile.DatadogConnectorProfileCredentialsProperty( api_key="apiKey", application_key="applicationKey" ), dynatrace=appflow.CfnConnectorProfile.DynatraceConnectorProfileCredentialsProperty( api_token="apiToken" ), google_analytics=appflow.CfnConnectorProfile.GoogleAnalyticsConnectorProfileCredentialsProperty( client_id="clientId", client_secret="clientSecret", # the properties below are optional access_token="accessToken", connector_oAuth_request=appflow.CfnConnectorProfile.ConnectorOAuthRequestProperty( auth_code="authCode", redirect_uri="redirectUri" ), refresh_token="refreshToken" ), infor_nexus=appflow.CfnConnectorProfile.InforNexusConnectorProfileCredentialsProperty( access_key_id="accessKeyId", datakey="datakey", secret_access_key="secretAccessKey", user_id="userId" ), marketo=appflow.CfnConnectorProfile.MarketoConnectorProfileCredentialsProperty( client_id="clientId", client_secret="clientSecret", # the properties below are optional access_token="accessToken", connector_oAuth_request=appflow.CfnConnectorProfile.ConnectorOAuthRequestProperty( auth_code="authCode", redirect_uri="redirectUri" ) ), redshift=appflow.CfnConnectorProfile.RedshiftConnectorProfileCredentialsProperty( password="password", username="username" ), salesforce=appflow.CfnConnectorProfile.SalesforceConnectorProfileCredentialsProperty( access_token="accessToken", client_credentials_arn="clientCredentialsArn", connector_oAuth_request=appflow.CfnConnectorProfile.ConnectorOAuthRequestProperty( auth_code="authCode", redirect_uri="redirectUri" ), refresh_token="refreshToken" ), sapo_data=appflow.CfnConnectorProfile.SAPODataConnectorProfileCredentialsProperty( basic_auth_credentials=basic_auth_credentials, o_auth_credentials=o_auth_credentials ), service_now=appflow.CfnConnectorProfile.ServiceNowConnectorProfileCredentialsProperty( password="password", username="username" ), singular=appflow.CfnConnectorProfile.SingularConnectorProfileCredentialsProperty( api_key="apiKey" ), slack=appflow.CfnConnectorProfile.SlackConnectorProfileCredentialsProperty( client_id="clientId", client_secret="clientSecret", # the properties below are optional access_token="accessToken", connector_oAuth_request=appflow.CfnConnectorProfile.ConnectorOAuthRequestProperty( auth_code="authCode", redirect_uri="redirectUri" ) ), snowflake=appflow.CfnConnectorProfile.SnowflakeConnectorProfileCredentialsProperty( password="password", username="username" ), trendmicro=appflow.CfnConnectorProfile.TrendmicroConnectorProfileCredentialsProperty( api_secret_key="apiSecretKey" ), veeva=appflow.CfnConnectorProfile.VeevaConnectorProfileCredentialsProperty( password="password", username="username" ), zendesk=appflow.CfnConnectorProfile.ZendeskConnectorProfileCredentialsProperty( client_id="clientId", client_secret="clientSecret", # the properties below are optional access_token="accessToken", connector_oAuth_request=appflow.CfnConnectorProfile.ConnectorOAuthRequestProperty( auth_code="authCode", redirect_uri="redirectUri" ) ) ), # the properties below are optional connector_profile_properties=appflow.CfnConnectorProfile.ConnectorProfilePropertiesProperty( datadog=appflow.CfnConnectorProfile.DatadogConnectorProfilePropertiesProperty( instance_url="instanceUrl" ), dynatrace=appflow.CfnConnectorProfile.DynatraceConnectorProfilePropertiesProperty( instance_url="instanceUrl" ), infor_nexus=appflow.CfnConnectorProfile.InforNexusConnectorProfilePropertiesProperty( instance_url="instanceUrl" ), marketo=appflow.CfnConnectorProfile.MarketoConnectorProfilePropertiesProperty( instance_url="instanceUrl" ), redshift=appflow.CfnConnectorProfile.RedshiftConnectorProfilePropertiesProperty( bucket_name="bucketName", database_url="databaseUrl", role_arn="roleArn", # the properties below are optional bucket_prefix="bucketPrefix" ), salesforce=appflow.CfnConnectorProfile.SalesforceConnectorProfilePropertiesProperty( instance_url="instanceUrl", is_sandbox_environment=False ), sapo_data=appflow.CfnConnectorProfile.SAPODataConnectorProfilePropertiesProperty( application_host_url="applicationHostUrl", application_service_path="applicationServicePath", client_number="clientNumber", logon_language="logonLanguage", o_auth_properties=appflow.CfnConnectorProfile.OAuthPropertiesProperty( auth_code_url="authCodeUrl", o_auth_scopes=["oAuthScopes"], token_url="tokenUrl" ), port_number=123, private_link_service_name="privateLinkServiceName" ), service_now=appflow.CfnConnectorProfile.ServiceNowConnectorProfilePropertiesProperty( instance_url="instanceUrl" ), slack=appflow.CfnConnectorProfile.SlackConnectorProfilePropertiesProperty( instance_url="instanceUrl" ), snowflake=appflow.CfnConnectorProfile.SnowflakeConnectorProfilePropertiesProperty( bucket_name="bucketName", stage="stage", warehouse="warehouse", # the properties below are optional account_name="accountName", bucket_prefix="bucketPrefix", private_link_service_name="privateLinkServiceName", region="region" ), veeva=appflow.CfnConnectorProfile.VeevaConnectorProfilePropertiesProperty( instance_url="instanceUrl" ), zendesk=appflow.CfnConnectorProfile.ZendeskConnectorProfilePropertiesProperty( instance_url="instanceUrl" ) ) )
Attributes
-
connector_profile_credentials
¶ The connector-specific credentials required by each connector.
-
connector_profile_properties
¶ The connector-specific properties of the profile configuration.
ConnectorProfileCredentialsProperty¶
-
class
CfnConnectorProfile.
ConnectorProfileCredentialsProperty
(*, amplitude=None, datadog=None, dynatrace=None, google_analytics=None, infor_nexus=None, marketo=None, redshift=None, salesforce=None, sapo_data=None, service_now=None, singular=None, slack=None, snowflake=None, trendmicro=None, veeva=None, zendesk=None)¶ Bases:
object
The connector-specific credentials required by a connector.
- Parameters
amplitude (
Union
[IResolvable
,AmplitudeConnectorProfileCredentialsProperty
,None
]) – The connector-specific credentials required when using Amplitude.datadog (
Union
[IResolvable
,DatadogConnectorProfileCredentialsProperty
,None
]) – The connector-specific credentials required when using Datadog.dynatrace (
Union
[IResolvable
,DynatraceConnectorProfileCredentialsProperty
,None
]) – The connector-specific credentials required when using Dynatrace.google_analytics (
Union
[IResolvable
,GoogleAnalyticsConnectorProfileCredentialsProperty
,None
]) – The connector-specific credentials required when using Google Analytics.infor_nexus (
Union
[IResolvable
,InforNexusConnectorProfileCredentialsProperty
,None
]) – The connector-specific credentials required when using Infor Nexus.marketo (
Union
[IResolvable
,MarketoConnectorProfileCredentialsProperty
,None
]) – The connector-specific credentials required when using Marketo.redshift (
Union
[IResolvable
,RedshiftConnectorProfileCredentialsProperty
,None
]) – The connector-specific credentials required when using Amazon Redshift.salesforce (
Union
[IResolvable
,SalesforceConnectorProfileCredentialsProperty
,None
]) – The connector-specific credentials required when using Salesforce.sapo_data (
Union
[IResolvable
,SAPODataConnectorProfileCredentialsProperty
,None
]) – The connector-specific profile credentials required when using SAPOData.service_now (
Union
[IResolvable
,ServiceNowConnectorProfileCredentialsProperty
,None
]) – The connector-specific credentials required when using ServiceNow.singular (
Union
[IResolvable
,SingularConnectorProfileCredentialsProperty
,None
]) – The connector-specific credentials required when using Singular.slack (
Union
[IResolvable
,SlackConnectorProfileCredentialsProperty
,None
]) – The connector-specific credentials required when using Slack.snowflake (
Union
[IResolvable
,SnowflakeConnectorProfileCredentialsProperty
,None
]) – The connector-specific credentials required when using Snowflake.trendmicro (
Union
[IResolvable
,TrendmicroConnectorProfileCredentialsProperty
,None
]) – The connector-specific credentials required when using Trend Micro.veeva (
Union
[IResolvable
,VeevaConnectorProfileCredentialsProperty
,None
]) – The connector-specific credentials required when using Veeva.zendesk (
Union
[IResolvable
,ZendeskConnectorProfileCredentialsProperty
,None
]) – The connector-specific credentials required when using Zendesk.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appflow as appflow # basic_auth_credentials: Any # o_auth_credentials: Any connector_profile_credentials_property = appflow.CfnConnectorProfile.ConnectorProfileCredentialsProperty( amplitude=appflow.CfnConnectorProfile.AmplitudeConnectorProfileCredentialsProperty( api_key="apiKey", secret_key="secretKey" ), datadog=appflow.CfnConnectorProfile.DatadogConnectorProfileCredentialsProperty( api_key="apiKey", application_key="applicationKey" ), dynatrace=appflow.CfnConnectorProfile.DynatraceConnectorProfileCredentialsProperty( api_token="apiToken" ), google_analytics=appflow.CfnConnectorProfile.GoogleAnalyticsConnectorProfileCredentialsProperty( client_id="clientId", client_secret="clientSecret", # the properties below are optional access_token="accessToken", connector_oAuth_request=appflow.CfnConnectorProfile.ConnectorOAuthRequestProperty( auth_code="authCode", redirect_uri="redirectUri" ), refresh_token="refreshToken" ), infor_nexus=appflow.CfnConnectorProfile.InforNexusConnectorProfileCredentialsProperty( access_key_id="accessKeyId", datakey="datakey", secret_access_key="secretAccessKey", user_id="userId" ), marketo=appflow.CfnConnectorProfile.MarketoConnectorProfileCredentialsProperty( client_id="clientId", client_secret="clientSecret", # the properties below are optional access_token="accessToken", connector_oAuth_request=appflow.CfnConnectorProfile.ConnectorOAuthRequestProperty( auth_code="authCode", redirect_uri="redirectUri" ) ), redshift=appflow.CfnConnectorProfile.RedshiftConnectorProfileCredentialsProperty( password="password", username="username" ), salesforce=appflow.CfnConnectorProfile.SalesforceConnectorProfileCredentialsProperty( access_token="accessToken", client_credentials_arn="clientCredentialsArn", connector_oAuth_request=appflow.CfnConnectorProfile.ConnectorOAuthRequestProperty( auth_code="authCode", redirect_uri="redirectUri" ), refresh_token="refreshToken" ), sapo_data=appflow.CfnConnectorProfile.SAPODataConnectorProfileCredentialsProperty( basic_auth_credentials=basic_auth_credentials, o_auth_credentials=o_auth_credentials ), service_now=appflow.CfnConnectorProfile.ServiceNowConnectorProfileCredentialsProperty( password="password", username="username" ), singular=appflow.CfnConnectorProfile.SingularConnectorProfileCredentialsProperty( api_key="apiKey" ), slack=appflow.CfnConnectorProfile.SlackConnectorProfileCredentialsProperty( client_id="clientId", client_secret="clientSecret", # the properties below are optional access_token="accessToken", connector_oAuth_request=appflow.CfnConnectorProfile.ConnectorOAuthRequestProperty( auth_code="authCode", redirect_uri="redirectUri" ) ), snowflake=appflow.CfnConnectorProfile.SnowflakeConnectorProfileCredentialsProperty( password="password", username="username" ), trendmicro=appflow.CfnConnectorProfile.TrendmicroConnectorProfileCredentialsProperty( api_secret_key="apiSecretKey" ), veeva=appflow.CfnConnectorProfile.VeevaConnectorProfileCredentialsProperty( password="password", username="username" ), zendesk=appflow.CfnConnectorProfile.ZendeskConnectorProfileCredentialsProperty( client_id="clientId", client_secret="clientSecret", # the properties below are optional access_token="accessToken", connector_oAuth_request=appflow.CfnConnectorProfile.ConnectorOAuthRequestProperty( auth_code="authCode", redirect_uri="redirectUri" ) ) )
Attributes
-
amplitude
¶ The connector-specific credentials required when using Amplitude.
-
datadog
¶ The connector-specific credentials required when using Datadog.
-
dynatrace
¶ The connector-specific credentials required when using Dynatrace.
-
google_analytics
¶ The connector-specific credentials required when using Google Analytics.
- Link
- Return type
Union
[IResolvable
,GoogleAnalyticsConnectorProfileCredentialsProperty
,None
]
-
infor_nexus
¶ The connector-specific credentials required when using Infor Nexus.
-
marketo
¶ The connector-specific credentials required when using Marketo.
-
redshift
¶ The connector-specific credentials required when using Amazon Redshift.
-
salesforce
¶ The connector-specific credentials required when using Salesforce.
-
sapo_data
¶ The connector-specific profile credentials required when using SAPOData.
-
service_now
¶ The connector-specific credentials required when using ServiceNow.
-
singular
¶ The connector-specific credentials required when using Singular.
-
slack
¶ The connector-specific credentials required when using Slack.
-
snowflake
¶ The connector-specific credentials required when using Snowflake.
-
trendmicro
¶ The connector-specific credentials required when using Trend Micro.
-
veeva
¶ The connector-specific credentials required when using Veeva.
-
zendesk
¶ The connector-specific credentials required when using Zendesk.
ConnectorProfilePropertiesProperty¶
-
class
CfnConnectorProfile.
ConnectorProfilePropertiesProperty
(*, datadog=None, dynatrace=None, infor_nexus=None, marketo=None, redshift=None, salesforce=None, sapo_data=None, service_now=None, slack=None, snowflake=None, veeva=None, zendesk=None)¶ Bases:
object
The connector-specific profile properties required by each connector.
- Parameters
datadog (
Union
[IResolvable
,DatadogConnectorProfilePropertiesProperty
,None
]) – The connector-specific properties required by Datadog.dynatrace (
Union
[IResolvable
,DynatraceConnectorProfilePropertiesProperty
,None
]) – The connector-specific properties required by Dynatrace.infor_nexus (
Union
[IResolvable
,InforNexusConnectorProfilePropertiesProperty
,None
]) – The connector-specific properties required by Infor Nexus.marketo (
Union
[IResolvable
,MarketoConnectorProfilePropertiesProperty
,None
]) – The connector-specific properties required by Marketo.redshift (
Union
[IResolvable
,RedshiftConnectorProfilePropertiesProperty
,None
]) – The connector-specific properties required by Amazon Redshift.salesforce (
Union
[IResolvable
,SalesforceConnectorProfilePropertiesProperty
,None
]) – The connector-specific properties required by Salesforce.sapo_data (
Union
[IResolvable
,SAPODataConnectorProfilePropertiesProperty
,None
]) – The connector-specific profile properties required when using SAPOData.service_now (
Union
[IResolvable
,ServiceNowConnectorProfilePropertiesProperty
,None
]) – The connector-specific properties required by serviceNow.slack (
Union
[IResolvable
,SlackConnectorProfilePropertiesProperty
,None
]) – The connector-specific properties required by Slack.snowflake (
Union
[IResolvable
,SnowflakeConnectorProfilePropertiesProperty
,None
]) – The connector-specific properties required by Snowflake.veeva (
Union
[IResolvable
,VeevaConnectorProfilePropertiesProperty
,None
]) – The connector-specific properties required by Veeva.zendesk (
Union
[IResolvable
,ZendeskConnectorProfilePropertiesProperty
,None
]) – The connector-specific properties required by Zendesk.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appflow as appflow connector_profile_properties_property = appflow.CfnConnectorProfile.ConnectorProfilePropertiesProperty( datadog=appflow.CfnConnectorProfile.DatadogConnectorProfilePropertiesProperty( instance_url="instanceUrl" ), dynatrace=appflow.CfnConnectorProfile.DynatraceConnectorProfilePropertiesProperty( instance_url="instanceUrl" ), infor_nexus=appflow.CfnConnectorProfile.InforNexusConnectorProfilePropertiesProperty( instance_url="instanceUrl" ), marketo=appflow.CfnConnectorProfile.MarketoConnectorProfilePropertiesProperty( instance_url="instanceUrl" ), redshift=appflow.CfnConnectorProfile.RedshiftConnectorProfilePropertiesProperty( bucket_name="bucketName", database_url="databaseUrl", role_arn="roleArn", # the properties below are optional bucket_prefix="bucketPrefix" ), salesforce=appflow.CfnConnectorProfile.SalesforceConnectorProfilePropertiesProperty( instance_url="instanceUrl", is_sandbox_environment=False ), sapo_data=appflow.CfnConnectorProfile.SAPODataConnectorProfilePropertiesProperty( application_host_url="applicationHostUrl", application_service_path="applicationServicePath", client_number="clientNumber", logon_language="logonLanguage", o_auth_properties=appflow.CfnConnectorProfile.OAuthPropertiesProperty( auth_code_url="authCodeUrl", o_auth_scopes=["oAuthScopes"], token_url="tokenUrl" ), port_number=123, private_link_service_name="privateLinkServiceName" ), service_now=appflow.CfnConnectorProfile.ServiceNowConnectorProfilePropertiesProperty( instance_url="instanceUrl" ), slack=appflow.CfnConnectorProfile.SlackConnectorProfilePropertiesProperty( instance_url="instanceUrl" ), snowflake=appflow.CfnConnectorProfile.SnowflakeConnectorProfilePropertiesProperty( bucket_name="bucketName", stage="stage", warehouse="warehouse", # the properties below are optional account_name="accountName", bucket_prefix="bucketPrefix", private_link_service_name="privateLinkServiceName", region="region" ), veeva=appflow.CfnConnectorProfile.VeevaConnectorProfilePropertiesProperty( instance_url="instanceUrl" ), zendesk=appflow.CfnConnectorProfile.ZendeskConnectorProfilePropertiesProperty( instance_url="instanceUrl" ) )
Attributes
-
datadog
¶ The connector-specific properties required by Datadog.
-
dynatrace
¶ The connector-specific properties required by Dynatrace.
-
infor_nexus
¶ The connector-specific properties required by Infor Nexus.
-
marketo
¶ The connector-specific properties required by Marketo.
-
redshift
¶ The connector-specific properties required by Amazon Redshift.
-
salesforce
¶ The connector-specific properties required by Salesforce.
-
sapo_data
¶ The connector-specific profile properties required when using SAPOData.
-
service_now
¶ The connector-specific properties required by serviceNow.
-
slack
¶ The connector-specific properties required by Slack.
-
snowflake
¶ The connector-specific properties required by Snowflake.
-
veeva
¶ The connector-specific properties required by Veeva.
-
zendesk
¶ The connector-specific properties required by Zendesk.
DatadogConnectorProfileCredentialsProperty¶
-
class
CfnConnectorProfile.
DatadogConnectorProfileCredentialsProperty
(*, api_key, application_key)¶ Bases:
object
The connector-specific credentials required by Datadog.
- Parameters
api_key (
str
) – A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.application_key (
str
) – 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.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appflow as appflow datadog_connector_profile_credentials_property = appflow.CfnConnectorProfile.DatadogConnectorProfileCredentialsProperty( api_key="apiKey", application_key="applicationKey" )
Attributes
-
api_key
¶ A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.
-
application_key
¶ 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.
DatadogConnectorProfilePropertiesProperty¶
-
class
CfnConnectorProfile.
DatadogConnectorProfilePropertiesProperty
(*, instance_url)¶ Bases:
object
The connector-specific profile properties required by Datadog.
- Parameters
instance_url (
str
) – The location of the Datadog resource.- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appflow as appflow datadog_connector_profile_properties_property = appflow.CfnConnectorProfile.DatadogConnectorProfilePropertiesProperty( instance_url="instanceUrl" )
Attributes
-
instance_url
¶ The location of the Datadog resource.
DynatraceConnectorProfileCredentialsProperty¶
-
class
CfnConnectorProfile.
DynatraceConnectorProfileCredentialsProperty
(*, api_token)¶ Bases:
object
The connector-specific profile credentials required by Dynatrace.
- Parameters
api_token (
str
) – The API tokens used by Dynatrace API to authenticate various API calls.- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appflow as appflow dynatrace_connector_profile_credentials_property = appflow.CfnConnectorProfile.DynatraceConnectorProfileCredentialsProperty( api_token="apiToken" )
Attributes
-
api_token
¶ The API tokens used by Dynatrace API to authenticate various API calls.
DynatraceConnectorProfilePropertiesProperty¶
-
class
CfnConnectorProfile.
DynatraceConnectorProfilePropertiesProperty
(*, instance_url)¶ Bases:
object
The connector-specific profile properties required by Dynatrace.
- Parameters
instance_url (
str
) – The location of the Dynatrace resource.- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appflow as appflow dynatrace_connector_profile_properties_property = appflow.CfnConnectorProfile.DynatraceConnectorProfilePropertiesProperty( instance_url="instanceUrl" )
Attributes
-
instance_url
¶ The location of the Dynatrace resource.
GoogleAnalyticsConnectorProfileCredentialsProperty¶
-
class
CfnConnectorProfile.
GoogleAnalyticsConnectorProfileCredentialsProperty
(*, client_id, client_secret, access_token=None, connector_o_auth_request=None, refresh_token=None)¶ Bases:
object
The connector-specific profile credentials required by Google Analytics.
- Parameters
client_id (
str
) – The identifier for the desired client.client_secret (
str
) – The client secret used by the OAuth client to authenticate to the authorization server.access_token (
Optional
[str
]) – The credentials used to access protected Google Analytics resources.connector_o_auth_request (
Union
[IResolvable
,ConnectorOAuthRequestProperty
,None
]) – Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.refresh_token (
Optional
[str
]) – The credentials used to acquire new access tokens. This is required only for OAuth2 access tokens, and is not required for OAuth1 access tokens.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appflow as appflow google_analytics_connector_profile_credentials_property = appflow.CfnConnectorProfile.GoogleAnalyticsConnectorProfileCredentialsProperty( client_id="clientId", client_secret="clientSecret", # the properties below are optional access_token="accessToken", connector_oAuth_request=appflow.CfnConnectorProfile.ConnectorOAuthRequestProperty( auth_code="authCode", redirect_uri="redirectUri" ), refresh_token="refreshToken" )
Attributes
-
access_token
¶ The credentials used to access protected Google Analytics resources.
-
client_id
¶ The identifier for the desired client.
-
client_secret
¶ The client secret used by the OAuth client to authenticate to the authorization server.
-
connector_o_auth_request
¶ Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.
- Link
- Return type
Union
[IResolvable
,ConnectorOAuthRequestProperty
,None
]
-
refresh_token
¶ The credentials used to acquire new access tokens.
This is required only for OAuth2 access tokens, and is not required for OAuth1 access tokens.
InforNexusConnectorProfileCredentialsProperty¶
-
class
CfnConnectorProfile.
InforNexusConnectorProfileCredentialsProperty
(*, access_key_id, datakey, secret_access_key, user_id)¶ Bases:
object
The connector-specific profile credentials required by Infor Nexus.
- Parameters
access_key_id (
str
) – The Access Key portion of the credentials.datakey (
str
) – The encryption keys used to encrypt data.secret_access_key (
str
) – The secret key used to sign requests.user_id (
str
) – The identifier for the user.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appflow as appflow infor_nexus_connector_profile_credentials_property = appflow.CfnConnectorProfile.InforNexusConnectorProfileCredentialsProperty( access_key_id="accessKeyId", datakey="datakey", secret_access_key="secretAccessKey", user_id="userId" )
Attributes
-
access_key_id
¶ The Access Key portion of the credentials.
-
datakey
¶ The encryption keys used to encrypt data.
-
secret_access_key
¶ The secret key used to sign requests.
-
user_id
¶ The identifier for the user.
InforNexusConnectorProfilePropertiesProperty¶
-
class
CfnConnectorProfile.
InforNexusConnectorProfilePropertiesProperty
(*, instance_url)¶ Bases:
object
The connector-specific profile properties required by Infor Nexus.
- Parameters
instance_url (
str
) – The location of the Infor Nexus resource.- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appflow as appflow infor_nexus_connector_profile_properties_property = appflow.CfnConnectorProfile.InforNexusConnectorProfilePropertiesProperty( instance_url="instanceUrl" )
Attributes
-
instance_url
¶ The location of the Infor Nexus resource.
MarketoConnectorProfileCredentialsProperty¶
-
class
CfnConnectorProfile.
MarketoConnectorProfileCredentialsProperty
(*, client_id, client_secret, access_token=None, connector_o_auth_request=None)¶ Bases:
object
The connector-specific profile credentials required by Marketo.
- Parameters
client_id (
str
) – The identifier for the desired client.client_secret (
str
) – The client secret used by the OAuth client to authenticate to the authorization server.access_token (
Optional
[str
]) – The credentials used to access protected Marketo resources.connector_o_auth_request (
Union
[IResolvable
,ConnectorOAuthRequestProperty
,None
]) – Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appflow as appflow marketo_connector_profile_credentials_property = appflow.CfnConnectorProfile.MarketoConnectorProfileCredentialsProperty( client_id="clientId", client_secret="clientSecret", # the properties below are optional access_token="accessToken", connector_oAuth_request=appflow.CfnConnectorProfile.ConnectorOAuthRequestProperty( auth_code="authCode", redirect_uri="redirectUri" ) )
Attributes
-
access_token
¶ The credentials used to access protected Marketo resources.
-
client_id
¶ The identifier for the desired client.
-
client_secret
¶ The client secret used by the OAuth client to authenticate to the authorization server.
-
connector_o_auth_request
¶ Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.
- Link
- Return type
Union
[IResolvable
,ConnectorOAuthRequestProperty
,None
]
MarketoConnectorProfilePropertiesProperty¶
-
class
CfnConnectorProfile.
MarketoConnectorProfilePropertiesProperty
(*, instance_url)¶ Bases:
object
The connector-specific profile properties required when using Marketo.
- Parameters
instance_url (
str
) – The location of the Marketo resource.- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appflow as appflow marketo_connector_profile_properties_property = appflow.CfnConnectorProfile.MarketoConnectorProfilePropertiesProperty( instance_url="instanceUrl" )
Attributes
-
instance_url
¶ The location of the Marketo resource.
OAuthPropertiesProperty¶
-
class
CfnConnectorProfile.
OAuthPropertiesProperty
(*, auth_code_url=None, o_auth_scopes=None, token_url=None)¶ Bases:
object
The OAuth properties required for OAuth type authentication.
- Parameters
auth_code_url (
Optional
[str
]) – The authorization code url required to redirect to SAP Login Page to fetch authorization code for OAuth type authentication.o_auth_scopes (
Optional
[Sequence
[str
]]) – The OAuth scopes required for OAuth type authentication.token_url (
Optional
[str
]) – The token url required to fetch access/refresh tokens using authorization code and also to refresh expired access token using refresh token.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appflow as appflow o_auth_properties_property = appflow.CfnConnectorProfile.OAuthPropertiesProperty( auth_code_url="authCodeUrl", o_auth_scopes=["oAuthScopes"], token_url="tokenUrl" )
Attributes
-
auth_code_url
¶ The authorization code url required to redirect to SAP Login Page to fetch authorization code for OAuth type authentication.
-
o_auth_scopes
¶ The OAuth scopes required for OAuth type authentication.
-
token_url
¶ The token url required to fetch access/refresh tokens using authorization code and also to refresh expired access token using refresh token.
RedshiftConnectorProfileCredentialsProperty¶
-
class
CfnConnectorProfile.
RedshiftConnectorProfileCredentialsProperty
(*, password, username)¶ Bases:
object
The connector-specific profile credentials required when using Amazon Redshift.
- Parameters
password (
str
) – The password that corresponds to the user name.username (
str
) – The name of the user.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appflow as appflow redshift_connector_profile_credentials_property = appflow.CfnConnectorProfile.RedshiftConnectorProfileCredentialsProperty( password="password", username="username" )
Attributes
-
password
¶ The password that corresponds to the user name.
RedshiftConnectorProfilePropertiesProperty¶
-
class
CfnConnectorProfile.
RedshiftConnectorProfilePropertiesProperty
(*, bucket_name, database_url, role_arn, bucket_prefix=None)¶ Bases:
object
The connector-specific profile properties when using Amazon Redshift.
- Parameters
bucket_name (
str
) – A name for the associated Amazon S3 bucket.database_url (
str
) – The JDBC URL of the Amazon Redshift cluster.role_arn (
str
) – The Amazon Resource Name (ARN) of the IAM role.bucket_prefix (
Optional
[str
]) – The object key for the destination bucket in which Amazon AppFlow places the files.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appflow as appflow redshift_connector_profile_properties_property = appflow.CfnConnectorProfile.RedshiftConnectorProfilePropertiesProperty( bucket_name="bucketName", database_url="databaseUrl", role_arn="roleArn", # the properties below are optional bucket_prefix="bucketPrefix" )
Attributes
-
bucket_name
¶ A name for the associated Amazon S3 bucket.
-
bucket_prefix
¶ The object key for the destination bucket in which Amazon AppFlow places the files.
-
database_url
¶ The JDBC URL of the Amazon Redshift cluster.
-
role_arn
¶ The Amazon Resource Name (ARN) of the IAM role.
SAPODataConnectorProfileCredentialsProperty¶
-
class
CfnConnectorProfile.
SAPODataConnectorProfileCredentialsProperty
(*, basic_auth_credentials=None, o_auth_credentials=None)¶ Bases:
object
The connector-specific profile credentials required when using SAPOData.
- Parameters
basic_auth_credentials (
Optional
[Any
]) – The SAPOData basic authentication credentials.o_auth_credentials (
Optional
[Any
]) – The SAPOData OAuth type authentication credentials.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appflow as appflow # basic_auth_credentials: Any # o_auth_credentials: Any s_aPOData_connector_profile_credentials_property = appflow.CfnConnectorProfile.SAPODataConnectorProfileCredentialsProperty( basic_auth_credentials=basic_auth_credentials, o_auth_credentials=o_auth_credentials )
Attributes
-
basic_auth_credentials
¶ The SAPOData basic authentication credentials.
-
o_auth_credentials
¶ The SAPOData OAuth type authentication credentials.
SAPODataConnectorProfilePropertiesProperty¶
-
class
CfnConnectorProfile.
SAPODataConnectorProfilePropertiesProperty
(*, application_host_url=None, application_service_path=None, client_number=None, logon_language=None, o_auth_properties=None, port_number=None, private_link_service_name=None)¶ Bases:
object
The connector-specific profile properties required when using SAPOData.
- Parameters
application_host_url (
Optional
[str
]) – The location of the SAPOData resource.application_service_path (
Optional
[str
]) – The application path to catalog service.client_number (
Optional
[str
]) – The client number for the client creating the connection.logon_language (
Optional
[str
]) – The logon language of SAPOData instance.o_auth_properties (
Union
[IResolvable
,OAuthPropertiesProperty
,None
]) – The SAPOData OAuth properties required for OAuth type authentication.port_number (
Union
[int
,float
,None
]) – The port number of the SAPOData instance.private_link_service_name (
Optional
[str
]) – The SAPOData Private Link service name to be used for private data transfers.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appflow as appflow s_aPOData_connector_profile_properties_property = appflow.CfnConnectorProfile.SAPODataConnectorProfilePropertiesProperty( application_host_url="applicationHostUrl", application_service_path="applicationServicePath", client_number="clientNumber", logon_language="logonLanguage", o_auth_properties=appflow.CfnConnectorProfile.OAuthPropertiesProperty( auth_code_url="authCodeUrl", o_auth_scopes=["oAuthScopes"], token_url="tokenUrl" ), port_number=123, private_link_service_name="privateLinkServiceName" )
Attributes
-
application_host_url
¶ The location of the SAPOData resource.
-
application_service_path
¶ The application path to catalog service.
-
client_number
¶ The client number for the client creating the connection.
-
logon_language
¶ The logon language of SAPOData instance.
-
o_auth_properties
¶ The SAPOData OAuth properties required for OAuth type authentication.
-
port_number
¶ The port number of the SAPOData instance.
-
private_link_service_name
¶ The SAPOData Private Link service name to be used for private data transfers.
SalesforceConnectorProfileCredentialsProperty¶
-
class
CfnConnectorProfile.
SalesforceConnectorProfileCredentialsProperty
(*, access_token=None, client_credentials_arn=None, connector_o_auth_request=None, refresh_token=None)¶ Bases:
object
The connector-specific profile credentials required when using Salesforce.
- Parameters
access_token (
Optional
[str
]) – The credentials used to access protected Salesforce resources.client_credentials_arn (
Optional
[str
]) – The secret manager ARN, which contains the client ID and client secret of the connected app.connector_o_auth_request (
Union
[IResolvable
,ConnectorOAuthRequestProperty
,None
]) – Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.refresh_token (
Optional
[str
]) – The credentials used to acquire new access tokens.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appflow as appflow salesforce_connector_profile_credentials_property = appflow.CfnConnectorProfile.SalesforceConnectorProfileCredentialsProperty( access_token="accessToken", client_credentials_arn="clientCredentialsArn", connector_oAuth_request=appflow.CfnConnectorProfile.ConnectorOAuthRequestProperty( auth_code="authCode", redirect_uri="redirectUri" ), refresh_token="refreshToken" )
Attributes
-
access_token
¶ The credentials used to access protected Salesforce resources.
-
client_credentials_arn
¶ The secret manager ARN, which contains the client ID and client secret of the connected app.
-
connector_o_auth_request
¶ Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.
- Link
- Return type
Union
[IResolvable
,ConnectorOAuthRequestProperty
,None
]
-
refresh_token
¶ The credentials used to acquire new access tokens.
SalesforceConnectorProfilePropertiesProperty¶
-
class
CfnConnectorProfile.
SalesforceConnectorProfilePropertiesProperty
(*, instance_url=None, is_sandbox_environment=None)¶ Bases:
object
The connector-specific profile properties required when using Salesforce.
- Parameters
instance_url (
Optional
[str
]) – The location of the Salesforce resource.is_sandbox_environment (
Union
[bool
,IResolvable
,None
]) – Indicates whether the connector profile applies to a sandbox or production environment.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appflow as appflow salesforce_connector_profile_properties_property = appflow.CfnConnectorProfile.SalesforceConnectorProfilePropertiesProperty( instance_url="instanceUrl", is_sandbox_environment=False )
Attributes
-
instance_url
¶ The location of the Salesforce resource.
-
is_sandbox_environment
¶ Indicates whether the connector profile applies to a sandbox or production environment.
ServiceNowConnectorProfileCredentialsProperty¶
-
class
CfnConnectorProfile.
ServiceNowConnectorProfileCredentialsProperty
(*, password, username)¶ Bases:
object
The connector-specific profile credentials required when using ServiceNow.
- Parameters
password (
str
) – The password that corresponds to the user name.username (
str
) – The name of the user.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appflow as appflow service_now_connector_profile_credentials_property = appflow.CfnConnectorProfile.ServiceNowConnectorProfileCredentialsProperty( password="password", username="username" )
Attributes
-
password
¶ The password that corresponds to the user name.
ServiceNowConnectorProfilePropertiesProperty¶
-
class
CfnConnectorProfile.
ServiceNowConnectorProfilePropertiesProperty
(*, instance_url)¶ Bases:
object
The connector-specific profile properties required when using ServiceNow.
- Parameters
instance_url (
str
) – The location of the ServiceNow resource.- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appflow as appflow service_now_connector_profile_properties_property = appflow.CfnConnectorProfile.ServiceNowConnectorProfilePropertiesProperty( instance_url="instanceUrl" )
Attributes
-
instance_url
¶ The location of the ServiceNow resource.
SingularConnectorProfileCredentialsProperty¶
-
class
CfnConnectorProfile.
SingularConnectorProfileCredentialsProperty
(*, api_key)¶ Bases:
object
The connector-specific profile credentials required when using Singular.
- Parameters
api_key (
str
) – A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appflow as appflow singular_connector_profile_credentials_property = appflow.CfnConnectorProfile.SingularConnectorProfileCredentialsProperty( api_key="apiKey" )
Attributes
-
api_key
¶ A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.
SlackConnectorProfileCredentialsProperty¶
-
class
CfnConnectorProfile.
SlackConnectorProfileCredentialsProperty
(*, client_id, client_secret, access_token=None, connector_o_auth_request=None)¶ Bases:
object
The connector-specific profile credentials required when using Slack.
- Parameters
client_id (
str
) – The identifier for the client.client_secret (
str
) – The client secret used by the OAuth client to authenticate to the authorization server.access_token (
Optional
[str
]) – The credentials used to access protected Slack resources.connector_o_auth_request (
Union
[IResolvable
,ConnectorOAuthRequestProperty
,None
]) – Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appflow as appflow slack_connector_profile_credentials_property = appflow.CfnConnectorProfile.SlackConnectorProfileCredentialsProperty( client_id="clientId", client_secret="clientSecret", # the properties below are optional access_token="accessToken", connector_oAuth_request=appflow.CfnConnectorProfile.ConnectorOAuthRequestProperty( auth_code="authCode", redirect_uri="redirectUri" ) )
Attributes
-
access_token
¶ The credentials used to access protected Slack resources.
-
client_id
¶ The identifier for the client.
-
client_secret
¶ The client secret used by the OAuth client to authenticate to the authorization server.
-
connector_o_auth_request
¶ Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.
SlackConnectorProfilePropertiesProperty¶
-
class
CfnConnectorProfile.
SlackConnectorProfilePropertiesProperty
(*, instance_url)¶ Bases:
object
The connector-specific profile properties required when using Slack.
- Parameters
instance_url (
str
) – The location of the Slack resource.- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appflow as appflow slack_connector_profile_properties_property = appflow.CfnConnectorProfile.SlackConnectorProfilePropertiesProperty( instance_url="instanceUrl" )
Attributes
-
instance_url
¶ The location of the Slack resource.
SnowflakeConnectorProfileCredentialsProperty¶
-
class
CfnConnectorProfile.
SnowflakeConnectorProfileCredentialsProperty
(*, password, username)¶ Bases:
object
The connector-specific profile credentials required when using Snowflake.
- Parameters
password (
str
) – The password that corresponds to the user name.username (
str
) – The name of the user.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appflow as appflow snowflake_connector_profile_credentials_property = appflow.CfnConnectorProfile.SnowflakeConnectorProfileCredentialsProperty( password="password", username="username" )
Attributes
-
password
¶ The password that corresponds to the user name.
SnowflakeConnectorProfilePropertiesProperty¶
-
class
CfnConnectorProfile.
SnowflakeConnectorProfilePropertiesProperty
(*, bucket_name, stage, warehouse, account_name=None, bucket_prefix=None, private_link_service_name=None, region=None)¶ Bases:
object
The connector-specific profile properties required when using Snowflake.
- Parameters
bucket_name (
str
) – The name of the Amazon S3 bucket associated with Snowflake.stage (
str
) – 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>.warehouse (
str
) – The name of the Snowflake warehouse.account_name (
Optional
[str
]) – The name of the account.bucket_prefix (
Optional
[str
]) – The bucket path that refers to the Amazon S3 bucket associated with Snowflake.private_link_service_name (
Optional
[str
]) – The Snowflake Private Link service name to be used for private data transfers.region (
Optional
[str
]) – The AWS Region of the Snowflake account.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appflow as appflow snowflake_connector_profile_properties_property = appflow.CfnConnectorProfile.SnowflakeConnectorProfilePropertiesProperty( bucket_name="bucketName", stage="stage", warehouse="warehouse", # the properties below are optional account_name="accountName", bucket_prefix="bucketPrefix", private_link_service_name="privateLinkServiceName", region="region" )
Attributes
-
account_name
¶ The name of the account.
-
bucket_name
¶ The name of the Amazon S3 bucket associated with Snowflake.
-
bucket_prefix
¶ The bucket path that refers to the Amazon S3 bucket associated with Snowflake.
-
private_link_service_name
¶ The Snowflake Private Link service name to be used for private data transfers.
-
region
¶ The AWS Region of the Snowflake account.
-
stage
¶ 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>.
-
warehouse
¶ The name of the Snowflake warehouse.
TrendmicroConnectorProfileCredentialsProperty¶
-
class
CfnConnectorProfile.
TrendmicroConnectorProfileCredentialsProperty
(*, api_secret_key)¶ Bases:
object
The connector-specific profile credentials required when using Trend Micro.
- Parameters
api_secret_key (
str
) – The Secret Access Key portion of the credentials.- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appflow as appflow trendmicro_connector_profile_credentials_property = appflow.CfnConnectorProfile.TrendmicroConnectorProfileCredentialsProperty( api_secret_key="apiSecretKey" )
Attributes
-
api_secret_key
¶ The Secret Access Key portion of the credentials.
VeevaConnectorProfileCredentialsProperty¶
-
class
CfnConnectorProfile.
VeevaConnectorProfileCredentialsProperty
(*, password, username)¶ Bases:
object
The connector-specific profile credentials required when using Veeva.
- Parameters
password (
str
) – The password that corresponds to the user name.username (
str
) – The name of the user.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appflow as appflow veeva_connector_profile_credentials_property = appflow.CfnConnectorProfile.VeevaConnectorProfileCredentialsProperty( password="password", username="username" )
Attributes
-
password
¶ The password that corresponds to the user name.
VeevaConnectorProfilePropertiesProperty¶
-
class
CfnConnectorProfile.
VeevaConnectorProfilePropertiesProperty
(*, instance_url)¶ Bases:
object
The connector-specific profile properties required when using Veeva.
- Parameters
instance_url (
str
) – The location of the Veeva resource.- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appflow as appflow veeva_connector_profile_properties_property = appflow.CfnConnectorProfile.VeevaConnectorProfilePropertiesProperty( instance_url="instanceUrl" )
Attributes
-
instance_url
¶ The location of the Veeva resource.
ZendeskConnectorProfileCredentialsProperty¶
-
class
CfnConnectorProfile.
ZendeskConnectorProfileCredentialsProperty
(*, client_id, client_secret, access_token=None, connector_o_auth_request=None)¶ Bases:
object
The connector-specific profile credentials required when using Zendesk.
- Parameters
client_id (
str
) – The identifier for the desired client.client_secret (
str
) – The client secret used by the OAuth client to authenticate to the authorization server.access_token (
Optional
[str
]) – The credentials used to access protected Zendesk resources.connector_o_auth_request (
Union
[IResolvable
,ConnectorOAuthRequestProperty
,None
]) – Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appflow as appflow zendesk_connector_profile_credentials_property = appflow.CfnConnectorProfile.ZendeskConnectorProfileCredentialsProperty( client_id="clientId", client_secret="clientSecret", # the properties below are optional access_token="accessToken", connector_oAuth_request=appflow.CfnConnectorProfile.ConnectorOAuthRequestProperty( auth_code="authCode", redirect_uri="redirectUri" ) )
Attributes
-
access_token
¶ The credentials used to access protected Zendesk resources.
-
client_id
¶ The identifier for the desired client.
-
client_secret
¶ The client secret used by the OAuth client to authenticate to the authorization server.
-
connector_o_auth_request
¶ Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.
- Link
- Return type
Union
[IResolvable
,ConnectorOAuthRequestProperty
,None
]
ZendeskConnectorProfilePropertiesProperty¶
-
class
CfnConnectorProfile.
ZendeskConnectorProfilePropertiesProperty
(*, instance_url)¶ Bases:
object
The connector-specific profile properties required when using Zendesk.
- Parameters
instance_url (
str
) – The location of the Zendesk resource.- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appflow as appflow zendesk_connector_profile_properties_property = appflow.CfnConnectorProfile.ZendeskConnectorProfilePropertiesProperty( instance_url="instanceUrl" )
Attributes
-
instance_url
¶ The location of the Zendesk resource.