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

Class: Aws::Firehose::Types::RedshiftDestinationUpdate

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

Overview

Note:

When passing RedshiftDestinationUpdate as input to an Aws::Client method, you can use a vanilla Hash:

{
  role_arn: "RoleARN",
  cluster_jdbc_url: "ClusterJDBCURL",
  copy_command: {
    data_table_name: "DataTableName", # required
    data_table_columns: "DataTableColumns",
    copy_options: "CopyOptions",
  },
  username: "Username",
  password: "Password",
  retry_options: {
    duration_in_seconds: 1,
  },
  s3_update: {
    role_arn: "RoleARN",
    bucket_arn: "BucketARN",
    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_update: {
    role_arn: "RoleARN",
    bucket_arn: "BucketARN",
    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 an update for a destination in Amazon Redshift.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions

The Amazon 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_mode ⇒ String

You can update a delivery stream 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) —

    You can update a delivery stream to enable Amazon S3 backup if it is disabled.

#s3_backup_update ⇒ Types::S3DestinationUpdate

The Amazon S3 destination for backup.

Returns:

#s3_update ⇒ Types::S3DestinationUpdate

The Amazon S3 destination.

The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationUpdate.S3Update 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.