Header menu logo FsCDK

BedrockGuardrailBuilder Type

Constructors

Constructor Description

BedrockGuardrailBuilder(name)

Full Usage: BedrockGuardrailBuilder(name)

Parameters:
    name : string

Returns: BedrockGuardrailBuilder
name : string
Returns: BedrockGuardrailBuilder

Instance members

Instance member Description

blockedInputMessaging message

Full Usage: blockedInputMessaging message

Parameters:
    message : string - The blocked input message.

Returns: BedrockGuardrailConfig

Sets the message shown when input is blocked.

message : string

The blocked input message.

Returns: BedrockGuardrailConfig

blockedOutputsMessaging message

Full Usage: blockedOutputsMessaging message

Parameters:
    message : string - The blocked output message.

Returns: BedrockGuardrailConfig

Sets the message shown when output is blocked.

message : string

The blocked output message.

Returns: BedrockGuardrailConfig

this.Combine

Full Usage: this.Combine

Parameters:
Returns: BedrockGuardrailConfig
state1 : BedrockGuardrailConfig
state2 : BedrockGuardrailConfig
Returns: BedrockGuardrailConfig

constructId id

Full Usage: constructId id

Parameters:
    id : string - The construct ID.

Returns: BedrockGuardrailConfig

Sets the construct ID for the guardrail.

id : string

The construct ID.

Returns: BedrockGuardrailConfig

contentPolicyConfig policyConfig

Full Usage: contentPolicyConfig policyConfig

Parameters:
Returns: BedrockGuardrailConfig

Sets the content policy configuration (content filters).

policyConfig : IContentPolicyConfigProperty

The CfnGuardrail.IContentPolicyConfigProperty.

Returns: BedrockGuardrailConfig

contextualGroundingPolicyConfig policyConfig

Full Usage: contextualGroundingPolicyConfig policyConfig

Parameters:
Returns: BedrockGuardrailConfig

Sets the contextual grounding policy configuration.

policyConfig : IContextualGroundingPolicyConfigProperty

The CfnGuardrail.IContextualGroundingPolicyConfigProperty.

Returns: BedrockGuardrailConfig

this.Delay

Full Usage: this.Delay

Parameters:
Returns: BedrockGuardrailConfig
Modifiers: inline
f : unit -> BedrockGuardrailConfig
Returns: BedrockGuardrailConfig

description description

Full Usage: description description

Parameters:
    description : string - The description.

Returns: BedrockGuardrailConfig

Sets the description for the guardrail.

description : string

The description.

Returns: BedrockGuardrailConfig

this.For

Full Usage: this.For

Parameters:
Returns: BedrockGuardrailConfig
Modifiers: inline
config : BedrockGuardrailConfig
f : unit -> BedrockGuardrailConfig
Returns: BedrockGuardrailConfig

kmsKeyArn keyArn

Full Usage: kmsKeyArn keyArn

Parameters:
    keyArn : string - The KMS key ARN.

Returns: BedrockGuardrailConfig

Sets the KMS key ARN for encrypting the guardrail.

keyArn : string

The KMS key ARN.

Returns: BedrockGuardrailConfig

this.Run

Full Usage: this.Run

Parameters:
Returns: BedrockGuardrailSpec
config : BedrockGuardrailConfig
Returns: BedrockGuardrailSpec

sensitiveInformationPolicyConfig policyConfig

Full Usage: sensitiveInformationPolicyConfig policyConfig

Parameters:
Returns: BedrockGuardrailConfig

Sets the sensitive information policy configuration (PII filters).

policyConfig : ISensitiveInformationPolicyConfigProperty

The CfnGuardrail.ISensitiveInformationPolicyConfigProperty.

Returns: BedrockGuardrailConfig

tags tags

Full Usage: tags tags

Parameters:
    tags : (string * string) list - List of key-value tag pairs.

Returns: BedrockGuardrailConfig

Adds tags to the guardrail.

tags : (string * string) list

List of key-value tag pairs.

Returns: BedrockGuardrailConfig

topicPolicyConfig policyConfig

Full Usage: topicPolicyConfig policyConfig

Parameters:
Returns: BedrockGuardrailConfig

Sets the topic policy configuration (denied topics).

policyConfig : ITopicPolicyConfigProperty

The CfnGuardrail.ITopicPolicyConfigProperty.

Returns: BedrockGuardrailConfig

wordPolicyConfig policyConfig

Full Usage: wordPolicyConfig policyConfig

Parameters:
Returns: BedrockGuardrailConfig

Sets the word policy configuration (blocked words/phrases).

policyConfig : IWordPolicyConfigProperty

The CfnGuardrail.IWordPolicyConfigProperty.

Returns: BedrockGuardrailConfig

this.Yield

Full Usage: this.Yield

Parameters:
    () : unit

Returns: BedrockGuardrailConfig
() : unit
Returns: BedrockGuardrailConfig

this.Zero

Full Usage: this.Zero

Returns: BedrockGuardrailConfig
Returns: BedrockGuardrailConfig

Type something to start searching.