AWS CDK Reference

Appearance

v2.275.0

Experimental

@aws-cdk/aws-bedrock-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

PIIFilter Struct ​

Interface to define a PII Filter.

Stability
Experimental
Source
bedrock/guardrails/guardrail-filters.ts

Example ​

ts
const guardrail = new bedrock.Guardrail(this, 'bedrockGuardrails', {
  guardrailName: 'my-BedrockGuardrails',
});

// Add PII filter for addresses with input/output actions
guardrail.addPIIFilter({
  type: bedrock.GeneralPIIType.ADDRESS,
  action: bedrock.GuardrailAction.BLOCK,
  // below props are optional
  inputAction: bedrock.GuardrailAction.BLOCK,
  inputEnabled: true,
  outputAction: bedrock.GuardrailAction.ANONYMIZE,
  outputEnabled: true,
});

// Add PII filter for credit card numbers with input/output actions
guardrail.addPIIFilter({
  type: bedrock.FinancePIIType.CREDIT_DEBIT_CARD_NUMBER,
  action: bedrock.GuardrailAction.BLOCK,
  // below props are optional
  inputAction: bedrock.GuardrailAction.BLOCK,
  inputEnabled: true,
  outputAction: bedrock.GuardrailAction.ANONYMIZE,
  outputEnabled: true,
});

// Add PII filter for email addresses
guardrail.addPIIFilter({
  type: bedrock.GeneralPIIType.EMAIL,
  action: bedrock.GuardrailAction.ANONYMIZE,
});

// Add PII filter for US Social Security Numbers
guardrail.addPIIFilter({
  type: bedrock.USASpecificPIIType.US_SOCIAL_SECURITY_NUMBER,
  action: bedrock.GuardrailAction.BLOCK,
});

// Add PII filter for IP addresses
guardrail.addPIIFilter({
  type: bedrock.InformationTechnologyPIIType.IP_ADDRESS,
  action: bedrock.GuardrailAction.ANONYMIZE,
});

Properties ​

actionGuardrailActionactionGuardrailActionactionGuardrailActionActionGuardrailActionActionGuardrailActionrequired#
The action to take when PII is detected.
inputActionoptionalGuardrailActioninput_actionoptionalGuardrailActioninputActionoptionalGuardrailActionInputActionoptionalGuardrailActionInputActionoptionalGuardrailAction= GuardrailAction.BLOCK#
The action to take when PII is detected in the input.
inputEnabledoptionalbooleaninput_enabledoptionalboolinputEnabledoptionalBooleanInputEnabledoptionalboolInputEnabledoptional*bool= true#
Whether the PII filter is enabled for input.
outputActionoptionalGuardrailActionoutput_actionoptionalGuardrailActionoutputActionoptionalGuardrailActionOutputActionoptionalGuardrailActionOutputActionoptionalGuardrailAction= GuardrailAction.BLOCK#
The action to take when PII is detected in the output.
outputEnabledoptionalbooleanoutput_enabledoptionalbooloutputEnabledoptionalBooleanOutputEnabledoptionalboolOutputEnabledoptional*bool= true#
Whether the PII filter is enabled for output.
typePIITypetypePIITypetypePIITypeTypePIITypeTypePIITyperequired#
The type of PII to filter.