Struct aws_sdk_rds::client::fluent_builders::CreateEventSubscription

pub struct CreateEventSubscription { /* private fields */ }

Fluent builder constructing a request to CreateEventSubscription.

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

You can specify the type of source (SourceType) that you want to be notified of and provide a list of RDS sources (SourceIds) that triggers the events. You can also 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 SourceIds = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify SourceIds, you receive notice of the events for that source type for all your RDS sources. If you don't specify either the SourceType or the SourceIds, you are notified of events generated from all RDS sources belonging to your customer account.

RDS event notification is only available for unencrypted SNS topics. If you specify an encrypted SNS topic, event notifications aren't sent for the topic.

Implementations

impl CreateEventSubscription

pub async fn send(
    self
) -> Result<CreateEventSubscriptionOutput, SdkError<CreateEventSubscriptionError>>

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 less than 255 characters.

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

The name of the subscription.

Constraints: The name must be less 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. The ARN is created by Amazon SNS 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. The ARN is created by Amazon SNS 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 a DB instance, you set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are returned.

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy

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 a DB instance, you set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are returned.

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy

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 particular source type (SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide or the Amazon Aurora User Guide . You can also see this list by using the DescribeEventCategories operation.

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

A list of event categories for a particular source type (SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide or the Amazon Aurora User Guide . You can also see this list by using the DescribeEventCategories operation.

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 supplied, SourceType must also be provided.

• If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

• If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

• If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

• If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

• If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

• If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

• If the source type is an RDS Proxy, a DBProxyName value must be supplied.

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 supplied, SourceType must also be provided.

• If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

• If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

• If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

• If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

• If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

• If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

• If the source type is an RDS Proxy, a DBProxyName value must be supplied.

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

A value that indicates whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.

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

A value that indicates whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.

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

Appends an item to Tags.

To override the contents of this collection use set_tags.

A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

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

A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

Trait Implementations

impl Clone for CreateEventSubscription

fn clone(&self) -> CreateEventSubscription

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateEventSubscription

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

Formats the value using the given formatter.