import * as pulumi from "@pulumi/pulumi"; /** * Provides a DB event subscription resource. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const _default = new aws.rds.Instance("default", { * allocatedStorage: 10, * engine: "mysql", * engineVersion: "5.6.17", * instanceClass: aws.rds.InstanceType.T2_Micro, * dbName: "mydb", * username: "foo", * password: "bar", * dbSubnetGroupName: "my_database_subnet_group", * parameterGroupName: "default.mysql5.6", * }); * const defaultTopic = new aws.sns.Topic("default", {name: "rds-events"}); * const defaultEventSubscription = new aws.rds.EventSubscription("default", { * name: "rds-event-sub", * snsTopic: defaultTopic.arn, * sourceType: "db-instance", * sourceIds: [_default.identifier], * eventCategories: [ * "availability", * "deletion", * "failover", * "failure", * "low storage", * "maintenance", * "notification", * "read replica", * "recovery", * "restoration", * ], * }); * ``` * * ## Import * * Using `pulumi import`, import DB Event Subscriptions using the `name`. For example: * * ```sh * $ pulumi import aws:rds/eventSubscription:EventSubscription default rds-event-sub * ``` */ 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 state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: EventSubscriptionState, 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; /** * ARN of the RDS event notification subscription */ readonly arn: pulumi.Output; /** * AWS customer account associated with the RDS event notification subscription */ readonly customerAwsId: pulumi.Output; /** * Boolean flag to enable/disable the subscription. Defaults to `true`. */ readonly enabled: pulumi.Output; /** * List of event categories for a SourceType that you want to subscribe to. See http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html or run `aws rds describe-event-categories`. */ readonly eventCategories: pulumi.Output; /** * Name of the DB event subscription. By default generated by Terraform. */ readonly name: pulumi.Output; /** * Creates a unique name beginning with the specified prefix. Conflicts with `name`. */ readonly namePrefix: pulumi.Output; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ readonly region: pulumi.Output; /** * SNS topic to send events to. */ readonly snsTopic: pulumi.Output; /** * List of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. If specified, a sourceType must also be specified. */ readonly sourceIds: pulumi.Output; /** * Type of source that will be generating the events. Valid options are `db-instance`, `db-parameter-group`, `db-security-group`, `db-snapshot`, `db-cluster`, `db-cluster-snapshot`, `custom-engine-version`, `db-proxy`, `blue-green-deployment`, `db-shard-group`, and `zero-etl`. If not set, all sources will be subscribed to. */ readonly sourceType: pulumi.Output; /** * Map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. */ readonly tags: pulumi.Output<{ [key: string]: string; } | undefined>; /** * Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. */ readonly tagsAll: pulumi.Output<{ [key: string]: string; }>; /** * 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); } /** * Input properties used for looking up and filtering EventSubscription resources. */ export interface EventSubscriptionState { /** * ARN of the RDS event notification subscription */ arn?: pulumi.Input; /** * AWS customer account associated with the RDS event notification subscription */ customerAwsId?: pulumi.Input; /** * Boolean flag to enable/disable the subscription. Defaults to `true`. */ enabled?: pulumi.Input; /** * List of event categories for a SourceType that you want to subscribe to. See http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html or run `aws rds describe-event-categories`. */ eventCategories?: pulumi.Input[] | undefined>; /** * Name of the DB event subscription. By default generated by Terraform. */ name?: pulumi.Input; /** * Creates a unique name beginning with the specified prefix. Conflicts with `name`. */ namePrefix?: pulumi.Input; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ region?: pulumi.Input; /** * SNS topic to send events to. */ snsTopic?: pulumi.Input; /** * List of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. If specified, a sourceType must also be specified. */ sourceIds?: pulumi.Input[] | undefined>; /** * Type of source that will be generating the events. Valid options are `db-instance`, `db-parameter-group`, `db-security-group`, `db-snapshot`, `db-cluster`, `db-cluster-snapshot`, `custom-engine-version`, `db-proxy`, `blue-green-deployment`, `db-shard-group`, and `zero-etl`. If not set, all sources will be subscribed to. */ sourceType?: pulumi.Input; /** * Map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. */ tagsAll?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; } /** * The set of arguments for constructing a EventSubscription resource. */ export interface EventSubscriptionArgs { /** * Boolean flag to enable/disable the subscription. Defaults to `true`. */ enabled?: pulumi.Input; /** * List of event categories for a SourceType that you want to subscribe to. See http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html or run `aws rds describe-event-categories`. */ eventCategories?: pulumi.Input[] | undefined>; /** * Name of the DB event subscription. By default generated by Terraform. */ name?: pulumi.Input; /** * Creates a unique name beginning with the specified prefix. Conflicts with `name`. */ namePrefix?: pulumi.Input; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ region?: pulumi.Input; /** * SNS topic to send events to. */ snsTopic: pulumi.Input; /** * List of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. If specified, a sourceType must also be specified. */ sourceIds?: pulumi.Input[] | undefined>; /** * Type of source that will be generating the events. Valid options are `db-instance`, `db-parameter-group`, `db-security-group`, `db-snapshot`, `db-cluster`, `db-cluster-snapshot`, `custom-engine-version`, `db-proxy`, `blue-green-deployment`, `db-shard-group`, and `zero-etl`. If not set, all sources will be subscribed to. */ sourceType?: pulumi.Input; /** * Map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; } //# sourceMappingURL=eventSubscription.d.ts.map