Package software.amazon.awscdk.services.appflow

Interface CfnConnectorProfile.RedshiftConnectorProfilePropertiesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnConnectorProfile.RedshiftConnectorProfilePropertiesProperty.Jsii$Proxy

Enclosing class:

CfnConnectorProfile

@Stability(Stable)
public static interface CfnConnectorProfile.RedshiftConnectorProfilePropertiesProperty
extends software.amazon.jsii.JsiiSerializable

The connector-specific profile properties when using Amazon Redshift.

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.*;
 RedshiftConnectorProfilePropertiesProperty redshiftConnectorProfilePropertiesProperty = RedshiftConnectorProfilePropertiesProperty.builder()
         .bucketName("bucketName")
         .roleArn("roleArn")
         // the properties below are optional
         .bucketPrefix("bucketPrefix")
         .clusterIdentifier("clusterIdentifier")
         .dataApiRoleArn("dataApiRoleArn")
         .databaseName("databaseName")
         .databaseUrl("databaseUrl")
         .isRedshiftServerless(false)
         .workgroupName("workgroupName")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-redshiftconnectorprofileproperties.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnConnectorProfile.RedshiftConnectorProfilePropertiesProperty.Builder	A builder for CfnConnectorProfile.RedshiftConnectorProfilePropertiesProperty
static final class	CfnConnectorProfile.RedshiftConnectorProfilePropertiesProperty.Jsii$Proxy	An implementation for CfnConnectorProfile.RedshiftConnectorProfilePropertiesProperty

Method Summary

Modifier and Type	Method	Description
static CfnConnectorProfile.RedshiftConnectorProfilePropertiesProperty.Builder	builder()
String	getBucketName()	A name for the associated Amazon S3 bucket.
default String	getBucketPrefix()	The object key for the destination bucket in which Amazon AppFlow places the files.
default String	getClusterIdentifier()	The unique ID that's assigned to an Amazon Redshift cluster.
default String	getDataApiRoleArn()	The Amazon Resource Name (ARN) of an IAM role that permits Amazon AppFlow to access your Amazon Redshift database through the Data API.
default String	getDatabaseName()	The name of an Amazon Redshift database.
default String	getDatabaseUrl()	The JDBC URL of the Amazon Redshift cluster.
default Object	getIsRedshiftServerless()	Indicates whether the connector profile defines a connection to an Amazon Redshift Serverless data warehouse.
String	getRoleArn()	The Amazon Resource Name (ARN) of IAM role that grants Amazon Redshift read-only access to Amazon S3.
default String	getWorkgroupName()	The name of an Amazon Redshift workgroup.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBucketName

@Stability(Stable)
@NotNull
String getBucketName()

A name for the associated Amazon S3 bucket.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-redshiftconnectorprofileproperties.html#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-bucketname

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

The Amazon Resource Name (ARN) of IAM role that grants Amazon Redshift read-only access to Amazon S3.

For more information, and for the polices that you attach to this role, see Allow Amazon Redshift to access your Amazon AppFlow data in Amazon S3 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-redshiftconnectorprofileproperties.html#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-rolearn

getBucketPrefix

@Stability(Stable)
@Nullable
default String getBucketPrefix()

The object key for the destination bucket in which Amazon AppFlow places the files.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-redshiftconnectorprofileproperties.html#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-bucketprefix

getClusterIdentifier

@Stability(Stable)
@Nullable
default String getClusterIdentifier()

The unique ID that's assigned to an Amazon Redshift cluster.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-redshiftconnectorprofileproperties.html#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-clusteridentifier

getDataApiRoleArn

@Stability(Stable)
@Nullable
default String getDataApiRoleArn()

The Amazon Resource Name (ARN) of an IAM role that permits Amazon AppFlow to access your Amazon Redshift database through the Data API.

For more information, and for the polices that you attach to this role, see Allow Amazon AppFlow to access Amazon Redshift databases with the Data API .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-redshiftconnectorprofileproperties.html#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-dataapirolearn

getDatabaseName

@Stability(Stable)
@Nullable
default String getDatabaseName()

The name of an Amazon Redshift database.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-redshiftconnectorprofileproperties.html#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-databasename

getDatabaseUrl

@Stability(Stable)
@Nullable
default String getDatabaseUrl()

The JDBC URL of the Amazon Redshift cluster.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-redshiftconnectorprofileproperties.html#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-databaseurl

getIsRedshiftServerless

@Stability(Stable)
@Nullable
default Object getIsRedshiftServerless()

Indicates whether the connector profile defines a connection to an Amazon Redshift Serverless data warehouse.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-redshiftconnectorprofileproperties.html#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-isredshiftserverless

getWorkgroupName

@Stability(Stable)
@Nullable
default String getWorkgroupName()

The name of an Amazon Redshift workgroup.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-redshiftconnectorprofileproperties.html#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-workgroupname

builder

@Stability(Stable)
static CfnConnectorProfile.RedshiftConnectorProfilePropertiesProperty.Builder builder()

Returns:

a CfnConnectorProfile.RedshiftConnectorProfilePropertiesProperty.Builder of CfnConnectorProfile.RedshiftConnectorProfilePropertiesProperty