Class: Convection::Model::Template::Resource::EventsRule

Inherits:
Convection::Model::Template::Resource show all
Defined in:
lib/convection/model/template/resource/aws_events_rule.rb

Overview

AWS::Events::Rule

See Also:

Instance Attribute Summary

Attributes inherited from Convection::Model::Template::Resource

#exist, #parent, #properties, #resource_attributes, #template

Instance Method Summary collapse

Methods inherited from Convection::Model::Template::Resource

#as_attribute, attach_method, #deletion_policy, #depends_on, #initialize, properties, property, #property, #reference, #render, type, #type, #with_output

Methods included from Mixin::Conditional

#condition, #render_condition

Methods included from DSL::Template::Resource

attach_resource

Methods included from DSL::Helpers

#camel_case, included, method_name, #screaming_snake_case, #snake_case

Methods included from DSL::IntrinsicFunctions

#base64, #find_in_map, #fn_and, #fn_equals, #fn_if, #fn_not, #fn_or, #fn_ref, #get_att, #get_azs, #join, #select

Constructor Details

This class inherits a constructor from Convection::Model::Template::Resource

Instance Method Details

#description ⇒ Object #description(value) ⇒ Object

Overloads:

  • #description ⇒ Object

    Returns the value of the 'Description' CloudFormation property.

  • #description(value) ⇒ Object

    Sets the 'Description' CloudFormation property.

    Parameters:

    • value —

      the value to set the 'Description' CloudFormation property to.



12
 
# File 'lib/convection/model/template/resource/aws_events_rule.rb', line 12

property :description, 'Description'

#domain ⇒ Object #domain(value) ⇒ Object

Overloads:

  • #domain ⇒ Object

    Returns the value of the 'Domain' CloudFormation property.

  • #domain(value) ⇒ Object

    Sets the 'Domain' CloudFormation property.

    Parameters:

    • value —

      the value to set the 'Domain' CloudFormation property to.



13
 
# File 'lib/convection/model/template/resource/aws_events_rule.rb', line 13

property :domain, 'Domain'

#event_pattern(value) ⇒ Object

Event patterns are documented as the type “JSON Object”. We can define it here as a Hash. Example usage of the `event_pattern` method property being used can be found in the EventsRule spec.



18
 
# File 'lib/convection/model/template/resource/aws_events_rule.rb', line 18

property :event_pattern, 'EventPattern', :type => :hash

#name ⇒ Object #name(value) ⇒ Object

Overloads:

  • #name ⇒ Object

    Returns the value of the 'Name' CloudFormation property.

  • #name(value) ⇒ Object

    Sets the 'Name' CloudFormation property.

    Parameters:

    • value —

      the value to set the 'Name' CloudFormation property to.



19
 
# File 'lib/convection/model/template/resource/aws_events_rule.rb', line 19

property :name, 'Name'

#role_arn ⇒ Object #role_arn(value) ⇒ Object

Overloads:

  • #role_arn ⇒ Object

    Returns the value of the 'RoleArn' CloudFormation property.

  • #role_arn(value) ⇒ Object

    Sets the 'RoleArn' CloudFormation property.

    Parameters:

    • value —

      the value to set the 'RoleArn' CloudFormation property to.



20
 
# File 'lib/convection/model/template/resource/aws_events_rule.rb', line 20

property :role_arn, 'RoleArn'

#schedule_expression ⇒ Object #schedule_expression(value) ⇒ Object

Overloads:

  • #schedule_expression ⇒ Object

    Returns the value of the 'ScheduleExpression' CloudFormation property.

  • #schedule_expression(value) ⇒ Object

    Sets the 'ScheduleExpression' CloudFormation property.

    Parameters:

    • value —

      the value to set the 'ScheduleExpression' CloudFormation property to.



21
 
# File 'lib/convection/model/template/resource/aws_events_rule.rb', line 21

property :schedule_expression, 'ScheduleExpression'

#state ⇒ Object #state(value) ⇒ Object

Overloads:

  • #state ⇒ Object

    Returns the value of the 'State' CloudFormation property.

  • #state(value) ⇒ Object

    Sets the 'State' CloudFormation property.

    Parameters:

    • value —

      the value to set the 'State' CloudFormation property to.



22
 
# File 'lib/convection/model/template/resource/aws_events_rule.rb', line 22

property :state, 'State'

#target(&block) ⇒ Object 



25
26
27
28
29
 
# File 'lib/convection/model/template/resource/aws_events_rule.rb', line 25

def target(&block)
  target = ResourceProperty::EventsRuleTarget.new(self)
  target.instance_exec(&block) if block
  targets << target
end

#targets ⇒ Object #targets(value) ⇒ Object

Overloads:

  • #targets ⇒ Object

    Returns the value of the 'Targets' CloudFormation property.

  • #targets(value) ⇒ Object

    Sets the 'Targets' CloudFormation property.

    Parameters:

    • value —

      the value to set the 'Targets' CloudFormation property to.



23
 
# File 'lib/convection/model/template/resource/aws_events_rule.rb', line 23

property :targets, 'Targets', :type => :array