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

Class: Aws::Redshift::Types::CreateEventSubscriptionMessage

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-redshift/lib/aws-sdk-redshift/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",
  source_ids: ["String"],
  event_categories: ["String"],
  severity: "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)


1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 1717

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

#event_categoriesArray<String>

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

Values: Configuration, Management, Monitoring, Security

Returns:

  • (Array<String>)


1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 1717

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

#severityString

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

Values: ERROR, INFO

Returns:

  • (String)


1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 1717

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

#sns_topic_arnString

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.

Returns:

  • (String)


1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 1717

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

#source_idsArray<String>

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

Returns:

  • (Array<String>)


1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 1717

class CreateEventSubscriptionMessage < Struct.new(
  :subscription_name,
  :sns_topic_arn,
  :source_type,
  :source_ids,
  :event_categories,
  :severity,
  :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 cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs.

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

Returns:

  • (String)


1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 1717

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

#subscription_nameString

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.

Returns:

  • (String)


1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 1717

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

#tagsArray<Types::Tag>

A list of tag instances.

Returns:



1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 1717

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