Skip to content

CreateEventSubscriptionMessage

Source code in docs_src/capo_neptune/types/create_event_subscription_message.py
class CreateEventSubscriptionMessage(TypedDict, closed=True):
    subscription_name: NotRequired["capo_neptune.types.string.String"]
    """<p>The name of the subscription.</p> <p>Constraints: The name must be less than 255 characters.</p>"""
    sns_topic_arn: NotRequired["capo_neptune.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_neptune.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. if this value is not specified, all events are returned.</p> <p>Valid values: <code>db-instance</code> | <code>db-cluster</code> | <code>db-parameter-group</code> | <code>db-security-group</code> | <code>db-snapshot</code> | <code>db-cluster-snapshot</code> </p>"""
    event_categories: NotRequired[
        "capo_neptune.types.event_categories_list.EventCategoriesList"
    ]
    """<p> A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType by using the <b>DescribeEventCategories</b> action.</p>"""
    source_ids: NotRequired["capo_neptune.types.source_ids_list.SourceIdsList"]
    """<p>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.</p> <p>Constraints:</p> <ul> <li> <p>If SourceIds are supplied, SourceType must also be provided.</p> </li> <li> <p>If the source type is a DB instance, then a <code>DBInstanceIdentifier</code> must be supplied.</p> </li> <li> <p>If the source type is a DB security group, a <code>DBSecurityGroupName</code> must be supplied.</p> </li> <li> <p>If the source type is a DB parameter group, a <code>DBParameterGroupName</code> must be supplied.</p> </li> <li> <p>If the source type is a DB snapshot, a <code>DBSnapshotIdentifier</code> must be supplied.</p> </li> </ul>"""
    enabled: NotRequired["capo_neptune.types.boolean_optional.BooleanOptional"]
    """<p> A Boolean value; set to <b>true</b> to activate the subscription, set to <b>false</b> to create the subscription but not activate it.</p>"""
    tags: NotRequired["capo_neptune.types.tag_list.TagList"]
    """<p>The tags to be applied to the new event subscription.</p>"""

enabled instance-attribute

enabled: NotRequired[BooleanOptional]

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

event_categories instance-attribute

event_categories: NotRequired[EventCategoriesList]

A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType by using the DescribeEventCategories action.

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_ids instance-attribute

source_ids: NotRequired[SourceIdsList]

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, then a DBInstanceIdentifier must be supplied.

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

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

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

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. if this value is not specified, all events are returned.

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

subscription_name instance-attribute

subscription_name: NotRequired[String]

The name of the subscription.

Constraints: The name must be less than 255 characters.

tags instance-attribute

tags: NotRequired[TagList]

The tags to be applied to the new event subscription.