Skip to content

Modify Event Subscription

redshift_modify_event_subscription R Documentation

Modifies an existing Amazon Redshift event notification subscription

Description

Modifies an existing Amazon Redshift event notification subscription.

Usage

redshift_modify_event_subscription(SubscriptionName, SnsTopicArn,
  SourceType, SourceIds, EventCategories, Severity, Enabled)

Arguments

SubscriptionName

[required] The name of the modified Amazon Redshift event notification subscription.

SnsTopicArn

The Amazon Resource Name (ARN) of the SNS topic to be used by the event notification subscription.

SourceType

The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your Amazon Web Services account. You must specify a source type in order to specify source IDs.

Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.

SourceIds

A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.

Example: my-cluster-1, my-cluster-2

Example: my-snapshot-20131010

EventCategories

Specifies the Amazon Redshift event categories to be published by the event notification subscription.

Values: configuration, management, monitoring, security, pending

Severity

Specifies the Amazon Redshift event severity to be published by the event notification subscription.

Values: ERROR, INFO

Enabled

A Boolean value indicating if the subscription is enabled. true indicates the subscription is enabled

Value

A list with the following syntax: 

list(
  EventSubscription = list(
    CustomerAwsId = "string",
    CustSubscriptionId = "string",
    SnsTopicArn = "string",
    Status = "string",
    SubscriptionCreationTime = as.POSIXct(
      "2015-01-01"
    ),
    SourceType = "string",
    SourceIdsList = list(
      "string"
    ),
    EventCategoriesList = list(
      "string"
    ),
    Severity = "string",
    Enabled = TRUE|FALSE,
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    )
  )
)

Request syntax

svc$modify_event_subscription(
  SubscriptionName = "string",
  SnsTopicArn = "string",
  SourceType = "string",
  SourceIds = list(
    "string"
  ),
  EventCategories = list(
    "string"
  ),
  Severity = "string",
  Enabled = TRUE|FALSE
)