AWS Native

Pulumi Official
Package maintained by Pulumi
v0.19.0 published on Wednesday, Jun 8, 2022 by Pulumi

getEventSubscription

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 Pulumi.AwsNative.RDS.EventSubscriptionSourceType

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.

SubscriptionName string

The name of the subscription.

Tags List<Pulumi.AwsNative.RDS.Outputs.EventSubscriptionTag>

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 EventSubscriptionSourceType

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.

SubscriptionName string

The name of the subscription.

Tags []EventSubscriptionTag

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 EventSubscriptionSourceType

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.

subscriptionName String

The name of the subscription.

tags List<EventSubscriptionTag>

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 EventSubscriptionSourceType

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.

subscriptionName string

The name of the subscription.

tags EventSubscriptionTag[]

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 EventSubscriptionSourceType

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.

subscription_name str

The name of the subscription.

tags Sequence[EventSubscriptionTag]

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 "custom-engine-version" | "db-cluster" | "db-cluster-snapshot" | "db-instance" | "db-proxy" | "db-parameter-group" | "db-security-group" | "db-snapshot"

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.

subscriptionName String

The name of the subscription.

tags List<Property Map>

An array of key-value pairs to apply to this resource.

Supporting Types

EventSubscriptionSourceType

EventSubscriptionTag

Key string

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Value string

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Key string

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Value string

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value String

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key string

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value string

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key str

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value str

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value String

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0