@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)
92 lines (91 loc) • 4.94 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Resource Type definition for AWS::Neptune::EventSubscription
*/
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;
/**
* A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
*/
readonly enabled: pulumi.Output<boolean | undefined>;
/**
* 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 in the Events topic in the Amazon Neptune User Guide or by using the DescribeEventCategories action.
*/
readonly eventCategories: pulumi.Output<string[] | undefined>;
/**
* 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.
*/
readonly snsTopicArn: pulumi.Output<string>;
/**
* The list of identifiers of the event sources for which events will be 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 cannot end with a hyphen or contain two consecutive hyphens.
*/
readonly sourceIds: pulumi.Output<string[] | undefined>;
/**
* The type of source that will be 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.
*/
readonly sourceType: pulumi.Output<string | undefined>;
/**
* The name of the subscription.
*/
readonly subscriptionName: pulumi.Output<string | undefined>;
/**
* An array of key-value pairs to apply to this resource.
*/
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 {
/**
* A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
*/
enabled?: pulumi.Input<boolean>;
/**
* 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 in the Events topic in the Amazon Neptune User Guide or by using the DescribeEventCategories action.
*/
eventCategories?: pulumi.Input<pulumi.Input<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.
*/
snsTopicArn: pulumi.Input<string>;
/**
* The list of identifiers of the event sources for which events will be 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 cannot end with a hyphen or contain two consecutive hyphens.
*/
sourceIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The type of source that will be 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.
*/
sourceType?: pulumi.Input<string>;
/**
* The name of the subscription.
*/
subscriptionName?: pulumi.Input<string>;
/**
* An array of key-value pairs to apply to this resource.
*/
tags?: pulumi.Input<pulumi.Input<inputs.TagArgs>[]>;
}