AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::EventBridge::Types::Rule

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

Overview

Contains information about a rule in Amazon EventBridge.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The Amazon Resource Name (ARN) of the rule.

Returns:

  • (String)


4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4595

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

#descriptionString

The description of the rule.

Returns:

  • (String)


4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4595

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

#event_bus_nameString

The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

Returns:

  • (String)


4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4595

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

#event_patternString

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

Returns:

  • (String)


4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4595

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

#managed_byString

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

Returns:

  • (String)


4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4595

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

#nameString

The name of the rule.

Returns:

  • (String)


4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4595

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

#role_arnString

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

If you're setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a RoleArn with proper permissions in the Target structure, instead of here in this parameter.

Returns:

  • (String)


4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4595

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

#schedule_expressionString

The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see Creating an Amazon EventBridge rule that runs on a schedule.

Returns:

  • (String)


4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4595

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

#stateString

The state of the rule.

Returns:

  • (String)


4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4595

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