@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
116 lines (115 loc) • 8.69 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* 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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html) in the *Amazon RDS User Guide*.
*/
export declare class EventSubscription extends pulumi.CustomResource {
/**
* Get an existing EventSubscription resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): EventSubscription;
/**
* Returns true if the given object is an instance of EventSubscription. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is EventSubscription;
/**
* Specifies whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.
*/
readonly enabled: pulumi.Output<boolean | undefined>;
/**
* 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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html) or the [Amazon Aurora User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html). You can also see this list by using the ``DescribeEventCategories`` operation.
*/
readonly eventCategories: pulumi.Output<string[] | undefined>;
/**
* 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)](https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html) in the *Amazon Simple Notification Service Developer Guide*.
*/
readonly snsTopicArn: pulumi.Output<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.
*/
readonly sourceIds: pulumi.Output<string[] | undefined>;
/**
* 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``
*/
readonly sourceType: pulumi.Output<string | undefined>;
/**
* The name of the subscription.
* Constraints: The name must be less than 255 characters.
*/
readonly subscriptionName: pulumi.Output<string | undefined>;
/**
* An optional array of key-value pairs to apply to this subscription.
*/
readonly tags: pulumi.Output<outputs.Tag[] | undefined>;
/**
* Create a EventSubscription resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: EventSubscriptionArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a EventSubscription resource.
*/
export interface EventSubscriptionArgs {
/**
* Specifies whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.
*/
enabled?: pulumi.Input<boolean>;
/**
* 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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html) or the [Amazon Aurora User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html). You can also see this list by using the ``DescribeEventCategories`` operation.
*/
eventCategories?: pulumi.Input<pulumi.Input<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)](https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html) in the *Amazon Simple Notification Service Developer Guide*.
*/
snsTopicArn: pulumi.Input<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.
*/
sourceIds?: pulumi.Input<pulumi.Input<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``
*/
sourceType?: pulumi.Input<string>;
/**
* The name of the subscription.
* Constraints: The name must be less than 255 characters.
*/
subscriptionName?: pulumi.Input<string>;
/**
* An optional array of key-value pairs to apply to this subscription.
*/
tags?: pulumi.Input<pulumi.Input<inputs.TagArgs>[]>;
}