Class: Aws::Appflow::Types::RedshiftConnectorProfileProperties

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb

Overview

Note:

When making an API call, you may pass RedshiftConnectorProfileProperties data as a hash:

{
  database_url: "DatabaseUrl",
  bucket_name: "BucketName", # required
  bucket_prefix: "BucketPrefix",
  role_arn: "RoleArn", # required
  data_api_role_arn: "DataApiRoleArn",
  is_redshift_serverless: false,
  cluster_identifier: "ClusterIdentifier",
  workgroup_name: "WorkgroupName",
  database_name: "DatabaseName",
}

The connector-specific profile properties when using Amazon Redshift.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucket_nameString

A name for the associated Amazon S3 bucket.

Returns:

  • (String)


5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 5275

class RedshiftConnectorProfileProperties < Struct.new(
  :database_url,
  :bucket_name,
  :bucket_prefix,
  :role_arn,
  :data_api_role_arn,
  :is_redshift_serverless,
  :cluster_identifier,
  :workgroup_name,
  :database_name)
  SENSITIVE = []
  include Aws::Structure
end

#bucket_prefixString

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

Returns:

  • (String)


5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 5275

class RedshiftConnectorProfileProperties < Struct.new(
  :database_url,
  :bucket_name,
  :bucket_prefix,
  :role_arn,
  :data_api_role_arn,
  :is_redshift_serverless,
  :cluster_identifier,
  :workgroup_name,
  :database_name)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_identifierString

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

Returns:

  • (String)


5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 5275

class RedshiftConnectorProfileProperties < Struct.new(
  :database_url,
  :bucket_name,
  :bucket_prefix,
  :role_arn,
  :data_api_role_arn,
  :is_redshift_serverless,
  :cluster_identifier,
  :workgroup_name,
  :database_name)
  SENSITIVE = []
  include Aws::Structure
end

#data_api_role_arnString

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.

Returns:

  • (String)


5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 5275

class RedshiftConnectorProfileProperties < Struct.new(
  :database_url,
  :bucket_name,
  :bucket_prefix,
  :role_arn,
  :data_api_role_arn,
  :is_redshift_serverless,
  :cluster_identifier,
  :workgroup_name,
  :database_name)
  SENSITIVE = []
  include Aws::Structure
end

#database_nameString

The name of an Amazon Redshift database.

Returns:

  • (String)


5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 5275

class RedshiftConnectorProfileProperties < Struct.new(
  :database_url,
  :bucket_name,
  :bucket_prefix,
  :role_arn,
  :data_api_role_arn,
  :is_redshift_serverless,
  :cluster_identifier,
  :workgroup_name,
  :database_name)
  SENSITIVE = []
  include Aws::Structure
end

#database_urlString

The JDBC URL of the Amazon Redshift cluster.

Returns:

  • (String)


5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 5275

class RedshiftConnectorProfileProperties < Struct.new(
  :database_url,
  :bucket_name,
  :bucket_prefix,
  :role_arn,
  :data_api_role_arn,
  :is_redshift_serverless,
  :cluster_identifier,
  :workgroup_name,
  :database_name)
  SENSITIVE = []
  include Aws::Structure
end

#is_redshift_serverlessBoolean

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

Returns:

  • (Boolean)


5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 5275

class RedshiftConnectorProfileProperties < Struct.new(
  :database_url,
  :bucket_name,
  :bucket_prefix,
  :role_arn,
  :data_api_role_arn,
  :is_redshift_serverless,
  :cluster_identifier,
  :workgroup_name,
  :database_name)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

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.

Returns:

  • (String)


5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 5275

class RedshiftConnectorProfileProperties < Struct.new(
  :database_url,
  :bucket_name,
  :bucket_prefix,
  :role_arn,
  :data_api_role_arn,
  :is_redshift_serverless,
  :cluster_identifier,
  :workgroup_name,
  :database_name)
  SENSITIVE = []
  include Aws::Structure
end

#workgroup_nameString

The name of an Amazon Redshift workgroup.

Returns:

  • (String)


5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 5275

class RedshiftConnectorProfileProperties < Struct.new(
  :database_url,
  :bucket_name,
  :bucket_prefix,
  :role_arn,
  :data_api_role_arn,
  :is_redshift_serverless,
  :cluster_identifier,
  :workgroup_name,
  :database_name)
  SENSITIVE = []
  include Aws::Structure
end