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

Inherits:

Struct

• Object
• Struct
• Aws::Connect::Types::CreateRuleRequest

Defined in:

gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #actions ⇒ Array<Types::RuleAction>

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

• #client_token ⇒ String

  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

• #function ⇒ String

  The conditions of the rule.

• #instance_id ⇒ String

  The identifier of the Connect Customer instance.

• #name ⇒ String

  A unique name for the rule.

• #pre_evaluation_filters ⇒ Types::PreEvaluationFilters

  The pre-evaluation filters for the rule, that restrict the rule to be applied to only certain resources based on the resource's attributes, such as tags assigned to a contact.

• #publish_status ⇒ String

  The publish status of the rule.

• #tags ⇒ Hash<String,String>

  The tags used to organize, track, or control access for this resource.

• #trigger_event_source ⇒ Types::RuleTriggerEventSource

  The event source to trigger the rule.

Instance Attribute Details

#actions ⇒ Array<Types::RuleAction>

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

Returns:

• (Array<Types::RuleAction>)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 7704

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

#client_token ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 7704

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

#function ⇒ String

The conditions of the rule.

Returns:

• (String)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 7704

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

#instance_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 7704

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

#name ⇒ String

A unique name for the rule.

Returns:

• (String)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 7704

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

#pre_evaluation_filters ⇒ Types::PreEvaluationFilters

The pre-evaluation filters for the rule, that restrict the rule to be applied to only certain resources based on the resource's attributes, such as tags assigned to a contact. The pre-evaluation filters are applied even before rule conditions are evaluated and are used to enforce tag-based-access-control while applying rules.

Returns:

• (Types::PreEvaluationFilters)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 7704

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

#publish_status ⇒ String

The publish status of the rule.

Returns:

• (String)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 7704

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

#tags ⇒ Hash<String,String>

The tags used to organize, track, or control access for this resource. For example, { "Tags": "key2":"value2" }.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 7704

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

#trigger_event_source ⇒ Types::RuleTriggerEventSource

The event source to trigger the rule.

Returns:

• (Types::RuleTriggerEventSource)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 7704

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