Class: Aws::Firehose::Types::RedshiftDestinationUpdate
- Inherits:
-
Struct
- Object
- Struct
- Aws::Firehose::Types::RedshiftDestinationUpdate
- Defined in:
- gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb
Overview
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",
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.
Constant Summary collapse
- SENSITIVE =
[:username, :password]
Instance Attribute Summary collapse
-
#cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions
The Amazon 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 Kinesis Data Firehose is unable to deliver documents to Amazon Redshift.
-
#role_arn ⇒ 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.
-
#s3_backup_update ⇒ Types::S3DestinationUpdate
The Amazon S3 destination for backup.
-
#s3_update ⇒ Types::S3DestinationUpdate
The Amazon S3 destination.
-
#username ⇒ String
The name of the user.
Instance Attribute Details
#cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions
The Amazon CloudWatch logging options for your delivery stream.
4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4021 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) SENSITIVE = [:username, :password] include Aws::Structure end |
#cluster_jdbc_url ⇒ String
The database connection string.
4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4021 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) SENSITIVE = [:username, :password] include Aws::Structure end |
#copy_command ⇒ Types::CopyCommand
The COPY
command.
4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4021 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) SENSITIVE = [:username, :password] include Aws::Structure end |
#password ⇒ String
The user password.
4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4021 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) SENSITIVE = [:username, :password] include Aws::Structure end |
#processing_configuration ⇒ Types::ProcessingConfiguration
The data processing configuration.
4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4021 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) SENSITIVE = [:username, :password] include Aws::Structure end |
#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).
4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4021 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) SENSITIVE = [:username, :password] include Aws::Structure end |
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4021 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) SENSITIVE = [:username, :password] include Aws::Structure end |
#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.
4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4021 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) SENSITIVE = [:username, :password] include Aws::Structure end |
#s3_backup_update ⇒ Types::S3DestinationUpdate
The Amazon S3 destination for backup.
4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4021 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) SENSITIVE = [:username, :password] include Aws::Structure end |
#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.
4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4021 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) SENSITIVE = [:username, :password] include Aws::Structure end |
#username ⇒ String
The name of the user.
4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4021 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) SENSITIVE = [:username, :password] include Aws::Structure end |