class Aws::RDS::Types::CreateEventSubscriptionMessage
@note When making an API call, you may pass CreateEventSubscriptionMessage
data as a hash: { subscription_name: "String", # required sns_topic_arn: "String", # required source_type: "String", event_categories: ["String"], source_ids: ["String"], enabled: false, tags: [ { key: "String", value: "String", }, ], }
@!attribute [rw] subscription_name
The name of the subscription. Constraints: The name must be less than 255 characters. @return [String]
@!attribute [rw] sns_topic_arn
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. @return [String]
@!attribute [rw] source_type
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`. 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` @return [String]
@!attribute [rw] 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 [Events][1] in the *Amazon RDS User Guide* or by using the `DescribeEventCategories` operation. [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html @return [Array<String>]
@!attribute [rw] 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. @return [Array<String>]
@!attribute [rw] enabled
A value that indicates whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active. @return [Boolean]
@!attribute [rw] tags
A list of tags. For more information, see [Tagging Amazon RDS Resources][1] in the *Amazon RDS User Guide.* [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html @return [Array<Types::Tag>]
@see docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateEventSubscriptionMessage AWS API Documentation
Constants
- SENSITIVE