Class: Aws::Firehose::Types::HttpEndpointDestinationUpdate
- Inherits:
-
Struct
- Object
- Struct
- Aws::Firehose::Types::HttpEndpointDestinationUpdate
- Defined in:
- gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb
Overview
When making an API call, you may pass HttpEndpointDestinationUpdate data as a hash:
{
endpoint_configuration: {
url: "HttpEndpointUrl", # required
name: "HttpEndpointName",
access_key: "HttpEndpointAccessKey",
},
buffering_hints: {
size_in_m_bs: 1,
interval_in_seconds: 1,
},
cloud_watch_logging_options: {
enabled: false,
log_group_name: "LogGroupName",
log_stream_name: "LogStreamName",
},
request_configuration: {
content_encoding: "NONE", # accepts NONE, GZIP
common_attributes: [
{
attribute_name: "HttpEndpointAttributeName", # required
attribute_value: "HttpEndpointAttributeValue", # required
},
],
},
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
},
],
},
],
},
role_arn: "RoleARN",
retry_options: {
duration_in_seconds: 1,
},
s3_backup_mode: "FailedDataOnly", # accepts FailedDataOnly, AllData
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",
},
},
}
Updates the specified HTTP endpoint destination.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#buffering_hints ⇒ Types::HttpEndpointBufferingHints
Describes buffering options that can be applied to the data before it is delivered to the HTTPS endpoint destination.
-
#cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions
Describes the Amazon CloudWatch logging options for your delivery stream.
-
#endpoint_configuration ⇒ Types::HttpEndpointConfiguration
Describes the configuration of the HTTP endpoint destination.
-
#processing_configuration ⇒ Types::ProcessingConfiguration
Describes a data processing configuration.
-
#request_configuration ⇒ Types::HttpEndpointRequestConfiguration
The configuration of the request sent to the HTTP endpoint specified as the destination.
-
#retry_options ⇒ Types::HttpEndpointRetryOptions
Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.
-
#role_arn ⇒ String
Kinesis Data Firehose uses this IAM role for all the permissions that the delivery stream needs.
-
#s3_backup_mode ⇒ String
Describes the S3 bucket backup options for the data that Kinesis Firehose delivers to the HTTP endpoint destination.
-
#s3_update ⇒ Types::S3DestinationUpdate
Describes an update for a destination in Amazon S3.
Instance Attribute Details
#buffering_hints ⇒ Types::HttpEndpointBufferingHints
Describes buffering options that can be applied to the data before
it is delivered to the HTTPS endpoint destination. Kinesis Data
Firehose teats these options as hints, and it might choose to use
more optimal values. The SizeInMBs
and IntervalInSeconds
parameters are optional. However, if specify a value for one of
them, you must also provide a value for the other.
2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2734 class HttpEndpointDestinationUpdate < Struct.new( :endpoint_configuration, :buffering_hints, :cloud_watch_logging_options, :request_configuration, :processing_configuration, :role_arn, :retry_options, :s3_backup_mode, :s3_update) SENSITIVE = [] include Aws::Structure end |
#cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions
Describes the Amazon CloudWatch logging options for your delivery stream.
2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2734 class HttpEndpointDestinationUpdate < Struct.new( :endpoint_configuration, :buffering_hints, :cloud_watch_logging_options, :request_configuration, :processing_configuration, :role_arn, :retry_options, :s3_backup_mode, :s3_update) SENSITIVE = [] include Aws::Structure end |
#endpoint_configuration ⇒ Types::HttpEndpointConfiguration
Describes the configuration of the HTTP endpoint destination.
2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2734 class HttpEndpointDestinationUpdate < Struct.new( :endpoint_configuration, :buffering_hints, :cloud_watch_logging_options, :request_configuration, :processing_configuration, :role_arn, :retry_options, :s3_backup_mode, :s3_update) SENSITIVE = [] include Aws::Structure end |
#processing_configuration ⇒ Types::ProcessingConfiguration
Describes a data processing configuration.
2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2734 class HttpEndpointDestinationUpdate < Struct.new( :endpoint_configuration, :buffering_hints, :cloud_watch_logging_options, :request_configuration, :processing_configuration, :role_arn, :retry_options, :s3_backup_mode, :s3_update) SENSITIVE = [] include Aws::Structure end |
#request_configuration ⇒ Types::HttpEndpointRequestConfiguration
The configuration of the request sent to the HTTP endpoint specified as the destination.
2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2734 class HttpEndpointDestinationUpdate < Struct.new( :endpoint_configuration, :buffering_hints, :cloud_watch_logging_options, :request_configuration, :processing_configuration, :role_arn, :retry_options, :s3_backup_mode, :s3_update) SENSITIVE = [] include Aws::Structure end |
#retry_options ⇒ Types::HttpEndpointRetryOptions
Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.
2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2734 class HttpEndpointDestinationUpdate < Struct.new( :endpoint_configuration, :buffering_hints, :cloud_watch_logging_options, :request_configuration, :processing_configuration, :role_arn, :retry_options, :s3_backup_mode, :s3_update) SENSITIVE = [] include Aws::Structure end |
#role_arn ⇒ String
Kinesis Data Firehose uses this IAM role for all the permissions that the delivery stream needs.
2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2734 class HttpEndpointDestinationUpdate < Struct.new( :endpoint_configuration, :buffering_hints, :cloud_watch_logging_options, :request_configuration, :processing_configuration, :role_arn, :retry_options, :s3_backup_mode, :s3_update) SENSITIVE = [] include Aws::Structure end |
#s3_backup_mode ⇒ String
Describes the S3 bucket backup options for the data that Kinesis
Firehose delivers to the HTTP endpoint destination. You can back up
all documents (AllData
) or only the documents that Kinesis Data
Firehose could not deliver to the specified HTTP endpoint
destination (FailedDataOnly
).
2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2734 class HttpEndpointDestinationUpdate < Struct.new( :endpoint_configuration, :buffering_hints, :cloud_watch_logging_options, :request_configuration, :processing_configuration, :role_arn, :retry_options, :s3_backup_mode, :s3_update) SENSITIVE = [] include Aws::Structure end |
#s3_update ⇒ Types::S3DestinationUpdate
Describes an update for a destination in Amazon S3.
2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2734 class HttpEndpointDestinationUpdate < Struct.new( :endpoint_configuration, :buffering_hints, :cloud_watch_logging_options, :request_configuration, :processing_configuration, :role_arn, :retry_options, :s3_backup_mode, :s3_update) SENSITIVE = [] include Aws::Structure end |