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

Class: Aws::Redshift::Types::ModifyEventSubscriptionMessage

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 ModifyEventSubscriptionMessage data as a hash:

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

Instance Attribute Summary collapse

Instance Attribute Details

#enabledBoolean

A Boolean value indicating if the subscription is enabled. true indicates the subscription is enabled

Returns:

  • (Boolean)


4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4868

class ModifyEventSubscriptionMessage < Struct.new(
  :subscription_name,
  :sns_topic_arn,
  :source_type,
  :source_ids,
  :event_categories,
  :severity,
  :enabled)
  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>)


4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4868

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

#severityString

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

Values: ERROR, INFO

Returns:

  • (String)


4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4868

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

#sns_topic_arnString

The Amazon Resource Name (ARN) of the SNS topic to be used by the event notification subscription.

Returns:

  • (String)


4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4868

class ModifyEventSubscriptionMessage < Struct.new(
  :subscription_name,
  :sns_topic_arn,
  :source_type,
  :source_ids,
  :event_categories,
  :severity,
  :enabled)
  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>)


4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4868

class ModifyEventSubscriptionMessage < Struct.new(
  :subscription_name,
  :sns_topic_arn,
  :source_type,
  :source_ids,
  :event_categories,
  :severity,
  :enabled)
  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)


4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4868

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

#subscription_nameString

The name of the modified Amazon Redshift event notification subscription.

Returns:

  • (String)


4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4868

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