AWS::AppFlow::ConnectorProfile RedshiftConnectorProfileProperties - AWS CloudFormation
SyntaxPropertiesSee also

AWS::AppFlow::ConnectorProfile RedshiftConnectorProfileProperties

The connector-specific profile properties when using Amazon Redshift.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "BucketName" : String,
  "BucketPrefix" : String,
  "ClusterIdentifier" : String,
  "DataApiRoleArn" : String,
  "DatabaseName" : String,
  "DatabaseUrl" : String,
  "IsRedshiftServerless" : Boolean,
  "RoleArn" : String,
  "WorkgroupName" : String
}

YAML

  BucketName: String
  BucketPrefix: String
  ClusterIdentifier: String
  DataApiRoleArn: String
  DatabaseName: String
  DatabaseUrl: String
  IsRedshiftServerless: Boolean
  RoleArn: String
  WorkgroupName: String

Properties

BucketName

A name for the associated Amazon S3 bucket.

Required: Yes

Type: String

Pattern: \S+

Minimum: 3

Maximum: 63

Update requires: No interruption

BucketPrefix

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

Required: No

Type: String

Maximum: 128

Update requires: No interruption

ClusterIdentifier

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

Required: No

Type: String

Pattern: \S+

Maximum: 512

Update requires: No interruption

DataApiRoleArn

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.

Required: No

Type: String

Pattern: arn:aws:iam:.*:[0-9]+:.*

Maximum: 512

Update requires: No interruption

DatabaseName

The name of an Amazon Redshift database.

Required: No

Type: String

Pattern: \S+

Maximum: 512

Update requires: No interruption

DatabaseUrl

The JDBC URL of the Amazon Redshift cluster.

Required: No

Type: String

Pattern: \S+

Maximum: 512

Update requires: No interruption

IsRedshiftServerless

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

Required: No

Type: Boolean

Update requires: No interruption

RoleArn

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.

Required: Yes

Type: String

Pattern: arn:aws:iam:.*:[0-9]+:.*

Maximum: 512

Update requires: No interruption

WorkgroupName

The name of an Amazon Redshift workgroup.

Required: No

Type: String

Pattern: \S+

Maximum: 512

Update requires: No interruption

See also