Class: Aws::Firehose::Types::RedshiftDestinationConfiguration
- Inherits:
-
Struct
- Object
- Struct
- Aws::Firehose::Types::RedshiftDestinationConfiguration
- Defined in:
- gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb
Overview
When making an API call, you may pass RedshiftDestinationConfiguration data as a hash:
{
role_arn: "RoleARN", # required
cluster_jdbc_url: "ClusterJDBCURL", # required
copy_command: { # required
data_table_name: "DataTableName", # required
data_table_columns: "DataTableColumns",
copy_options: "CopyOptions",
},
username: "Username", # required
password: "Password", # required
retry_options: {
duration_in_seconds: 1,
},
s3_configuration: { # required
role_arn: "RoleARN", # required
bucket_arn: "BucketARN", # required
prefix: "Prefix",
error_output_prefix: "ErrorOutputPrefix",
buffering_hints: {
size_in_m_bs: 1,
interval_in_seconds: 1,
},
compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy, HADOOP_SNAPPY
encryption_configuration: {
no_encryption_config: "NoEncryption", # accepts NoEncryption
kms_encryption_config: {
awskms_key_arn: "AWSKMSKeyARN", # required
},
},
cloud_watch_logging_options: {
enabled: false,
log_group_name: "LogGroupName",
log_stream_name: "LogStreamName",
},
},
processing_configuration: {
enabled: false,
processors: [
{
type: "Lambda", # required, accepts Lambda
parameters: [
{
parameter_name: "LambdaArn", # required, accepts LambdaArn, NumberOfRetries, RoleArn, BufferSizeInMBs, BufferIntervalInSeconds
parameter_value: "ProcessorParameterValue", # required
},
],
},
],
},
s3_backup_mode: "Disabled", # accepts Disabled, Enabled
s3_backup_configuration: {
role_arn: "RoleARN", # required
bucket_arn: "BucketARN", # required
prefix: "Prefix",
error_output_prefix: "ErrorOutputPrefix",
buffering_hints: {
size_in_m_bs: 1,
interval_in_seconds: 1,
},
compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy, HADOOP_SNAPPY
encryption_configuration: {
no_encryption_config: "NoEncryption", # accepts NoEncryption
kms_encryption_config: {
awskms_key_arn: "AWSKMSKeyARN", # required
},
},
cloud_watch_logging_options: {
enabled: false,
log_group_name: "LogGroupName",
log_stream_name: "LogStreamName",
},
},
cloud_watch_logging_options: {
enabled: false,
log_group_name: "LogGroupName",
log_stream_name: "LogStreamName",
},
}
Describes the configuration of a destination in Amazon Redshift.
Constant Summary collapse
- SENSITIVE =
[:username, :password]
Instance Attribute Summary collapse
-
#cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions
The CloudWatch logging options for your delivery stream.
-
#cluster_jdbc_url ⇒ String
The database connection string.
-
#copy_command ⇒ Types::CopyCommand
The
COPY
command. -
#password ⇒ String
The user password.
-
#processing_configuration ⇒ Types::ProcessingConfiguration
The data processing configuration.
-
#retry_options ⇒ Types::RedshiftRetryOptions
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift.
-
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the AWS credentials.
-
#s3_backup_configuration ⇒ Types::S3DestinationConfiguration
The configuration for backup in Amazon S3.
-
#s3_backup_mode ⇒ String
The Amazon S3 backup mode.
-
#s3_configuration ⇒ Types::S3DestinationConfiguration
The configuration for the intermediate Amazon S3 location from which Amazon Redshift obtains data.
-
#username ⇒ String
The name of the user.
Instance Attribute Details
#cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions
The CloudWatch logging options for your delivery stream.
3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 3793 class RedshiftDestinationConfiguration < Struct.new( :role_arn, :cluster_jdbc_url, :copy_command, :username, :password, :retry_options, :s3_configuration, :processing_configuration, :s3_backup_mode, :s3_backup_configuration, :cloud_watch_logging_options) SENSITIVE = [:username, :password] include Aws::Structure end |
#cluster_jdbc_url ⇒ String
The database connection string.
3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 3793 class RedshiftDestinationConfiguration < Struct.new( :role_arn, :cluster_jdbc_url, :copy_command, :username, :password, :retry_options, :s3_configuration, :processing_configuration, :s3_backup_mode, :s3_backup_configuration, :cloud_watch_logging_options) SENSITIVE = [:username, :password] include Aws::Structure end |
#copy_command ⇒ Types::CopyCommand
The COPY
command.
3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 3793 class RedshiftDestinationConfiguration < Struct.new( :role_arn, :cluster_jdbc_url, :copy_command, :username, :password, :retry_options, :s3_configuration, :processing_configuration, :s3_backup_mode, :s3_backup_configuration, :cloud_watch_logging_options) SENSITIVE = [:username, :password] include Aws::Structure end |
#password ⇒ String
The user password.
3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 3793 class RedshiftDestinationConfiguration < Struct.new( :role_arn, :cluster_jdbc_url, :copy_command, :username, :password, :retry_options, :s3_configuration, :processing_configuration, :s3_backup_mode, :s3_backup_configuration, :cloud_watch_logging_options) SENSITIVE = [:username, :password] include Aws::Structure end |
#processing_configuration ⇒ Types::ProcessingConfiguration
The data processing configuration.
3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 3793 class RedshiftDestinationConfiguration < Struct.new( :role_arn, :cluster_jdbc_url, :copy_command, :username, :password, :retry_options, :s3_configuration, :processing_configuration, :s3_backup_mode, :s3_backup_configuration, :cloud_watch_logging_options) SENSITIVE = [:username, :password] include Aws::Structure end |
#retry_options ⇒ Types::RedshiftRetryOptions
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).
3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 3793 class RedshiftDestinationConfiguration < Struct.new( :role_arn, :cluster_jdbc_url, :copy_command, :username, :password, :retry_options, :s3_configuration, :processing_configuration, :s3_backup_mode, :s3_backup_configuration, :cloud_watch_logging_options) SENSITIVE = [:username, :password] include Aws::Structure end |
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 3793 class RedshiftDestinationConfiguration < Struct.new( :role_arn, :cluster_jdbc_url, :copy_command, :username, :password, :retry_options, :s3_configuration, :processing_configuration, :s3_backup_mode, :s3_backup_configuration, :cloud_watch_logging_options) SENSITIVE = [:username, :password] include Aws::Structure end |
#s3_backup_configuration ⇒ Types::S3DestinationConfiguration
The configuration for backup in Amazon S3.
3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 3793 class RedshiftDestinationConfiguration < Struct.new( :role_arn, :cluster_jdbc_url, :copy_command, :username, :password, :retry_options, :s3_configuration, :processing_configuration, :s3_backup_mode, :s3_backup_configuration, :cloud_watch_logging_options) SENSITIVE = [:username, :password] include Aws::Structure end |
#s3_backup_mode ⇒ String
The Amazon S3 backup mode. After you create a delivery stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it.
3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 3793 class RedshiftDestinationConfiguration < Struct.new( :role_arn, :cluster_jdbc_url, :copy_command, :username, :password, :retry_options, :s3_configuration, :processing_configuration, :s3_backup_mode, :s3_backup_configuration, :cloud_watch_logging_options) SENSITIVE = [:username, :password] include Aws::Structure end |
#s3_configuration ⇒ Types::S3DestinationConfiguration
The configuration for the intermediate Amazon S3 location from which Amazon Redshift obtains data. Restrictions are described in the topic for CreateDeliveryStream.
The compression formats SNAPPY
or ZIP
cannot be specified in
RedshiftDestinationConfiguration.S3Configuration
because the
Amazon Redshift COPY
operation that reads from the S3 bucket
doesn't support these compression formats.
3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 3793 class RedshiftDestinationConfiguration < Struct.new( :role_arn, :cluster_jdbc_url, :copy_command, :username, :password, :retry_options, :s3_configuration, :processing_configuration, :s3_backup_mode, :s3_backup_configuration, :cloud_watch_logging_options) SENSITIVE = [:username, :password] include Aws::Structure end |
#username ⇒ String
The name of the user.
3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 3793 class RedshiftDestinationConfiguration < Struct.new( :role_arn, :cluster_jdbc_url, :copy_command, :username, :password, :retry_options, :s3_configuration, :processing_configuration, :s3_backup_mode, :s3_backup_configuration, :cloud_watch_logging_options) SENSITIVE = [:username, :password] include Aws::Structure end |