Struct aws_sdk_docdb::operation::create_event_subscription::CreateEventSubscriptionInput

#[non_exhaustive]
pub struct CreateEventSubscriptionInput {
    pub subscription_name: Option<String>,
    pub sns_topic_arn: Option<String>,
    pub source_type: Option<String>,
    pub event_categories: Option<Vec<String>>,
    pub source_ids: Option<Vec<String>>,
    pub enabled: Option<bool>,
    pub tags: Option<Vec<Tag>>,
}

Represents the input to CreateEventSubscription.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

subscription_name: Option<String>

The name of the subscription.

Constraints: The name must be fewer than 255 characters.

sns_topic_arn: Option<String>

The Amazon Resource Name (ARN) of the SNS topic created for event notification. Amazon SNS creates the ARN when you create a topic and subscribe to it.

source_type: Option<String>

The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, you would set this parameter to db-instance. If this value is not specified, all events are returned.

Valid values: db-instance, db-cluster, db-parameter-group, db-security-group, db-cluster-snapshot

event_categories: Option<Vec<String>>

A list of event categories for a SourceType that you want to subscribe to.

source_ids: Option<Vec<String>>

The list of identifiers of the event sources for which events are 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 can't end with a hyphen or contain two consecutive hyphens.

Constraints:

• If SourceIds are provided, SourceType must also be provided.

• If the source type is an instance, a DBInstanceIdentifier must be provided.

• If the source type is a security group, a DBSecurityGroupName must be provided.

• If the source type is a parameter group, a DBParameterGroupName must be provided.

• If the source type is a snapshot, a DBSnapshotIdentifier must be provided.

enabled: Option<bool>

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

tags: Option<Vec<Tag>>

The tags to be assigned to the event subscription.

Implementations

impl CreateEventSubscriptionInput

pub fn subscription_name(&self) -> Option<&str>

The name of the subscription.

Constraints: The name must be fewer than 255 characters.

pub fn sns_topic_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the SNS topic created for event notification. Amazon SNS creates the ARN when you create a topic and subscribe to it.

pub fn source_type(&self) -> Option<&str>

The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, you would set this parameter to db-instance. If this value is not specified, all events are returned.

Valid values: db-instance, db-cluster, db-parameter-group, db-security-group, db-cluster-snapshot

pub fn event_categories(&self) -> &[String]

A list of event categories for a SourceType that you want to subscribe to.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .event_categories.is_none().

pub fn source_ids(&self) -> &[String]

The list of identifiers of the event sources for which events are 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 can't end with a hyphen or contain two consecutive hyphens.

Constraints:

• If SourceIds are provided, SourceType must also be provided.

• If the source type is an instance, a DBInstanceIdentifier must be provided.

• If the source type is a security group, a DBSecurityGroupName must be provided.

• If the source type is a parameter group, a DBParameterGroupName must be provided.

• If the source type is a snapshot, a DBSnapshotIdentifier must be provided.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .source_ids.is_none().

pub fn enabled(&self) -> Option<bool>

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

pub fn tags(&self) -> &[Tag]

The tags to be assigned to the event subscription.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

impl CreateEventSubscriptionInput

pub fn builder() -> CreateEventSubscriptionInputBuilder

Creates a new builder-style object to manufacture CreateEventSubscriptionInput.

Trait Implementations

impl Clone for CreateEventSubscriptionInput

fn clone(&self) -> CreateEventSubscriptionInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateEventSubscriptionInput

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

Formats the value using the given formatter.

impl PartialEq for CreateEventSubscriptionInput

fn eq(&self, other: &CreateEventSubscriptionInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateEventSubscriptionInput