2.214.0

interface PIIFilter 🔹

LanguageType name
.NETAmazon.CDK.AWS.Bedrock.Alpha.PIIFilter
Gogithub.com/aws/aws-cdk-go/awsbedrockalpha/v2#PIIFilter
Javasoftware.amazon.awscdk.services.bedrock.alpha.PIIFilter
Pythonaws_cdk.aws_bedrock_alpha.PIIFilter
TypeScript (source)@aws-cdk/aws-bedrock-alpha » PIIFilter

Interface to define a PII Filter.

Example

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

NameTypeDescription
action🔹GuardrailActionThe action to take when PII is detected.
type🔹PIITypeThe type of PII to filter.
inputAction?🔹GuardrailActionThe action to take when PII is detected in the input.
inputEnabled?🔹booleanWhether the PII filter is enabled for input.
outputAction?🔹GuardrailActionThe action to take when PII is detected in the output.
outputEnabled?🔹booleanWhether the PII filter is enabled for output.

action🔹

Type: GuardrailAction

The action to take when PII is detected.

type🔹

Type: PIIType

The type of PII to filter.

inputAction?🔹

Type: GuardrailAction (optional, default: GuardrailAction.BLOCK)

The action to take when PII is detected in the input.

inputEnabled?🔹

Type: boolean (optional, default: true)

Whether the PII filter is enabled for input.

outputAction?🔹

Type: GuardrailAction (optional, default: GuardrailAction.BLOCK)

The action to take when PII is detected in the output.

outputEnabled?🔹

Type: boolean (optional, default: true)

Whether the PII filter is enabled for output.

← PreviousNext →