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

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

Overview

Describes the configuration of a destination in Amazon Redshift.

Constant Summary collapse

SENSITIVE =
[:username, :password]

Instance Attribute Summary collapse

Instance Attribute Details

#cloud_watch_logging_optionsTypes::CloudWatchLoggingOptions

The CloudWatch logging options for your delivery stream.



3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
# File 'lib/aws-sdk-firehose/types.rb', line 3296

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_urlString

The database connection string.

Returns:

  • (String)


3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
# File 'lib/aws-sdk-firehose/types.rb', line 3296

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_commandTypes::CopyCommand

The ‘COPY` command.

Returns:



3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
# File 'lib/aws-sdk-firehose/types.rb', line 3296

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

#passwordString

The user password.

Returns:

  • (String)


3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
# File 'lib/aws-sdk-firehose/types.rb', line 3296

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_configurationTypes::ProcessingConfiguration

The data processing configuration.



3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
# File 'lib/aws-sdk-firehose/types.rb', line 3296

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_optionsTypes::RedshiftRetryOptions

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



3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
# File 'lib/aws-sdk-firehose/types.rb', line 3296

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_arnString

The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces].

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

  • (String)


3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
# File 'lib/aws-sdk-firehose/types.rb', line 3296

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_configurationTypes::S3DestinationConfiguration

The configuration for backup in Amazon S3.



3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
# File 'lib/aws-sdk-firehose/types.rb', line 3296

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_modeString

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.

Returns:

  • (String)


3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
# File 'lib/aws-sdk-firehose/types.rb', line 3296

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



3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
# File 'lib/aws-sdk-firehose/types.rb', line 3296

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

#usernameString

The name of the user.

Returns:

  • (String)


3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
# File 'lib/aws-sdk-firehose/types.rb', line 3296

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