You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Firehose::Types::RedshiftDestinationConfiguration

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

Overview

Note:

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",
    buffering_hints: {
      size_in_m_bs: 1,
      interval_in_seconds: 1,
    },
    compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, 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
            parameter_value: "ProcessorParameterValue", # required
          },
        ],
      },
    ],
  },
  s3_backup_mode: "Disabled", # accepts Disabled, Enabled
  s3_backup_configuration: {
    role_arn: "RoleARN", # required
    bucket_arn: "BucketARN", # required
    prefix: "Prefix",
    buffering_hints: {
      size_in_m_bs: 1,
      interval_in_seconds: 1,
    },
    compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, 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.

Instance Attribute Summary collapse

Instance Attribute Details

#cloud_watch_logging_optionsTypes::CloudWatchLoggingOptions

The CloudWatch logging options for your delivery stream.



1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1883

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)
  include Aws::Structure
end

#cluster_jdbc_urlString

The database connection string.

Returns:

  • (String)


1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1883

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)
  include Aws::Structure
end

#copy_commandTypes::CopyCommand

The COPY command.

Returns:



1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1883

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)
  include Aws::Structure
end

#passwordString

The user password.

Returns:

  • (String)


1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1883

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)
  include Aws::Structure
end

#processing_configurationTypes::ProcessingConfiguration

The data processing configuration.



1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1883

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)
  include Aws::Structure
end

#retry_optionsTypes::RedshiftRetryOptions

The retry behavior in case Kinesis Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).



1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1883

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)
  include Aws::Structure
end

#role_arnString

The ARN of the AWS credentials.

Returns:

  • (String)


1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1883

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)
  include Aws::Structure
end

#s3_backup_configurationTypes::S3DestinationConfiguration

The configuration for backup in Amazon S3.



1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1883

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)
  include Aws::Structure
end

#s3_backup_modeString

The Amazon S3 backup mode.

Returns:

  • (String)


1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1883

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)
  include Aws::Structure
end

#s3_configurationTypes::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.



1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1883

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)
  include Aws::Structure
end

#usernameString

The name of the user.

Returns:

  • (String)


1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1883

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)
  include Aws::Structure
end