Class: Aws::Firehose::Types::RedshiftDestinationDescription

Inherits:

Struct

• Object
• Struct
• Aws::Firehose::Types::RedshiftDestinationDescription

Defined in:

gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb

Overview

Describes a destination in Amazon Redshift.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:username]

Instance Attribute Summary

• #cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions

  The Amazon CloudWatch logging options for your Firehose stream.

• #cluster_jdbc_url ⇒ String

  The database connection string.

• #copy_command ⇒ Types::CopyCommand

  The COPY command.

• #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_description ⇒ Types::S3DestinationDescription

  The configuration for backup in Amazon S3.

• #s3_backup_mode ⇒ String

  The Amazon S3 backup mode.

• #s3_destination_description ⇒ Types::S3DestinationDescription

  The Amazon S3 destination.

• #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 Amazon CloudWatch logging options for your Firehose stream.

Returns:

• (Types::CloudWatchLoggingOptions)

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

class RedshiftDestinationDescription < Struct.new(
  :role_arn,
  :cluster_jdbc_url,
  :copy_command,
  :username,
  :retry_options,
  :s3_destination_description,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_description,
  :cloud_watch_logging_options,
  :secrets_manager_configuration)
  SENSITIVE = [:username]
  include Aws::Structure
end

#cluster_jdbc_url ⇒ String

The database connection string.

Returns:

• (String)

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

class RedshiftDestinationDescription < Struct.new(
  :role_arn,
  :cluster_jdbc_url,
  :copy_command,
  :username,
  :retry_options,
  :s3_destination_description,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_description,
  :cloud_watch_logging_options,
  :secrets_manager_configuration)
  SENSITIVE = [:username]
  include Aws::Structure
end

#copy_command ⇒ Types::CopyCommand

The COPY command.

Returns:

• (Types::CopyCommand)

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

class RedshiftDestinationDescription < Struct.new(
  :role_arn,
  :cluster_jdbc_url,
  :copy_command,
  :username,
  :retry_options,
  :s3_destination_description,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_description,
  :cloud_watch_logging_options,
  :secrets_manager_configuration)
  SENSITIVE = [:username]
  include Aws::Structure
end

#processing_configuration ⇒ Types::ProcessingConfiguration

The data processing configuration.

Returns:

• (Types::ProcessingConfiguration)

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

class RedshiftDestinationDescription < Struct.new(
  :role_arn,
  :cluster_jdbc_url,
  :copy_command,
  :username,
  :retry_options,
  :s3_destination_description,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_description,
  :cloud_watch_logging_options,
  :secrets_manager_configuration)
  SENSITIVE = [:username]
  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 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4289

class RedshiftDestinationDescription < Struct.new(
  :role_arn,
  :cluster_jdbc_url,
  :copy_command,
  :username,
  :retry_options,
  :s3_destination_description,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_description,
  :cloud_watch_logging_options,
  :secrets_manager_configuration)
  SENSITIVE = [:username]
  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.

Returns:

• (String)

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

class RedshiftDestinationDescription < Struct.new(
  :role_arn,
  :cluster_jdbc_url,
  :copy_command,
  :username,
  :retry_options,
  :s3_destination_description,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_description,
  :cloud_watch_logging_options,
  :secrets_manager_configuration)
  SENSITIVE = [:username]
  include Aws::Structure
end

#s3_backup_description ⇒ Types::S3DestinationDescription

The configuration for backup in Amazon S3.

Returns:

• (Types::S3DestinationDescription)

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

class RedshiftDestinationDescription < Struct.new(
  :role_arn,
  :cluster_jdbc_url,
  :copy_command,
  :username,
  :retry_options,
  :s3_destination_description,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_description,
  :cloud_watch_logging_options,
  :secrets_manager_configuration)
  SENSITIVE = [:username]
  include Aws::Structure
end

#s3_backup_mode ⇒ String

The Amazon S3 backup mode.

Returns:

• (String)

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

class RedshiftDestinationDescription < Struct.new(
  :role_arn,
  :cluster_jdbc_url,
  :copy_command,
  :username,
  :retry_options,
  :s3_destination_description,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_description,
  :cloud_watch_logging_options,
  :secrets_manager_configuration)
  SENSITIVE = [:username]
  include Aws::Structure
end

#s3_destination_description ⇒ Types::S3DestinationDescription

The Amazon S3 destination.

Returns:

• (Types::S3DestinationDescription)

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

class RedshiftDestinationDescription < Struct.new(
  :role_arn,
  :cluster_jdbc_url,
  :copy_command,
  :username,
  :retry_options,
  :s3_destination_description,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_description,
  :cloud_watch_logging_options,
  :secrets_manager_configuration)
  SENSITIVE = [:username]
  include Aws::Structure
end

#secrets_manager_configuration ⇒ Types::SecretsManagerConfiguration

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

Returns:

• (Types::SecretsManagerConfiguration)

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

class RedshiftDestinationDescription < Struct.new(
  :role_arn,
  :cluster_jdbc_url,
  :copy_command,
  :username,
  :retry_options,
  :s3_destination_description,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_description,
  :cloud_watch_logging_options,
  :secrets_manager_configuration)
  SENSITIVE = [:username]
  include Aws::Structure
end

#username ⇒ String

The name of the user.

Returns:

• (String)

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

class RedshiftDestinationDescription < Struct.new(
  :role_arn,
  :cluster_jdbc_url,
  :copy_command,
  :username,
  :retry_options,
  :s3_destination_description,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_description,
  :cloud_watch_logging_options,
  :secrets_manager_configuration)
  SENSITIVE = [:username]
  include Aws::Structure
end