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

Inherits:

Struct

• Object
• Struct
• Aws::Firehose::Types::RedshiftDestinationConfiguration

Includes:

Structure

Defined in:

lib/aws-sdk-firehose/types.rb

Overview

Describes the configuration of a destination in Amazon Redshift.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:username, :password]

Instance Attribute Summary

• #cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions

  The CloudWatch logging options for your delivery stream.

• #cluster_jdbc_url ⇒ String

  The database connection string.

• #copy_command ⇒ Types::CopyCommand

  The ‘COPY` command.

• #password ⇒ String

  The user password.

• #processing_configuration ⇒ Types::ProcessingConfiguration

  The data processing configuration.

• #retry_options ⇒ Types::RedshiftRetryOptions

  The retry behavior in case Firehose is unable to deliver documents to Amazon Redshift.

• #role_arn ⇒ String

  The Amazon Resource Name (ARN) of the Amazon Web Services credentials.

• #s3_backup_configuration ⇒ Types::S3DestinationConfiguration

  The configuration for backup in Amazon S3.

• #s3_backup_mode ⇒ String

  The Amazon S3 backup mode.

• #s3_configuration ⇒ Types::S3DestinationConfiguration

  The configuration for the intermediate Amazon S3 location from which Amazon Redshift obtains data.

• #secrets_manager_configuration ⇒ Types::SecretsManagerConfiguration

  The configuration that defines how you access secrets for Amazon Redshift.

• #username ⇒ String

  The name of the user.

Instance Attribute Details

#cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions

The CloudWatch logging options for your delivery stream.

Returns:

• (Types::CloudWatchLoggingOptions)

# File 'lib/aws-sdk-firehose/types.rb', line 3641

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,
  :secrets_manager_configuration)
  SENSITIVE = [:username, :password]
  include Aws::Structure
end

#cluster_jdbc_url ⇒ String

The database connection string.

Returns:

• (String)

# File 'lib/aws-sdk-firehose/types.rb', line 3641

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,
  :secrets_manager_configuration)
  SENSITIVE = [:username, :password]
  include Aws::Structure
end

#copy_command ⇒ Types::CopyCommand

The ‘COPY` command.

Returns:

• (Types::CopyCommand)

# File 'lib/aws-sdk-firehose/types.rb', line 3641

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,
  :secrets_manager_configuration)
  SENSITIVE = [:username, :password]
  include Aws::Structure
end

#password ⇒ String

The user password.

Returns:

• (String)

# File 'lib/aws-sdk-firehose/types.rb', line 3641

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,
  :secrets_manager_configuration)
  SENSITIVE = [:username, :password]
  include Aws::Structure
end

#processing_configuration ⇒ Types::ProcessingConfiguration

The data processing configuration.

Returns:

• (Types::ProcessingConfiguration)

# File 'lib/aws-sdk-firehose/types.rb', line 3641

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,
  :secrets_manager_configuration)
  SENSITIVE = [:username, :password]
  include Aws::Structure
end

#retry_options ⇒ Types::RedshiftRetryOptions

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

Returns:

• (Types::RedshiftRetryOptions)

# File 'lib/aws-sdk-firehose/types.rb', line 3641

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,
  :secrets_manager_configuration)
  SENSITIVE = [:username, :password]
  include Aws::Structure
end

#role_arn ⇒ String

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)

# File 'lib/aws-sdk-firehose/types.rb', line 3641

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,
  :secrets_manager_configuration)
  SENSITIVE = [:username, :password]
  include Aws::Structure
end

#s3_backup_configuration ⇒ Types::S3DestinationConfiguration

The configuration for backup in Amazon S3.

Returns:

• (Types::S3DestinationConfiguration)

# File 'lib/aws-sdk-firehose/types.rb', line 3641

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,
  :secrets_manager_configuration)
  SENSITIVE = [:username, :password]
  include Aws::Structure
end

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

Returns:

• (String)

# File 'lib/aws-sdk-firehose/types.rb', line 3641

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,
  :secrets_manager_configuration)
  SENSITIVE = [:username, :password]
  include Aws::Structure
end

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

• (Types::S3DestinationConfiguration)

# File 'lib/aws-sdk-firehose/types.rb', line 3641

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,
  :secrets_manager_configuration)
  SENSITIVE = [:username, :password]
  include Aws::Structure
end

#secrets_manager_configuration ⇒ Types::SecretsManagerConfiguration

The configuration that defines how you access secrets for Amazon Redshift.

Returns:

• (Types::SecretsManagerConfiguration)

# File 'lib/aws-sdk-firehose/types.rb', line 3641

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,
  :secrets_manager_configuration)
  SENSITIVE = [:username, :password]
  include Aws::Structure
end

#username ⇒ String

The name of the user.

Returns:

• (String)

# File 'lib/aws-sdk-firehose/types.rb', line 3641

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,
  :secrets_manager_configuration)
  SENSITIVE = [:username, :password]
  include Aws::Structure
end