Class: Aws::Connect::Types::CreateRuleRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-connect/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#actionsArray<Types::RuleAction>

A list of actions to be run when the rule is triggered.

Returns:



4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
# File 'lib/aws-sdk-connect/types.rb', line 4174

class CreateRuleRequest < Struct.new(
  :instance_id,
  :name,
  :trigger_event_source,
  :function,
  :actions,
  :publish_status,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#client_tokenString

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs].

**A suitable default value is auto-generated.** You should normally not need to pass this option.

[1]: aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/

Returns:

  • (String)


4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
# File 'lib/aws-sdk-connect/types.rb', line 4174

class CreateRuleRequest < Struct.new(
  :instance_id,
  :name,
  :trigger_event_source,
  :function,
  :actions,
  :publish_status,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#functionString

The conditions of the rule.

Returns:

  • (String)


4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
# File 'lib/aws-sdk-connect/types.rb', line 4174

class CreateRuleRequest < Struct.new(
  :instance_id,
  :name,
  :trigger_event_source,
  :function,
  :actions,
  :publish_status,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#instance_idString

The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource Name (ARN) of the instance.

[1]: docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html

Returns:

  • (String)


4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
# File 'lib/aws-sdk-connect/types.rb', line 4174

class CreateRuleRequest < Struct.new(
  :instance_id,
  :name,
  :trigger_event_source,
  :function,
  :actions,
  :publish_status,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

A unique name for the rule.

Returns:

  • (String)


4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
# File 'lib/aws-sdk-connect/types.rb', line 4174

class CreateRuleRequest < Struct.new(
  :instance_id,
  :name,
  :trigger_event_source,
  :function,
  :actions,
  :publish_status,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#publish_statusString

The publish status of the rule.

Returns:

  • (String)


4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
# File 'lib/aws-sdk-connect/types.rb', line 4174

class CreateRuleRequest < Struct.new(
  :instance_id,
  :name,
  :trigger_event_source,
  :function,
  :actions,
  :publish_status,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#trigger_event_sourceTypes::RuleTriggerEventSource

The event source to trigger the rule.



4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
# File 'lib/aws-sdk-connect/types.rb', line 4174

class CreateRuleRequest < Struct.new(
  :instance_id,
  :name,
  :trigger_event_source,
  :function,
  :actions,
  :publish_status,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end