Experimental
@aws-cdk/aws-bedrock-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
GeneralPIIType Class
Types of PII that are general, and not domain-specific.
| Stability | Experimental |
|---|---|
| Source | bedrock/guardrails/guardrail-filters.ts |
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,
});
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
)
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());
// 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
});
// 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
ADDRESSGeneralPIITypeADDRESSGeneralPIITypeADDRESSGeneralPIITypeADDRESSGeneralPIITypeADDRESSGeneralPIIType static #An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood.
DRIVER_IDGeneralPIITypeDRIVER_IDGeneralPIITypeDRIVER_IDGeneralPIITypeDRIVER_IDGeneralPIITypeDRIVER_IDGeneralPIIType static #A driver's license number consists of alphanumeric characters.
EMAILGeneralPIITypeEMAILGeneralPIITypeEMAILGeneralPIITypeEMAILGeneralPIITypeEMAILGeneralPIIType static #LICENSE_PLATEGeneralPIITypeLICENSE_PLATEGeneralPIITypeLICENSE_PLATEGeneralPIITypeLICENSE_PLATEGeneralPIITypeLICENSE_PLATEGeneralPIIType static #The format for passenger vehicles is typically five to eight digits, consisting of upper-case letters and numbers. The format varies depending on the location of the issuing state or country.
This entity type does not include titles, such as Dr., Mr., Mrs., or Miss.
PASSWORDGeneralPIITypePASSWORDGeneralPIITypePASSWORDGeneralPIITypePASSWORDGeneralPIITypePASSWORDGeneralPIIType static #PHONEGeneralPIITypePHONEGeneralPIITypePHONEGeneralPIITypePHONEGeneralPIITypePHONEGeneralPIIType static #This entity type also includes fax and pager numbers.
USERNAMEGeneralPIITypeUSERNAMEGeneralPIITypeUSERNAMEGeneralPIITypeUSERNAMEGeneralPIITypeUSERNAMEGeneralPIIType static #VEHICLE_IDENTIFICATION_NUMBERGeneralPIITypeVEHICLE_IDENTIFICATION_NUMBERGeneralPIITypeVEHICLE_IDENTIFICATION_NUMBERGeneralPIITypeVEHICLE_IDENTIFICATION_NUMBERGeneralPIITypeVEHICLE_IDENTIFICATION_NUMBERGeneralPIIType static #VIN content and format are defined in the ISO 3779 specification. Each country has specific codes and formats for VINs.
Methods
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string #returns
Returns: The string value of the PII type.