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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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",
    },
  ],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#enabled ⇒ Boolean

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

Returns:

  • (Boolean) 


3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
 
# File 'lib/aws-sdk-rds/types.rb', line 3595

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

#event_categories ⇒ Array<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.

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html

Returns:

  • (Array<String>) 


3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
 
# File 'lib/aws-sdk-rds/types.rb', line 3595

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

#sns_topic_arn ⇒ String

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) 


3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
 
# File 'lib/aws-sdk-rds/types.rb', line 3595

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

#source_ids ⇒ Array<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 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>) 


3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
 
# File 'lib/aws-sdk-rds/types.rb', line 3595

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

#source_type ⇒ String

The type of source that is 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) 


3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
 
# File 'lib/aws-sdk-rds/types.rb', line 3595

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

#subscription_name ⇒ String

The name of the subscription.

Constraints: The name must be less than 255 characters.

Returns:

  • (String) 


3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
 
# File 'lib/aws-sdk-rds/types.rb', line 3595

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

#tags ⇒ Array<Types::Tag>

A list of tags. For more information, see [Tagging Amazon RDS Resources] in the *Amazon RDS User Guide.*

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html

Returns:



3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
 
# File 'lib/aws-sdk-rds/types.rb', line 3595

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