Struct vector::sources::aws_sqs::AwsSqsConfig

pub struct AwsSqsConfig {
    pub region: RegionOrEndpoint,
    pub auth: AwsAuthentication,
    pub queue_url: String,
    pub poll_secs: u32,
    pub client_concurrency: Option<NonZeroUsize>,
    pub framing: FramingConfig,
    pub decoding: DeserializerConfig,
    pub acknowledgements: SourceAcknowledgementsConfig,
    pub tls: Option<TlsConfig>,
    pub log_namespace: Option<bool>,
    /* private fields */
}

Configuration for the aws_sqs source.

Fields

region: RegionOrEndpoint

auth: AwsAuthentication

queue_url: String

The URL of the SQS queue to poll for messages.

poll_secs: u32

How long to wait while polling the queue for new messages, in seconds.

Generally, this should not be changed unless instructed to do so, as if messages are available, they are always consumed, regardless of the value of poll_secs.

client_concurrency: Option<NonZeroUsize>

Number of concurrent tasks to create for polling the queue for messages.

Defaults to the number of available CPUs on the system.

Should not typically need to be changed, but it can sometimes be beneficial to raise this value when there is a high rate of messages being pushed into the queue and the messages being fetched are small. In these cases, system resources may not be fully utilized without fetching more messages per second, as it spends more time fetching the messages than processing them.

framing: FramingConfig

decoding: DeserializerConfig

acknowledgements: SourceAcknowledgementsConfig

tls: Option<TlsConfig>

log_namespace: Option<bool>

The namespace to use for logs. This overrides the global setting.

Trait Implementations

impl Clone for AwsSqsConfig

fn clone(&self) -> AwsSqsConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Configurable for AwsSqsConfig

fn referenceable_name() -> Option<&'static str>

Gets the referenceable name of this value, if any.

fn metadata() -> Metadata

Gets the metadata for this value.

fn generate_schema( schema_gen: &RefCell<SchemaGenerator>, ) -> Result<SchemaObject, GenerateError>

Generates the schema for this value.

fn is_optional() -> bool

where Self: Sized,

Whether or not this value is optional.

fn validate_metadata(_metadata: &Metadata) -> Result<(), GenerateError>

where Self: Sized,

Validates the given metadata against this type.

fn as_configurable_ref() -> ConfigurableRef

where Self: Sized + 'static,

Create a new configurable reference table.

impl Debug for AwsSqsConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for AwsSqsConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AwsSqsConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl GenerateConfig for AwsSqsConfig

fn generate_config() -> Value

impl NamedComponent for AwsSqsConfig

fn get_component_name(&self) -> &'static str

Gets the name of the component.

impl Serialize for AwsSqsConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SourceConfig for AwsSqsConfig

fn build<'life0, 'async_trait>( &'life0 self, cx: SourceContext, ) -> Pin<Box<dyn Future<Output = Result<Source>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Builds the source with the given context.

fn outputs(&self, global_log_namespace: LogNamespace) -> Vec<SourceOutput>

Gets the list of outputs exposed by this source.

fn can_acknowledge(&self) -> bool

Whether or not this source can acknowledge the events it emits.

fn resources(&self) -> Vec<Resource>

Gets the list of resources, if any, used by this source.

impl ToValue for AwsSqsConfig

fn to_value(&self) -> Value

Convert this value into a serde_json::Value. Must not fail.