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::DescribeRuleResponse

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The Amazon Resource Name (ARN) of the rule.

Returns:

  • (String)


2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2200

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_byString

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)


2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2200

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

#descriptionString

The description of the rule.

Returns:

  • (String)


2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2200

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_nameString

The name of the event bus associated with the rule.

Returns:

  • (String)


2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2200

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_patternString

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

Returns:

  • (String)


2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2200

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_byString

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)


2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2200

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

#nameString

The name of the rule.

Returns:

  • (String)


2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2200

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_arnString

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

Returns:

  • (String)


2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2200

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_expressionString

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

Returns:

  • (String)


2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2200

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

#stateString

Specifies whether the rule is enabled or disabled.

Returns:

  • (String)


2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2200

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