You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::RDS::Types::CreateEventSubscriptionMessage

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb

Overview

Note:

When making an API call, you may pass CreateEventSubscriptionMessage data as a hash:

{
  subscription_name: "String", # required
  sns_topic_arn: "String", # required
  source_type: "String",
  event_categories: ["String"],
  source_ids: ["String"],
  enabled: false,
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#enabledBoolean

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

Returns:

  • (Boolean)


3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3308

class CreateEventSubscriptionMessage < Struct.new(
  :subscription_name,
  :sns_topic_arn,
  :source_type,
  :event_categories,
  :source_ids,
  :enabled,
  :tags)
  include Aws::Structure
end

#event_categoriesArray<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.

Returns:

  • (Array<String>)


3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3308

class CreateEventSubscriptionMessage < Struct.new(
  :subscription_name,
  :sns_topic_arn,
  :source_type,
  :event_categories,
  :source_ids,
  :enabled,
  :tags)
  include Aws::Structure
end

#sns_topic_arnString

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

Returns:

  • (String)


3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3308

class CreateEventSubscriptionMessage < Struct.new(
  :subscription_name,
  :sns_topic_arn,
  :source_type,
  :event_categories,
  :source_ids,
  :enabled,
  :tags)
  include Aws::Structure
end

#source_idsArray<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.

Constraints:

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

  • If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.

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

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

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

Returns:

  • (Array<String>)


3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3308

class CreateEventSubscriptionMessage < Struct.new(
  :subscription_name,
  :sns_topic_arn,
  :source_type,
  :event_categories,
  :source_ids,
  :enabled,
  :tags)
  include Aws::Structure
end

#source_typeString

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.

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

Returns:

  • (String)


3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3308

class CreateEventSubscriptionMessage < Struct.new(
  :subscription_name,
  :sns_topic_arn,
  :source_type,
  :event_categories,
  :source_ids,
  :enabled,
  :tags)
  include Aws::Structure
end

#subscription_nameString

The name of the subscription.

Constraints: The name must be less than 255 characters.

Returns:

  • (String)


3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3308

class CreateEventSubscriptionMessage < Struct.new(
  :subscription_name,
  :sns_topic_arn,
  :source_type,
  :event_categories,
  :source_ids,
  :enabled,
  :tags)
  include Aws::Structure
end

#tagsArray<Types::Tag>

A list of tags.

Returns:



3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3308

class CreateEventSubscriptionMessage < Struct.new(
  :subscription_name,
  :sns_topic_arn,
  :source_type,
  :event_categories,
  :source_ids,
  :enabled,
  :tags)
  include Aws::Structure
end