Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. rds
  5. EventSubscription

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.rds.EventSubscription

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
pulumi/pulumi-aws-native

    The AWS::RDS::EventSubscription resource allows you to receive notifications for Amazon Relational Database Service events through the Amazon Simple Notification Service (Amazon SNS). For more information, see Using Amazon RDS Event Notification in the Amazon RDS User Guide.

    Create EventSubscription Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new EventSubscription(name: string, args: EventSubscriptionArgs, opts?: CustomResourceOptions);
    @overload
def EventSubscription(resource_name: str,
                      args: EventSubscriptionArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def EventSubscription(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      sns_topic_arn: Optional[str] = None,
                      enabled: Optional[bool] = None,
                      event_categories: Optional[Sequence[str]] = None,
                      source_ids: Optional[Sequence[str]] = None,
                      source_type: Optional[str] = None,
                      subscription_name: Optional[str] = None,
                      tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewEventSubscription(ctx *Context, name string, args EventSubscriptionArgs, opts ...ResourceOption) (*EventSubscription, error)
    public EventSubscription(string name, EventSubscriptionArgs args, CustomResourceOptions? opts = null)
    public EventSubscription(String name, EventSubscriptionArgs args)
public EventSubscription(String name, EventSubscriptionArgs args, CustomResourceOptions options)

    type: aws-native:rds:EventSubscription
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args EventSubscriptionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args EventSubscriptionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args EventSubscriptionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EventSubscriptionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EventSubscriptionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    EventSubscription Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The EventSubscription resource accepts the following input properties:

    SnsTopicArn 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.
    Enabled bool
    Specifies whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.
    EventCategories List<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.
    SourceIds List<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 a SourceIds value is 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.
    SourceType 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, 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
    SubscriptionName string
    The name of the subscription. Constraints: The name must be less than 255 characters.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An optional array of key-value pairs to apply to this subscription.
    SnsTopicArn 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.
    Enabled bool
    Specifies whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.
    EventCategories []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.
    SourceIds []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 a SourceIds value is 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.
    SourceType 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, 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
    SubscriptionName string
    The name of the subscription. Constraints: The name must be less than 255 characters.
    Tags TagArgs
    An optional array of key-value pairs to apply to this subscription.
    snsTopicArn 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.
    enabled Boolean
    Specifies whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.
    eventCategories List<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.
    sourceIds List<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 a SourceIds value is 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.
    sourceType 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, 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
    subscriptionName String
    The name of the subscription. Constraints: The name must be less than 255 characters.
    tags List<Tag>
    An optional array of key-value pairs to apply to this subscription.
    snsTopicArn 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.
    enabled boolean
    Specifies whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.
    eventCategories 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.
    sourceIds 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 a SourceIds value is 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.
    sourceType 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, 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
    subscriptionName string
    The name of the subscription. Constraints: The name must be less than 255 characters.
    tags Tag[]
    An optional array of key-value pairs to apply to this subscription.
    sns_topic_arn 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.
    enabled bool
    Specifies whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.
    event_categories Sequence[str]
    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 Sequence[str]
    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 a SourceIds value is 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.
    source_type 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, 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
    subscription_name str
    The name of the subscription. Constraints: The name must be less than 255 characters.
    tags Sequence[TagArgs]
    An optional array of key-value pairs to apply to this subscription.
    snsTopicArn 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.
    enabled Boolean
    Specifies whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.
    eventCategories List<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.
    sourceIds List<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 a SourceIds value is 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.
    sourceType 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, 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
    subscriptionName String
    The name of the subscription. Constraints: The name must be less than 255 characters.
    tags List<Property Map>
    An optional array of key-value pairs to apply to this subscription.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the EventSubscription resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
    pulumi/pulumi-aws-native