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

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

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.rds.getEventSubscription

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.103.0 published on Monday, Apr 22, 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.

    Using getEventSubscription

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getEventSubscription(args: GetEventSubscriptionArgs, opts?: InvokeOptions): Promise<GetEventSubscriptionResult>
function getEventSubscriptionOutput(args: GetEventSubscriptionOutputArgs, opts?: InvokeOptions): Output<GetEventSubscriptionResult>
    def get_event_subscription(subscription_name: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetEventSubscriptionResult
def get_event_subscription_output(subscription_name: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetEventSubscriptionResult]
    func LookupEventSubscription(ctx *Context, args *LookupEventSubscriptionArgs, opts ...InvokeOption) (*LookupEventSubscriptionResult, error)
func LookupEventSubscriptionOutput(ctx *Context, args *LookupEventSubscriptionOutputArgs, opts ...InvokeOption) LookupEventSubscriptionResultOutput

    > Note: This function is named LookupEventSubscription in the Go SDK.

    public static class GetEventSubscription 
{
    public static Task<GetEventSubscriptionResult> InvokeAsync(GetEventSubscriptionArgs args, InvokeOptions? opts = null)
    public static Output<GetEventSubscriptionResult> Invoke(GetEventSubscriptionInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetEventSubscriptionResult> getEventSubscription(GetEventSubscriptionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:rds:getEventSubscription
  arguments:
    # arguments dictionary

    The following arguments are supported:

    SubscriptionName string
    The name of the subscription.
    SubscriptionName string
    The name of the subscription.
    subscriptionName String
    The name of the subscription.
    subscriptionName string
    The name of the subscription.
    subscription_name str
    The name of the subscription.
    subscriptionName String
    The name of the subscription.

    getEventSubscription Result

    The following output properties are available:

    Enabled bool
    A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
    EventCategories List<string>
    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 RDS User Guide or by using the DescribeEventCategories action.
    SourceIds List<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.
    SourceType 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.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this resource.
    Enabled bool
    A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
    EventCategories []string
    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 RDS User Guide or by using the DescribeEventCategories action.
    SourceIds []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.
    SourceType 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.
    Tags Tag
    An array of key-value pairs to apply to this resource.
    enabled Boolean
    A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
    eventCategories List<String>
    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 RDS User Guide or by using the DescribeEventCategories action.
    sourceIds List<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.
    sourceType 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.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    enabled boolean
    A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
    eventCategories string[]
    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 RDS User Guide or by using the DescribeEventCategories action.
    sourceIds 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.
    sourceType 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.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    enabled bool
    A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
    event_categories Sequence[str]
    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 RDS User Guide or by using the DescribeEventCategories action.
    source_ids Sequence[str]
    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.
    source_type str
    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.
    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource.
    enabled Boolean
    A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
    eventCategories List<String>
    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 RDS User Guide or by using the DescribeEventCategories action.
    sourceIds List<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.
    sourceType 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.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Supporting Types

    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 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.103.0 published on Monday, Apr 22, 2024 by Pulumi
    pulumi/pulumi-aws-native