software.amazon.awscdk.services.appflow

Class CfnConnectorProfile

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.appflow.CfnConnectorProfile

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:04.883Z")
 @Stability(value=Stable)
public class CfnConnectorProfile
extends CfnResource
implements IInspectable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.appflow.*;
 Object basicAuthCredentials;
 Object oAuthCredentials;
 CfnConnectorProfile cfnConnectorProfile = CfnConnectorProfile.Builder.create(this, "MyCfnConnectorProfile")
         .connectionMode("connectionMode")
         .connectorProfileName("connectorProfileName")
         .connectorType("connectorType")
         // the properties below are optional
         .connectorProfileConfig(ConnectorProfileConfigProperty.builder()
                 .connectorProfileCredentials(ConnectorProfileCredentialsProperty.builder()
                         .amplitude(AmplitudeConnectorProfileCredentialsProperty.builder()
                                 .apiKey("apiKey")
                                 .secretKey("secretKey")
                                 .build())
                         .datadog(DatadogConnectorProfileCredentialsProperty.builder()
                                 .apiKey("apiKey")
                                 .applicationKey("applicationKey")
                                 .build())
                         .dynatrace(DynatraceConnectorProfileCredentialsProperty.builder()
                                 .apiToken("apiToken")
                                 .build())
                         .googleAnalytics(GoogleAnalyticsConnectorProfileCredentialsProperty.builder()
                                 .clientId("clientId")
                                 .clientSecret("clientSecret")
                                 // the properties below are optional
                                 .accessToken("accessToken")
                                 .connectorOAuthRequest(ConnectorOAuthRequestProperty.builder()
                                         .authCode("authCode")
                                         .redirectUri("redirectUri")
                                         .build())
                                 .refreshToken("refreshToken")
                                 .build())
                         .inforNexus(InforNexusConnectorProfileCredentialsProperty.builder()
                                 .accessKeyId("accessKeyId")
                                 .datakey("datakey")
                                 .secretAccessKey("secretAccessKey")
                                 .userId("userId")
                                 .build())
                         .marketo(MarketoConnectorProfileCredentialsProperty.builder()
                                 .clientId("clientId")
                                 .clientSecret("clientSecret")
                                 // the properties below are optional
                                 .accessToken("accessToken")
                                 .connectorOAuthRequest(ConnectorOAuthRequestProperty.builder()
                                         .authCode("authCode")
                                         .redirectUri("redirectUri")
                                         .build())
                                 .build())
                         .redshift(RedshiftConnectorProfileCredentialsProperty.builder()
                                 .password("password")
                                 .username("username")
                                 .build())
                         .salesforce(SalesforceConnectorProfileCredentialsProperty.builder()
                                 .accessToken("accessToken")
                                 .clientCredentialsArn("clientCredentialsArn")
                                 .connectorOAuthRequest(ConnectorOAuthRequestProperty.builder()
                                         .authCode("authCode")
                                         .redirectUri("redirectUri")
                                         .build())
                                 .refreshToken("refreshToken")
                                 .build())
                         .sapoData(SAPODataConnectorProfileCredentialsProperty.builder()
                                 .basicAuthCredentials(basicAuthCredentials)
                                 .oAuthCredentials(oAuthCredentials)
                                 .build())
                         .serviceNow(ServiceNowConnectorProfileCredentialsProperty.builder()
                                 .password("password")
                                 .username("username")
                                 .build())
                         .singular(SingularConnectorProfileCredentialsProperty.builder()
                                 .apiKey("apiKey")
                                 .build())
                         .slack(SlackConnectorProfileCredentialsProperty.builder()
                                 .clientId("clientId")
                                 .clientSecret("clientSecret")
                                 // the properties below are optional
                                 .accessToken("accessToken")
                                 .connectorOAuthRequest(ConnectorOAuthRequestProperty.builder()
                                         .authCode("authCode")
                                         .redirectUri("redirectUri")
                                         .build())
                                 .build())
                         .snowflake(SnowflakeConnectorProfileCredentialsProperty.builder()
                                 .password("password")
                                 .username("username")
                                 .build())
                         .trendmicro(TrendmicroConnectorProfileCredentialsProperty.builder()
                                 .apiSecretKey("apiSecretKey")
                                 .build())
                         .veeva(VeevaConnectorProfileCredentialsProperty.builder()
                                 .password("password")
                                 .username("username")
                                 .build())
                         .zendesk(ZendeskConnectorProfileCredentialsProperty.builder()
                                 .clientId("clientId")
                                 .clientSecret("clientSecret")
                                 // the properties below are optional
                                 .accessToken("accessToken")
                                 .connectorOAuthRequest(ConnectorOAuthRequestProperty.builder()
                                         .authCode("authCode")
                                         .redirectUri("redirectUri")
                                         .build())
                                 .build())
                         .build())
                 // the properties below are optional
                 .connectorProfileProperties(ConnectorProfilePropertiesProperty.builder()
                         .datadog(DatadogConnectorProfilePropertiesProperty.builder()
                                 .instanceUrl("instanceUrl")
                                 .build())
                         .dynatrace(DynatraceConnectorProfilePropertiesProperty.builder()
                                 .instanceUrl("instanceUrl")
                                 .build())
                         .inforNexus(InforNexusConnectorProfilePropertiesProperty.builder()
                                 .instanceUrl("instanceUrl")
                                 .build())
                         .marketo(MarketoConnectorProfilePropertiesProperty.builder()
                                 .instanceUrl("instanceUrl")
                                 .build())
                         .redshift(RedshiftConnectorProfilePropertiesProperty.builder()
                                 .bucketName("bucketName")
                                 .databaseUrl("databaseUrl")
                                 .roleArn("roleArn")
                                 // the properties below are optional
                                 .bucketPrefix("bucketPrefix")
                                 .build())
                         .salesforce(SalesforceConnectorProfilePropertiesProperty.builder()
                                 .instanceUrl("instanceUrl")
                                 .isSandboxEnvironment(false)
                                 .build())
                         .sapoData(SAPODataConnectorProfilePropertiesProperty.builder()
                                 .applicationHostUrl("applicationHostUrl")
                                 .applicationServicePath("applicationServicePath")
                                 .clientNumber("clientNumber")
                                 .logonLanguage("logonLanguage")
                                 .oAuthProperties(OAuthPropertiesProperty.builder()
                                         .authCodeUrl("authCodeUrl")
                                         .oAuthScopes(List.of("oAuthScopes"))
                                         .tokenUrl("tokenUrl")
                                         .build())
                                 .portNumber(123)
                                 .privateLinkServiceName("privateLinkServiceName")
                                 .build())
                         .serviceNow(ServiceNowConnectorProfilePropertiesProperty.builder()
                                 .instanceUrl("instanceUrl")
                                 .build())
                         .slack(SlackConnectorProfilePropertiesProperty.builder()
                                 .instanceUrl("instanceUrl")
                                 .build())
                         .snowflake(SnowflakeConnectorProfilePropertiesProperty.builder()
                                 .bucketName("bucketName")
                                 .stage("stage")
                                 .warehouse("warehouse")
                                 // the properties below are optional
                                 .accountName("accountName")
                                 .bucketPrefix("bucketPrefix")
                                 .privateLinkServiceName("privateLinkServiceName")
                                 .region("region")
                                 .build())
                         .veeva(VeevaConnectorProfilePropertiesProperty.builder()
                                 .instanceUrl("instanceUrl")
                                 .build())
                         .zendesk(ZendeskConnectorProfilePropertiesProperty.builder()
                                 .instanceUrl("instanceUrl")
                                 .build())
                         .build())
                 .build())
         .kmsArn("kmsArn")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnConnectorProfile.AmplitudeConnectorProfileCredentialsProperty Example:
static class	CfnConnectorProfile.Builder A fluent builder for CfnConnectorProfile.
static interface	CfnConnectorProfile.ConnectorOAuthRequestProperty Example:
static interface	CfnConnectorProfile.ConnectorProfileConfigProperty Example:
static interface	CfnConnectorProfile.ConnectorProfileCredentialsProperty Example:
static interface	CfnConnectorProfile.ConnectorProfilePropertiesProperty Example:
static interface	CfnConnectorProfile.DatadogConnectorProfileCredentialsProperty Example:
static interface	CfnConnectorProfile.DatadogConnectorProfilePropertiesProperty Example:
static interface	CfnConnectorProfile.DynatraceConnectorProfileCredentialsProperty Example:
static interface	CfnConnectorProfile.DynatraceConnectorProfilePropertiesProperty Example:
static interface	CfnConnectorProfile.GoogleAnalyticsConnectorProfileCredentialsProperty Example:
static interface	CfnConnectorProfile.InforNexusConnectorProfileCredentialsProperty Example:
static interface	CfnConnectorProfile.InforNexusConnectorProfilePropertiesProperty Example:
static interface	CfnConnectorProfile.MarketoConnectorProfileCredentialsProperty Example:
static interface	CfnConnectorProfile.MarketoConnectorProfilePropertiesProperty Example:
static interface	CfnConnectorProfile.OAuthPropertiesProperty Example:
static interface	CfnConnectorProfile.RedshiftConnectorProfileCredentialsProperty Example:
static interface	CfnConnectorProfile.RedshiftConnectorProfilePropertiesProperty Example:
static interface	CfnConnectorProfile.SalesforceConnectorProfileCredentialsProperty Example:
static interface	CfnConnectorProfile.SalesforceConnectorProfilePropertiesProperty Example:
static interface	CfnConnectorProfile.SAPODataConnectorProfileCredentialsProperty Example:
static interface	CfnConnectorProfile.SAPODataConnectorProfilePropertiesProperty Example:
static interface	CfnConnectorProfile.ServiceNowConnectorProfileCredentialsProperty Example:
static interface	CfnConnectorProfile.ServiceNowConnectorProfilePropertiesProperty Example:
static interface	CfnConnectorProfile.SingularConnectorProfileCredentialsProperty Example:
static interface	CfnConnectorProfile.SlackConnectorProfileCredentialsProperty Example:
static interface	CfnConnectorProfile.SlackConnectorProfilePropertiesProperty Example:
static interface	CfnConnectorProfile.SnowflakeConnectorProfileCredentialsProperty Example:
static interface	CfnConnectorProfile.SnowflakeConnectorProfilePropertiesProperty Example:
static interface	CfnConnectorProfile.TrendmicroConnectorProfileCredentialsProperty Example:
static interface	CfnConnectorProfile.VeevaConnectorProfileCredentialsProperty Example:
static interface	CfnConnectorProfile.VeevaConnectorProfilePropertiesProperty Example:
static interface	CfnConnectorProfile.ZendeskConnectorProfileCredentialsProperty Example:
static interface	CfnConnectorProfile.ZendeskConnectorProfilePropertiesProperty Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnConnectorProfile(software.constructs.Construct scope, String id, CfnConnectorProfileProps props) Create a new `AWS::AppFlow::ConnectorProfile`.
protected	CfnConnectorProfile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnConnectorProfile(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrConnectorProfileArn()
String	getAttrCredentialsArn()
protected Map<String,Object>	getCfnProperties()
String	getConnectionMode() `AWS::AppFlow::ConnectorProfile.ConnectionMode`.
Object	getConnectorProfileConfig() `AWS::AppFlow::ConnectorProfile.ConnectorProfileConfig`.
String	getConnectorProfileName() `AWS::AppFlow::ConnectorProfile.ConnectorProfileName`.
String	getConnectorType() `AWS::AppFlow::ConnectorProfile.ConnectorType`.
String	getKmsArn() `AWS::AppFlow::ConnectorProfile.KMSArn`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setConnectionMode(String value) `AWS::AppFlow::ConnectorProfile.ConnectionMode`.
void	setConnectorProfileConfig(CfnConnectorProfile.ConnectorProfileConfigProperty value) `AWS::AppFlow::ConnectorProfile.ConnectorProfileConfig`.
void	setConnectorProfileConfig(IResolvable value) `AWS::AppFlow::ConnectorProfile.ConnectorProfileConfig`.
void	setConnectorProfileName(String value) `AWS::AppFlow::ConnectorProfile.ConnectorProfileName`.
void	setConnectorType(String value) `AWS::AppFlow::ConnectorProfile.ConnectorType`.
void	setKmsArn(String value) `AWS::AppFlow::ConnectorProfile.KMSArn`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnConnectorProfile

protected CfnConnectorProfile(software.amazon.jsii.JsiiObjectRef objRef)

CfnConnectorProfile

protected CfnConnectorProfile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnConnectorProfile

@Stability(value=Stable)
public CfnConnectorProfile(@NotNull
                                                    software.constructs.Construct scope,
                                                    @NotNull
                                                    String id,
                                                    @NotNull
                                                    CfnConnectorProfileProps props)

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

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrConnectorProfileArn

@Stability(value=Stable)
 @NotNull
public String getAttrConnectorProfileArn()

getAttrCredentialsArn

@Stability(value=Stable)
 @NotNull
public String getAttrCredentialsArn()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getConnectionMode

@Stability(value=Stable)
 @NotNull
public String getConnectionMode()

`AWS::AppFlow::ConnectorProfile.ConnectionMode`.

setConnectionMode

@Stability(value=Stable)
public void setConnectionMode(@NotNull
                                                       String value)

`AWS::AppFlow::ConnectorProfile.ConnectionMode`.

getConnectorProfileConfig

@Stability(value=Stable)
 @Nullable
public Object getConnectorProfileConfig()

`AWS::AppFlow::ConnectorProfile.ConnectorProfileConfig`.

setConnectorProfileConfig

@Stability(value=Stable)
public void setConnectorProfileConfig(@Nullable
                                                               CfnConnectorProfile.ConnectorProfileConfigProperty value)

`AWS::AppFlow::ConnectorProfile.ConnectorProfileConfig`.

setConnectorProfileConfig

@Stability(value=Stable)
public void setConnectorProfileConfig(@Nullable
                                                               IResolvable value)

`AWS::AppFlow::ConnectorProfile.ConnectorProfileConfig`.

getConnectorProfileName

@Stability(value=Stable)
 @NotNull
public String getConnectorProfileName()

`AWS::AppFlow::ConnectorProfile.ConnectorProfileName`.

setConnectorProfileName

@Stability(value=Stable)
public void setConnectorProfileName(@NotNull
                                                             String value)

`AWS::AppFlow::ConnectorProfile.ConnectorProfileName`.

getConnectorType

@Stability(value=Stable)
 @NotNull
public String getConnectorType()

`AWS::AppFlow::ConnectorProfile.ConnectorType`.

setConnectorType

@Stability(value=Stable)
public void setConnectorType(@NotNull
                                                      String value)

`AWS::AppFlow::ConnectorProfile.ConnectorType`.

getKmsArn

@Stability(value=Stable)
 @Nullable
public String getKmsArn()

`AWS::AppFlow::ConnectorProfile.KMSArn`.

setKmsArn

@Stability(value=Stable)
public void setKmsArn(@Nullable
                                               String value)

`AWS::AppFlow::ConnectorProfile.KMSArn`.