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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing RedshiftDestinationConfiguration as input to an Aws::Client method, you can use a vanilla 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.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions

The CloudWatch logging options for your delivery stream.

Returns:

#cluster_jdbc_url ⇒ String

The database connection string.

Returns:

  • (String) —

    The database connection string.

#copy_command ⇒ Types::CopyCommand

The COPY command.

Returns:

#password ⇒ String

The user password.

Returns:

  • (String) —

    The user password.

#processing_configuration ⇒ Types::ProcessingConfiguration

The data processing configuration.

Returns:

#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).

Returns:

  • (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. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the AWS credentials.

#s3_backup_configuration ⇒ Types::S3DestinationConfiguration

The configuration for backup in Amazon S3.

Returns:

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

Possible values:

  • Disabled
  • Enabled

Returns:

  • (String) —

    The Amazon S3 backup mode.

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

Returns:

#username ⇒ String

The name of the user.

Returns:

  • (String) —

    The name of the user.