Struct aws_sdk_rds::operation::create_event_subscription::CreateEventSubscriptionInput

#[non_exhaustive]
pub struct CreateEventSubscriptionInput {
    pub subscription_name: Option<String>,
    pub sns_topic_arn: Option<String>,
    pub source_type: Option<String>,
    pub event_categories: Option<Vec<String>>,
    pub source_ids: Option<Vec<String>>,
    pub enabled: Option<bool>,
    pub tags: Option<Vec<Tag>>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

subscription_name: Option<String>

The name of the subscription.

Constraints: The name must be less than 255 characters.

sns_topic_arn: Option<String>

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

RDS doesn't support FIFO (first in, first out) topics. For more information, see Message ordering and deduplication (FIFO topics) in the Amazon Simple Notification Service Developer Guide.

source_type: Option<String>

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 | zero-etl | custom-engine-version | blue-green-deployment

event_categories: Option<Vec<String>>

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.

source_ids: Option<Vec<String>>

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.

enabled: Option<bool>

Specifies whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.

tags: Option<Vec<Tag>>

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

Implementations

impl CreateEventSubscriptionInput

pub fn subscription_name(&self) -> Option<&str>

The name of the subscription.

Constraints: The name must be less than 255 characters.

pub fn sns_topic_arn(&self) -> Option<&str>

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

RDS doesn't support FIFO (first in, first out) topics. For more information, see Message ordering and deduplication (FIFO topics) in the Amazon Simple Notification Service Developer Guide.

pub fn source_type(&self) -> Option<&str>

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 | zero-etl | custom-engine-version | blue-green-deployment

pub fn event_categories(&self) -> &[String]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .event_categories.is_none().

pub fn source_ids(&self) -> &[String]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .source_ids.is_none().

pub fn enabled(&self) -> Option<bool>

Specifies whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.

pub fn tags(&self) -> &[Tag]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

impl CreateEventSubscriptionInput

pub fn builder() -> CreateEventSubscriptionInputBuilder

Creates a new builder-style object to manufacture CreateEventSubscriptionInput.

Trait Implementations

impl Clone for CreateEventSubscriptionInput

fn clone(&self) -> CreateEventSubscriptionInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateEventSubscriptionInput

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

Formats the value using the given formatter.

impl PartialEq for CreateEventSubscriptionInput

fn eq(&self, other: &CreateEventSubscriptionInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateEventSubscriptionInput