class CfnAIGuardrailPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Wisdom.Mixins.CfnAIGuardrailPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awswisdom/mixins#CfnAIGuardrailPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.wisdom.mixins.CfnAIGuardrailPropsMixin
Python	aws_cdk.mixins_preview.aws_wisdom.mixins.CfnAIGuardrailPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_wisdom » mixins » CfnAIGuardrailPropsMixin

Implements IMixin

Extends Mixin

Creates an Amazon Q in Connect AI Guardrail.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiguardrail.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as wisdom_mixins } from '@aws-cdk/mixins-preview/aws-wisdom';
const cfnAIGuardrailPropsMixin = new wisdom_mixins.CfnAIGuardrailPropsMixin({
  assistantId: 'assistantId',
  blockedInputMessaging: 'blockedInputMessaging',
  blockedOutputsMessaging: 'blockedOutputsMessaging',
  contentPolicyConfig: {
    filtersConfig: [{
      inputStrength: 'inputStrength',
      outputStrength: 'outputStrength',
      type: 'type',
    }],
  },
  contextualGroundingPolicyConfig: {
    filtersConfig: [{
      threshold: 123,
      type: 'type',
    }],
  },
  description: 'description',
  name: 'name',
  sensitiveInformationPolicyConfig: {
    piiEntitiesConfig: [{
      action: 'action',
      type: 'type',
    }],
    regexesConfig: [{
      action: 'action',
      description: 'description',
      name: 'name',
      pattern: 'pattern',
    }],
  },
  tags: {
    tagsKey: 'tags',
  },
  topicPolicyConfig: {
    topicsConfig: [{
      definition: 'definition',
      examples: ['examples'],
      name: 'name',
      type: 'type',
    }],
  },
  wordPolicyConfig: {
    managedWordListsConfig: [{
      type: 'type',
    }],
    wordsConfig: [{
      text: 'text',
    }],
  },
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnAIGuardrailPropsMixin(props: CfnAIGuardrailMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnAIGuardrailMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::Wisdom::AIGuardrail.

Properties

Name	Type	Description
props	CfnAIGuardrailMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnAIGuardrailMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.