// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct UpdateSubscriberInput {
/// The Amazon Resource Name (ARN) that uniquely identifies a subscriber.
pub subscriber_arn: ::std::option::Option<::std::string::String>,
/// Free-text description. Used by every resource type that has one: event buses, subscribers, and event sources.
pub description: ::std::option::Option<::std::string::String>,
/// Customer-controlled run state of a subscriber, set on create or update. Distinct from the bus lifecycle vocabulary, where ACTIVE means "provisioned and healthy". Delivery requires State RUNNING on a subscriber that is not revoked.
pub state: ::std::option::Option<crate::types::SubscriberState>,
/// Position from which delivery resumes when a subscriber is unpaused. Honored only on an UpdateSubscriber call that transitions State from STOPPED to RUNNING (unpause); ignored on any other call and not accepted on Create. Defaults to LAST_PROCESSED when omitted.
pub resume_position: ::std::option::Option<crate::types::ResumePosition>,
/// Update-able configuration for how the subscriber invokes its target.
pub invoke_configuration: ::std::option::Option<crate::types::UpdateInvokeConfiguration>,
/// Configuration for filtering events delivered to a subscriber. On CreateSubscriber, Filters is required and must contain at least one Filter with a non-empty Pattern. On UpdateSubscriber, an empty `FilterConfiguration:{}` clears the existing filter. Any non-empty shape (including `{Language:X}` without Filters) must contain a valid Filters list — same contract as CreateSubscriber. A non-empty Filters list overwrites; an omitted FilterConfiguration preserves existing state. All Filters are implicitly ANDed — an event must match every Filter to be delivered.
pub filter_configuration: ::std::option::Option<crate::types::FilterConfiguration>,
/// Batching configuration for a subscriber.
pub batch_configuration: ::std::option::Option<crate::types::BatchConfiguration>,
/// Not applicable to universal (aws-sdk) targets, whose input transformation is UniversalTargetParameters.Input; a Transformer on such a target is rejected.
pub transformer: ::std::option::Option<crate::types::Transformer>,
/// Retry policy for a subscriber.
pub retry_policy: ::std::option::Option<crate::types::RetryPolicy>,
/// On-failure configuration: where a failed delivery is sent. Shared by the subscriber and the EventSource.
pub on_failure_configuration: ::std::option::Option<crate::types::OnFailureConfiguration>,
/// Log configuration for a subscriber.
pub log_configuration: ::std::option::Option<crate::types::LogConfiguration>,
}
impl UpdateSubscriberInput {
/// The Amazon Resource Name (ARN) that uniquely identifies a subscriber.
pub fn subscriber_arn(&self) -> ::std::option::Option<&str> {
self.subscriber_arn.as_deref()
}
/// Free-text description. Used by every resource type that has one: event buses, subscribers, and event sources.
pub fn description(&self) -> ::std::option::Option<&str> {
self.description.as_deref()
}
/// Customer-controlled run state of a subscriber, set on create or update. Distinct from the bus lifecycle vocabulary, where ACTIVE means "provisioned and healthy". Delivery requires State RUNNING on a subscriber that is not revoked.
pub fn state(&self) -> ::std::option::Option<&crate::types::SubscriberState> {
self.state.as_ref()
}
/// Position from which delivery resumes when a subscriber is unpaused. Honored only on an UpdateSubscriber call that transitions State from STOPPED to RUNNING (unpause); ignored on any other call and not accepted on Create. Defaults to LAST_PROCESSED when omitted.
pub fn resume_position(&self) -> ::std::option::Option<&crate::types::ResumePosition> {
self.resume_position.as_ref()
}
/// Update-able configuration for how the subscriber invokes its target.
pub fn invoke_configuration(&self) -> ::std::option::Option<&crate::types::UpdateInvokeConfiguration> {
self.invoke_configuration.as_ref()
}
/// Configuration for filtering events delivered to a subscriber. On CreateSubscriber, Filters is required and must contain at least one Filter with a non-empty Pattern. On UpdateSubscriber, an empty `FilterConfiguration:{}` clears the existing filter. Any non-empty shape (including `{Language:X}` without Filters) must contain a valid Filters list — same contract as CreateSubscriber. A non-empty Filters list overwrites; an omitted FilterConfiguration preserves existing state. All Filters are implicitly ANDed — an event must match every Filter to be delivered.
pub fn filter_configuration(&self) -> ::std::option::Option<&crate::types::FilterConfiguration> {
self.filter_configuration.as_ref()
}
/// Batching configuration for a subscriber.
pub fn batch_configuration(&self) -> ::std::option::Option<&crate::types::BatchConfiguration> {
self.batch_configuration.as_ref()
}
/// Not applicable to universal (aws-sdk) targets, whose input transformation is UniversalTargetParameters.Input; a Transformer on such a target is rejected.
pub fn transformer(&self) -> ::std::option::Option<&crate::types::Transformer> {
self.transformer.as_ref()
}
/// Retry policy for a subscriber.
pub fn retry_policy(&self) -> ::std::option::Option<&crate::types::RetryPolicy> {
self.retry_policy.as_ref()
}
/// On-failure configuration: where a failed delivery is sent. Shared by the subscriber and the EventSource.
pub fn on_failure_configuration(&self) -> ::std::option::Option<&crate::types::OnFailureConfiguration> {
self.on_failure_configuration.as_ref()
}
/// Log configuration for a subscriber.
pub fn log_configuration(&self) -> ::std::option::Option<&crate::types::LogConfiguration> {
self.log_configuration.as_ref()
}
}
impl UpdateSubscriberInput {
/// Creates a new builder-style object to manufacture [`UpdateSubscriberInput`](crate::operation::update_subscriber::UpdateSubscriberInput).
pub fn builder() -> crate::operation::update_subscriber::builders::UpdateSubscriberInputBuilder {
crate::operation::update_subscriber::builders::UpdateSubscriberInputBuilder::default()
}
}
/// A builder for [`UpdateSubscriberInput`](crate::operation::update_subscriber::UpdateSubscriberInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct UpdateSubscriberInputBuilder {
pub(crate) subscriber_arn: ::std::option::Option<::std::string::String>,
pub(crate) description: ::std::option::Option<::std::string::String>,
pub(crate) state: ::std::option::Option<crate::types::SubscriberState>,
pub(crate) resume_position: ::std::option::Option<crate::types::ResumePosition>,
pub(crate) invoke_configuration: ::std::option::Option<crate::types::UpdateInvokeConfiguration>,
pub(crate) filter_configuration: ::std::option::Option<crate::types::FilterConfiguration>,
pub(crate) batch_configuration: ::std::option::Option<crate::types::BatchConfiguration>,
pub(crate) transformer: ::std::option::Option<crate::types::Transformer>,
pub(crate) retry_policy: ::std::option::Option<crate::types::RetryPolicy>,
pub(crate) on_failure_configuration: ::std::option::Option<crate::types::OnFailureConfiguration>,
pub(crate) log_configuration: ::std::option::Option<crate::types::LogConfiguration>,
}
impl UpdateSubscriberInputBuilder {
/// The Amazon Resource Name (ARN) that uniquely identifies a subscriber.
/// This field is required.
pub fn subscriber_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.subscriber_arn = ::std::option::Option::Some(input.into());
self
}
/// The Amazon Resource Name (ARN) that uniquely identifies a subscriber.
pub fn set_subscriber_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.subscriber_arn = input;
self
}
/// The Amazon Resource Name (ARN) that uniquely identifies a subscriber.
pub fn get_subscriber_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.subscriber_arn
}
/// Free-text description. Used by every resource type that has one: event buses, subscribers, and event sources.
pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.description = ::std::option::Option::Some(input.into());
self
}
/// Free-text description. Used by every resource type that has one: event buses, subscribers, and event sources.
pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.description = input;
self
}
/// Free-text description. Used by every resource type that has one: event buses, subscribers, and event sources.
pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
&self.description
}
/// Customer-controlled run state of a subscriber, set on create or update. Distinct from the bus lifecycle vocabulary, where ACTIVE means "provisioned and healthy". Delivery requires State RUNNING on a subscriber that is not revoked.
pub fn state(mut self, input: crate::types::SubscriberState) -> Self {
self.state = ::std::option::Option::Some(input);
self
}
/// Customer-controlled run state of a subscriber, set on create or update. Distinct from the bus lifecycle vocabulary, where ACTIVE means "provisioned and healthy". Delivery requires State RUNNING on a subscriber that is not revoked.
pub fn set_state(mut self, input: ::std::option::Option<crate::types::SubscriberState>) -> Self {
self.state = input;
self
}
/// Customer-controlled run state of a subscriber, set on create or update. Distinct from the bus lifecycle vocabulary, where ACTIVE means "provisioned and healthy". Delivery requires State RUNNING on a subscriber that is not revoked.
pub fn get_state(&self) -> &::std::option::Option<crate::types::SubscriberState> {
&self.state
}
/// Position from which delivery resumes when a subscriber is unpaused. Honored only on an UpdateSubscriber call that transitions State from STOPPED to RUNNING (unpause); ignored on any other call and not accepted on Create. Defaults to LAST_PROCESSED when omitted.
pub fn resume_position(mut self, input: crate::types::ResumePosition) -> Self {
self.resume_position = ::std::option::Option::Some(input);
self
}
/// Position from which delivery resumes when a subscriber is unpaused. Honored only on an UpdateSubscriber call that transitions State from STOPPED to RUNNING (unpause); ignored on any other call and not accepted on Create. Defaults to LAST_PROCESSED when omitted.
pub fn set_resume_position(mut self, input: ::std::option::Option<crate::types::ResumePosition>) -> Self {
self.resume_position = input;
self
}
/// Position from which delivery resumes when a subscriber is unpaused. Honored only on an UpdateSubscriber call that transitions State from STOPPED to RUNNING (unpause); ignored on any other call and not accepted on Create. Defaults to LAST_PROCESSED when omitted.
pub fn get_resume_position(&self) -> &::std::option::Option<crate::types::ResumePosition> {
&self.resume_position
}
/// Update-able configuration for how the subscriber invokes its target.
pub fn invoke_configuration(mut self, input: crate::types::UpdateInvokeConfiguration) -> Self {
self.invoke_configuration = ::std::option::Option::Some(input);
self
}
/// Update-able configuration for how the subscriber invokes its target.
pub fn set_invoke_configuration(mut self, input: ::std::option::Option<crate::types::UpdateInvokeConfiguration>) -> Self {
self.invoke_configuration = input;
self
}
/// Update-able configuration for how the subscriber invokes its target.
pub fn get_invoke_configuration(&self) -> &::std::option::Option<crate::types::UpdateInvokeConfiguration> {
&self.invoke_configuration
}
/// Configuration for filtering events delivered to a subscriber. On CreateSubscriber, Filters is required and must contain at least one Filter with a non-empty Pattern. On UpdateSubscriber, an empty `FilterConfiguration:{}` clears the existing filter. Any non-empty shape (including `{Language:X}` without Filters) must contain a valid Filters list — same contract as CreateSubscriber. A non-empty Filters list overwrites; an omitted FilterConfiguration preserves existing state. All Filters are implicitly ANDed — an event must match every Filter to be delivered.
pub fn filter_configuration(mut self, input: crate::types::FilterConfiguration) -> Self {
self.filter_configuration = ::std::option::Option::Some(input);
self
}
/// Configuration for filtering events delivered to a subscriber. On CreateSubscriber, Filters is required and must contain at least one Filter with a non-empty Pattern. On UpdateSubscriber, an empty `FilterConfiguration:{}` clears the existing filter. Any non-empty shape (including `{Language:X}` without Filters) must contain a valid Filters list — same contract as CreateSubscriber. A non-empty Filters list overwrites; an omitted FilterConfiguration preserves existing state. All Filters are implicitly ANDed — an event must match every Filter to be delivered.
pub fn set_filter_configuration(mut self, input: ::std::option::Option<crate::types::FilterConfiguration>) -> Self {
self.filter_configuration = input;
self
}
/// Configuration for filtering events delivered to a subscriber. On CreateSubscriber, Filters is required and must contain at least one Filter with a non-empty Pattern. On UpdateSubscriber, an empty `FilterConfiguration:{}` clears the existing filter. Any non-empty shape (including `{Language:X}` without Filters) must contain a valid Filters list — same contract as CreateSubscriber. A non-empty Filters list overwrites; an omitted FilterConfiguration preserves existing state. All Filters are implicitly ANDed — an event must match every Filter to be delivered.
pub fn get_filter_configuration(&self) -> &::std::option::Option<crate::types::FilterConfiguration> {
&self.filter_configuration
}
/// Batching configuration for a subscriber.
pub fn batch_configuration(mut self, input: crate::types::BatchConfiguration) -> Self {
self.batch_configuration = ::std::option::Option::Some(input);
self
}
/// Batching configuration for a subscriber.
pub fn set_batch_configuration(mut self, input: ::std::option::Option<crate::types::BatchConfiguration>) -> Self {
self.batch_configuration = input;
self
}
/// Batching configuration for a subscriber.
pub fn get_batch_configuration(&self) -> &::std::option::Option<crate::types::BatchConfiguration> {
&self.batch_configuration
}
/// Not applicable to universal (aws-sdk) targets, whose input transformation is UniversalTargetParameters.Input; a Transformer on such a target is rejected.
pub fn transformer(mut self, input: crate::types::Transformer) -> Self {
self.transformer = ::std::option::Option::Some(input);
self
}
/// Not applicable to universal (aws-sdk) targets, whose input transformation is UniversalTargetParameters.Input; a Transformer on such a target is rejected.
pub fn set_transformer(mut self, input: ::std::option::Option<crate::types::Transformer>) -> Self {
self.transformer = input;
self
}
/// Not applicable to universal (aws-sdk) targets, whose input transformation is UniversalTargetParameters.Input; a Transformer on such a target is rejected.
pub fn get_transformer(&self) -> &::std::option::Option<crate::types::Transformer> {
&self.transformer
}
/// Retry policy for a subscriber.
pub fn retry_policy(mut self, input: crate::types::RetryPolicy) -> Self {
self.retry_policy = ::std::option::Option::Some(input);
self
}
/// Retry policy for a subscriber.
pub fn set_retry_policy(mut self, input: ::std::option::Option<crate::types::RetryPolicy>) -> Self {
self.retry_policy = input;
self
}
/// Retry policy for a subscriber.
pub fn get_retry_policy(&self) -> &::std::option::Option<crate::types::RetryPolicy> {
&self.retry_policy
}
/// On-failure configuration: where a failed delivery is sent. Shared by the subscriber and the EventSource.
pub fn on_failure_configuration(mut self, input: crate::types::OnFailureConfiguration) -> Self {
self.on_failure_configuration = ::std::option::Option::Some(input);
self
}
/// On-failure configuration: where a failed delivery is sent. Shared by the subscriber and the EventSource.
pub fn set_on_failure_configuration(mut self, input: ::std::option::Option<crate::types::OnFailureConfiguration>) -> Self {
self.on_failure_configuration = input;
self
}
/// On-failure configuration: where a failed delivery is sent. Shared by the subscriber and the EventSource.
pub fn get_on_failure_configuration(&self) -> &::std::option::Option<crate::types::OnFailureConfiguration> {
&self.on_failure_configuration
}
/// Log configuration for a subscriber.
pub fn log_configuration(mut self, input: crate::types::LogConfiguration) -> Self {
self.log_configuration = ::std::option::Option::Some(input);
self
}
/// Log configuration for a subscriber.
pub fn set_log_configuration(mut self, input: ::std::option::Option<crate::types::LogConfiguration>) -> Self {
self.log_configuration = input;
self
}
/// Log configuration for a subscriber.
pub fn get_log_configuration(&self) -> &::std::option::Option<crate::types::LogConfiguration> {
&self.log_configuration
}
/// Consumes the builder and constructs a [`UpdateSubscriberInput`](crate::operation::update_subscriber::UpdateSubscriberInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::update_subscriber::UpdateSubscriberInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::update_subscriber::UpdateSubscriberInput {
subscriber_arn: self.subscriber_arn,
description: self.description,
state: self.state,
resume_position: self.resume_position,
invoke_configuration: self.invoke_configuration,
filter_configuration: self.filter_configuration,
batch_configuration: self.batch_configuration,
transformer: self.transformer,
retry_policy: self.retry_policy,
on_failure_configuration: self.on_failure_configuration,
log_configuration: self.log_configuration,
})
}
}