Class CfnEnforcedGuardrailConfigurationProps

Properties for defining a CfnEnforcedGuardrailConfiguration.

Inheritance

object

CfnEnforcedGuardrailConfigurationProps

Implements

ICfnEnforcedGuardrailConfigurationProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Bedrock

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnEnforcedGuardrailConfigurationProps : ICfnEnforcedGuardrailConfigurationProps

Syntax (vb)

Public Class CfnEnforcedGuardrailConfigurationProps Implements ICfnEnforcedGuardrailConfigurationProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-enforcedguardrailconfiguration.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Bedrock;

             var cfnEnforcedGuardrailConfigurationProps = new CfnEnforcedGuardrailConfigurationProps {
                 GuardrailIdentifier = "guardrailIdentifier",
                 GuardrailVersion = "guardrailVersion",

                 // the properties below are optional
                 ModelEnforcement = new ModelEnforcementProperty {
                     ExcludedModels = new [] { "excludedModels" },
                     IncludedModels = new [] { "includedModels" }
                 },
                 SelectiveContentGuarding = new SelectiveContentGuardingProperty {
                     Messages = "messages",
                     System = "system"
                 }
             };

Synopsis

Constructors

CfnEnforcedGuardrailConfigurationProps()

Properties for defining a CfnEnforcedGuardrailConfiguration.

Properties

GuardrailIdentifier	Identifier for the guardrail, could be the ID or the ARN.
GuardrailVersion	Numerical guardrail version (not DRAFT).
ModelEnforcement	Model-specific information for the enforced guardrail configuration.
SelectiveContentGuarding	Selective content guarding controls for enforced guardrails.

Constructors

CfnEnforcedGuardrailConfigurationProps()

Properties for defining a CfnEnforcedGuardrailConfiguration.

public CfnEnforcedGuardrailConfigurationProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-enforcedguardrailconfiguration.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Bedrock;

             var cfnEnforcedGuardrailConfigurationProps = new CfnEnforcedGuardrailConfigurationProps {
                 GuardrailIdentifier = "guardrailIdentifier",
                 GuardrailVersion = "guardrailVersion",

                 // the properties below are optional
                 ModelEnforcement = new ModelEnforcementProperty {
                     ExcludedModels = new [] { "excludedModels" },
                     IncludedModels = new [] { "includedModels" }
                 },
                 SelectiveContentGuarding = new SelectiveContentGuardingProperty {
                     Messages = "messages",
                     System = "system"
                 }
             };

Properties

GuardrailIdentifier

Identifier for the guardrail, could be the ID or the ARN.

public string GuardrailIdentifier { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-enforcedguardrailconfiguration.html#cfn-bedrock-enforcedguardrailconfiguration-guardrailidentifier

GuardrailVersion

Numerical guardrail version (not DRAFT).

public string GuardrailVersion { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-enforcedguardrailconfiguration.html#cfn-bedrock-enforcedguardrailconfiguration-guardrailversion

ModelEnforcement

Model-specific information for the enforced guardrail configuration.

public object? ModelEnforcement { get; set; }

Property Value

object

Remarks

If not present, the configuration is enforced on all models

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-enforcedguardrailconfiguration.html#cfn-bedrock-enforcedguardrailconfiguration-modelenforcement

Type union: either IResolvable or CfnEnforcedGuardrailConfiguration.IModelEnforcementProperty

SelectiveContentGuarding

Selective content guarding controls for enforced guardrails.

public object? SelectiveContentGuarding { get; set; }