interface RedshiftConnectorProfilePropertiesProperty
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.AppFlow.CfnConnectorProfile.RedshiftConnectorProfilePropertiesProperty |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsappflow#CfnConnectorProfile_RedshiftConnectorProfilePropertiesProperty |
Java | software.amazon.awscdk.services.appflow.CfnConnectorProfile.RedshiftConnectorProfilePropertiesProperty |
Python | aws_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
Name | Type | Description |
---|---|---|
bucket | string | A name for the associated Amazon S3 bucket. |
role | string | The Amazon Resource Name (ARN) of IAM role that grants Amazon Redshift read-only access to Amazon S3. |
bucket | string | The object key for the destination bucket in which Amazon AppFlow places the files. |
cluster | string | The unique ID that's assigned to an Amazon Redshift cluster. |
data | string | The Amazon Resource Name (ARN) of an IAM role that permits Amazon AppFlow to access your Amazon Redshift database through the Data API. |
database | string | The name of an Amazon Redshift database. |
database | string | The JDBC URL of the Amazon Redshift cluster. |
is | boolean | IResolvable | Indicates whether the connector profile defines a connection to an Amazon Redshift Serverless data warehouse. |
workgroup | string | The name of an Amazon Redshift workgroup. |
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)
The unique ID that's assigned to an Amazon Redshift cluster.
dataApiRoleArn?
Type:
string
(optional)
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 .
databaseName?
Type:
string
(optional)
The name of an Amazon Redshift database.
databaseUrl?
Type:
string
(optional)
The JDBC URL of the Amazon Redshift cluster.
isRedshiftServerless?
Type:
boolean |
IResolvable
(optional)
Indicates whether the connector profile defines a connection to an Amazon Redshift Serverless data warehouse.
workgroupName?
Type:
string
(optional)
The name of an Amazon Redshift workgroup.