aws-cdk-lib.aws_appflow.CfnConnectorProfile.RedshiftConnectorProfilePropertiesProperty

interface RedshiftConnectorProfilePropertiesProperty

LanguageType name
.NETAmazon.CDK.AWS.AppFlow.CfnConnectorProfile.RedshiftConnectorProfilePropertiesProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsappflow#CfnConnectorProfile_RedshiftConnectorProfilePropertiesProperty
Javasoftware.amazon.awscdk.services.appflow.CfnConnectorProfile.RedshiftConnectorProfilePropertiesProperty
Pythonaws_cdk.aws_appflow.CfnConnectorProfile.RedshiftConnectorProfilePropertiesProperty
TypeScript aws-cdk-lib » aws_appflow » CfnConnectorProfile » RedshiftConnectorProfilePropertiesProperty

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 { aws_appflow as appflow } from 'aws-cdk-lib';
const redshiftConnectorProfilePropertiesProperty: appflow.CfnConnectorProfile.RedshiftConnectorProfilePropertiesProperty = {
  bucketName: 'bucketName',
  roleArn: 'roleArn',

  // the properties below are optional
  bucketPrefix: 'bucketPrefix',
  clusterIdentifier: 'clusterIdentifier',
  dataApiRoleArn: 'dataApiRoleArn',
  databaseName: 'databaseName',
  databaseUrl: 'databaseUrl',
  isRedshiftServerless: false,
  workgroupName: 'workgroupName',
};

Properties

NameTypeDescription
bucketNamestringA name for the associated Amazon S3 bucket.
roleArnstringThe Amazon Resource Name (ARN) of IAM role that grants Amazon Redshift read-only access to Amazon S3.
bucketPrefix?stringThe object key for the destination bucket in which Amazon AppFlow places the files.
clusterIdentifier?stringCfnConnectorProfile.RedshiftConnectorProfilePropertiesProperty.ClusterIdentifier.
dataApiRoleArn?stringCfnConnectorProfile.RedshiftConnectorProfilePropertiesProperty.DataApiRoleArn.
databaseName?stringCfnConnectorProfile.RedshiftConnectorProfilePropertiesProperty.DatabaseName.
databaseUrl?stringThe JDBC URL of the Amazon Redshift cluster.
isRedshiftServerless?boolean | IResolvableCfnConnectorProfile.RedshiftConnectorProfilePropertiesProperty.IsRedshiftServerless.
workgroupName?stringCfnConnectorProfile.RedshiftConnectorProfilePropertiesProperty.WorkgroupName.

bucketName

Type: string

A name for the associated Amazon S3 bucket.


roleArn

Type: string

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 .


bucketPrefix?

Type: string (optional)

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


clusterIdentifier?

Type: string (optional)

CfnConnectorProfile.RedshiftConnectorProfilePropertiesProperty.ClusterIdentifier.


dataApiRoleArn?

Type: string (optional)

CfnConnectorProfile.RedshiftConnectorProfilePropertiesProperty.DataApiRoleArn.


databaseName?

Type: string (optional)

CfnConnectorProfile.RedshiftConnectorProfilePropertiesProperty.DatabaseName.


databaseUrl?

Type: string (optional)

The JDBC URL of the Amazon Redshift cluster.


isRedshiftServerless?

Type: boolean | IResolvable (optional)

CfnConnectorProfile.RedshiftConnectorProfilePropertiesProperty.IsRedshiftServerless.


workgroupName?

Type: string (optional)

CfnConnectorProfile.RedshiftConnectorProfilePropertiesProperty.WorkgroupName.