Class: AWSCDK::Bedrock::CfnGuardrail::TopicConfigProperty

Inherits:

Jsii::Struct

Object
Jsii::Struct
AWSCDK::Bedrock::CfnGuardrail::TopicConfigProperty

show all

Defined in:: bedrock/cfn_guardrail.rb

Overview

Details about topics for the guardrail to identify and deny.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html

Instance Attribute Summary collapse

#definition ⇒ String readonly
A definition of the topic to deny.
#examples ⇒ Array<String>^? readonly
A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.
#input_action ⇒ String^? readonly
Specifies the action to take when harmful content is detected in the input.
#input_enabled ⇒ Boolean, ... readonly
Specifies whether to enable guardrail evaluation on the input.
#name ⇒ String readonly
The name of the topic to deny.
#output_action ⇒ String^? readonly
Specifies the action to take when harmful content is detected in the output.
#output_enabled ⇒ Boolean, ... readonly
Specifies whether to enable guardrail evaluation on the output.
#type ⇒ String readonly
Specifies to deny the topic.

Class Method Summary collapse

.jsii_properties ⇒ Object

Instance Method Summary collapse

#initialize(definition:, name:, type:, examples: nil, input_action: nil, input_enabled: nil, output_action: nil, output_enabled: nil) ⇒ TopicConfigProperty constructor
A new instance of TopicConfigProperty.
#to_jsii ⇒ Object

Constructor Details

#initialize(definition:, name:, type:, examples: nil, input_action: nil, input_enabled: nil, output_action: nil, output_enabled: nil) ⇒ `TopicConfigProperty`

Returns a new instance of TopicConfigProperty.

Parameters:

definition (String) —
A definition of the topic to deny.
name (String) —
The name of the topic to deny.
type (String) —
Specifies to deny the topic.
examples (Array<String>, nil) (defaults to: nil) —
A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.
input_action (String, nil) (defaults to: nil) —
Specifies the action to take when harmful content is detected in the input. Supported values include:.
input_enabled (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —
Specifies whether to enable guardrail evaluation on the input.
output_action (String, nil) (defaults to: nil) —
Specifies the action to take when harmful content is detected in the output. Supported values include:.
output_enabled (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —
Specifies whether to enable guardrail evaluation on the output.

# File 'bedrock/cfn_guardrail.rb', line 1640

def initialize(definition:, name:, type:, examples: nil, input_action: nil, input_enabled: nil, output_action: nil, output_enabled: nil)
  @definition = definition
  Jsii::Type.check_type(@definition, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "definition")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  @examples = examples
  Jsii::Type.check_type(@examples, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "examples") unless @examples.nil?
  @input_action = input_action
  Jsii::Type.check_type(@input_action, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "inputAction") unless @input_action.nil?
  @input_enabled = input_enabled
  Jsii::Type.check_type(@input_enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "inputEnabled") unless @input_enabled.nil?
  @output_action = output_action
  Jsii::Type.check_type(@output_action, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "outputAction") unless @output_action.nil?
  @output_enabled = output_enabled
  Jsii::Type.check_type(@output_enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "outputEnabled") unless @output_enabled.nil?
end

Instance Attribute Details

#definition ⇒ `String` (readonly)

A definition of the topic to deny.

Returns:

(String)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html#cfn-bedrock-guardrail-topicconfig-definition



1663
1664
1665

# File 'bedrock/cfn_guardrail.rb', line 1663

def definition
  @definition
end

#examples ⇒ `Array<String>`^? (readonly)

A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.

Returns:

(Array<String>, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html#cfn-bedrock-guardrail-topicconfig-examples



1678
1679
1680

# File 'bedrock/cfn_guardrail.rb', line 1678

def examples
  @examples
end

#input_action ⇒ `String`^? (readonly)

Specifies the action to take when harmful content is detected in the input. Supported values include:.

BLOCK – Block the content and replace it with blocked messaging.
NONE – Take no action but return detection information in the trace response.

Returns:

(String, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html#cfn-bedrock-guardrail-topicconfig-inputaction



1686
1687
1688

# File 'bedrock/cfn_guardrail.rb', line 1686

def input_action
  @input_action
end

#input_enabled ⇒ `Boolean`, ... (readonly)

Specifies whether to enable guardrail evaluation on the input.

When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.

Returns:

(Boolean, AWSCDK::IResolvable, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html#cfn-bedrock-guardrail-topicconfig-inputenabled



1693
1694
1695

# File 'bedrock/cfn_guardrail.rb', line 1693

def input_enabled
  @input_enabled
end

#name ⇒ `String` (readonly)

The name of the topic to deny.

Returns:

(String)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html#cfn-bedrock-guardrail-topicconfig-name



1668
1669
1670

# File 'bedrock/cfn_guardrail.rb', line 1668

def name
  @name
end

#output_action ⇒ `String`^? (readonly)

Specifies the action to take when harmful content is detected in the output. Supported values include:.

BLOCK – Block the content and replace it with blocked messaging.
NONE – Take no action but return detection information in the trace response.

Returns:

(String, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html#cfn-bedrock-guardrail-topicconfig-outputaction



1701
1702
1703

# File 'bedrock/cfn_guardrail.rb', line 1701

def output_action
  @output_action
end

#output_enabled ⇒ `Boolean`, ... (readonly)

Specifies whether to enable guardrail evaluation on the output.

When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.

Returns:

(Boolean, AWSCDK::IResolvable, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html#cfn-bedrock-guardrail-topicconfig-outputenabled



1708
1709
1710

# File 'bedrock/cfn_guardrail.rb', line 1708

def output_enabled
  @output_enabled
end

#type ⇒ `String` (readonly)

Specifies to deny the topic.

Returns:

(String)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html#cfn-bedrock-guardrail-topicconfig-type



1673
1674
1675

# File 'bedrock/cfn_guardrail.rb', line 1673

def type
  @type
end

Class Method Details

.jsii_properties ⇒ `Object`

# File 'bedrock/cfn_guardrail.rb', line 1710

def self.jsii_properties
  {
    :definition => "definition",
    :name => "name",
    :type => "type",
    :examples => "examples",
    :input_action => "inputAction",
    :input_enabled => "inputEnabled",
    :output_action => "outputAction",
    :output_enabled => "outputEnabled",
  }
end

Instance Method Details

#to_jsii ⇒ `Object`

# File 'bedrock/cfn_guardrail.rb', line 1723

def to_jsii
  result = {}
  result.merge!({
    "definition" => @definition,
    "name" => @name,
    "type" => @type,
    "examples" => @examples,
    "inputAction" => @input_action,
    "inputEnabled" => @input_enabled,
    "outputAction" => @output_action,
    "outputEnabled" => @output_enabled,
  })
  result.compact
end

Class: AWSCDK::Bedrock::CfnGuardrail::TopicConfigProperty

Overview

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(definition:, name:, type:, examples: nil, input_action: nil, input_enabled: nil, output_action: nil, output_enabled: nil) ⇒ TopicConfigProperty

Instance Attribute Details

#definition ⇒ String (readonly)

#examples ⇒ Array<String>? (readonly)

#input_action ⇒ String? (readonly)

#input_enabled ⇒ Boolean, ... (readonly)

#name ⇒ String (readonly)

#output_action ⇒ String? (readonly)

#output_enabled ⇒ Boolean, ... (readonly)

#type ⇒ String (readonly)

Class Method Details

.jsii_properties ⇒ Object

Instance Method Details

#to_jsii ⇒ Object

#initialize(definition:, name:, type:, examples: nil, input_action: nil, input_enabled: nil, output_action: nil, output_enabled: nil) ⇒ `TopicConfigProperty`

#definition ⇒ `String` (readonly)

#examples ⇒ `Array<String>`^? (readonly)

#input_action ⇒ `String`^? (readonly)

#input_enabled ⇒ `Boolean`, ... (readonly)

#name ⇒ `String` (readonly)

#output_action ⇒ `String`^? (readonly)

#output_enabled ⇒ `Boolean`, ... (readonly)

#type ⇒ `String` (readonly)

.jsii_properties ⇒ `Object`

#to_jsii ⇒ `Object`