Class: Ansible::Ruby::Modules::Cloudwatchevent_rule

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Cloudwatchevent_rule

Defined in:

lib/ansible/ruby/modules/generated/cloud/amazon/cloudwatchevent_rule.rb

Overview

This module creates and manages CloudWatch event rules and targets.

Instance Method Summary

• #description ⇒ String^?

  A description of the rule.

• #event_pattern ⇒ Object^?

  A string pattern (in valid JSON format) that is used to match against incoming events to determine if the rule should be triggered.

• #name ⇒ String

  The name of the rule you are creating, updating or deleting.

• #role_arn ⇒ Object^?

  The Amazon Resource Name (ARN) of the IAM role associated with the rule.

• #schedule_expression ⇒ String^?

  A cron or rate expression that defines the schedule the rule will trigger on.

• #state ⇒ :present, ...

  Whether the rule is present (and enabled), disabled, or absent.

• #targets ⇒ Array<Hash>, ...

  A dictionary array of targets to add to or update for the rule, in the form C({ id: [string], arn: [string], role_arn: [string], input: [valid JSON string], input_path: [valid JSONPath string], ecs_parameters: [string], task_count: [int]}).

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#description ⇒ String^?

Returns A description of the rule.

Returns:

• (String, nil) —

  A description of the rule

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudwatchevent_rule.rb', line 27

attribute :description

#event_pattern ⇒ Object^?

Returns A string pattern (in valid JSON format) that is used to match against incoming events to determine if the rule should be triggered.

Returns:

• (Object, nil) —

  A string pattern (in valid JSON format) that is used to match against incoming events to determine if the rule should be triggered

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudwatchevent_rule.rb', line 20

attribute :event_pattern

#name ⇒ String

Returns The name of the rule you are creating, updating or deleting. No spaces or special characters allowed (i.e. must match C(+)).

Returns:

• (String) —

  The name of the rule you are creating, updating or deleting. No spaces or special characters allowed (i.e. must match C(+))

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudwatchevent_rule.rb', line 12

attribute :name

#role_arn ⇒ Object^?

Returns The Amazon Resource Name (ARN) of the IAM role associated with the rule.

Returns:

• (Object, nil) —

  The Amazon Resource Name (ARN) of the IAM role associated with the rule

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudwatchevent_rule.rb', line 31

attribute :role_arn

#schedule_expression ⇒ String^?

Returns A cron or rate expression that defines the schedule the rule will trigger on. For example, C(cron(0 20 * * ? *)), C(rate(5 minutes)).

Returns:

• (String, nil) —

  A cron or rate expression that defines the schedule the rule will trigger on. For example, C(cron(0 20 * * ? *)), C(rate(5 minutes))

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudwatchevent_rule.rb', line 16

attribute :schedule_expression

#state ⇒ :present, ...

Returns Whether the rule is present (and enabled), disabled, or absent.

Returns:

• (:present, :disabled, :absent, nil) —

  Whether the rule is present (and enabled), disabled, or absent

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudwatchevent_rule.rb', line 23

attribute :state

#targets ⇒ Array<Hash>, ...

Returns A dictionary array of targets to add to or update for the rule, in the form C({ id: [string], arn: [string], role_arn: [string], input: [valid JSON string], input_path: [valid JSONPath string], ecs_parameters: [string], task_count: [int]}). I(id) [required] is the unique target assignment ID. I(arn) (required) is the Amazon Resource Name associated with the target. I(role_arn) (optional) is The Amazon Resource Name of the IAM role to be used for this target when the rule is triggered. I(input) (optional) is a JSON object that will override the event data when passed to the target. I(input_path) (optional) is a JSONPath string (e.g. C($.detail)) that specifies the part of the event data to be passed to the target. If neither I(input) nor I(input_path) is specified, then the entire event is passed to the target in JSON form. I(task_definition_arn) [optional] is ecs task definition arn. I(task_count) [optional] is ecs task count.

Returns:

• (Array<Hash>, Hash, nil) —

  A dictionary array of targets to add to or update for the rule, in the form C({ id: [string], arn: [string], role_arn: [string], input: [valid JSON string], input_path: [valid JSONPath string], ecs_parameters: [string], task_count: [int]}). I(id) [required] is the unique target assignment ID. I(arn) (required) is the Amazon Resource Name associated with the target. I(role_arn) (optional) is The Amazon Resource Name of the IAM role to be used for this target when the rule is triggered. I(input) (optional) is a JSON object that will override the event data when passed to the target. I(input_path) (optional) is a JSONPath string (e.g. C($.detail)) that specifies the part of the event data to be passed to the target. If neither I(input) nor I(input_path) is specified, then the entire event is passed to the target in JSON form. I(task_definition_arn) [optional] is ecs task definition arn. I(task_count) [optional] is ecs task count.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudwatchevent_rule.rb', line 34

attribute :targets