Skip to content

RedshiftConnectorProfileProperties

Source code in docs_src/capo_appflow/types/redshift_connector_profile_properties.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
class RedshiftConnectorProfileProperties(TypedDict, closed=True):
    database_url: NotRequired["capo_appflow.types.database_url.DatabaseUrl"]
    """<p> The JDBC URL of the Amazon Redshift cluster. </p>"""
    bucket_name: "capo_appflow.types.bucket_name.BucketName"
    """<p> A name for the associated Amazon S3 bucket. </p>"""
    bucket_prefix: NotRequired["capo_appflow.types.bucket_prefix.BucketPrefix"]
    """<p> The object key for the destination bucket in which Amazon AppFlow places the files. </p>"""
    role_arn: "capo_appflow.types.role_arn.RoleArn"
    """<p> 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 <a href="https://docs.aws.amazon.com/appflow/latest/userguide/security_iam_service-role-policies.html#redshift-access-s3">Allow Amazon Redshift to access your Amazon AppFlow data in Amazon S3</a>.</p>"""
    data_api_role_arn: NotRequired[
        "capo_appflow.types.data_api_role_arn.DataApiRoleArn"
    ]
    """<p>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 <a href="https://docs.aws.amazon.com/appflow/latest/userguide/security_iam_service-role-policies.html#access-redshift">Allow Amazon AppFlow to access Amazon Redshift databases with the Data API</a>.</p>"""
    is_redshift_serverless: "capo_appflow.types.boolean.Boolean"
    """<p>Indicates whether the connector profile defines a connection to an Amazon Redshift Serverless data warehouse.</p>"""
    cluster_identifier: NotRequired[
        "capo_appflow.types.cluster_identifier.ClusterIdentifier"
    ]
    """<p>The unique ID that's assigned to an Amazon Redshift cluster.</p>"""
    workgroup_name: NotRequired["capo_appflow.types.workgroup_name.WorkgroupName"]
    """<p>The name of an Amazon Redshift workgroup.</p>"""
    database_name: NotRequired["capo_appflow.types.database_name.DatabaseName"]
    """<p>The name of an Amazon Redshift database.</p>"""

bucket_name instance-attribute 

bucket_name: BucketName

A name for the associated Amazon S3 bucket.

bucket_prefix instance-attribute 

bucket_prefix: NotRequired[BucketPrefix]

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

cluster_identifier instance-attribute 

cluster_identifier: NotRequired[ClusterIdentifier]

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

data_api_role_arn instance-attribute 

data_api_role_arn: NotRequired[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.

database_name instance-attribute 

database_name: NotRequired[DatabaseName]

The name of an Amazon Redshift database.

database_url instance-attribute 

database_url: NotRequired[DatabaseUrl]

The JDBC URL of the Amazon Redshift cluster.

is_redshift_serverless instance-attribute 

is_redshift_serverless: Boolean

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

role_arn instance-attribute 

role_arn: 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.

workgroup_name instance-attribute 

workgroup_name: NotRequired[WorkgroupName]

The name of an Amazon Redshift workgroup.