class CfnGuardrail (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.aws_bedrock.CfnGuardrail |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsbedrock#CfnGuardrail |
![]() | software.amazon.awscdk.services.bedrock.CfnGuardrail |
![]() | aws_cdk.aws_bedrock.CfnGuardrail |
![]() | aws-cdk-lib » aws_bedrock » CfnGuardrail |
Implements
IConstruct
, IDependable
, IInspectable
, ITaggable
Creates a guardrail to block topics and to implement safeguards for your generative AI applications.
You can configure the following policies in a guardrail to avoid undesirable and harmful content, filter out denied topics and words, and remove sensitive information for privacy protection.
- Content filters - Adjust filter strengths to block input prompts or model responses containing harmful content.
- Denied topics - Define a set of topics that are undesirable in the context of your application. These topics will be blocked if detected in user queries or model responses.
- Word filters - Configure filters to block undesirable words, phrases, and profanity. Such words can include offensive terms, competitor names etc.
- Sensitive information filters - Block or mask sensitive information such as personally identifiable information (PII) or custom regex in user inputs and model responses.
In addition to the above policies, you can also configure the messages to be returned to the user if a user input or model response is in violation of the policies defined in the guardrail.
For more information, see Amazon Bedrock Guardrails in the Amazon Bedrock User Guide .
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_bedrock as bedrock } from 'aws-cdk-lib';
const cfnGuardrail = new bedrock.CfnGuardrail(this, 'MyCfnGuardrail', {
blockedInputMessaging: 'blockedInputMessaging',
blockedOutputsMessaging: 'blockedOutputsMessaging',
name: 'name',
// the properties below are optional
contentPolicyConfig: {
filtersConfig: [{
inputStrength: 'inputStrength',
outputStrength: 'outputStrength',
type: 'type',
}],
},
contextualGroundingPolicyConfig: {
filtersConfig: [{
threshold: 123,
type: 'type',
}],
},
description: 'description',
kmsKeyArn: 'kmsKeyArn',
sensitiveInformationPolicyConfig: {
piiEntitiesConfig: [{
action: 'action',
type: 'type',
}],
regexesConfig: [{
action: 'action',
name: 'name',
pattern: 'pattern',
// the properties below are optional
description: 'description',
}],
},
tags: [{
key: 'key',
value: 'value',
}],
topicPolicyConfig: {
topicsConfig: [{
definition: 'definition',
name: 'name',
type: 'type',
// the properties below are optional
examples: ['examples'],
}],
},
wordPolicyConfig: {
managedWordListsConfig: [{
type: 'type',
}],
wordsConfig: [{
text: 'text',
}],
},
});
Initializer
new CfnGuardrail(scope: Construct, id: string, props: CfnGuardrailProps)
Parameters
- scope
Construct
— Scope in which this resource is defined. - id
string
— Construct identifier for this resource (unique in its scope). - props
Cfn
— Resource properties.Guardrail Props
Construct Props
Name | Type | Description |
---|---|---|
blocked | string | The message to return when the guardrail blocks a prompt. |
blocked | string | The message to return when the guardrail blocks a model response. |
name | string | The name of the guardrail. |
content | IResolvable | Content | The content filter policies to configure for the guardrail. |
contextual | IResolvable | Contextual | Contextual grounding policy config for a guardrail. |
description? | string | A description of the guardrail. |
kms | string | The ARN of the AWS KMS key that you use to encrypt the guardrail. |
sensitive | IResolvable | Sensitive | The sensitive information policy to configure for the guardrail. |
tags? | Cfn [] | The tags that you want to attach to the guardrail. |
topic | IResolvable | Topic | The topic policies to configure for the guardrail. |
word | IResolvable | Word | The word policy you configure for the guardrail. |
blockedInputMessaging
Type:
string
The message to return when the guardrail blocks a prompt.
blockedOutputsMessaging
Type:
string
The message to return when the guardrail blocks a model response.
name
Type:
string
The name of the guardrail.
contentPolicyConfig?
Type:
IResolvable
|
Content
(optional)
The content filter policies to configure for the guardrail.
contextualGroundingPolicyConfig?
Type:
IResolvable
|
Contextual
(optional)
Contextual grounding policy config for a guardrail.
description?
Type:
string
(optional)
A description of the guardrail.
kmsKeyArn?
Type:
string
(optional)
The ARN of the AWS KMS key that you use to encrypt the guardrail.
sensitiveInformationPolicyConfig?
Type:
IResolvable
|
Sensitive
(optional)
The sensitive information policy to configure for the guardrail.
tags?
Type:
Cfn
[]
(optional)
The tags that you want to attach to the guardrail.
topicPolicyConfig?
Type:
IResolvable
|
Topic
(optional)
The topic policies to configure for the guardrail.
wordPolicyConfig?
Type:
IResolvable
|
Word
(optional)
The word policy you configure for the guardrail.
Properties
Name | Type | Description |
---|---|---|
attr | string | The date and time at which the guardrail was created. |
attr | string[] | Appears if the status of the guardrail is FAILED . |
attr | string | The ARN of the guardrail. |
attr | string | The unique identifier of the guardrail. |
attr | string | The status of the guardrail. |
attr | string[] | Appears if the status is FAILED . |
attr | string | The date and time at which the guardrail was last updated. |
attr | string | The version of the guardrail that was created. |
blocked | string | The message to return when the guardrail blocks a prompt. |
blocked | string | The message to return when the guardrail blocks a model response. |
cdk | Tag | Tag Manager which manages the tags for this resource. |
cfn | ICfn | Options for this resource, such as condition, update policy etc. |
cfn | { [string]: any } | |
cfn | string | AWS resource type. |
creation | string[] | |
logical | string | The logical ID for this CloudFormation stack element. |
name | string | The name of the guardrail. |
node | Node | The tree node. |
ref | string | Return a string that will be resolved to a CloudFormation { Ref } for this element. |
stack | Stack | The stack in which this element is defined. |
content | IResolvable | Content | The content filter policies to configure for the guardrail. |
contextual | IResolvable | Contextual | Contextual grounding policy config for a guardrail. |
description? | string | A description of the guardrail. |
kms | string | The ARN of the AWS KMS key that you use to encrypt the guardrail. |
sensitive | IResolvable | Sensitive | The sensitive information policy to configure for the guardrail. |
tags? | Cfn [] | The tags that you want to attach to the guardrail. |
topic | IResolvable | Topic | The topic policies to configure for the guardrail. |
word | IResolvable | Word | The word policy you configure for the guardrail. |
static CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. |
attrCreatedAt
Type:
string
The date and time at which the guardrail was created.
attrFailureRecommendations
Type:
string[]
Appears if the status
of the guardrail is FAILED
.
A list of recommendations to carry out before retrying the request.
attrGuardrailArn
Type:
string
The ARN of the guardrail.
attrGuardrailId
Type:
string
The unique identifier of the guardrail.
attrStatus
Type:
string
The status of the guardrail.
attrStatusReasons
Type:
string[]
Appears if the status
is FAILED
.
A list of reasons for why the guardrail failed to be created, updated, versioned, or deleted.
attrUpdatedAt
Type:
string
The date and time at which the guardrail was last updated.
attrVersion
Type:
string
The version of the guardrail that was created.
This value will always be DRAFT
.
blockedInputMessaging
Type:
string
The message to return when the guardrail blocks a prompt.
blockedOutputsMessaging
Type:
string
The message to return when the guardrail blocks a model response.
cdkTagManager
Type:
Tag
Tag Manager which manages the tags for this resource.
cfnOptions
Type:
ICfn
Options for this resource, such as condition, update policy etc.
cfnProperties
Type:
{ [string]: any }
cfnResourceType
Type:
string
AWS resource type.
creationStack
Type:
string[]
logicalId
Type:
string
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId)
.
name
Type:
string
The name of the guardrail.
node
Type:
Node
The tree node.
ref
Type:
string
Return a string that will be resolved to a CloudFormation { Ref }
for this element.
If, by any chance, the intrinsic reference of a resource is not a string, you could
coerce it to an IResolvable through Lazy.any({ produce: resource.ref })
.
stack
Type:
Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
contentPolicyConfig?
Type:
IResolvable
|
Content
(optional)
The content filter policies to configure for the guardrail.
contextualGroundingPolicyConfig?
Type:
IResolvable
|
Contextual
(optional)
Contextual grounding policy config for a guardrail.
description?
Type:
string
(optional)
A description of the guardrail.
kmsKeyArn?
Type:
string
(optional)
The ARN of the AWS KMS key that you use to encrypt the guardrail.
sensitiveInformationPolicyConfig?
Type:
IResolvable
|
Sensitive
(optional)
The sensitive information policy to configure for the guardrail.
tags?
Type:
Cfn
[]
(optional)
The tags that you want to attach to the guardrail.
topicPolicyConfig?
Type:
IResolvable
|
Topic
(optional)
The topic policies to configure for the guardrail.
wordPolicyConfig?
Type:
IResolvable
|
Word
(optional)
The word policy you configure for the guardrail.
static CFN_RESOURCE_TYPE_NAME
Type:
string
The CloudFormation resource type name for this resource class.
Methods
Name | Description |
---|---|
add | Syntactic sugar for addOverride(path, undefined) . |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Add a value to the CloudFormation Resource Metadata. |
add | Adds an override to the synthesized CloudFormation resource. |
add | Adds an override that deletes the value of a property from the resource definition. |
add | Adds an override to a resource property. |
apply | Sets the deletion policy of the resource based on the removal policy specified. |
get | Returns a token for an runtime attribute of this resource. |
get | Retrieve a value value from the CloudFormation Resource Metadata. |
inspect(inspector) | Examines the CloudFormation resource and discloses attributes. |
obtain | Retrieves an array of resources this resource depends on. |
obtain | Get a shallow copy of dependencies between this resource and other resources in the same stack. |
override | Overrides the auto-generated logical ID with a specific ID. |
remove | Indicates that this resource no longer depends on another resource. |
replace | Replaces one dependency with another. |
to | Returns a string representation of this construct. |
protected render |
addDeletionOverride(path)
public addDeletionOverride(path: string): void
Parameters
- path
string
— The path of the value to delete.
Syntactic sugar for addOverride(path, undefined)
.
addDependency(target)
public addDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
addDependsOn(target)
public addDependsOn(target: CfnResource): void
⚠️ Deprecated: use addDependency
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)
public addMetadata(key: string, value: any): void
Parameters
- key
string
- value
any
Add a value to the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
addOverride(path, value)
public addOverride(path: string, value: any): void
Parameters
- path
string
— - The path of the property, you can use dot notation to override values in complex types. - value
any
— - The value.
Adds an override to the synthesized CloudFormation resource.
To add a
property override, either use addPropertyOverride
or prefix path
with
"Properties." (i.e. Properties.TopicName
).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal .
in the property name, prefix with a \
. In most
programming languages you will need to write this as "\\."
because the
\
itself will need to be escaped.
For example,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value
argument to addOverride
will not be processed or translated
in any way. Pass raw JSON values in here with the correct capitalization
for CloudFormation. If you pass CDK classes or structs, they will be
rendered with lowercased key names, and CloudFormation will reject the
template.
addPropertyDeletionOverride(propertyPath)
public addPropertyDeletionOverride(propertyPath: string): void
Parameters
- propertyPath
string
— The path to the property.
Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)
public addPropertyOverride(propertyPath: string, value: any): void
Parameters
- propertyPath
string
— The path of the property. - value
any
— The value.
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value)
.
applyRemovalPolicy(policy?, options?)
public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void
Parameters
- policy
Removal
Policy - options
Removal
Policy Options
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY
), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN
). In some
cases, a snapshot can be taken of the resource prior to deletion
(RemovalPolicy.SNAPSHOT
). A list of resources that support this policy
can be found in the following link:
getAtt(attributeName, typeHint?)
public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference
Parameters
- attributeName
string
— The name of the attribute. - typeHint
Resolution
Type Hint
Returns
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn
), but this can be used for future compatibility
in case there is no generated attribute.
getMetadata(key)
public getMetadata(key: string): any
Parameters
- key
string
Returns
any
Retrieve a value value from the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
inspect(inspector)
public inspect(inspector: TreeInspector): void
Parameters
- inspector
Tree
— tree inspector to collect and process attributes.Inspector
Examines the CloudFormation resource and discloses attributes.
obtainDependencies()
public obtainDependencies(): Stack | CfnResource[]
Returns
Stack
|
Cfn
Resource []
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
obtainResourceDependencies()
public obtainResourceDependencies(): CfnResource[]
Returns
Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)
public overrideLogicalId(newLogicalId: string): void
Parameters
- newLogicalId
string
— The new logical ID to use for this stack element.
Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)
public removeDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target, newTarget)
public replaceDependency(target: CfnResource, newTarget: CfnResource): void
Parameters
- target
Cfn
— The dependency to replace.Resource - newTarget
Cfn
— The new dependency to add.Resource
Replaces one dependency with another.
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
protected renderProperties(props)
protected renderProperties(props: { [string]: any }): { [string]: any }
Parameters
- props
{ [string]: any }
Returns
{ [string]: any }