Struct aws_sdk_docdb::client::fluent_builders::CreateEventSubscription

pub struct CreateEventSubscription<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to CreateEventSubscription.

Creates an Amazon DocumentDB event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the Amazon SNS console.

You can specify the type of source (SourceType) that you want to be notified of. You can also provide a list of Amazon DocumentDB sources (SourceIds) that trigger the events, and you can provide a list of event categories (EventCategories) for events that you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.

If you specify both the SourceType and SourceIds (such as SourceType = db-instance and SourceIdentifier = myDBInstance1), you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Amazon DocumentDB sources. If you do not specify either the SourceType or the SourceIdentifier, you are notified of events generated from all Amazon DocumentDB sources belonging to your customer account.

Implementations

impl<C, M, R> CreateEventSubscription<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<CreateEventSubscriptionOutput, SdkError<CreateEventSubscriptionError>> where
    R::Policy: SmithyRetryPolicy<CreateEventSubscriptionInputOperationOutputAlias, CreateEventSubscriptionOutput, CreateEventSubscriptionError, CreateEventSubscriptionInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn subscription_name(self, input: impl Into<String>) -> Self

The name of the subscription.

Constraints: The name must be fewer than 255 characters.

pub fn set_subscription_name(self, input: Option<String>) -> Self

The name of the subscription.

Constraints: The name must be fewer than 255 characters.

pub fn sns_topic_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the SNS topic created for event notification. Amazon SNS creates the ARN when you create a topic and subscribe to it.

pub fn set_sns_topic_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the SNS topic created for event notification. Amazon SNS creates the ARN when you create a topic and subscribe to it.

pub fn source_type(self, input: impl Into<String>) -> Self

The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, you would set this parameter to db-instance. If this value is not specified, all events are returned.

Valid values: db-instance, db-cluster, db-parameter-group, db-security-group, db-cluster-snapshot

pub fn set_source_type(self, input: Option<String>) -> Self

The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, you would set this parameter to db-instance. If this value is not specified, all events are returned.

Valid values: db-instance, db-cluster, db-parameter-group, db-security-group, db-cluster-snapshot

pub fn event_categories(self, input: impl Into<String>) -> Self

Appends an item to EventCategories.

To override the contents of this collection use set_event_categories.

A list of event categories for a SourceType that you want to subscribe to.

pub fn set_event_categories(self, input: Option<Vec<String>>) -> Self

A list of event categories for a SourceType that you want to subscribe to.

pub fn source_ids(self, input: impl Into<String>) -> Self

Appends an item to SourceIds.

To override the contents of this collection use set_source_ids.

The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

Constraints:

• If SourceIds are provided, SourceType must also be provided.

• If the source type is an instance, a DBInstanceIdentifier must be provided.

• If the source type is a security group, a DBSecurityGroupName must be provided.

• If the source type is a parameter group, a DBParameterGroupName must be provided.

• If the source type is a snapshot, a DBSnapshotIdentifier must be provided.

pub fn set_source_ids(self, input: Option<Vec<String>>) -> Self

The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

Constraints:

• If SourceIds are provided, SourceType must also be provided.

• If the source type is an instance, a DBInstanceIdentifier must be provided.

• If the source type is a security group, a DBSecurityGroupName must be provided.

• If the source type is a parameter group, a DBParameterGroupName must be provided.

• If the source type is a snapshot, a DBSnapshotIdentifier must be provided.

pub fn enabled(self, input: bool) -> Self

A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

pub fn set_enabled(self, input: Option<bool>) -> Self

A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

pub fn tags(self, input: Tag) -> Self

Appends an item to Tags.

To override the contents of this collection use set_tags.

The tags to be assigned to the event subscription.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

The tags to be assigned to the event subscription.

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for CreateEventSubscription<C, M, R>

fn clone(&self) -> CreateEventSubscription<C, M, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for CreateEventSubscription<C, M, R>

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

Formats the value using the given formatter.