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.

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The Amazon Resource Name (ARN) of the rule.

Returns:

  • (String)


844
845
846
847
848
849
850
851
852
853
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 844

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

#descriptionString

The description of the rule.

Returns:

  • (String)


844
845
846
847
848
849
850
851
852
853
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 844

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

#event_patternString

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

Returns:

  • (String)


844
845
846
847
848
849
850
851
852
853
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 844

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

#nameString

The name of the rule.

Returns:

  • (String)


844
845
846
847
848
849
850
851
852
853
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 844

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

#role_arnString

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

Returns:

  • (String)


844
845
846
847
848
849
850
851
852
853
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 844

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

#schedule_expressionString

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

Returns:

  • (String)


844
845
846
847
848
849
850
851
852
853
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 844

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

#stateString

The state of the rule.

Returns:

  • (String)


844
845
846
847
848
849
850
851
852
853
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 844

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