AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Firehose::Types::HttpEndpointDestinationConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing HttpEndpointDestinationConfiguration as input to an Aws::Client method, you can use a vanilla Hash:

{
  endpoint_configuration: { # required
    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_configuration: { # required
    role_arn: "RoleARN", # required
    bucket_arn: "BucketARN", # required
    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",
    },
  },
}

Describes the configuration of the HTTP endpoint destination.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#buffering_hintsTypes::HttpEndpointBufferingHints

The buffering options that can be used before data is delivered to the specified destination. Kinesis Data Firehose treats these options as hints, and it might choose to use more optimal values. The SizeInMBs and IntervalInSeconds parameters are optional. However, if you specify a value for one of them, you must also provide a value for the other.

Returns:

#cloud_watch_logging_optionsTypes::CloudWatchLoggingOptions

Describes the Amazon CloudWatch logging options for your delivery stream.

Returns:

#endpoint_configurationTypes::HttpEndpointConfiguration

The configuration of the HTTP endpoint selected as the destination.

Returns:

#processing_configurationTypes::ProcessingConfiguration

Describes a data processing configuration.

Returns:

#request_configurationTypes::HttpEndpointRequestConfiguration

The configuration of the requeste sent to the HTTP endpoint specified as the destination.

Returns:

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

  • (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_arnString

Kinesis Data Firehose uses this IAM role for all the permissions that the delivery stream needs.

Returns:

  • (String)

    Kinesis Data Firehose uses this IAM role for all the permissions that the delivery stream needs.

#s3_backup_modeString

Describes the S3 bucket backup options for the data that Kinesis Data 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).

Possible values:

  • FailedDataOnly
  • AllData

Returns:

  • (String)

    Describes the S3 bucket backup options for the data that Kinesis Data Firehose delivers to the HTTP endpoint destination.

#s3_configurationTypes::S3DestinationConfiguration

Describes the configuration of a destination in Amazon S3.

Returns: