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

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

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 RedshiftDestinationUpdate data as a 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",
    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_update: {
    role_arn: "RoleARN",
    bucket_arn: "BucketARN",
    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 an update for 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.



1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1950

class RedshiftDestinationUpdate < Struct.new(
  :role_arn,
  :cluster_jdbc_url,
  :copy_command,
  :username,
  :password,
  :retry_options,
  :s3_update,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_update,
  :cloud_watch_logging_options)
  include Aws::Structure
end

#cluster_jdbc_urlString

The database connection string.

Returns:

  • (String)


1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1950

class RedshiftDestinationUpdate < Struct.new(
  :role_arn,
  :cluster_jdbc_url,
  :copy_command,
  :username,
  :password,
  :retry_options,
  :s3_update,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_update,
  :cloud_watch_logging_options)
  include Aws::Structure
end

#copy_commandTypes::CopyCommand

The COPY command.

Returns:



1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1950

class RedshiftDestinationUpdate < Struct.new(
  :role_arn,
  :cluster_jdbc_url,
  :copy_command,
  :username,
  :password,
  :retry_options,
  :s3_update,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_update,
  :cloud_watch_logging_options)
  include Aws::Structure
end

#passwordString

The user password.

Returns:

  • (String)


1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1950

class RedshiftDestinationUpdate < Struct.new(
  :role_arn,
  :cluster_jdbc_url,
  :copy_command,
  :username,
  :password,
  :retry_options,
  :s3_update,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_update,
  :cloud_watch_logging_options)
  include Aws::Structure
end

#processing_configurationTypes::ProcessingConfiguration

The data processing configuration.



1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1950

class RedshiftDestinationUpdate < Struct.new(
  :role_arn,
  :cluster_jdbc_url,
  :copy_command,
  :username,
  :password,
  :retry_options,
  :s3_update,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_update,
  :cloud_watch_logging_options)
  include Aws::Structure
end

#retry_optionsTypes::RedshiftRetryOptions

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



1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1950

class RedshiftDestinationUpdate < Struct.new(
  :role_arn,
  :cluster_jdbc_url,
  :copy_command,
  :username,
  :password,
  :retry_options,
  :s3_update,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_update,
  :cloud_watch_logging_options)
  include Aws::Structure
end

#role_arnString

The ARN of the AWS credentials.

Returns:

  • (String)


1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1950

class RedshiftDestinationUpdate < Struct.new(
  :role_arn,
  :cluster_jdbc_url,
  :copy_command,
  :username,
  :password,
  :retry_options,
  :s3_update,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_update,
  :cloud_watch_logging_options)
  include Aws::Structure
end

#s3_backup_modeString

The Amazon S3 backup mode.

Returns:

  • (String)


1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1950

class RedshiftDestinationUpdate < Struct.new(
  :role_arn,
  :cluster_jdbc_url,
  :copy_command,
  :username,
  :password,
  :retry_options,
  :s3_update,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_update,
  :cloud_watch_logging_options)
  include Aws::Structure
end

#s3_backup_updateTypes::S3DestinationUpdate

The Amazon S3 destination for backup.



1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1950

class RedshiftDestinationUpdate < Struct.new(
  :role_arn,
  :cluster_jdbc_url,
  :copy_command,
  :username,
  :password,
  :retry_options,
  :s3_update,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_update,
  :cloud_watch_logging_options)
  include Aws::Structure
end

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



1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1950

class RedshiftDestinationUpdate < Struct.new(
  :role_arn,
  :cluster_jdbc_url,
  :copy_command,
  :username,
  :password,
  :retry_options,
  :s3_update,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_update,
  :cloud_watch_logging_options)
  include Aws::Structure
end

#usernameString

The name of the user.

Returns:

  • (String)


1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1950

class RedshiftDestinationUpdate < Struct.new(
  :role_arn,
  :cluster_jdbc_url,
  :copy_command,
  :username,
  :password,
  :retry_options,
  :s3_update,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_update,
  :cloud_watch_logging_options)
  include Aws::Structure
end