Skip to content

ModifyEventSubscriptionMessage

Source code in docs_src/capo_rds/types/modify_event_subscription_message.py
class ModifyEventSubscriptionMessage(TypedDict, closed=True):
    subscription_name: NotRequired["capo_rds.types.string.String"]
    """<p>The name of the RDS event notification subscription.</p>"""
    sns_topic_arn: NotRequired["capo_rds.types.string.String"]
    """<p>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.</p>"""
    source_type: NotRequired["capo_rds.types.string.String"]
    """<p>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 would set this parameter to db-instance. For RDS Proxy events, specify <code>db-proxy</code>. If this value isn't specified, all events are returned.</p> <p>Valid Values:<code> 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 </code> </p>"""
    event_categories: NotRequired[
        "capo_rds.types.event_categories_list.EventCategoriesList"
    ]
    """<p>A list of event categories for a source type (<code>SourceType</code>) that you want to subscribe to. You can see a list of the categories for a given source type in <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html">Events</a> in the <i>Amazon RDS User Guide</i> or by using the <code>DescribeEventCategories</code> operation.</p>"""
    enabled: NotRequired["capo_rds.types.boolean_optional.BooleanOptional"]
    """<p>Specifies whether to activate the subscription.</p>"""

enabled instance-attribute

enabled: NotRequired[BooleanOptional]

Specifies whether to activate the subscription.

event_categories instance-attribute

event_categories: NotRequired[EventCategoriesList]

A list of event categories for a source type (SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in Events in the Amazon RDS User Guide or by using the DescribeEventCategories operation.

sns_topic_arn instance-attribute

sns_topic_arn: NotRequired[String]

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.

source_type instance-attribute

source_type: NotRequired[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 would 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

subscription_name instance-attribute

subscription_name: NotRequired[String]

The name of the RDS event notification subscription.