You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Appflow::Types::CreateConnectorProfileRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Appflow::Types::CreateConnectorProfileRequest
- Defined in:
- (unknown)
Overview
When passing CreateConnectorProfileRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
connector_profile_name: "ConnectorProfileName", # required
kms_arn: "KMSArn",
connector_type: "Salesforce", # required, accepts Salesforce, Singular, Slack, Redshift, S3, Marketo, Googleanalytics, Zendesk, Servicenow, Datadog, Trendmicro, Snowflake, Dynatrace, Infornexus, Amplitude, Veeva, EventBridge
connection_mode: "Public", # required, accepts Public, Private
connector_profile_config: { # required
connector_profile_properties: { # required
amplitude: {
},
datadog: {
instance_url: "InstanceUrl", # required
},
dynatrace: {
instance_url: "InstanceUrl", # required
},
google_analytics: {
},
infor_nexus: {
instance_url: "InstanceUrl", # required
},
marketo: {
instance_url: "InstanceUrl", # required
},
redshift: {
database_url: "DatabaseUrl", # required
bucket_name: "BucketName", # required
bucket_prefix: "BucketPrefix",
role_arn: "RoleArn", # required
},
salesforce: {
instance_url: "InstanceUrl",
is_sandbox_environment: false,
},
service_now: {
instance_url: "InstanceUrl", # required
},
singular: {
},
slack: {
instance_url: "InstanceUrl", # required
},
snowflake: {
warehouse: "Warehouse", # required
stage: "Stage", # required
bucket_name: "BucketName", # required
bucket_prefix: "BucketPrefix",
private_link_service_name: "PrivateLinkServiceName",
account_name: "AccountName",
region: "Region",
},
trendmicro: {
},
veeva: {
instance_url: "InstanceUrl", # required
},
zendesk: {
instance_url: "InstanceUrl", # required
},
},
connector_profile_credentials: { # required
amplitude: {
api_key: "ApiKey", # required
secret_key: "SecretKey", # required
},
datadog: {
api_key: "ApiKey", # required
application_key: "ApplicationKey", # required
},
dynatrace: {
api_token: "ApiToken", # required
},
google_analytics: {
client_id: "ClientId", # required
client_secret: "ClientSecret", # required
access_token: "AccessToken",
refresh_token: "RefreshToken",
o_auth_request: {
auth_code: "AuthCode",
redirect_uri: "RedirectUri",
},
},
infor_nexus: {
access_key_id: "AccessKeyId", # required
user_id: "Username", # required
secret_access_key: "Key", # required
datakey: "Key", # required
},
marketo: {
client_id: "ClientId", # required
client_secret: "ClientSecret", # required
access_token: "AccessToken",
o_auth_request: {
auth_code: "AuthCode",
redirect_uri: "RedirectUri",
},
},
redshift: {
username: "Username", # required
password: "Password", # required
},
salesforce: {
access_token: "AccessToken",
refresh_token: "RefreshToken",
o_auth_request: {
auth_code: "AuthCode",
redirect_uri: "RedirectUri",
},
client_credentials_arn: "ClientCredentialsArn",
},
service_now: {
username: "Username", # required
password: "Password", # required
},
singular: {
api_key: "ApiKey", # required
},
slack: {
client_id: "ClientId", # required
client_secret: "ClientSecret", # required
access_token: "AccessToken",
o_auth_request: {
auth_code: "AuthCode",
redirect_uri: "RedirectUri",
},
},
snowflake: {
username: "Username", # required
password: "Password", # required
},
trendmicro: {
api_secret_key: "ApiSecretKey", # required
},
veeva: {
username: "Username", # required
password: "Password", # required
},
zendesk: {
client_id: "ClientId", # required
client_secret: "ClientSecret", # required
access_token: "AccessToken",
o_auth_request: {
auth_code: "AuthCode",
redirect_uri: "RedirectUri",
},
},
},
},
}
Instance Attribute Summary collapse
-
#connection_mode ⇒ String
Indicates the connection mode and specifies whether it is public or private.
-
#connector_profile_config ⇒ Types::ConnectorProfileConfig
Defines the connector-specific configuration and credentials.
-
#connector_profile_name ⇒ String
The name of the connector profile.
-
#connector_type ⇒ String
The type of connector, such as Salesforce, Amplitude, and so on.
-
#kms_arn ⇒ String
The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.
Instance Attribute Details
#connection_mode ⇒ String
Indicates the connection mode and specifies whether it is public or private. Private flows use AWS PrivateLink to route data over AWS infrastructure without exposing it to the public internet.
Possible values:
- Public
- Private
#connector_profile_config ⇒ Types::ConnectorProfileConfig
Defines the connector-specific configuration and credentials.
#connector_profile_name ⇒ String
The name of the connector profile. The name is unique for each
ConnectorProfile
in your AWS account.
#connector_type ⇒ String
The type of connector, such as Salesforce, Amplitude, and so on.
Possible values:
- Salesforce
- Singular
- Slack
- Redshift
- S3
- Marketo
- Googleanalytics
- Zendesk
- Servicenow
- Datadog
- Trendmicro
- Snowflake
- Dynatrace
- Infornexus
- Amplitude
- Veeva
- EventBridge
#kms_arn ⇒ String
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.