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

Inherits:

Struct

• Object
• Struct
• Aws::Firehose::Types::HttpEndpointDestinationConfiguration

Defined in:

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

Overview

Describes the configuration of the HTTP endpoint destination.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #buffering_hints ⇒ Types::HttpEndpointBufferingHints

  The buffering options that can be used before data is delivered to the specified destination.

• #cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions

  Describes the Amazon CloudWatch logging options for your Firehose stream.

• #endpoint_configuration ⇒ Types::HttpEndpointConfiguration

  The configuration of the HTTP endpoint selected as the destination.

• #processing_configuration ⇒ Types::ProcessingConfiguration

  Describes a data processing configuration.

• #request_configuration ⇒ Types::HttpEndpointRequestConfiguration

  The configuration of the request sent to the HTTP endpoint that is specified as the destination.

• #retry_options ⇒ Types::HttpEndpointRetryOptions

  Describes the retry behavior in case 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

  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 Firehose delivers to the HTTP endpoint destination.

• #s3_configuration ⇒ Types::S3DestinationConfiguration

  Describes the configuration of a destination in Amazon S3.

• #secrets_manager_configuration ⇒ Types::SecretsManagerConfiguration

  The configuration that defines how you access secrets for HTTP Endpoint destination.

Instance Attribute Details

#buffering_hints ⇒ Types::HttpEndpointBufferingHints

The buffering options that can be used before data is delivered to the specified destination. 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:

• (Types::HttpEndpointBufferingHints)

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

class HttpEndpointDestinationConfiguration < Struct.new(
  :endpoint_configuration,
  :buffering_hints,
  :cloud_watch_logging_options,
  :request_configuration,
  :processing_configuration,
  :role_arn,
  :retry_options,
  :s3_backup_mode,
  :s3_configuration,
  :secrets_manager_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions

Describes the Amazon CloudWatch logging options for your Firehose stream.

Returns:

• (Types::CloudWatchLoggingOptions)

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

class HttpEndpointDestinationConfiguration < Struct.new(
  :endpoint_configuration,
  :buffering_hints,
  :cloud_watch_logging_options,
  :request_configuration,
  :processing_configuration,
  :role_arn,
  :retry_options,
  :s3_backup_mode,
  :s3_configuration,
  :secrets_manager_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_configuration ⇒ Types::HttpEndpointConfiguration

The configuration of the HTTP endpoint selected as the destination.

Returns:

• (Types::HttpEndpointConfiguration)

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

class HttpEndpointDestinationConfiguration < Struct.new(
  :endpoint_configuration,
  :buffering_hints,
  :cloud_watch_logging_options,
  :request_configuration,
  :processing_configuration,
  :role_arn,
  :retry_options,
  :s3_backup_mode,
  :s3_configuration,
  :secrets_manager_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#processing_configuration ⇒ Types::ProcessingConfiguration

Describes a data processing configuration.

Returns:

• (Types::ProcessingConfiguration)

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

class HttpEndpointDestinationConfiguration < Struct.new(
  :endpoint_configuration,
  :buffering_hints,
  :cloud_watch_logging_options,
  :request_configuration,
  :processing_configuration,
  :role_arn,
  :retry_options,
  :s3_backup_mode,
  :s3_configuration,
  :secrets_manager_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#request_configuration ⇒ Types::HttpEndpointRequestConfiguration

The configuration of the request sent to the HTTP endpoint that is specified as the destination.

Returns:

• (Types::HttpEndpointRequestConfiguration)

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

class HttpEndpointDestinationConfiguration < Struct.new(
  :endpoint_configuration,
  :buffering_hints,
  :cloud_watch_logging_options,
  :request_configuration,
  :processing_configuration,
  :role_arn,
  :retry_options,
  :s3_backup_mode,
  :s3_configuration,
  :secrets_manager_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#retry_options ⇒ Types::HttpEndpointRetryOptions

Describes the retry behavior in case 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)

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

class HttpEndpointDestinationConfiguration < Struct.new(
  :endpoint_configuration,
  :buffering_hints,
  :cloud_watch_logging_options,
  :request_configuration,
  :processing_configuration,
  :role_arn,
  :retry_options,
  :s3_backup_mode,
  :s3_configuration,
  :secrets_manager_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

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

Returns:

• (String)

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

class HttpEndpointDestinationConfiguration < Struct.new(
  :endpoint_configuration,
  :buffering_hints,
  :cloud_watch_logging_options,
  :request_configuration,
  :processing_configuration,
  :role_arn,
  :retry_options,
  :s3_backup_mode,
  :s3_configuration,
  :secrets_manager_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#s3_backup_mode ⇒ String

Describes the S3 bucket backup options for the data that Firehose delivers to the HTTP endpoint destination. You can back up all documents (AllData) or only the documents that Firehose could not deliver to the specified HTTP endpoint destination (FailedDataOnly).

Returns:

• (String)

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

class HttpEndpointDestinationConfiguration < Struct.new(
  :endpoint_configuration,
  :buffering_hints,
  :cloud_watch_logging_options,
  :request_configuration,
  :processing_configuration,
  :role_arn,
  :retry_options,
  :s3_backup_mode,
  :s3_configuration,
  :secrets_manager_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#s3_configuration ⇒ Types::S3DestinationConfiguration

Describes the configuration of a destination in Amazon S3.

Returns:

• (Types::S3DestinationConfiguration)

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

class HttpEndpointDestinationConfiguration < Struct.new(
  :endpoint_configuration,
  :buffering_hints,
  :cloud_watch_logging_options,
  :request_configuration,
  :processing_configuration,
  :role_arn,
  :retry_options,
  :s3_backup_mode,
  :s3_configuration,
  :secrets_manager_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#secrets_manager_configuration ⇒ Types::SecretsManagerConfiguration

The configuration that defines how you access secrets for HTTP Endpoint destination.

Returns:

• (Types::SecretsManagerConfiguration)

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

class HttpEndpointDestinationConfiguration < Struct.new(
  :endpoint_configuration,
  :buffering_hints,
  :cloud_watch_logging_options,
  :request_configuration,
  :processing_configuration,
  :role_arn,
  :retry_options,
  :s3_backup_mode,
  :s3_configuration,
  :secrets_manager_configuration)
  SENSITIVE = []
  include Aws::Structure
end