aws-cdk-lib 2.207.0__py3-none-any.whl → 2.209.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of aws-cdk-lib might be problematic. Click here for more details.
- aws_cdk/__init__.py +31 -3
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.207.0.jsii.tgz → aws-cdk-lib@2.209.0.jsii.tgz} +0 -0
- aws_cdk/aws_aiops/__init__.py +16 -12
- aws_cdk/aws_amazonmq/__init__.py +8 -18
- aws_cdk/aws_appstream/__init__.py +36 -4
- aws_cdk/aws_bedrock/__init__.py +227 -102
- aws_cdk/aws_certificatemanager/__init__.py +45 -0
- aws_cdk/aws_cloudfront/__init__.py +12 -2
- aws_cdk/aws_connect/__init__.py +107 -3
- aws_cdk/aws_customerprofiles/__init__.py +27 -22
- aws_cdk/aws_docdb/__init__.py +5 -3
- aws_cdk/aws_ec2/__init__.py +58 -16
- aws_cdk/aws_ecs/__init__.py +1554 -78
- aws_cdk/aws_elasticloadbalancingv2/__init__.py +27 -15
- aws_cdk/aws_events/__init__.py +142 -0
- aws_cdk/aws_gamelift/__init__.py +2 -2
- aws_cdk/aws_guardduty/__init__.py +86 -0
- aws_cdk/aws_kinesisfirehose/__init__.py +377 -4
- aws_cdk/aws_lambda/__init__.py +76 -67
- aws_cdk/aws_logs/__init__.py +53 -4
- aws_cdk/aws_mediapackagev2/__init__.py +881 -0
- aws_cdk/aws_omics/__init__.py +13 -10
- aws_cdk/aws_quicksight/__init__.py +111 -4
- aws_cdk/aws_rds/__init__.py +214 -10
- aws_cdk/aws_route53/__init__.py +97 -41
- aws_cdk/aws_s3/__init__.py +775 -5
- aws_cdk/aws_s3express/__init__.py +61 -3
- aws_cdk/aws_s3tables/__init__.py +254 -0
- aws_cdk/aws_sagemaker/__init__.py +524 -137
- aws_cdk/aws_ssm/__init__.py +48 -0
- aws_cdk/aws_transfer/__init__.py +49 -0
- aws_cdk/aws_wisdom/__init__.py +1185 -100
- aws_cdk/cloud_assembly_schema/__init__.py +28 -2
- aws_cdk/custom_resources/__init__.py +1 -1
- {aws_cdk_lib-2.207.0.dist-info → aws_cdk_lib-2.209.0.dist-info}/METADATA +2 -2
- {aws_cdk_lib-2.207.0.dist-info → aws_cdk_lib-2.209.0.dist-info}/RECORD +41 -41
- {aws_cdk_lib-2.207.0.dist-info → aws_cdk_lib-2.209.0.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.207.0.dist-info → aws_cdk_lib-2.209.0.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.207.0.dist-info → aws_cdk_lib-2.209.0.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.207.0.dist-info → aws_cdk_lib-2.209.0.dist-info}/top_level.txt +0 -0
aws_cdk/aws_bedrock/__init__.py
CHANGED
|
@@ -3539,27 +3539,30 @@ class CfnApplicationInferenceProfile(
|
|
|
3539
3539
|
|
|
3540
3540
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-applicationinferenceprofile.html
|
|
3541
3541
|
:cloudformationResource: AWS::Bedrock::ApplicationInferenceProfile
|
|
3542
|
-
:exampleMetadata: fixture=
|
|
3542
|
+
:exampleMetadata: fixture=default infused
|
|
3543
3543
|
|
|
3544
3544
|
Example::
|
|
3545
3545
|
|
|
3546
|
-
#
|
|
3547
|
-
|
|
3548
|
-
|
|
3546
|
+
# Create or reference an existing L1 CfnApplicationInferenceProfile
|
|
3547
|
+
cfn_profile = aws_bedrock_cfn.CfnApplicationInferenceProfile(self, "CfnProfile",
|
|
3548
|
+
inference_profile_name="my-cfn-profile",
|
|
3549
|
+
model_source=aws_bedrock_cfn.CfnApplicationInferenceProfile.InferenceProfileModelSourceProperty(
|
|
3550
|
+
copy_from=bedrock.BedrockFoundationModel.ANTHROPIC_CLAUDE_3_5_SONNET_V1_0.invokable_arn
|
|
3551
|
+
),
|
|
3552
|
+
description="Profile created via L1 construct"
|
|
3553
|
+
)
|
|
3549
3554
|
|
|
3550
|
-
|
|
3551
|
-
|
|
3555
|
+
# Import the L1 construct as an L2 ApplicationInferenceProfile
|
|
3556
|
+
imported_from_cfn = bedrock.ApplicationInferenceProfile.from_cfn_application_inference_profile(cfn_profile)
|
|
3552
3557
|
|
|
3553
|
-
|
|
3554
|
-
|
|
3555
|
-
|
|
3556
|
-
|
|
3557
|
-
)
|
|
3558
|
-
tags=[CfnTag(
|
|
3559
|
-
key="key",
|
|
3560
|
-
value="value"
|
|
3561
|
-
)]
|
|
3558
|
+
# Grant permissions to use the imported profile
|
|
3559
|
+
lambda_function = lambda_.Function(self, "MyFunction",
|
|
3560
|
+
runtime=lambda_.Runtime.PYTHON_3_11,
|
|
3561
|
+
handler="index.handler",
|
|
3562
|
+
code=lambda_.Code.from_inline("def handler(event, context): return \"Hello\"")
|
|
3562
3563
|
)
|
|
3564
|
+
|
|
3565
|
+
imported_from_cfn.grant_profile_usage(lambda_function)
|
|
3563
3566
|
'''
|
|
3564
3567
|
|
|
3565
3568
|
def __init__(
|
|
@@ -3899,27 +3902,30 @@ class CfnApplicationInferenceProfileProps:
|
|
|
3899
3902
|
:param tags: A list of tags associated with the inference profile.
|
|
3900
3903
|
|
|
3901
3904
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-applicationinferenceprofile.html
|
|
3902
|
-
:exampleMetadata: fixture=
|
|
3905
|
+
:exampleMetadata: fixture=default infused
|
|
3903
3906
|
|
|
3904
3907
|
Example::
|
|
3905
3908
|
|
|
3906
|
-
#
|
|
3907
|
-
|
|
3908
|
-
|
|
3909
|
+
# Create or reference an existing L1 CfnApplicationInferenceProfile
|
|
3910
|
+
cfn_profile = aws_bedrock_cfn.CfnApplicationInferenceProfile(self, "CfnProfile",
|
|
3911
|
+
inference_profile_name="my-cfn-profile",
|
|
3912
|
+
model_source=aws_bedrock_cfn.CfnApplicationInferenceProfile.InferenceProfileModelSourceProperty(
|
|
3913
|
+
copy_from=bedrock.BedrockFoundationModel.ANTHROPIC_CLAUDE_3_5_SONNET_V1_0.invokable_arn
|
|
3914
|
+
),
|
|
3915
|
+
description="Profile created via L1 construct"
|
|
3916
|
+
)
|
|
3909
3917
|
|
|
3910
|
-
|
|
3911
|
-
|
|
3918
|
+
# Import the L1 construct as an L2 ApplicationInferenceProfile
|
|
3919
|
+
imported_from_cfn = bedrock.ApplicationInferenceProfile.from_cfn_application_inference_profile(cfn_profile)
|
|
3912
3920
|
|
|
3913
|
-
|
|
3914
|
-
|
|
3915
|
-
|
|
3916
|
-
|
|
3917
|
-
)
|
|
3918
|
-
tags=[CfnTag(
|
|
3919
|
-
key="key",
|
|
3920
|
-
value="value"
|
|
3921
|
-
)]
|
|
3921
|
+
# Grant permissions to use the imported profile
|
|
3922
|
+
lambda_function = lambda_.Function(self, "MyFunction",
|
|
3923
|
+
runtime=lambda_.Runtime.PYTHON_3_11,
|
|
3924
|
+
handler="index.handler",
|
|
3925
|
+
code=lambda_.Code.from_inline("def handler(event, context): return \"Hello\"")
|
|
3922
3926
|
)
|
|
3927
|
+
|
|
3928
|
+
imported_from_cfn.grant_profile_usage(lambda_function)
|
|
3923
3929
|
'''
|
|
3924
3930
|
if __debug__:
|
|
3925
3931
|
type_hints = typing.get_type_hints(_typecheckingstub__396027668dce29a45dd42acb9bb8358fa9135a15e45d6925e8a78acced3bd78d)
|
|
@@ -23387,7 +23393,7 @@ class CfnGuardrail(
|
|
|
23387
23393
|
:param name: The name of the guardrail.
|
|
23388
23394
|
:param content_policy_config: The content filter policies to configure for the guardrail.
|
|
23389
23395
|
:param contextual_grounding_policy_config: Contextual grounding policy config for a guardrail.
|
|
23390
|
-
:param cross_region_config: The system-defined guardrail profile that you
|
|
23396
|
+
:param cross_region_config: The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination AWS Regions where guardrail inference requests can be automatically routed. Using guardrail profiles helps maintain guardrail performance and reliability when demand increases. For more information, see the `Amazon Bedrock User Guide <https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html>`_ .
|
|
23391
23397
|
:param description: A description of the guardrail.
|
|
23392
23398
|
:param kms_key_arn: The ARN of the AWS KMS key that you use to encrypt the guardrail.
|
|
23393
23399
|
:param sensitive_information_policy_config: The sensitive information policy to configure for the guardrail.
|
|
@@ -23615,7 +23621,7 @@ class CfnGuardrail(
|
|
|
23615
23621
|
def cross_region_config(
|
|
23616
23622
|
self,
|
|
23617
23623
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnGuardrail.GuardrailCrossRegionConfigProperty"]]:
|
|
23618
|
-
'''The system-defined guardrail profile that you
|
|
23624
|
+
'''The system-defined guardrail profile that you're using with your guardrail.'''
|
|
23619
23625
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnGuardrail.GuardrailCrossRegionConfigProperty"]], jsii.get(self, "crossRegionConfig"))
|
|
23620
23626
|
|
|
23621
23627
|
@cross_region_config.setter
|
|
@@ -23766,12 +23772,12 @@ class CfnGuardrail(
|
|
|
23766
23772
|
:param input_strength: The strength of the content filter to apply to prompts. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.
|
|
23767
23773
|
:param output_strength: The strength of the content filter to apply to model responses. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.
|
|
23768
23774
|
:param type: The harmful category that the content filter is applied to.
|
|
23769
|
-
:param input_action:
|
|
23770
|
-
:param input_enabled:
|
|
23771
|
-
:param input_modalities:
|
|
23772
|
-
:param output_action:
|
|
23773
|
-
:param output_enabled:
|
|
23774
|
-
:param output_modalities:
|
|
23775
|
+
:param input_action: Specifies the action to take when harmful content is detected. Supported values include:. - ``BLOCK`` – Block the content and replace it with blocked messaging. - ``NONE`` – Take no action but return detection information in the trace response.
|
|
23776
|
+
:param input_enabled: Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
23777
|
+
:param input_modalities: The input modalities selected for the guardrail content filter configuration.
|
|
23778
|
+
:param output_action: Specifies the action to take when harmful content is detected in the output. Supported values include:. - ``BLOCK`` – Block the content and replace it with blocked messaging. - ``NONE`` – Take no action but return detection information in the trace response.
|
|
23779
|
+
:param output_enabled: Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
23780
|
+
:param output_modalities: The output modalities selected for the guardrail content filter configuration.
|
|
23775
23781
|
|
|
23776
23782
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html
|
|
23777
23783
|
:exampleMetadata: fixture=_generated
|
|
@@ -23861,7 +23867,11 @@ class CfnGuardrail(
|
|
|
23861
23867
|
|
|
23862
23868
|
@builtins.property
|
|
23863
23869
|
def input_action(self) -> typing.Optional[builtins.str]:
|
|
23864
|
-
'''
|
|
23870
|
+
'''Specifies the action to take when harmful content is detected. Supported values include:.
|
|
23871
|
+
|
|
23872
|
+
- ``BLOCK`` – Block the content and replace it with blocked messaging.
|
|
23873
|
+
- ``NONE`` – Take no action but return detection information in the trace response.
|
|
23874
|
+
|
|
23865
23875
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html#cfn-bedrock-guardrail-contentfilterconfig-inputaction
|
|
23866
23876
|
'''
|
|
23867
23877
|
result = self._values.get("input_action")
|
|
@@ -23871,7 +23881,10 @@ class CfnGuardrail(
|
|
|
23871
23881
|
def input_enabled(
|
|
23872
23882
|
self,
|
|
23873
23883
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
23874
|
-
'''
|
|
23884
|
+
'''Specifies whether to enable guardrail evaluation on the input.
|
|
23885
|
+
|
|
23886
|
+
When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
23887
|
+
|
|
23875
23888
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html#cfn-bedrock-guardrail-contentfilterconfig-inputenabled
|
|
23876
23889
|
'''
|
|
23877
23890
|
result = self._values.get("input_enabled")
|
|
@@ -23879,7 +23892,7 @@ class CfnGuardrail(
|
|
|
23879
23892
|
|
|
23880
23893
|
@builtins.property
|
|
23881
23894
|
def input_modalities(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
23882
|
-
'''
|
|
23895
|
+
'''The input modalities selected for the guardrail content filter configuration.
|
|
23883
23896
|
|
|
23884
23897
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html#cfn-bedrock-guardrail-contentfilterconfig-inputmodalities
|
|
23885
23898
|
'''
|
|
@@ -23888,7 +23901,11 @@ class CfnGuardrail(
|
|
|
23888
23901
|
|
|
23889
23902
|
@builtins.property
|
|
23890
23903
|
def output_action(self) -> typing.Optional[builtins.str]:
|
|
23891
|
-
'''
|
|
23904
|
+
'''Specifies the action to take when harmful content is detected in the output. Supported values include:.
|
|
23905
|
+
|
|
23906
|
+
- ``BLOCK`` – Block the content and replace it with blocked messaging.
|
|
23907
|
+
- ``NONE`` – Take no action but return detection information in the trace response.
|
|
23908
|
+
|
|
23892
23909
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html#cfn-bedrock-guardrail-contentfilterconfig-outputaction
|
|
23893
23910
|
'''
|
|
23894
23911
|
result = self._values.get("output_action")
|
|
@@ -23898,7 +23915,10 @@ class CfnGuardrail(
|
|
|
23898
23915
|
def output_enabled(
|
|
23899
23916
|
self,
|
|
23900
23917
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
23901
|
-
'''
|
|
23918
|
+
'''Specifies whether to enable guardrail evaluation on the output.
|
|
23919
|
+
|
|
23920
|
+
When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
23921
|
+
|
|
23902
23922
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html#cfn-bedrock-guardrail-contentfilterconfig-outputenabled
|
|
23903
23923
|
'''
|
|
23904
23924
|
result = self._values.get("output_enabled")
|
|
@@ -23906,7 +23926,7 @@ class CfnGuardrail(
|
|
|
23906
23926
|
|
|
23907
23927
|
@builtins.property
|
|
23908
23928
|
def output_modalities(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
23909
|
-
'''
|
|
23929
|
+
'''The output modalities selected for the guardrail content filter configuration.
|
|
23910
23930
|
|
|
23911
23931
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html#cfn-bedrock-guardrail-contentfilterconfig-outputmodalities
|
|
23912
23932
|
'''
|
|
@@ -23931,9 +23951,11 @@ class CfnGuardrail(
|
|
|
23931
23951
|
)
|
|
23932
23952
|
class ContentFiltersTierConfigProperty:
|
|
23933
23953
|
def __init__(self, *, tier_name: builtins.str) -> None:
|
|
23934
|
-
'''
|
|
23954
|
+
'''The tier that your guardrail uses for content filters.
|
|
23955
|
+
|
|
23956
|
+
Consider using a tier that balances performance, accuracy, and compatibility with your existing generative AI workflows.
|
|
23935
23957
|
|
|
23936
|
-
:param tier_name:
|
|
23958
|
+
:param tier_name: The tier that your guardrail uses for content filters. Valid values include:. - ``CLASSIC`` tier – Provides established guardrails functionality supporting English, French, and Spanish languages. - ``STANDARD`` tier – Provides a more robust solution than the ``CLASSIC`` tier and has more comprehensive language support. This tier requires that your guardrail use `cross-Region inference <https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html>`_ .
|
|
23937
23959
|
|
|
23938
23960
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterstierconfig.html
|
|
23939
23961
|
:exampleMetadata: fixture=_generated
|
|
@@ -23957,7 +23979,10 @@ class CfnGuardrail(
|
|
|
23957
23979
|
|
|
23958
23980
|
@builtins.property
|
|
23959
23981
|
def tier_name(self) -> builtins.str:
|
|
23960
|
-
'''
|
|
23982
|
+
'''The tier that your guardrail uses for content filters. Valid values include:.
|
|
23983
|
+
|
|
23984
|
+
- ``CLASSIC`` tier – Provides established guardrails functionality supporting English, French, and Spanish languages.
|
|
23985
|
+
- ``STANDARD`` tier – Provides a more robust solution than the ``CLASSIC`` tier and has more comprehensive language support. This tier requires that your guardrail use `cross-Region inference <https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html>`_ .
|
|
23961
23986
|
|
|
23962
23987
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterstierconfig.html#cfn-bedrock-guardrail-contentfilterstierconfig-tiername
|
|
23963
23988
|
'''
|
|
@@ -23994,7 +24019,7 @@ class CfnGuardrail(
|
|
|
23994
24019
|
'''Contains details about how to handle harmful content.
|
|
23995
24020
|
|
|
23996
24021
|
:param filters_config: Contains the type of the content filter and how strongly it should apply to prompts and model responses.
|
|
23997
|
-
:param content_filters_tier_config:
|
|
24022
|
+
:param content_filters_tier_config: The tier that your guardrail uses for content filters. Consider using a tier that balances performance, accuracy, and compatibility with your existing generative AI workflows.
|
|
23998
24023
|
|
|
23999
24024
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentpolicyconfig.html
|
|
24000
24025
|
:exampleMetadata: fixture=_generated
|
|
@@ -24052,7 +24077,9 @@ class CfnGuardrail(
|
|
|
24052
24077
|
def content_filters_tier_config(
|
|
24053
24078
|
self,
|
|
24054
24079
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnGuardrail.ContentFiltersTierConfigProperty"]]:
|
|
24055
|
-
'''
|
|
24080
|
+
'''The tier that your guardrail uses for content filters.
|
|
24081
|
+
|
|
24082
|
+
Consider using a tier that balances performance, accuracy, and compatibility with your existing generative AI workflows.
|
|
24056
24083
|
|
|
24057
24084
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentpolicyconfig.html#cfn-bedrock-guardrail-contentpolicyconfig-contentfilterstierconfig
|
|
24058
24085
|
'''
|
|
@@ -24093,8 +24120,8 @@ class CfnGuardrail(
|
|
|
24093
24120
|
|
|
24094
24121
|
:param threshold: The threshold details for the guardrails contextual grounding filter.
|
|
24095
24122
|
:param type: The filter details for the guardrails contextual grounding filter.
|
|
24096
|
-
:param action:
|
|
24097
|
-
:param enabled:
|
|
24123
|
+
:param action: Specifies the action to take when content fails the contextual grounding evaluation. Supported values include:. - ``BLOCK`` – Block the content and replace it with blocked messaging. - ``NONE`` – Take no action but return detection information in the trace response.
|
|
24124
|
+
:param enabled: Specifies whether to enable contextual grounding evaluation. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
24098
24125
|
|
|
24099
24126
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contextualgroundingfilterconfig.html
|
|
24100
24127
|
:exampleMetadata: fixture=_generated
|
|
@@ -24151,7 +24178,11 @@ class CfnGuardrail(
|
|
|
24151
24178
|
|
|
24152
24179
|
@builtins.property
|
|
24153
24180
|
def action(self) -> typing.Optional[builtins.str]:
|
|
24154
|
-
'''
|
|
24181
|
+
'''Specifies the action to take when content fails the contextual grounding evaluation. Supported values include:.
|
|
24182
|
+
|
|
24183
|
+
- ``BLOCK`` – Block the content and replace it with blocked messaging.
|
|
24184
|
+
- ``NONE`` – Take no action but return detection information in the trace response.
|
|
24185
|
+
|
|
24155
24186
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contextualgroundingfilterconfig.html#cfn-bedrock-guardrail-contextualgroundingfilterconfig-action
|
|
24156
24187
|
'''
|
|
24157
24188
|
result = self._values.get("action")
|
|
@@ -24161,7 +24192,10 @@ class CfnGuardrail(
|
|
|
24161
24192
|
def enabled(
|
|
24162
24193
|
self,
|
|
24163
24194
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
24164
|
-
'''
|
|
24195
|
+
'''Specifies whether to enable contextual grounding evaluation.
|
|
24196
|
+
|
|
24197
|
+
When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
24198
|
+
|
|
24165
24199
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contextualgroundingfilterconfig.html#cfn-bedrock-guardrail-contextualgroundingfilterconfig-enabled
|
|
24166
24200
|
'''
|
|
24167
24201
|
result = self._values.get("enabled")
|
|
@@ -24256,7 +24290,7 @@ class CfnGuardrail(
|
|
|
24256
24290
|
|
|
24257
24291
|
For more information, see the `Amazon Bedrock User Guide <https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html>`_ .
|
|
24258
24292
|
|
|
24259
|
-
:param guardrail_profile_arn: The Amazon Resource Name (ARN) of the guardrail profile.
|
|
24293
|
+
:param guardrail_profile_arn: The Amazon Resource Name (ARN) of the guardrail profile that your guardrail is using. Guardrail profile availability depends on your current AWS Region . For more information, see the `Amazon Bedrock User Guide <https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region-support.html>`_ .
|
|
24260
24294
|
|
|
24261
24295
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-guardrailcrossregionconfig.html
|
|
24262
24296
|
:exampleMetadata: fixture=_generated
|
|
@@ -24280,7 +24314,9 @@ class CfnGuardrail(
|
|
|
24280
24314
|
|
|
24281
24315
|
@builtins.property
|
|
24282
24316
|
def guardrail_profile_arn(self) -> builtins.str:
|
|
24283
|
-
'''The Amazon Resource Name (ARN) of the guardrail profile.
|
|
24317
|
+
'''The Amazon Resource Name (ARN) of the guardrail profile that your guardrail is using.
|
|
24318
|
+
|
|
24319
|
+
Guardrail profile availability depends on your current AWS Region . For more information, see the `Amazon Bedrock User Guide <https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region-support.html>`_ .
|
|
24284
24320
|
|
|
24285
24321
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-guardrailcrossregionconfig.html#cfn-bedrock-guardrail-guardrailcrossregionconfig-guardrailprofilearn
|
|
24286
24322
|
'''
|
|
@@ -24323,10 +24359,10 @@ class CfnGuardrail(
|
|
|
24323
24359
|
'''The managed word list to configure for the guardrail.
|
|
24324
24360
|
|
|
24325
24361
|
:param type: The managed word type to configure for the guardrail.
|
|
24326
|
-
:param input_action:
|
|
24327
|
-
:param input_enabled:
|
|
24328
|
-
:param output_action:
|
|
24329
|
-
:param output_enabled:
|
|
24362
|
+
:param input_action: Specifies the action to take when harmful content is detected in the input. Supported values include:. - ``BLOCK`` – Block the content and replace it with blocked messaging. - ``NONE`` – Take no action but return detection information in the trace response.
|
|
24363
|
+
:param input_enabled: Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
24364
|
+
:param output_action: Specifies the action to take when harmful content is detected in the output. Supported values include:. - ``BLOCK`` – Block the content and replace it with blocked messaging. - ``NONE`` – Take no action but return detection information in the trace response.
|
|
24365
|
+
:param output_enabled: Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
24330
24366
|
|
|
24331
24367
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-managedwordsconfig.html
|
|
24332
24368
|
:exampleMetadata: fixture=_generated
|
|
@@ -24378,7 +24414,11 @@ class CfnGuardrail(
|
|
|
24378
24414
|
|
|
24379
24415
|
@builtins.property
|
|
24380
24416
|
def input_action(self) -> typing.Optional[builtins.str]:
|
|
24381
|
-
'''
|
|
24417
|
+
'''Specifies the action to take when harmful content is detected in the input. Supported values include:.
|
|
24418
|
+
|
|
24419
|
+
- ``BLOCK`` – Block the content and replace it with blocked messaging.
|
|
24420
|
+
- ``NONE`` – Take no action but return detection information in the trace response.
|
|
24421
|
+
|
|
24382
24422
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-managedwordsconfig.html#cfn-bedrock-guardrail-managedwordsconfig-inputaction
|
|
24383
24423
|
'''
|
|
24384
24424
|
result = self._values.get("input_action")
|
|
@@ -24388,7 +24428,10 @@ class CfnGuardrail(
|
|
|
24388
24428
|
def input_enabled(
|
|
24389
24429
|
self,
|
|
24390
24430
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
24391
|
-
'''
|
|
24431
|
+
'''Specifies whether to enable guardrail evaluation on the input.
|
|
24432
|
+
|
|
24433
|
+
When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
24434
|
+
|
|
24392
24435
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-managedwordsconfig.html#cfn-bedrock-guardrail-managedwordsconfig-inputenabled
|
|
24393
24436
|
'''
|
|
24394
24437
|
result = self._values.get("input_enabled")
|
|
@@ -24396,7 +24439,11 @@ class CfnGuardrail(
|
|
|
24396
24439
|
|
|
24397
24440
|
@builtins.property
|
|
24398
24441
|
def output_action(self) -> typing.Optional[builtins.str]:
|
|
24399
|
-
'''
|
|
24442
|
+
'''Specifies the action to take when harmful content is detected in the output. Supported values include:.
|
|
24443
|
+
|
|
24444
|
+
- ``BLOCK`` – Block the content and replace it with blocked messaging.
|
|
24445
|
+
- ``NONE`` – Take no action but return detection information in the trace response.
|
|
24446
|
+
|
|
24400
24447
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-managedwordsconfig.html#cfn-bedrock-guardrail-managedwordsconfig-outputaction
|
|
24401
24448
|
'''
|
|
24402
24449
|
result = self._values.get("output_action")
|
|
@@ -24406,7 +24453,10 @@ class CfnGuardrail(
|
|
|
24406
24453
|
def output_enabled(
|
|
24407
24454
|
self,
|
|
24408
24455
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
24409
|
-
'''
|
|
24456
|
+
'''Specifies whether to enable guardrail evaluation on the output.
|
|
24457
|
+
|
|
24458
|
+
When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
24459
|
+
|
|
24410
24460
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-managedwordsconfig.html#cfn-bedrock-guardrail-managedwordsconfig-outputenabled
|
|
24411
24461
|
'''
|
|
24412
24462
|
result = self._values.get("output_enabled")
|
|
@@ -24450,10 +24500,10 @@ class CfnGuardrail(
|
|
|
24450
24500
|
|
|
24451
24501
|
:param action: Configure guardrail action when the PII entity is detected.
|
|
24452
24502
|
:param type: Configure guardrail type when the PII entity is detected. The following PIIs are used to block or mask sensitive information: - *General* - *ADDRESS* A physical address, such as "100 Main Street, Anytown, USA" or "Suite #12, Building 123". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood. - *AGE* An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guardrails recognizes "40 years" as an age. - *NAME* An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. guardrails doesn't apply this entity type to names that are part of organizations or addresses. For example, guardrails recognizes the "John Doe Organization" as an organization, and it recognizes "Jane Doe Street" as an address. - *EMAIL* An email address, such as *marymajor@email.com* . - *PHONE* A phone number. This entity type also includes fax and pager numbers. - *USERNAME* A user name that identifies an account, such as a login name, screen name, nick name, or handle. - *PASSWORD* An alphanumeric string that is used as a password, such as "* *very20special#pass** ". - *DRIVER_ID* The number assigned to a driver's license, which is an official document permitting an individual to operate one or more motorized vehicles on a public road. A driver's license number consists of alphanumeric characters. - *LICENSE_PLATE* A license plate for a vehicle is issued by the state or country where the vehicle is registered. 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. - *VEHICLE_IDENTIFICATION_NUMBER* A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the *ISO 3779* specification. Each country has specific codes and formats for VINs. - *Finance* - *CREDIT_DEBIT_CARD_CVV* A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code. - *CREDIT_DEBIT_CARD_EXPIRY* The expiration date for a credit or debit card. This number is usually four digits long and is often formatted as *month/year* or *MM/YY* . Guardrails recognizes expiration dates such as *01/21* , *01/2021* , and *Jan 2021* . - *CREDIT_DEBIT_CARD_NUMBER* The number for a credit or debit card. These numbers can vary from 13 to 16 digits in length. However, Amazon Comprehend also recognizes credit or debit card numbers when only the last four digits are present. - *PIN* A four-digit personal identification number (PIN) with which you can access your bank account. - *INTERNATIONAL_BANK_ACCOUNT_NUMBER* An International Bank Account Number has specific formats in each country. For more information, see `www.iban.com/structure <https://docs.aws.amazon.com/https://www.iban.com/structure>`_ . - *SWIFT_CODE* A SWIFT code is a standard format of Bank Identifier Code (BIC) used to specify a particular bank or branch. Banks use these codes for money transfers such as international wire transfers. SWIFT codes consist of eight or 11 characters. The 11-digit codes refer to specific branches, while eight-digit codes (or 11-digit codes ending in 'XXX') refer to the head or primary office. - *IT* - *IP_ADDRESS* An IPv4 address, such as *198.51.100.0* . - *MAC_ADDRESS* A *media access control* (MAC) address is a unique identifier assigned to a network interface controller (NIC). - *URL* A web address, such as *www.example.com* . - *AWS_ACCESS_KEY* A unique identifier that's associated with a secret access key; you use the access key ID and secret access key to sign programmatic AWS requests cryptographically. - *AWS_SECRET_KEY* A unique identifier that's associated with an access key. You use the access key ID and secret access key to sign programmatic AWS requests cryptographically. - *USA specific* - *US_BANK_ACCOUNT_NUMBER* A US bank account number, which is typically 10 to 12 digits long. - *US_BANK_ROUTING_NUMBER* A US bank account routing number. These are typically nine digits long, - *US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER* A US Individual Taxpayer Identification Number (ITIN) is a nine-digit number that starts with a "9" and contain a "7" or "8" as the fourth digit. An ITIN can be formatted with a space or a dash after the third and forth digits. - *US_PASSPORT_NUMBER* A US passport number. Passport numbers range from six to nine alphanumeric characters. - *US_SOCIAL_SECURITY_NUMBER* A US Social Security Number (SSN) is a nine-digit number that is issued to US citizens, permanent residents, and temporary working residents. - *Canada specific* - *CA_HEALTH_NUMBER* A Canadian Health Service Number is a 10-digit unique identifier, required for individuals to access healthcare benefits. - *CA_SOCIAL_INSURANCE_NUMBER* A Canadian Social Insurance Number (SIN) is a nine-digit unique identifier, required for individuals to access government programs and benefits. The SIN is formatted as three groups of three digits, such as *123-456-789* . A SIN can be validated through a simple check-digit process called the `Luhn algorithm <https://docs.aws.amazon.com/https://www.wikipedia.org/wiki/Luhn_algorithm>`_ . - *UK Specific* - *UK_NATIONAL_HEALTH_SERVICE_NUMBER* A UK National Health Service Number is a 10-17 digit number, such as *485 777 3456* . The current system formats the 10-digit number with spaces after the third and sixth digits. The final digit is an error-detecting checksum. - *UK_NATIONAL_INSURANCE_NUMBER* A UK National Insurance Number (NINO) provides individuals with access to National Insurance (social security) benefits. It is also used for some purposes in the UK tax system. The number is nine digits long and starts with two letters, followed by six numbers and one letter. A NINO can be formatted with a space or a dash after the two letters and after the second, forth, and sixth digits. - *UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER* A UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a taxpayer or a business. - *Custom* - *Regex filter* - You can use a regular expressions to define patterns for a guardrail to recognize and act upon such as serial number, booking ID etc..
|
|
24453
|
-
:param input_action:
|
|
24454
|
-
:param input_enabled:
|
|
24455
|
-
:param output_action:
|
|
24456
|
-
:param output_enabled:
|
|
24503
|
+
:param input_action: Specifies the action to take when harmful content is detected in the input. Supported values include:. - ``BLOCK`` – Block the content and replace it with blocked messaging. - ``ANONYMIZE`` – Mask the content and replace it with identifier tags. - ``NONE`` – Take no action but return detection information in the trace response.
|
|
24504
|
+
:param input_enabled: Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
24505
|
+
:param output_action: Specifies the action to take when harmful content is detected in the output. Supported values include:. - ``BLOCK`` – Block the content and replace it with blocked messaging. - ``ANONYMIZE`` – Mask the content and replace it with identifier tags. - ``NONE`` – Take no action but return detection information in the trace response.
|
|
24506
|
+
:param output_enabled: Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
24457
24507
|
|
|
24458
24508
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-piientityconfig.html
|
|
24459
24509
|
:exampleMetadata: fixture=_generated
|
|
@@ -24659,7 +24709,11 @@ class CfnGuardrail(
|
|
|
24659
24709
|
|
|
24660
24710
|
@builtins.property
|
|
24661
24711
|
def input_action(self) -> typing.Optional[builtins.str]:
|
|
24662
|
-
'''
|
|
24712
|
+
'''Specifies the action to take when harmful content is detected in the input. Supported values include:.
|
|
24713
|
+
|
|
24714
|
+
- ``BLOCK`` – Block the content and replace it with blocked messaging.
|
|
24715
|
+
- ``ANONYMIZE`` – Mask the content and replace it with identifier tags.
|
|
24716
|
+
- ``NONE`` – Take no action but return detection information in the trace response.
|
|
24663
24717
|
|
|
24664
24718
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-piientityconfig.html#cfn-bedrock-guardrail-piientityconfig-inputaction
|
|
24665
24719
|
'''
|
|
@@ -24670,7 +24724,10 @@ class CfnGuardrail(
|
|
|
24670
24724
|
def input_enabled(
|
|
24671
24725
|
self,
|
|
24672
24726
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
24673
|
-
'''
|
|
24727
|
+
'''Specifies whether to enable guardrail evaluation on the input.
|
|
24728
|
+
|
|
24729
|
+
When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
24730
|
+
|
|
24674
24731
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-piientityconfig.html#cfn-bedrock-guardrail-piientityconfig-inputenabled
|
|
24675
24732
|
'''
|
|
24676
24733
|
result = self._values.get("input_enabled")
|
|
@@ -24678,7 +24735,11 @@ class CfnGuardrail(
|
|
|
24678
24735
|
|
|
24679
24736
|
@builtins.property
|
|
24680
24737
|
def output_action(self) -> typing.Optional[builtins.str]:
|
|
24681
|
-
'''
|
|
24738
|
+
'''Specifies the action to take when harmful content is detected in the output. Supported values include:.
|
|
24739
|
+
|
|
24740
|
+
- ``BLOCK`` – Block the content and replace it with blocked messaging.
|
|
24741
|
+
- ``ANONYMIZE`` – Mask the content and replace it with identifier tags.
|
|
24742
|
+
- ``NONE`` – Take no action but return detection information in the trace response.
|
|
24682
24743
|
|
|
24683
24744
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-piientityconfig.html#cfn-bedrock-guardrail-piientityconfig-outputaction
|
|
24684
24745
|
'''
|
|
@@ -24689,7 +24750,10 @@ class CfnGuardrail(
|
|
|
24689
24750
|
def output_enabled(
|
|
24690
24751
|
self,
|
|
24691
24752
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
24692
|
-
'''
|
|
24753
|
+
'''Indicates whether guardrail evaluation is enabled on the output.
|
|
24754
|
+
|
|
24755
|
+
When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
24756
|
+
|
|
24693
24757
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-piientityconfig.html#cfn-bedrock-guardrail-piientityconfig-outputenabled
|
|
24694
24758
|
'''
|
|
24695
24759
|
result = self._values.get("output_enabled")
|
|
@@ -24739,10 +24803,10 @@ class CfnGuardrail(
|
|
|
24739
24803
|
:param name: The name of the regular expression to configure for the guardrail.
|
|
24740
24804
|
:param pattern: The regular expression pattern to configure for the guardrail.
|
|
24741
24805
|
:param description: The description of the regular expression to configure for the guardrail.
|
|
24742
|
-
:param input_action:
|
|
24743
|
-
:param input_enabled:
|
|
24744
|
-
:param output_action:
|
|
24745
|
-
:param output_enabled:
|
|
24806
|
+
:param input_action: Specifies the action to take when harmful content is detected in the input. Supported values include:. - ``BLOCK`` – Block the content and replace it with blocked messaging. - ``NONE`` – Take no action but return detection information in the trace response.
|
|
24807
|
+
:param input_enabled: Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
24808
|
+
:param output_action: Specifies the action to take when harmful content is detected in the output. Supported values include:. - ``BLOCK`` – Block the content and replace it with blocked messaging. - ``NONE`` – Take no action but return detection information in the trace response.
|
|
24809
|
+
:param output_enabled: Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
24746
24810
|
|
|
24747
24811
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-regexconfig.html
|
|
24748
24812
|
:exampleMetadata: fixture=_generated
|
|
@@ -24833,7 +24897,10 @@ class CfnGuardrail(
|
|
|
24833
24897
|
|
|
24834
24898
|
@builtins.property
|
|
24835
24899
|
def input_action(self) -> typing.Optional[builtins.str]:
|
|
24836
|
-
'''
|
|
24900
|
+
'''Specifies the action to take when harmful content is detected in the input. Supported values include:.
|
|
24901
|
+
|
|
24902
|
+
- ``BLOCK`` – Block the content and replace it with blocked messaging.
|
|
24903
|
+
- ``NONE`` – Take no action but return detection information in the trace response.
|
|
24837
24904
|
|
|
24838
24905
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-regexconfig.html#cfn-bedrock-guardrail-regexconfig-inputaction
|
|
24839
24906
|
'''
|
|
@@ -24844,7 +24911,10 @@ class CfnGuardrail(
|
|
|
24844
24911
|
def input_enabled(
|
|
24845
24912
|
self,
|
|
24846
24913
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
24847
|
-
'''
|
|
24914
|
+
'''Specifies whether to enable guardrail evaluation on the input.
|
|
24915
|
+
|
|
24916
|
+
When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
24917
|
+
|
|
24848
24918
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-regexconfig.html#cfn-bedrock-guardrail-regexconfig-inputenabled
|
|
24849
24919
|
'''
|
|
24850
24920
|
result = self._values.get("input_enabled")
|
|
@@ -24852,7 +24922,10 @@ class CfnGuardrail(
|
|
|
24852
24922
|
|
|
24853
24923
|
@builtins.property
|
|
24854
24924
|
def output_action(self) -> typing.Optional[builtins.str]:
|
|
24855
|
-
'''
|
|
24925
|
+
'''Specifies the action to take when harmful content is detected in the output. Supported values include:.
|
|
24926
|
+
|
|
24927
|
+
- ``BLOCK`` – Block the content and replace it with blocked messaging.
|
|
24928
|
+
- ``NONE`` – Take no action but return detection information in the trace response.
|
|
24856
24929
|
|
|
24857
24930
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-regexconfig.html#cfn-bedrock-guardrail-regexconfig-outputaction
|
|
24858
24931
|
'''
|
|
@@ -24863,7 +24936,10 @@ class CfnGuardrail(
|
|
|
24863
24936
|
def output_enabled(
|
|
24864
24937
|
self,
|
|
24865
24938
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
24866
|
-
'''
|
|
24939
|
+
'''Specifies whether to enable guardrail evaluation on the output.
|
|
24940
|
+
|
|
24941
|
+
When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
24942
|
+
|
|
24867
24943
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-regexconfig.html#cfn-bedrock-guardrail-regexconfig-outputenabled
|
|
24868
24944
|
'''
|
|
24869
24945
|
result = self._values.get("output_enabled")
|
|
@@ -25010,10 +25086,10 @@ class CfnGuardrail(
|
|
|
25010
25086
|
:param name: The name of the topic to deny.
|
|
25011
25087
|
:param type: Specifies to deny the topic.
|
|
25012
25088
|
:param examples: A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.
|
|
25013
|
-
:param input_action:
|
|
25014
|
-
:param input_enabled:
|
|
25015
|
-
:param output_action:
|
|
25016
|
-
:param output_enabled:
|
|
25089
|
+
:param input_action: Specifies the action to take when harmful content is detected in the input. Supported values include:. - ``BLOCK`` – Block the content and replace it with blocked messaging. - ``NONE`` – Take no action but return detection information in the trace response.
|
|
25090
|
+
:param input_enabled: Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
25091
|
+
:param output_action: Specifies the action to take when harmful content is detected in the output. Supported values include:. - ``BLOCK`` – Block the content and replace it with blocked messaging. - ``NONE`` – Take no action but return detection information in the trace response.
|
|
25092
|
+
:param output_enabled: Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
25017
25093
|
|
|
25018
25094
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html
|
|
25019
25095
|
:exampleMetadata: fixture=_generated
|
|
@@ -25104,7 +25180,11 @@ class CfnGuardrail(
|
|
|
25104
25180
|
|
|
25105
25181
|
@builtins.property
|
|
25106
25182
|
def input_action(self) -> typing.Optional[builtins.str]:
|
|
25107
|
-
'''
|
|
25183
|
+
'''Specifies the action to take when harmful content is detected in the input. Supported values include:.
|
|
25184
|
+
|
|
25185
|
+
- ``BLOCK`` – Block the content and replace it with blocked messaging.
|
|
25186
|
+
- ``NONE`` – Take no action but return detection information in the trace response.
|
|
25187
|
+
|
|
25108
25188
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html#cfn-bedrock-guardrail-topicconfig-inputaction
|
|
25109
25189
|
'''
|
|
25110
25190
|
result = self._values.get("input_action")
|
|
@@ -25114,7 +25194,10 @@ class CfnGuardrail(
|
|
|
25114
25194
|
def input_enabled(
|
|
25115
25195
|
self,
|
|
25116
25196
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
25117
|
-
'''
|
|
25197
|
+
'''Specifies whether to enable guardrail evaluation on the input.
|
|
25198
|
+
|
|
25199
|
+
When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
25200
|
+
|
|
25118
25201
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html#cfn-bedrock-guardrail-topicconfig-inputenabled
|
|
25119
25202
|
'''
|
|
25120
25203
|
result = self._values.get("input_enabled")
|
|
@@ -25122,7 +25205,11 @@ class CfnGuardrail(
|
|
|
25122
25205
|
|
|
25123
25206
|
@builtins.property
|
|
25124
25207
|
def output_action(self) -> typing.Optional[builtins.str]:
|
|
25125
|
-
'''
|
|
25208
|
+
'''Specifies the action to take when harmful content is detected in the output. Supported values include:.
|
|
25209
|
+
|
|
25210
|
+
- ``BLOCK`` – Block the content and replace it with blocked messaging.
|
|
25211
|
+
- ``NONE`` – Take no action but return detection information in the trace response.
|
|
25212
|
+
|
|
25126
25213
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html#cfn-bedrock-guardrail-topicconfig-outputaction
|
|
25127
25214
|
'''
|
|
25128
25215
|
result = self._values.get("output_action")
|
|
@@ -25132,7 +25219,10 @@ class CfnGuardrail(
|
|
|
25132
25219
|
def output_enabled(
|
|
25133
25220
|
self,
|
|
25134
25221
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
25135
|
-
'''
|
|
25222
|
+
'''Specifies whether to enable guardrail evaluation on the output.
|
|
25223
|
+
|
|
25224
|
+
When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
25225
|
+
|
|
25136
25226
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html#cfn-bedrock-guardrail-topicconfig-outputenabled
|
|
25137
25227
|
'''
|
|
25138
25228
|
result = self._values.get("output_enabled")
|
|
@@ -25167,7 +25257,7 @@ class CfnGuardrail(
|
|
|
25167
25257
|
'''Contains details about topics that the guardrail should identify and deny.
|
|
25168
25258
|
|
|
25169
25259
|
:param topics_config: A list of policies related to topics that the guardrail should deny.
|
|
25170
|
-
:param topics_tier_config:
|
|
25260
|
+
:param topics_tier_config: The tier that your guardrail uses for denied topic filters.
|
|
25171
25261
|
|
|
25172
25262
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicpolicyconfig.html
|
|
25173
25263
|
:exampleMetadata: fixture=_generated
|
|
@@ -25224,7 +25314,7 @@ class CfnGuardrail(
|
|
|
25224
25314
|
def topics_tier_config(
|
|
25225
25315
|
self,
|
|
25226
25316
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnGuardrail.TopicsTierConfigProperty"]]:
|
|
25227
|
-
'''
|
|
25317
|
+
'''The tier that your guardrail uses for denied topic filters.
|
|
25228
25318
|
|
|
25229
25319
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicpolicyconfig.html#cfn-bedrock-guardrail-topicpolicyconfig-topicstierconfig
|
|
25230
25320
|
'''
|
|
@@ -25249,9 +25339,11 @@ class CfnGuardrail(
|
|
|
25249
25339
|
)
|
|
25250
25340
|
class TopicsTierConfigProperty:
|
|
25251
25341
|
def __init__(self, *, tier_name: builtins.str) -> None:
|
|
25252
|
-
'''
|
|
25342
|
+
'''The tier that your guardrail uses for denied topic filters.
|
|
25253
25343
|
|
|
25254
|
-
|
|
25344
|
+
Consider using a tier that balances performance, accuracy, and compatibility with your existing generative AI workflows.
|
|
25345
|
+
|
|
25346
|
+
:param tier_name: The tier that your guardrail uses for denied topic filters. Valid values include:. - ``CLASSIC`` tier – Provides established guardrails functionality supporting English, French, and Spanish languages. - ``STANDARD`` tier – Provides a more robust solution than the ``CLASSIC`` tier and has more comprehensive language support. This tier requires that your guardrail use `cross-Region inference <https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html>`_ .
|
|
25255
25347
|
|
|
25256
25348
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicstierconfig.html
|
|
25257
25349
|
:exampleMetadata: fixture=_generated
|
|
@@ -25275,7 +25367,10 @@ class CfnGuardrail(
|
|
|
25275
25367
|
|
|
25276
25368
|
@builtins.property
|
|
25277
25369
|
def tier_name(self) -> builtins.str:
|
|
25278
|
-
'''
|
|
25370
|
+
'''The tier that your guardrail uses for denied topic filters. Valid values include:.
|
|
25371
|
+
|
|
25372
|
+
- ``CLASSIC`` tier – Provides established guardrails functionality supporting English, French, and Spanish languages.
|
|
25373
|
+
- ``STANDARD`` tier – Provides a more robust solution than the ``CLASSIC`` tier and has more comprehensive language support. This tier requires that your guardrail use `cross-Region inference <https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html>`_ .
|
|
25279
25374
|
|
|
25280
25375
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicstierconfig.html#cfn-bedrock-guardrail-topicstierconfig-tiername
|
|
25281
25376
|
'''
|
|
@@ -25318,10 +25413,10 @@ class CfnGuardrail(
|
|
|
25318
25413
|
'''A word to configure for the guardrail.
|
|
25319
25414
|
|
|
25320
25415
|
:param text: Text of the word configured for the guardrail to block.
|
|
25321
|
-
:param input_action:
|
|
25322
|
-
:param input_enabled:
|
|
25323
|
-
:param output_action:
|
|
25324
|
-
:param output_enabled:
|
|
25416
|
+
:param input_action: Specifies the action to take when harmful content is detected in the input. Supported values include:. - ``BLOCK`` – Block the content and replace it with blocked messaging. - ``NONE`` – Take no action but return detection information in the trace response.
|
|
25417
|
+
:param input_enabled: Specifies whether to enable guardrail evaluation on the intput. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
25418
|
+
:param output_action: Specifies the action to take when harmful content is detected in the output. Supported values include:. - ``BLOCK`` – Block the content and replace it with blocked messaging. - ``NONE`` – Take no action but return detection information in the trace response.
|
|
25419
|
+
:param output_enabled: Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
25325
25420
|
|
|
25326
25421
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordconfig.html
|
|
25327
25422
|
:exampleMetadata: fixture=_generated
|
|
@@ -25373,7 +25468,11 @@ class CfnGuardrail(
|
|
|
25373
25468
|
|
|
25374
25469
|
@builtins.property
|
|
25375
25470
|
def input_action(self) -> typing.Optional[builtins.str]:
|
|
25376
|
-
'''
|
|
25471
|
+
'''Specifies the action to take when harmful content is detected in the input. Supported values include:.
|
|
25472
|
+
|
|
25473
|
+
- ``BLOCK`` – Block the content and replace it with blocked messaging.
|
|
25474
|
+
- ``NONE`` – Take no action but return detection information in the trace response.
|
|
25475
|
+
|
|
25377
25476
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordconfig.html#cfn-bedrock-guardrail-wordconfig-inputaction
|
|
25378
25477
|
'''
|
|
25379
25478
|
result = self._values.get("input_action")
|
|
@@ -25383,7 +25482,10 @@ class CfnGuardrail(
|
|
|
25383
25482
|
def input_enabled(
|
|
25384
25483
|
self,
|
|
25385
25484
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
25386
|
-
'''
|
|
25485
|
+
'''Specifies whether to enable guardrail evaluation on the intput.
|
|
25486
|
+
|
|
25487
|
+
When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
25488
|
+
|
|
25387
25489
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordconfig.html#cfn-bedrock-guardrail-wordconfig-inputenabled
|
|
25388
25490
|
'''
|
|
25389
25491
|
result = self._values.get("input_enabled")
|
|
@@ -25391,7 +25493,11 @@ class CfnGuardrail(
|
|
|
25391
25493
|
|
|
25392
25494
|
@builtins.property
|
|
25393
25495
|
def output_action(self) -> typing.Optional[builtins.str]:
|
|
25394
|
-
'''
|
|
25496
|
+
'''Specifies the action to take when harmful content is detected in the output. Supported values include:.
|
|
25497
|
+
|
|
25498
|
+
- ``BLOCK`` – Block the content and replace it with blocked messaging.
|
|
25499
|
+
- ``NONE`` – Take no action but return detection information in the trace response.
|
|
25500
|
+
|
|
25395
25501
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordconfig.html#cfn-bedrock-guardrail-wordconfig-outputaction
|
|
25396
25502
|
'''
|
|
25397
25503
|
result = self._values.get("output_action")
|
|
@@ -25401,7 +25507,10 @@ class CfnGuardrail(
|
|
|
25401
25507
|
def output_enabled(
|
|
25402
25508
|
self,
|
|
25403
25509
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
25404
|
-
'''
|
|
25510
|
+
'''Specifies whether to enable guardrail evaluation on the output.
|
|
25511
|
+
|
|
25512
|
+
When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
25513
|
+
|
|
25405
25514
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordconfig.html#cfn-bedrock-guardrail-wordconfig-outputenabled
|
|
25406
25515
|
'''
|
|
25407
25516
|
result = self._values.get("output_enabled")
|
|
@@ -25554,7 +25663,7 @@ class CfnGuardrailProps:
|
|
|
25554
25663
|
:param name: The name of the guardrail.
|
|
25555
25664
|
:param content_policy_config: The content filter policies to configure for the guardrail.
|
|
25556
25665
|
:param contextual_grounding_policy_config: Contextual grounding policy config for a guardrail.
|
|
25557
|
-
:param cross_region_config: The system-defined guardrail profile that you
|
|
25666
|
+
:param cross_region_config: The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination AWS Regions where guardrail inference requests can be automatically routed. Using guardrail profiles helps maintain guardrail performance and reliability when demand increases. For more information, see the `Amazon Bedrock User Guide <https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html>`_ .
|
|
25558
25667
|
:param description: A description of the guardrail.
|
|
25559
25668
|
:param kms_key_arn: The ARN of the AWS KMS key that you use to encrypt the guardrail.
|
|
25560
25669
|
:param sensitive_information_policy_config: The sensitive information policy to configure for the guardrail.
|
|
@@ -25775,7 +25884,11 @@ class CfnGuardrailProps:
|
|
|
25775
25884
|
def cross_region_config(
|
|
25776
25885
|
self,
|
|
25777
25886
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnGuardrail.GuardrailCrossRegionConfigProperty]]:
|
|
25778
|
-
'''The system-defined guardrail profile that you
|
|
25887
|
+
'''The system-defined guardrail profile that you're using with your guardrail.
|
|
25888
|
+
|
|
25889
|
+
Guardrail profiles define the destination AWS Regions where guardrail inference requests can be automatically routed. Using guardrail profiles helps maintain guardrail performance and reliability when demand increases.
|
|
25890
|
+
|
|
25891
|
+
For more information, see the `Amazon Bedrock User Guide <https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html>`_ .
|
|
25779
25892
|
|
|
25780
25893
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-crossregionconfig
|
|
25781
25894
|
'''
|
|
@@ -36623,6 +36736,18 @@ class FoundationModelIdentifier(
|
|
|
36623
36736
|
'''Base model "stability.stable-image-ultra-v1:1".'''
|
|
36624
36737
|
return typing.cast("FoundationModelIdentifier", jsii.sget(cls, "STABILITY_STABLE_IMAGE_ULTRA_V1_1"))
|
|
36625
36738
|
|
|
36739
|
+
@jsii.python.classproperty
|
|
36740
|
+
@jsii.member(jsii_name="TWELVELABS_MARENGO_EMBED_2_7_V1_0")
|
|
36741
|
+
def TWELVELABS_MARENGO_EMBED_2_7_V1_0(cls) -> "FoundationModelIdentifier":
|
|
36742
|
+
'''Base model "twelvelabs.marengo-embed-2-7-v1:0".'''
|
|
36743
|
+
return typing.cast("FoundationModelIdentifier", jsii.sget(cls, "TWELVELABS_MARENGO_EMBED_2_7_V1_0"))
|
|
36744
|
+
|
|
36745
|
+
@jsii.python.classproperty
|
|
36746
|
+
@jsii.member(jsii_name="TWELVELABS_PEGASUS_1_2_V1_0")
|
|
36747
|
+
def TWELVELABS_PEGASUS_1_2_V1_0(cls) -> "FoundationModelIdentifier":
|
|
36748
|
+
'''Base model "twelvelabs.pegasus-1-2-v1:0".'''
|
|
36749
|
+
return typing.cast("FoundationModelIdentifier", jsii.sget(cls, "TWELVELABS_PEGASUS_1_2_V1_0"))
|
|
36750
|
+
|
|
36626
36751
|
@jsii.python.classproperty
|
|
36627
36752
|
@jsii.member(jsii_name="WRITER_PALMYRA_X4_V1_0")
|
|
36628
36753
|
def WRITER_PALMYRA_X4_V1_0(cls) -> "FoundationModelIdentifier":
|