Class: MintPress::Aws::RDS::EventSubscription

Inherits:
Object
  • Object
show all
Includes:
MintLogger, AwsCommon, Mixins::Properties
Defined in:
src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/event_subscription.rb

Properties (Read/Write)

  • #enabled ⇒ [TrueClass,FalseClass]
    'A value that indicates whether to activate the subscription. If the event notification subscription isn"t activated, the subscription is created but not active.'
    Property Attributes
    • source ⇒ "create_event_subscription"
    • orig_name ⇒ 'enabled'
    • create_event_subscription_prop ⇒ 'enabled'
    • read_only ⇒ false
    • modify_event_subscription_prop ⇒ 'enabled'
    

26
27
28
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/event_subscription.rb', line 26

property :enabled, description: 'A value that indicates whether to activate the subscription. If the
event notification subscription isn"t activated, the subscription is
created but not active.', source: "create_event_subscription", orig_name: 'enabled', type: [TrueClass,FalseClass], create_event_subscription_prop: 'enabled', read_only: false, modify_event_subscription_prop: 'enabled'
  • #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.'
    Property Attributes
    • source ⇒ "create_event_subscription"
    • orig_name ⇒ 'sns_topic_arn'
    • create_event_subscription_prop ⇒ 'sns_topic_arn'
    • read_only ⇒ false
    • modify_event_subscription_prop ⇒ 'sns_topic_arn'
    

31
32
33
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/event_subscription.rb', line 31

property :sns_topic_arn, description: '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.', source: "create_event_subscription", orig_name: 'sns_topic_arn', type: [String], create_event_subscription_prop: 'sns_topic_arn', read_only: false, modify_event_subscription_prop: 'sns_topic_arn'
  • #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 set this parameter to db-instance. If this value isn"t specified, all events are returned. Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot'
    Property Attributes
    • source ⇒ "create_event_subscription"
    • orig_name ⇒ 'source_type'
    • create_event_subscription_prop ⇒ 'source_type'
    • read_only ⇒ false
    • modify_event_subscription_prop ⇒ 'source_type'
    

35
36
37
38
39
40
41
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/event_subscription.rb', line 35

property :source_type, description: '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 set this
parameter to db-instance. If this value isn"t specified, all events
are returned.

Valid values: db-instance | db-cluster | db-parameter-group |
db-security-group | db-snapshot | db-cluster-snapshot', source: "create_event_subscription", orig_name: 'source_type', type: [String], create_event_subscription_prop: 'source_type', read_only: false, modify_event_subscription_prop: 'source_type'
  • #subscription_name ⇒ [String]
    'The name of the subscription. Constraints: The name must be less than 255 characters.'
    Property Attributes
    • create_event_subscription_prop ⇒ 'subscription_name'
    • read_only ⇒ false
    • source ⇒ "create_event_subscription"
    • delete_event_subscription_prop ⇒ 'subscription_name'
    • describe_event_subscriptions_prop ⇒ 'subscription_name'
    • modify_event_subscription_prop ⇒ 'subscription_name'
    

44
45
46
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/event_subscription.rb', line 44

property :subscription_name, create_event_subscription_prop: 'subscription_name', type: [String], read_only: false, source: "create_event_subscription", description: 'The name of the subscription.

Constraints: The name must be less than 255 characters.', delete_event_subscription_prop: 'subscription_name', describe_event_subscriptions_prop: 'subscription_name', modify_event_subscription_prop: 'subscription_name'
  • #event_categories ⇒ Array of ⇒ [String]
    'A list of event categories for a particular source type (SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in Events in the Amazon RDS User Guide or by using the DescribeEventCategories operation.'
    Property Attributes
    • create_event_subscription_prop ⇒ 'event_categories'
    • read_only ⇒ false
    • source ⇒ "create_event_subscription"
    • modify_event_subscription_prop ⇒ 'event_categories'
    

47
48
49
50
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/event_subscription.rb', line 47

property :event_categories, create_event_subscription_prop: 'event_categories', type: [String], array: true, read_only: false, source: "create_event_subscription", description: 'A list of event categories for a particular source type (SourceType)
that you want to subscribe to. You can see a list of the categories
for a given source type in Events in the Amazon RDS User Guide
or by using the DescribeEventCategories operation.', modify_event_subscription_prop: 'event_categories'
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::RDS::Tag]
    'A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.'
    Property Attributes
    • create_event_subscription_prop ⇒ 'tags'
    • read_only ⇒ false
    • source ⇒ "create_event_subscription"
    

51
52
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/event_subscription.rb', line 51

property :tags, create_event_subscription_prop: 'tags', type: [MintPress::Aws::RDS::Tag], array: false, read_only: false, source: "create_event_subscription", description: 'A list of tags. For more information, see Tagging Amazon RDS
Resources in the Amazon RDS User Guide.', hash: true
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::RDS::Filter]
    'This parameter isn"t currently supported.'
    Property Attributes
    • describe_event_subscriptions_prop ⇒ 'filters'
    • source ⇒ "describe_event_subscriptions"
    

53
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/event_subscription.rb', line 53

property :filters, describe_event_subscriptions_prop: 'filters', type: [MintPress::Aws::RDS::Filter], array: false, source: "describe_event_subscriptions", description: 'This parameter isn"t currently supported.', hash: true
  • #max_records ⇒ [Integer]
    'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.'
    Property Attributes
    • describe_event_subscriptions_prop ⇒ 'max_records'
    • source ⇒ "describe_event_subscriptions"
    

54
55
56
57
58
59
60
61
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/event_subscription.rb', line 54

property :max_records, describe_event_subscriptions_prop: 'max_records', type: [Integer], source: "describe_event_subscriptions", description: 'The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a pagination
token called a marker is included in the response so that you can
retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.'
  • #cust_subscription ⇒ [String]
    'The RDS event notification subscription Id.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::RDS::EventSubscription"
    • orig_name ⇒ 'cust_subscription_id'
    

63
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/event_subscription.rb', line 63

property :cust_subscription, disposition: :attribute, description: 'The RDS event notification subscription Id.', source: "MintPress::Aws::RDS::EventSubscription", orig_name: 'cust_subscription_id', type: [String]
  • #sources ⇒ Array of ⇒ [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 a SourceIds value is supplied, SourceType must also be provided. If the source type is a DB instance, a DBInstanceIdentifier value must be supplied. If the source type is a DB cluster, a DBClusterIdentifier value must be supplied. If the source type is a DB parameter group, a DBParameterGroupName value must be supplied. If the source type is a DB security group, a DBSecurityGroupName value must be supplied. If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied. If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.'
    Property Attributes
    • create_event_subscription_prop ⇒ 'source_ids'
    • read_only ⇒ false
    • source ⇒ "create_event_subscription"
    

65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/event_subscription.rb', line 65

property :sources, create_event_subscription_prop: 'source_ids', type: [String], array: true, read_only: false, source: "create_event_subscription", description: '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 a SourceIds value is supplied, SourceType must also be
provided.
If the source type is a DB instance, a DBInstanceIdentifier value
must be supplied.
If the source type is a DB cluster, a DBClusterIdentifier value
must be supplied.
If the source type is a DB parameter group, a DBParameterGroupName
value must be supplied.
If the source type is a DB security group, a DBSecurityGroupName
value must be supplied.
If the source type is a DB snapshot, a DBSnapshotIdentifier value
must be supplied.
If the source type is a DB cluster snapshot, a
DBClusterSnapshotIdentifier value must be supplied.'
  • #region ⇒ String
    Region _specifically for this object_. If you're not doing different objects in different regions, you should not set this, but rather set the region on your AwsPlatformProvider instead
    Property Attributes 
    

91
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/event_subscription.rb', line 91

property :region, type: String
  • #platform ⇒ MintPress::InfrastructureAws::AwsPlatform (Default Value: MintPress::InfrastructureAws::AwsPlatform.new)
    The platform details, including credentials - normally this will come via AwsPlatformProvider (see the Infrastructure Providers section of the documentation)
    Property Attributes
    • default ⇒ MintPress::InfrastructureAws::AwsPlatform.new
    

94
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/event_subscription.rb', line 94

property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new

Properties (Read Only)

  • #event_categories_list ⇒ Array of ⇒ [String]
    'A list of event categories for the RDS event notification subscription.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "EventSubscription"
    • orig_name ⇒ 'event_categories_list'
    • read_only ⇒ true
    

29
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/event_subscription.rb', line 29

property :event_categories_list, disposition: :read_only_attribute, description: 'A list of event categories for the RDS event notification subscription.', source: "EventSubscription", orig_name: 'event_categories_list', type: [String], array: true, read_only: true
  • #event_subscription_arn ⇒ [String]
    'The Amazon Resource Name (ARN) for the event subscription.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "EventSubscription"
    • orig_name ⇒ 'event_subscription_arn'
    • read_only ⇒ true
    

30
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/event_subscription.rb', line 30

property :event_subscription_arn, disposition: :read_only_attribute, description: 'The Amazon Resource Name (ARN) for the event subscription.', source: "EventSubscription", orig_name: 'event_subscription_arn', type: [String], read_only: true
  • #source_ids_list ⇒ Array of ⇒ [String]
    'A list of source IDs for the RDS event notification subscription.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "EventSubscription"
    • orig_name ⇒ 'source_ids_list'
    • read_only ⇒ true
    

34
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/event_subscription.rb', line 34

property :source_ids_list, disposition: :read_only_attribute, description: 'A list of source IDs for the RDS event notification subscription.', source: "EventSubscription", orig_name: 'source_ids_list', type: [String], array: true, read_only: true
  • #status ⇒ [String]
    'The status of the RDS event notification subscription.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "EventSubscription"
    • orig_name ⇒ 'status'
    • read_only ⇒ true
    

42
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/event_subscription.rb', line 42

property :status, disposition: :read_only_attribute, description: 'The status of the RDS event notification subscription.', source: "EventSubscription", orig_name: 'status', type: [String], read_only: true
  • #subscription_creation_time ⇒ [String]
    'The time the RDS event notification subscription was created.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "EventSubscription"
    • orig_name ⇒ 'subscription_creation_time'
    • read_only ⇒ true
    

43
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/event_subscription.rb', line 43

property :subscription_creation_time, disposition: :read_only_attribute, description: 'The time the RDS event notification subscription was created.', source: "EventSubscription", orig_name: 'subscription_creation_time', type: [String], read_only: true
  • #name ⇒ [String]
    '(also: #cust_subscription_id)'
    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "EventSubscription"
    • orig_name ⇒ 'name'
    

62
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/event_subscription.rb', line 62

property :name, read_only: true, disposition: :read_only_attribute, description: '(also: #cust_subscription_id)', source: "EventSubscription", orig_name: 'name', type: [String]
  • #customer_aws ⇒ [String]
    'The AWS customer account associated with the RDS event notification subscription.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "EventSubscription"
    • orig_name ⇒ 'customer_aws_id'
    • read_only ⇒ true
    

64
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/event_subscription.rb', line 64

property :customer_aws, disposition: :read_only_attribute, description: 'The AWS customer account associated with the RDS event notification subscription.', source: "EventSubscription", orig_name: 'customer_aws_id', type: [String], read_only: true

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary collapse

Methods included from AwsCommon

#alive?, all, #attach_generic, #attached?, #available?, #build_create_hash, #by_id, #by_name, #create_generic, #delete_cascade_generic, #delete_generic, #detach_generic, #exists?, #fill_in_details, #find_by_details, #find_global_object, #get_aws_region, #get_state, #handle_singleton_object, #harvest, #perform_operation, #prop_to_hash, #register_aws_object, #resource_api, #running?, #start_generic, #started?, #stop_generic, #terminate_generic

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Constructor Details

#initialize(opts = {}) ⇒ EventSubscription

Returns a new instance of EventSubscription.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object

#modify ⇒ Object