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,
});
python
guardrail = bedrock.Guardrail(self, "bedrockGuardrails",
guardrail_name="my-BedrockGuardrails"
)
# Add PII filter for addresses with input/output actions
guardrail.add_pii_filter(
type=bedrock.GeneralPIIType.ADDRESS,
action=bedrock.GuardrailAction.BLOCK,
# below props are optional
input_action=bedrock.GuardrailAction.BLOCK,
input_enabled=True,
output_action=bedrock.GuardrailAction.ANONYMIZE,
output_enabled=True
)
# Add PII filter for credit card numbers with input/output actions
guardrail.add_pii_filter(
type=bedrock.FinancePIIType.CREDIT_DEBIT_CARD_NUMBER,
action=bedrock.GuardrailAction.BLOCK,
# below props are optional
input_action=bedrock.GuardrailAction.BLOCK,
input_enabled=True,
output_action=bedrock.GuardrailAction.ANONYMIZE,
output_enabled=True
)
# Add PII filter for email addresses
guardrail.add_pii_filter(
type=bedrock.GeneralPIIType.EMAIL,
action=bedrock.GuardrailAction.ANONYMIZE
)
# Add PII filter for US Social Security Numbers
guardrail.add_pii_filter(
type=bedrock.USASpecificPIIType.US_SOCIAL_SECURITY_NUMBER,
action=bedrock.GuardrailAction.BLOCK
)
# Add PII filter for IP addresses
guardrail.add_pii_filter(
type=bedrock.InformationTechnologyPIIType.IP_ADDRESS,
action=bedrock.GuardrailAction.ANONYMIZE
)
java
Guardrail guardrail = Guardrail.Builder.create(this, "bedrockGuardrails")
.guardrailName("my-BedrockGuardrails")
.build();
// Add PII filter for addresses with input/output actions
guardrail.addPIIFilter(PIIFilter.builder()
.type(GeneralPIIType.ADDRESS)
.action(GuardrailAction.BLOCK)
// below props are optional
.inputAction(GuardrailAction.BLOCK)
.inputEnabled(true)
.outputAction(GuardrailAction.ANONYMIZE)
.outputEnabled(true)
.build());
// Add PII filter for credit card numbers with input/output actions
guardrail.addPIIFilter(PIIFilter.builder()
.type(FinancePIIType.CREDIT_DEBIT_CARD_NUMBER)
.action(GuardrailAction.BLOCK)
// below props are optional
.inputAction(GuardrailAction.BLOCK)
.inputEnabled(true)
.outputAction(GuardrailAction.ANONYMIZE)
.outputEnabled(true)
.build());
// Add PII filter for email addresses
guardrail.addPIIFilter(PIIFilter.builder()
.type(GeneralPIIType.EMAIL)
.action(GuardrailAction.ANONYMIZE)
.build());
// Add PII filter for US Social Security Numbers
guardrail.addPIIFilter(PIIFilter.builder()
.type(USASpecificPIIType.US_SOCIAL_SECURITY_NUMBER)
.action(GuardrailAction.BLOCK)
.build());
// Add PII filter for IP addresses
guardrail.addPIIFilter(PIIFilter.builder()
.type(InformationTechnologyPIIType.IP_ADDRESS)
.action(GuardrailAction.ANONYMIZE)
.build());
csharp
// Install: dotnet add package Amazon.CDK.AWS.Bedrock.Alpha
var guardrail = new Guardrail(this, "bedrockGuardrails", new GuardrailProps {
GuardrailName = "my-BedrockGuardrails"
});
// Add PII filter for addresses with input/output actions
guardrail.AddPIIFilter(new PIIFilter {
Type = GeneralPIIType.ADDRESS,
Action = GuardrailAction.BLOCK,
// below props are optional
InputAction = GuardrailAction.BLOCK,
InputEnabled = true,
OutputAction = GuardrailAction.ANONYMIZE,
OutputEnabled = true
});
// Add PII filter for credit card numbers with input/output actions
guardrail.AddPIIFilter(new PIIFilter {
Type = FinancePIIType.CREDIT_DEBIT_CARD_NUMBER,
Action = GuardrailAction.BLOCK,
// below props are optional
InputAction = GuardrailAction.BLOCK,
InputEnabled = true,
OutputAction = GuardrailAction.ANONYMIZE,
OutputEnabled = true
});
// Add PII filter for email addresses
guardrail.AddPIIFilter(new PIIFilter {
Type = GeneralPIIType.EMAIL,
Action = GuardrailAction.ANONYMIZE
});
// Add PII filter for US Social Security Numbers
guardrail.AddPIIFilter(new PIIFilter {
Type = USASpecificPIIType.US_SOCIAL_SECURITY_NUMBER,
Action = GuardrailAction.BLOCK
});
// Add PII filter for IP addresses
guardrail.AddPIIFilter(new PIIFilter {
Type = InformationTechnologyPIIType.IP_ADDRESS,
Action = GuardrailAction.ANONYMIZE
});
go
// Install: go get github.com/aws/aws-cdk-go/awsbedrockalpha/v2
guardrail := bedrock.NewGuardrail(this, jsii.String("bedrockGuardrails"), &GuardrailProps{
GuardrailName: jsii.String("my-BedrockGuardrails"),
})
// Add PII filter for addresses with input/output actions
guardrail.AddPIIFilter(&PIIFilter{
Type: bedrock.GeneralPIIType_ADDRESS(),
Action: bedrock.GuardrailAction_BLOCK,
// below props are optional
InputAction: bedrock.GuardrailAction_BLOCK,
InputEnabled: jsii.Boolean(true),
OutputAction: bedrock.GuardrailAction_ANONYMIZE,
OutputEnabled: jsii.Boolean(true),
})
// Add PII filter for credit card numbers with input/output actions
guardrail.AddPIIFilter(&PIIFilter{
Type: bedrock.FinancePIIType_CREDIT_DEBIT_CARD_NUMBER(),
Action: bedrock.GuardrailAction_BLOCK,
// below props are optional
InputAction: bedrock.GuardrailAction_BLOCK,
InputEnabled: jsii.Boolean(true),
OutputAction: bedrock.GuardrailAction_ANONYMIZE,
OutputEnabled: jsii.Boolean(true),
})
// Add PII filter for email addresses
guardrail.AddPIIFilter(&PIIFilter{
Type: bedrock.GeneralPIIType_EMAIL(),
Action: bedrock.GuardrailAction_ANONYMIZE,
})
// Add PII filter for US Social Security Numbers
guardrail.AddPIIFilter(&PIIFilter{
Type: bedrock.USASpecificPIIType_US_SOCIAL_SECURITY_NUMBER(),
Action: bedrock.GuardrailAction_BLOCK,
})
// Add PII filter for IP addresses
guardrail.AddPIIFilter(&PIIFilter{
Type: bedrock.InformationTechnologyPIIType_IP_ADDRESS(),
Action: bedrock.GuardrailAction_ANONYMIZE,
})
Properties
actionGuardrailActionactionGuardrailActionactionGuardrailActionActionGuardrailActionActionGuardrailAction required #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.