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

Inherits:

Struct

• Object
• Struct
• Aws::CloudWatchEvents::Types::DescribeRuleResponse

Includes:

Structure

Defined in:

lib/aws-sdk-cloudwatchevents/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the rule.

• #created_by ⇒ String

  The account ID of the user that created the rule.

• #description ⇒ String

  The description of the rule.

• #event_bus_name ⇒ String

  The name of the event bus associated with the rule.

• #event_pattern ⇒ String

  The event pattern.

• #managed_by ⇒ String

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

• #name ⇒ String

  The name of the rule.

• #role_arn ⇒ String

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

• #schedule_expression ⇒ String

  The scheduling expression.

• #state ⇒ String

  Specifies whether the rule is enabled or disabled.

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the rule.

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchevents/types.rb', line 1709

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

#created_by ⇒ String

The account ID of the user that created the rule. If you use ‘PutRule` to put a rule on an event bus in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that account. However, the value for `CreatedBy` is the account ID as the account that created the rule in the other account.

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchevents/types.rb', line 1709

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

#description ⇒ String

The description of the rule.

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchevents/types.rb', line 1709

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

#event_bus_name ⇒ String

The name of the event bus associated with the rule.

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchevents/types.rb', line 1709

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

#event_pattern ⇒ String

The event pattern. For more information, see [Events and Event Patterns] in the *Amazon EventBridge User Guide*.

[1]: docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchevents/types.rb', line 1709

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

#managed_by ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchevents/types.rb', line 1709

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

#name ⇒ String

The name of the rule.

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchevents/types.rb', line 1709

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

#role_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchevents/types.rb', line 1709

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

#schedule_expression ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchevents/types.rb', line 1709

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

#state ⇒ String

Specifies whether the rule is enabled or disabled.

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchevents/types.rb', line 1709

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