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 EventBridge.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The Amazon Resource Name (ARN) of the rule.

Returns:

  • (String)


2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 2236

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)


2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 2236

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 event bus associated with the rule.

Returns:

  • (String)


2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 2236

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)


2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 2236

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 AWS service, this field displays the principal name of the service that created the rule.

Returns:

  • (String)


2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 2236

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)


2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 2236

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.

Returns:

  • (String)


2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 2236

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)".

Returns:

  • (String)


2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 2236

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)


2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 2236

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