Struct aws_sdk_redshift::client::fluent_builders::CreateEventSubscription

pub struct CreateEventSubscription { /* private fields */ }

Fluent builder constructing a request to CreateEventSubscription.

Creates an Amazon Redshift event notification subscription. This action requires an ARN (Amazon Resource Name) of an Amazon SNS topic created by either the Amazon Redshift console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.

You can specify the source type, and lists of Amazon Redshift source IDs, event categories, and event severities. Notifications will be sent for all events you want that match those criteria. For example, you can specify source type = cluster, source ID = my-cluster-1 and mycluster2, event categories = Availability, Backup, and severity = ERROR. The subscription will only send notifications for those ERROR events in the Availability and Backup categories for the specified clusters.

If you specify both the source type and source IDs, such as source type = cluster and source identifier = my-cluster-1, notifications will be sent for all the cluster events for my-cluster-1. If you specify a source type but do not specify a source identifier, you will receive notice of the events for the objects of that type in your Amazon Web Services account. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all Amazon Redshift sources belonging to your Amazon Web Services account. You must specify a source type if you specify a source ID.

Implementations

impl CreateEventSubscription

pub async fn send(
    self
) -> Result<CreateEventSubscriptionOutput, SdkError<CreateEventSubscriptionError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn subscription_name(self, input: impl Into<String>) -> Self

The name of the event subscription to be created.

Constraints:

• Cannot be null, empty, or blank.

• Must contain from 1 to 255 alphanumeric characters or hyphens.

• First character must be a letter.

• Cannot end with a hyphen or contain two consecutive hyphens.

pub fn set_subscription_name(self, input: Option<String>) -> Self

The name of the event subscription to be created.

Constraints:

• Cannot be null, empty, or blank.

• Must contain from 1 to 255 alphanumeric characters or hyphens.

• First character must be a letter.

• Cannot end with a hyphen or contain two consecutive hyphens.

pub fn sns_topic_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

pub fn set_sns_topic_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

pub fn source_type(self, input: impl Into<String>) -> Self

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.

pub fn set_source_type(self, input: Option<String>) -> Self

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.

pub fn source_ids(self, input: impl Into<String>) -> Self

Appends an item to SourceIds.

To override the contents of this collection use set_source_ids.

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

pub fn set_source_ids(self, input: Option<Vec<String>>) -> Self

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

pub fn event_categories(self, input: impl Into<String>) -> Self

Appends an item to EventCategories.

To override the contents of this collection use set_event_categories.

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

Values: configuration, management, monitoring, security, pending

pub fn set_event_categories(self, input: Option<Vec<String>>) -> Self

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

Values: configuration, management, monitoring, security, pending

pub fn severity(self, input: impl Into<String>) -> Self

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

Values: ERROR, INFO

pub fn set_severity(self, input: Option<String>) -> Self

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

Values: ERROR, INFO

pub fn enabled(self, input: bool) -> Self

A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it.

pub fn set_enabled(self, input: Option<bool>) -> Self

A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it.

pub fn tags(self, input: Tag) -> Self

Appends an item to Tags.

To override the contents of this collection use set_tags.

A list of tag instances.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

A list of tag instances.

Trait Implementations

impl Clone for CreateEventSubscription

fn clone(&self) -> CreateEventSubscription

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateEventSubscription

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.