Class: Aws::Firehose::Types::HttpEndpointDestinationUpdate

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

Overview

Note:

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: "RecordDeAggregation", # required, accepts RecordDeAggregation, Lambda, MetadataExtraction, AppendDelimiterToRecord
        parameters: [
          {
            parameter_name: "LambdaArn", # required, accepts LambdaArn, NumberOfRetries, MetadataExtractionQuery, JsonParsingEngine, RoleArn, BufferSizeInMBs, BufferIntervalInSeconds, SubRecordType, Delimiter
            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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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.

Returns:


3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
 
# File 'lib/aws-sdk-firehose/types.rb', line 3258

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.

Returns:


3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
 
# File 'lib/aws-sdk-firehose/types.rb', line 3258

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.

Returns:


3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
 
# File 'lib/aws-sdk-firehose/types.rb', line 3258

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.

Returns:


3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
 
# File 'lib/aws-sdk-firehose/types.rb', line 3258

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.

Returns:


3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
 
# File 'lib/aws-sdk-firehose/types.rb', line 3258

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.

Returns:


3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
 
# File 'lib/aws-sdk-firehose/types.rb', line 3258

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.

Returns:

  • (String) 

3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
 
# File 'lib/aws-sdk-firehose/types.rb', line 3258

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`).

Returns:

  • (String) 

3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
 
# File 'lib/aws-sdk-firehose/types.rb', line 3258

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.

Returns:


3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
 
# File 'lib/aws-sdk-firehose/types.rb', line 3258

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