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

Class: Aws::CloudWatchEvents::Types::Rule

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb

Overview

Contains information about a rule in Amazon CloudWatch Events.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the rule.

Returns:

  • (String) 


954
955
956
957
958
959
960
961
962
963
 
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 954

class Rule < Struct.new(
  :name,
  :arn,
  :event_pattern,
  :state,
  :description,
  :schedule_expression,
  :role_arn)
  include Aws::Structure
end

#description ⇒ String

The description of the rule.

Returns:

  • (String) 


954
955
956
957
958
959
960
961
962
963
 
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 954

class Rule < Struct.new(
  :name,
  :arn,
  :event_pattern,
  :state,
  :description,
  :schedule_expression,
  :role_arn)
  include Aws::Structure
end

#event_pattern ⇒ String

The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon CloudWatch Events User Guide.

Returns:

  • (String) 


954
955
956
957
958
959
960
961
962
963
 
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 954

class Rule < Struct.new(
  :name,
  :arn,
  :event_pattern,
  :state,
  :description,
  :schedule_expression,
  :role_arn)
  include Aws::Structure
end

#name ⇒ String

The name of the rule.

Returns:

  • (String) 


954
955
956
957
958
959
960
961
962
963
 
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 954

class Rule < Struct.new(
  :name,
  :arn,
  :event_pattern,
  :state,
  :description,
  :schedule_expression,
  :role_arn)
  include Aws::Structure
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of the role that is used for target invocation.

Returns:

  • (String) 


954
955
956
957
958
959
960
961
962
963
 
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 954

class Rule < Struct.new(
  :name,
  :arn,
  :event_pattern,
  :state,
  :description,
  :schedule_expression,
  :role_arn)
  include Aws::Structure
end

#schedule_expression ⇒ String

The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".

Returns:

  • (String) 


954
955
956
957
958
959
960
961
962
963
 
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 954

class Rule < Struct.new(
  :name,
  :arn,
  :event_pattern,
  :state,
  :description,
  :schedule_expression,
  :role_arn)
  include Aws::Structure
end

#state ⇒ String

The state of the rule.

Returns:

  • (String) 


954
955
956
957
958
959
960
961
962
963
 
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 954

class Rule < Struct.new(
  :name,
  :arn,
  :event_pattern,
  :state,
  :description,
  :schedule_expression,
  :role_arn)
  include Aws::Structure
end