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

Class: Aws::CloudWatchEvents::Types::DescribeRuleResponse

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

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The Amazon Resource Name (ARN) of the rule.

Returns:

  • (String)


598
599
600
601
602
603
604
605
606
607
608
609
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 598

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

#descriptionString

The description of the rule.

Returns:

  • (String)


598
599
600
601
602
603
604
605
606
607
608
609
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 598

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

#event_bus_nameString

The event bus associated with the rule.

Returns:

  • (String)


598
599
600
601
602
603
604
605
606
607
608
609
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 598

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

#event_patternString

The event pattern. For more information, see Event Patterns in the Amazon EventBridge User Guide.

Returns:

  • (String)


598
599
600
601
602
603
604
605
606
607
608
609
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 598

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

#managed_byString

If this is a managed rule, created by an AWS service on your behalf, this field displays the principal name of the AWS service that created the rule.

Returns:

  • (String)


598
599
600
601
602
603
604
605
606
607
608
609
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 598

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

#nameString

The name of the rule.

Returns:

  • (String)


598
599
600
601
602
603
604
605
606
607
608
609
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 598

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

#role_arnString

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

Returns:

  • (String)


598
599
600
601
602
603
604
605
606
607
608
609
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 598

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

#schedule_expressionString

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

Returns:

  • (String)


598
599
600
601
602
603
604
605
606
607
608
609
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 598

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

#stateString

Specifies whether the rule is enabled or disabled.

Returns:

  • (String)


598
599
600
601
602
603
604
605
606
607
608
609
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 598

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