aws-cdk-lib 2.145.0__py3-none-any.whl → 2.147.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.

Files changed (71) hide show
  1. aws_cdk/__init__.py +12 -11
  2. aws_cdk/_jsii/__init__.py +1 -1
  3. aws_cdk/_jsii/{aws-cdk-lib@2.145.0.jsii.tgz → aws-cdk-lib@2.147.0.jsii.tgz} +0 -0
  4. aws_cdk/aws_apigateway/__init__.py +32 -12
  5. aws_cdk/aws_apigatewayv2/__init__.py +48 -2
  6. aws_cdk/aws_apigatewayv2_integrations/__init__.py +142 -4
  7. aws_cdk/aws_appconfig/__init__.py +8 -4
  8. aws_cdk/aws_applicationsignals/__init__.py +1766 -0
  9. aws_cdk/aws_appsync/__init__.py +62 -0
  10. aws_cdk/aws_auditmanager/__init__.py +5 -1
  11. aws_cdk/aws_autoscaling/__init__.py +457 -56
  12. aws_cdk/aws_batch/__init__.py +215 -0
  13. aws_cdk/aws_bedrock/__init__.py +272 -103
  14. aws_cdk/aws_cloudformation/__init__.py +5 -11
  15. aws_cdk/aws_cloudfront/__init__.py +10 -3
  16. aws_cdk/aws_cloudtrail/__init__.py +56 -2
  17. aws_cdk/aws_codebuild/__init__.py +85 -32
  18. aws_cdk/aws_codepipeline/__init__.py +10 -5
  19. aws_cdk/aws_connect/__init__.py +86 -0
  20. aws_cdk/aws_datazone/__init__.py +80 -68
  21. aws_cdk/aws_deadline/__init__.py +603 -17
  22. aws_cdk/aws_ec2/__init__.py +237 -112
  23. aws_cdk/aws_ecs/__init__.py +123 -12
  24. aws_cdk/aws_eks/__init__.py +1335 -50
  25. aws_cdk/aws_elasticloadbalancingv2/__init__.py +11 -5
  26. aws_cdk/aws_emrserverless/__init__.py +5 -5
  27. aws_cdk/aws_events/__init__.py +36 -16
  28. aws_cdk/aws_fsx/__init__.py +126 -21
  29. aws_cdk/aws_globalaccelerator/__init__.py +2 -1
  30. aws_cdk/aws_globalaccelerator_endpoints/__init__.py +35 -4
  31. aws_cdk/aws_glue/__init__.py +26 -0
  32. aws_cdk/aws_grafana/__init__.py +4 -4
  33. aws_cdk/aws_groundstation/__init__.py +55 -35
  34. aws_cdk/aws_guardduty/__init__.py +826 -0
  35. aws_cdk/aws_iam/__init__.py +13 -8
  36. aws_cdk/aws_iot/__init__.py +3 -3
  37. aws_cdk/aws_lambda/__init__.py +7 -5
  38. aws_cdk/aws_lightsail/__init__.py +1 -1
  39. aws_cdk/aws_location/__init__.py +10 -11
  40. aws_cdk/aws_mediapackagev2/__init__.py +38 -20
  41. aws_cdk/aws_mediatailor/__init__.py +2 -2
  42. aws_cdk/aws_msk/__init__.py +4 -4
  43. aws_cdk/aws_mwaa/__init__.py +16 -8
  44. aws_cdk/aws_nimblestudio/__init__.py +9 -9
  45. aws_cdk/aws_opensearchservice/__init__.py +11 -4
  46. aws_cdk/aws_opsworks/__init__.py +3 -3
  47. aws_cdk/aws_osis/__init__.py +33 -4
  48. aws_cdk/aws_pipes/__init__.py +691 -0
  49. aws_cdk/aws_quicksight/__init__.py +23 -21
  50. aws_cdk/aws_rds/__init__.py +55 -11
  51. aws_cdk/aws_refactorspaces/__init__.py +3 -3
  52. aws_cdk/aws_rolesanywhere/__init__.py +206 -3
  53. aws_cdk/aws_sagemaker/__init__.py +5 -2
  54. aws_cdk/aws_securityhub/__init__.py +163 -78
  55. aws_cdk/aws_securitylake/__init__.py +7 -5
  56. aws_cdk/aws_ses/__init__.py +117 -0
  57. aws_cdk/aws_simspaceweaver/__init__.py +2 -2
  58. aws_cdk/aws_sns/__init__.py +67 -13
  59. aws_cdk/aws_sqs/__init__.py +3 -3
  60. aws_cdk/aws_stepfunctions/__init__.py +51 -28
  61. aws_cdk/aws_stepfunctions_tasks/__init__.py +59 -5
  62. aws_cdk/aws_transfer/__init__.py +8 -2
  63. aws_cdk/aws_wafv2/__init__.py +10 -10
  64. aws_cdk/aws_workspacesweb/__init__.py +8 -8
  65. aws_cdk/region_info/__init__.py +6 -0
  66. {aws_cdk_lib-2.145.0.dist-info → aws_cdk_lib-2.147.0.dist-info}/METADATA +2 -2
  67. {aws_cdk_lib-2.145.0.dist-info → aws_cdk_lib-2.147.0.dist-info}/NOTICE +0 -35
  68. {aws_cdk_lib-2.145.0.dist-info → aws_cdk_lib-2.147.0.dist-info}/RECORD +71 -70
  69. {aws_cdk_lib-2.145.0.dist-info → aws_cdk_lib-2.147.0.dist-info}/LICENSE +0 -0
  70. {aws_cdk_lib-2.145.0.dist-info → aws_cdk_lib-2.147.0.dist-info}/WHEEL +0 -0
  71. {aws_cdk_lib-2.145.0.dist-info → aws_cdk_lib-2.147.0.dist-info}/top_level.txt +0 -0
@@ -1254,15 +1254,15 @@ class CfnAgent(
1254
1254
  top_k: typing.Optional[jsii.Number] = None,
1255
1255
  top_p: typing.Optional[jsii.Number] = None,
1256
1256
  ) -> None:
1257
- '''Specifications about the inference parameters that were provided alongside the prompt.
1257
+ '''Base inference parameters to pass to a model in a call to `Converse <https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html>`_ or `ConverseStream <https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html>`_ . For more information, see `Inference parameters for foundation models <https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html>`_ .
1258
1258
 
1259
- These are specified in the `PromptOverrideConfiguration <https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html>`_ object that was set when the agent was created or updated. For more information, see `Inference parameters for foundation models <https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html>`_ .
1259
+ If you need to pass additional parameters that the model supports, use the ``additionalModelRequestFields`` request field in the call to ``Converse`` or ``ConverseStream`` . For more information, see `Model parameters <https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html>`_ .
1260
1260
 
1261
1261
  :param maximum_length: The maximum number of tokens allowed in the generated response.
1262
1262
  :param stop_sequences: A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.
1263
- :param temperature: The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.
1263
+ :param temperature: The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options. The default value is the default value for the model that you are using. For more information, see `Inference parameters for foundation models <https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html>`_ .
1264
1264
  :param top_k: While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for ``topK`` is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set ``topK`` to 50, the model selects the next token from among the top 50 most likely choices.
1265
- :param top_p: While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for ``Top P`` determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set ``topP`` to 80, the model only selects the next token from the top 80% of the probability distribution of next tokens.
1265
+ :param top_p: The percentage of most-likely candidates that the model considers for the next token. For example, if you choose a value of 0.8 for ``topP`` , the model selects from the top 80% of the probability distribution of tokens that could be next in the sequence. The default value is the default value for the model that you are using. For more information, see `Inference parameters for foundation models <https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html>`_ .
1266
1266
 
1267
1267
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-inferenceconfiguration.html
1268
1268
  :exampleMetadata: fixture=_generated
@@ -1326,6 +1326,8 @@ class CfnAgent(
1326
1326
 
1327
1327
  A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.
1328
1328
 
1329
+ The default value is the default value for the model that you are using. For more information, see `Inference parameters for foundation models <https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html>`_ .
1330
+
1329
1331
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-inferenceconfiguration.html#cfn-bedrock-agent-inferenceconfiguration-temperature
1330
1332
  '''
1331
1333
  result = self._values.get("temperature")
@@ -1344,9 +1346,11 @@ class CfnAgent(
1344
1346
 
1345
1347
  @builtins.property
1346
1348
  def top_p(self) -> typing.Optional[jsii.Number]:
1347
- '''While generating a response, the model determines the probability of the following token at each point of generation.
1349
+ '''The percentage of most-likely candidates that the model considers for the next token.
1350
+
1351
+ For example, if you choose a value of 0.8 for ``topP`` , the model selects from the top 80% of the probability distribution of tokens that could be next in the sequence.
1348
1352
 
1349
- The value that you set for ``Top P`` determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set ``topP`` to 80, the model only selects the next token from the top 80% of the probability distribution of next tokens.
1353
+ The default value is the default value for the model that you are using. For more information, see `Inference parameters for foundation models <https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html>`_ .
1350
1354
 
1351
1355
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-inferenceconfiguration.html#cfn-bedrock-agent-inferenceconfiguration-topp
1352
1356
  '''
@@ -1495,7 +1499,7 @@ class CfnAgent(
1495
1499
 
1496
1500
  For more information, see `Advanced prompts <https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html>`_ .
1497
1501
 
1498
- :param base_prompt_template: Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see `Prompt template placeholder variables <https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html>`_ .
1502
+ :param base_prompt_template: Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see `Prompt template placeholder variables <https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html>`_ . For more information, see `Configure the prompt templates <https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts-configure.html>`_ .
1499
1503
  :param inference_configuration: Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the ``promptType`` . For more information, see `Inference parameters for foundation models <https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html>`_ .
1500
1504
  :param parser_mode: Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the ``promptType`` . If you set the field as ``OVERRIDEN`` , the ``overrideLambda`` field in the `PromptOverrideConfiguration <https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html>`_ must be specified with the ARN of a Lambda function.
1501
1505
  :param prompt_creation_mode: Specifies whether to override the default prompt template for this ``promptType`` . Set this value to ``OVERRIDDEN`` to use the prompt that you provide in the ``basePromptTemplate`` . If you leave it as ``DEFAULT`` , the agent uses a default prompt template.
@@ -1552,7 +1556,7 @@ class CfnAgent(
1552
1556
  def base_prompt_template(self) -> typing.Optional[builtins.str]:
1553
1557
  '''Defines the prompt template with which to replace the default prompt template.
1554
1558
 
1555
- You can use placeholder variables in the base prompt template to customize the prompt. For more information, see `Prompt template placeholder variables <https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html>`_ .
1559
+ You can use placeholder variables in the base prompt template to customize the prompt. For more information, see `Prompt template placeholder variables <https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html>`_ . For more information, see `Configure the prompt templates <https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts-configure.html>`_ .
1556
1560
 
1557
1561
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-promptconfiguration.html#cfn-bedrock-agent-promptconfiguration-baseprompttemplate
1558
1562
  '''
@@ -1650,7 +1654,7 @@ class CfnAgent(
1650
1654
  For more information, see `Advanced prompts <https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html>`_ .
1651
1655
 
1652
1656
  :param prompt_configurations: Contains configurations to override a prompt template in one part of an agent sequence. For more information, see `Advanced prompts <https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html>`_ .
1653
- :param override_lambda: The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the ``promptConfigurations`` must contain a ``parserMode`` value that is set to ``OVERRIDDEN`` .
1657
+ :param override_lambda: The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the ``promptConfigurations`` must contain a ``parserMode`` value that is set to ``OVERRIDDEN`` . For more information, see `Parser Lambda function in Agents for Amazon Bedrock <https://docs.aws.amazon.com/bedrock/latest/userguide/lambda-parser.html>`_ .
1654
1658
 
1655
1659
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-promptoverrideconfiguration.html
1656
1660
  :exampleMetadata: fixture=_generated
@@ -1709,7 +1713,7 @@ class CfnAgent(
1709
1713
  def override_lambda(self) -> typing.Optional[builtins.str]:
1710
1714
  '''The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence.
1711
1715
 
1712
- If you specify this field, at least one of the ``promptConfigurations`` must contain a ``parserMode`` value that is set to ``OVERRIDDEN`` .
1716
+ If you specify this field, at least one of the ``promptConfigurations`` must contain a ``parserMode`` value that is set to ``OVERRIDDEN`` . For more information, see `Parser Lambda function in Agents for Amazon Bedrock <https://docs.aws.amazon.com/bedrock/latest/userguide/lambda-parser.html>`_ .
1713
1717
 
1714
1718
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-promptoverrideconfiguration.html#cfn-bedrock-agent-promptoverrideconfiguration-overridelambda
1715
1719
  '''
@@ -3640,7 +3644,16 @@ class CfnGuardrail(
3640
3644
  ):
3641
3645
  '''Creates a guardrail to block topics and to implement safeguards for your generative AI applications.
3642
3646
 
3643
- You can configure denied topics to disallow undesirable topics and content filters to block harmful content in model inputs and responses. For more information, see `Guardrails for Amazon Bedrock <https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails.html>`_ in the *Amazon Bedrock User Guide*
3647
+ 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.
3648
+
3649
+ - *Content filters* - Adjust filter strengths to block input prompts or model responses containing harmful content.
3650
+ - *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.
3651
+ - *Word filters* - Configure filters to block undesirable words, phrases, and profanity. Such words can include offensive terms, competitor names etc.
3652
+ - *Sensitive information filters* - Block or mask sensitive information such as personally identifiable information (PII) or custom regex in user inputs and model responses.
3653
+
3654
+ 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.
3655
+
3656
+ For more information, see `Guardrails for Amazon Bedrock <https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails.html>`_ in the *Amazon Bedrock User Guide* .
3644
3657
 
3645
3658
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html
3646
3659
  :cloudformationResource: AWS::Bedrock::Guardrail
@@ -3728,13 +3741,13 @@ class CfnGuardrail(
3728
3741
  :param blocked_input_messaging: The message to return when the guardrail blocks a prompt.
3729
3742
  :param blocked_outputs_messaging: The message to return when the guardrail blocks a model response.
3730
3743
  :param name: The name of the guardrail.
3731
- :param content_policy_config: Content policy config for a guardrail.
3744
+ :param content_policy_config: The content filter policies to configure for the guardrail.
3732
3745
  :param description: A description of the guardrail.
3733
- :param kms_key_arn: The ARN of the AWS KMS key used to encrypt the guardrail.
3734
- :param sensitive_information_policy_config: Sensitive information policy config for a guardrail.
3735
- :param tags: Metadata that you can assign to a guardrail as key-value pairs. For more information, see the following resources:. - `Tag naming limits and requirements <https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-conventions>`_ - `Tagging best practices <https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-best-practices>`_
3736
- :param topic_policy_config: Topic policy config for a guardrail.
3737
- :param word_policy_config: Word policy config for a guardrail.
3746
+ :param kms_key_arn: The ARN of the AWS KMS key that you use to encrypt the guardrail.
3747
+ :param sensitive_information_policy_config: The sensitive information policy to configure for the guardrail.
3748
+ :param tags: The tags that you want to attach to the guardrail.
3749
+ :param topic_policy_config: The topic policies to configure for the guardrail.
3750
+ :param word_policy_config: The word policy you configure for the guardrail.
3738
3751
  '''
3739
3752
  if __debug__:
3740
3753
  type_hints = typing.get_type_hints(_typecheckingstub__2043b4e3280827dde584095cdad9778bf2076242696d52ba5a39dc96cedb89a0)
@@ -3797,7 +3810,9 @@ class CfnGuardrail(
3797
3810
  @builtins.property
3798
3811
  @jsii.member(jsii_name="attrFailureRecommendations")
3799
3812
  def attr_failure_recommendations(self) -> typing.List[builtins.str]:
3800
- '''List of failure recommendations.
3813
+ '''Appears if the ``status`` of the guardrail is ``FAILED`` .
3814
+
3815
+ A list of recommendations to carry out before retrying the request.
3801
3816
 
3802
3817
  :cloudformationAttribute: FailureRecommendations
3803
3818
  '''
@@ -3806,9 +3821,7 @@ class CfnGuardrail(
3806
3821
  @builtins.property
3807
3822
  @jsii.member(jsii_name="attrGuardrailArn")
3808
3823
  def attr_guardrail_arn(self) -> builtins.str:
3809
- '''The Amazon Resource Name (ARN) of the guardrail.
3810
-
3811
- This a the primary identifier for the guardrail.
3824
+ '''The ARN of the guardrail.
3812
3825
 
3813
3826
  :cloudformationAttribute: GuardrailArn
3814
3827
  '''
@@ -3826,7 +3839,7 @@ class CfnGuardrail(
3826
3839
  @builtins.property
3827
3840
  @jsii.member(jsii_name="attrStatus")
3828
3841
  def attr_status(self) -> builtins.str:
3829
- '''Status of the guardrail.
3842
+ '''The status of the guardrail.
3830
3843
 
3831
3844
  :cloudformationAttribute: Status
3832
3845
  '''
@@ -3835,7 +3848,9 @@ class CfnGuardrail(
3835
3848
  @builtins.property
3836
3849
  @jsii.member(jsii_name="attrStatusReasons")
3837
3850
  def attr_status_reasons(self) -> typing.List[builtins.str]:
3838
- '''List of status reasons.
3851
+ '''Appears if the ``status`` is ``FAILED`` .
3852
+
3853
+ A list of reasons for why the guardrail failed to be created, updated, versioned, or deleted.
3839
3854
 
3840
3855
  :cloudformationAttribute: StatusReasons
3841
3856
  '''
@@ -3853,7 +3868,9 @@ class CfnGuardrail(
3853
3868
  @builtins.property
3854
3869
  @jsii.member(jsii_name="attrVersion")
3855
3870
  def attr_version(self) -> builtins.str:
3856
- '''The version of the guardrail.
3871
+ '''The version of the guardrail that was created.
3872
+
3873
+ This value will always be ``DRAFT`` .
3857
3874
 
3858
3875
  :cloudformationAttribute: Version
3859
3876
  '''
@@ -3914,7 +3931,7 @@ class CfnGuardrail(
3914
3931
  def content_policy_config(
3915
3932
  self,
3916
3933
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnGuardrail.ContentPolicyConfigProperty"]]:
3917
- '''Content policy config for a guardrail.'''
3934
+ '''The content filter policies to configure for the guardrail.'''
3918
3935
  return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnGuardrail.ContentPolicyConfigProperty"]], jsii.get(self, "contentPolicyConfig"))
3919
3936
 
3920
3937
  @content_policy_config.setter
@@ -3943,7 +3960,7 @@ class CfnGuardrail(
3943
3960
  @builtins.property
3944
3961
  @jsii.member(jsii_name="kmsKeyArn")
3945
3962
  def kms_key_arn(self) -> typing.Optional[builtins.str]:
3946
- '''The ARN of the AWS KMS key used to encrypt the guardrail.'''
3963
+ '''The ARN of the AWS KMS key that you use to encrypt the guardrail.'''
3947
3964
  return typing.cast(typing.Optional[builtins.str], jsii.get(self, "kmsKeyArn"))
3948
3965
 
3949
3966
  @kms_key_arn.setter
@@ -3958,7 +3975,7 @@ class CfnGuardrail(
3958
3975
  def sensitive_information_policy_config(
3959
3976
  self,
3960
3977
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnGuardrail.SensitiveInformationPolicyConfigProperty"]]:
3961
- '''Sensitive information policy config for a guardrail.'''
3978
+ '''The sensitive information policy to configure for the guardrail.'''
3962
3979
  return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnGuardrail.SensitiveInformationPolicyConfigProperty"]], jsii.get(self, "sensitiveInformationPolicyConfig"))
3963
3980
 
3964
3981
  @sensitive_information_policy_config.setter
@@ -3974,10 +3991,7 @@ class CfnGuardrail(
3974
3991
  @builtins.property
3975
3992
  @jsii.member(jsii_name="tags")
3976
3993
  def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
3977
- '''Metadata that you can assign to a guardrail as key-value pairs.
3978
-
3979
- For more information, see the following resources:.
3980
- '''
3994
+ '''The tags that you want to attach to the guardrail.'''
3981
3995
  return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tags"))
3982
3996
 
3983
3997
  @tags.setter
@@ -3992,7 +4006,7 @@ class CfnGuardrail(
3992
4006
  def topic_policy_config(
3993
4007
  self,
3994
4008
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnGuardrail.TopicPolicyConfigProperty"]]:
3995
- '''Topic policy config for a guardrail.'''
4009
+ '''The topic policies to configure for the guardrail.'''
3996
4010
  return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnGuardrail.TopicPolicyConfigProperty"]], jsii.get(self, "topicPolicyConfig"))
3997
4011
 
3998
4012
  @topic_policy_config.setter
@@ -4010,7 +4024,7 @@ class CfnGuardrail(
4010
4024
  def word_policy_config(
4011
4025
  self,
4012
4026
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnGuardrail.WordPolicyConfigProperty"]]:
4013
- '''Word policy config for a guardrail.'''
4027
+ '''The word policy you configure for the guardrail.'''
4014
4028
  return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnGuardrail.WordPolicyConfigProperty"]], jsii.get(self, "wordPolicyConfig"))
4015
4029
 
4016
4030
  @word_policy_config.setter
@@ -4040,11 +4054,22 @@ class CfnGuardrail(
4040
4054
  output_strength: builtins.str,
4041
4055
  type: builtins.str,
4042
4056
  ) -> None:
4043
- '''Content filter config in content policy.
4057
+ '''Contains filter strengths for harmful content.
4058
+
4059
+ Guardrails support the following content filters to detect and filter harmful user inputs and FM-generated outputs.
4060
+
4061
+ - *Hate* – Describes language or a statement that discriminates, criticizes, insults, denounces, or dehumanizes a person or group on the basis of an identity (such as race, ethnicity, gender, religion, sexual orientation, ability, and national origin).
4062
+ - *Insults* – Describes language or a statement that includes demeaning, humiliating, mocking, insulting, or belittling language. This type of language is also labeled as bullying.
4063
+ - *Sexual* – Describes language or a statement that indicates sexual interest, activity, or arousal using direct or indirect references to body parts, physical traits, or sex.
4064
+ - *Violence* – Describes language or a statement that includes glorification of or threats to inflict physical pain, hurt, or injury toward a person, group or thing.
4065
+
4066
+ Content filtering depends on the confidence classification of user inputs and FM responses across each of the four harmful categories. All input and output statements are classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each harmful category. For example, if a statement is classified as *Hate* with HIGH confidence, the likelihood of the statement representing hateful content is high. A single statement can be classified across multiple categories with varying confidence levels. For example, a single statement can be classified as *Hate* with HIGH confidence, *Insults* with LOW confidence, *Sexual* with NONE confidence, and *Violence* with MEDIUM confidence.
4067
+
4068
+ For more information, see `Guardrails content filters <https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-filters.html>`_ .
4044
4069
 
4045
- :param input_strength: Strength for filters.
4046
- :param output_strength: Strength for filters.
4047
- :param type: Type of filter in content policy.
4070
+ :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.
4071
+ :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.
4072
+ :param type: The harmful category that the content filter is applied to.
4048
4073
 
4049
4074
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html
4050
4075
  :exampleMetadata: fixture=_generated
@@ -4074,7 +4099,9 @@ class CfnGuardrail(
4074
4099
 
4075
4100
  @builtins.property
4076
4101
  def input_strength(self) -> builtins.str:
4077
- '''Strength for filters.
4102
+ '''The strength of the content filter to apply to prompts.
4103
+
4104
+ As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.
4078
4105
 
4079
4106
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html#cfn-bedrock-guardrail-contentfilterconfig-inputstrength
4080
4107
  '''
@@ -4084,7 +4111,9 @@ class CfnGuardrail(
4084
4111
 
4085
4112
  @builtins.property
4086
4113
  def output_strength(self) -> builtins.str:
4087
- '''Strength for filters.
4114
+ '''The strength of the content filter to apply to model responses.
4115
+
4116
+ As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.
4088
4117
 
4089
4118
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html#cfn-bedrock-guardrail-contentfilterconfig-outputstrength
4090
4119
  '''
@@ -4094,7 +4123,7 @@ class CfnGuardrail(
4094
4123
 
4095
4124
  @builtins.property
4096
4125
  def type(self) -> builtins.str:
4097
- '''Type of filter in content policy.
4126
+ '''The harmful category that the content filter is applied to.
4098
4127
 
4099
4128
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html#cfn-bedrock-guardrail-contentfilterconfig-type
4100
4129
  '''
@@ -4124,9 +4153,9 @@ class CfnGuardrail(
4124
4153
  *,
4125
4154
  filters_config: typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnGuardrail.ContentFilterConfigProperty", typing.Dict[builtins.str, typing.Any]]]]],
4126
4155
  ) -> None:
4127
- '''Content policy config for a guardrail.
4156
+ '''Contains details about how to handle harmful content.
4128
4157
 
4129
- :param filters_config: List of content filter configs in content policy.
4158
+ :param filters_config: Contains the type of the content filter and how strongly it should apply to prompts and model responses.
4130
4159
 
4131
4160
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentpolicyconfig.html
4132
4161
  :exampleMetadata: fixture=_generated
@@ -4156,7 +4185,7 @@ class CfnGuardrail(
4156
4185
  def filters_config(
4157
4186
  self,
4158
4187
  ) -> typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnGuardrail.ContentFilterConfigProperty"]]]:
4159
- '''List of content filter configs in content policy.
4188
+ '''Contains the type of the content filter and how strongly it should apply to prompts and model responses.
4160
4189
 
4161
4190
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentpolicyconfig.html#cfn-bedrock-guardrail-contentpolicyconfig-filtersconfig
4162
4191
  '''
@@ -4182,9 +4211,9 @@ class CfnGuardrail(
4182
4211
  )
4183
4212
  class ManagedWordsConfigProperty:
4184
4213
  def __init__(self, *, type: builtins.str) -> None:
4185
- '''A managed words config.
4214
+ '''The managed word list to configure for the guardrail.
4186
4215
 
4187
- :param type: Options for managed words.
4216
+ :param type: The managed word type to configure for the guardrail.
4188
4217
 
4189
4218
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-managedwordsconfig.html
4190
4219
  :exampleMetadata: fixture=_generated
@@ -4208,7 +4237,7 @@ class CfnGuardrail(
4208
4237
 
4209
4238
  @builtins.property
4210
4239
  def type(self) -> builtins.str:
4211
- '''Options for managed words.
4240
+ '''The managed word type to configure for the guardrail.
4212
4241
 
4213
4242
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-managedwordsconfig.html#cfn-bedrock-guardrail-managedwordsconfig-type
4214
4243
  '''
@@ -4234,10 +4263,10 @@ class CfnGuardrail(
4234
4263
  )
4235
4264
  class PiiEntityConfigProperty:
4236
4265
  def __init__(self, *, action: builtins.str, type: builtins.str) -> None:
4237
- '''Pii entity configuration.
4266
+ '''The PII entity to configure for the guardrail.
4238
4267
 
4239
- :param action: Options for sensitive information action.
4240
- :param type: The currently supported PII entities.
4268
+ :param action: Configure guardrail action when the PII entity is detected.
4269
+ :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," Guarrails 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* - *REDIT_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..
4241
4270
 
4242
4271
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-piientityconfig.html
4243
4272
  :exampleMetadata: fixture=_generated
@@ -4264,7 +4293,7 @@ class CfnGuardrail(
4264
4293
 
4265
4294
  @builtins.property
4266
4295
  def action(self) -> builtins.str:
4267
- '''Options for sensitive information action.
4296
+ '''Configure guardrail action when the PII entity is detected.
4268
4297
 
4269
4298
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-piientityconfig.html#cfn-bedrock-guardrail-piientityconfig-action
4270
4299
  '''
@@ -4274,7 +4303,148 @@ class CfnGuardrail(
4274
4303
 
4275
4304
  @builtins.property
4276
4305
  def type(self) -> builtins.str:
4277
- '''The currently supported PII entities.
4306
+ '''Configure guardrail type when the PII entity is detected.
4307
+
4308
+ The following PIIs are used to block or mask sensitive information:
4309
+
4310
+ - *General*
4311
+ - *ADDRESS*
4312
+
4313
+ 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.
4314
+
4315
+ - *AGE*
4316
+
4317
+ An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guarrails recognizes "40 years" as an age.
4318
+
4319
+ - *NAME*
4320
+
4321
+ 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.
4322
+
4323
+ - *EMAIL*
4324
+
4325
+ An email address, such as *marymajor@email.com* .
4326
+
4327
+ - *PHONE*
4328
+
4329
+ A phone number. This entity type also includes fax and pager numbers.
4330
+
4331
+ - *USERNAME*
4332
+
4333
+ A user name that identifies an account, such as a login name, screen name, nick name, or handle.
4334
+
4335
+ - *PASSWORD*
4336
+
4337
+ An alphanumeric string that is used as a password, such as "* *very20special#pass** ".
4338
+
4339
+ - *DRIVER_ID*
4340
+
4341
+ 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.
4342
+
4343
+ - *LICENSE_PLATE*
4344
+
4345
+ 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.
4346
+
4347
+ - *VEHICLE_IDENTIFICATION_NUMBER*
4348
+
4349
+ 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.
4350
+
4351
+ - *Finance*
4352
+ - *REDIT_DEBIT_CARD_CVV*
4353
+
4354
+ 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.
4355
+
4356
+ - *CREDIT_DEBIT_CARD_EXPIRY*
4357
+
4358
+ 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* .
4359
+
4360
+ - *CREDIT_DEBIT_CARD_NUMBER*
4361
+
4362
+ 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.
4363
+
4364
+ - *PIN*
4365
+
4366
+ A four-digit personal identification number (PIN) with which you can access your bank account.
4367
+
4368
+ - *INTERNATIONAL_BANK_ACCOUNT_NUMBER*
4369
+
4370
+ 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>`_ .
4371
+
4372
+ - *SWIFT_CODE*
4373
+
4374
+ 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.
4375
+
4376
+ 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.
4377
+
4378
+ - *IT*
4379
+ - *IP_ADDRESS*
4380
+
4381
+ An IPv4 address, such as *198.51.100.0* .
4382
+
4383
+ - *MAC_ADDRESS*
4384
+
4385
+ A *media access control* (MAC) address is a unique identifier assigned to a network interface controller (NIC).
4386
+
4387
+ - *URL*
4388
+
4389
+ A web address, such as *www.example.com* .
4390
+
4391
+ - *AWS_ACCESS_KEY*
4392
+
4393
+ 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.
4394
+
4395
+ - *AWS_SECRET_KEY*
4396
+
4397
+ 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.
4398
+
4399
+ - *USA specific*
4400
+ - *US_BANK_ACCOUNT_NUMBER*
4401
+
4402
+ A US bank account number, which is typically 10 to 12 digits long.
4403
+
4404
+ - *US_BANK_ROUTING_NUMBER*
4405
+
4406
+ A US bank account routing number. These are typically nine digits long,
4407
+
4408
+ - *US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER*
4409
+
4410
+ 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.
4411
+
4412
+ - *US_PASSPORT_NUMBER*
4413
+
4414
+ A US passport number. Passport numbers range from six to nine alphanumeric characters.
4415
+
4416
+ - *US_SOCIAL_SECURITY_NUMBER*
4417
+
4418
+ A US Social Security Number (SSN) is a nine-digit number that is issued to US citizens, permanent residents, and temporary working residents.
4419
+
4420
+ - *Canada specific*
4421
+ - *CA_HEALTH_NUMBER*
4422
+
4423
+ A Canadian Health Service Number is a 10-digit unique identifier, required for individuals to access healthcare benefits.
4424
+
4425
+ - *CA_SOCIAL_INSURANCE_NUMBER*
4426
+
4427
+ A Canadian Social Insurance Number (SIN) is a nine-digit unique identifier, required for individuals to access government programs and benefits.
4428
+
4429
+ 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>`_ .
4430
+
4431
+ - *UK Specific*
4432
+ - *UK_NATIONAL_HEALTH_SERVICE_NUMBER*
4433
+
4434
+ 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.
4435
+
4436
+ - *UK_NATIONAL_INSURANCE_NUMBER*
4437
+
4438
+ 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.
4439
+
4440
+ 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.
4441
+
4442
+ - *UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER*
4443
+
4444
+ A UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a taxpayer or a business.
4445
+
4446
+ - *Custom*
4447
+ - *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..
4278
4448
 
4279
4449
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-piientityconfig.html#cfn-bedrock-guardrail-piientityconfig-type
4280
4450
  '''
@@ -4312,12 +4482,12 @@ class CfnGuardrail(
4312
4482
  pattern: builtins.str,
4313
4483
  description: typing.Optional[builtins.str] = None,
4314
4484
  ) -> None:
4315
- '''A regex configuration.
4485
+ '''The regular expression to configure for the guardrail.
4316
4486
 
4317
- :param action: Options for sensitive information action.
4318
- :param name: The regex name.
4319
- :param pattern: The regex pattern.
4320
- :param description: The regex description.
4487
+ :param action: The guardrail action to configure when matching regular expression is detected.
4488
+ :param name: The name of the regular expression to configure for the guardrail.
4489
+ :param pattern: The regular expression pattern to configure for the guardrail.
4490
+ :param description: The description of the regular expression to configure for the guardrail.
4321
4491
 
4322
4492
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-regexconfig.html
4323
4493
  :exampleMetadata: fixture=_generated
@@ -4353,7 +4523,7 @@ class CfnGuardrail(
4353
4523
 
4354
4524
  @builtins.property
4355
4525
  def action(self) -> builtins.str:
4356
- '''Options for sensitive information action.
4526
+ '''The guardrail action to configure when matching regular expression is detected.
4357
4527
 
4358
4528
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-regexconfig.html#cfn-bedrock-guardrail-regexconfig-action
4359
4529
  '''
@@ -4363,7 +4533,7 @@ class CfnGuardrail(
4363
4533
 
4364
4534
  @builtins.property
4365
4535
  def name(self) -> builtins.str:
4366
- '''The regex name.
4536
+ '''The name of the regular expression to configure for the guardrail.
4367
4537
 
4368
4538
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-regexconfig.html#cfn-bedrock-guardrail-regexconfig-name
4369
4539
  '''
@@ -4373,7 +4543,7 @@ class CfnGuardrail(
4373
4543
 
4374
4544
  @builtins.property
4375
4545
  def pattern(self) -> builtins.str:
4376
- '''The regex pattern.
4546
+ '''The regular expression pattern to configure for the guardrail.
4377
4547
 
4378
4548
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-regexconfig.html#cfn-bedrock-guardrail-regexconfig-pattern
4379
4549
  '''
@@ -4383,7 +4553,7 @@ class CfnGuardrail(
4383
4553
 
4384
4554
  @builtins.property
4385
4555
  def description(self) -> typing.Optional[builtins.str]:
4386
- '''The regex description.
4556
+ '''The description of the regular expression to configure for the guardrail.
4387
4557
 
4388
4558
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-regexconfig.html#cfn-bedrock-guardrail-regexconfig-description
4389
4559
  '''
@@ -4416,10 +4586,10 @@ class CfnGuardrail(
4416
4586
  pii_entities_config: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnGuardrail.PiiEntityConfigProperty", typing.Dict[builtins.str, typing.Any]]]]]] = None,
4417
4587
  regexes_config: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnGuardrail.RegexConfigProperty", typing.Dict[builtins.str, typing.Any]]]]]] = None,
4418
4588
  ) -> None:
4419
- '''Sensitive information policy config for a guardrail.
4589
+ '''Contains details about PII entities and regular expressions to configure for the guardrail.
4420
4590
 
4421
- :param pii_entities_config: List of entities.
4422
- :param regexes_config: List of regex.
4591
+ :param pii_entities_config: A list of PII entities to configure to the guardrail.
4592
+ :param regexes_config: A list of regular expressions to configure to the guardrail.
4423
4593
 
4424
4594
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-sensitiveinformationpolicyconfig.html
4425
4595
  :exampleMetadata: fixture=_generated
@@ -4459,7 +4629,7 @@ class CfnGuardrail(
4459
4629
  def pii_entities_config(
4460
4630
  self,
4461
4631
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnGuardrail.PiiEntityConfigProperty"]]]]:
4462
- '''List of entities.
4632
+ '''A list of PII entities to configure to the guardrail.
4463
4633
 
4464
4634
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-sensitiveinformationpolicyconfig.html#cfn-bedrock-guardrail-sensitiveinformationpolicyconfig-piientitiesconfig
4465
4635
  '''
@@ -4470,7 +4640,7 @@ class CfnGuardrail(
4470
4640
  def regexes_config(
4471
4641
  self,
4472
4642
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnGuardrail.RegexConfigProperty"]]]]:
4473
- '''List of regex.
4643
+ '''A list of regular expressions to configure to the guardrail.
4474
4644
 
4475
4645
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-sensitiveinformationpolicyconfig.html#cfn-bedrock-guardrail-sensitiveinformationpolicyconfig-regexesconfig
4476
4646
  '''
@@ -4507,12 +4677,12 @@ class CfnGuardrail(
4507
4677
  type: builtins.str,
4508
4678
  examples: typing.Optional[typing.Sequence[builtins.str]] = None,
4509
4679
  ) -> None:
4510
- '''Topic config in topic policy.
4680
+ '''Details about topics for the guardrail to identify and deny.
4511
4681
 
4512
- :param definition: Definition of topic in topic policy.
4513
- :param name: Name of topic in topic policy.
4514
- :param type: Type of topic in a policy.
4515
- :param examples: List of text examples.
4682
+ :param definition: A definition of the topic to deny.
4683
+ :param name: The name of the topic to deny.
4684
+ :param type: Specifies to deny the topic.
4685
+ :param examples: A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.
4516
4686
 
4517
4687
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html
4518
4688
  :exampleMetadata: fixture=_generated
@@ -4548,7 +4718,7 @@ class CfnGuardrail(
4548
4718
 
4549
4719
  @builtins.property
4550
4720
  def definition(self) -> builtins.str:
4551
- '''Definition of topic in topic policy.
4721
+ '''A definition of the topic to deny.
4552
4722
 
4553
4723
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html#cfn-bedrock-guardrail-topicconfig-definition
4554
4724
  '''
@@ -4558,7 +4728,7 @@ class CfnGuardrail(
4558
4728
 
4559
4729
  @builtins.property
4560
4730
  def name(self) -> builtins.str:
4561
- '''Name of topic in topic policy.
4731
+ '''The name of the topic to deny.
4562
4732
 
4563
4733
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html#cfn-bedrock-guardrail-topicconfig-name
4564
4734
  '''
@@ -4568,7 +4738,7 @@ class CfnGuardrail(
4568
4738
 
4569
4739
  @builtins.property
4570
4740
  def type(self) -> builtins.str:
4571
- '''Type of topic in a policy.
4741
+ '''Specifies to deny the topic.
4572
4742
 
4573
4743
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html#cfn-bedrock-guardrail-topicconfig-type
4574
4744
  '''
@@ -4578,7 +4748,7 @@ class CfnGuardrail(
4578
4748
 
4579
4749
  @builtins.property
4580
4750
  def examples(self) -> typing.Optional[typing.List[builtins.str]]:
4581
- '''List of text examples.
4751
+ '''A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.
4582
4752
 
4583
4753
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html#cfn-bedrock-guardrail-topicconfig-examples
4584
4754
  '''
@@ -4607,9 +4777,9 @@ class CfnGuardrail(
4607
4777
  *,
4608
4778
  topics_config: typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnGuardrail.TopicConfigProperty", typing.Dict[builtins.str, typing.Any]]]]],
4609
4779
  ) -> None:
4610
- '''Topic policy config for a guardrail.
4780
+ '''Contains details about topics that the guardrail should identify and deny.
4611
4781
 
4612
- :param topics_config: List of topic configs in topic policy.
4782
+ :param topics_config: A list of policies related to topics that the guardrail should deny.
4613
4783
 
4614
4784
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicpolicyconfig.html
4615
4785
  :exampleMetadata: fixture=_generated
@@ -4642,7 +4812,7 @@ class CfnGuardrail(
4642
4812
  def topics_config(
4643
4813
  self,
4644
4814
  ) -> typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnGuardrail.TopicConfigProperty"]]]:
4645
- '''List of topic configs in topic policy.
4815
+ '''A list of policies related to topics that the guardrail should deny.
4646
4816
 
4647
4817
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicpolicyconfig.html#cfn-bedrock-guardrail-topicpolicyconfig-topicsconfig
4648
4818
  '''
@@ -4668,9 +4838,9 @@ class CfnGuardrail(
4668
4838
  )
4669
4839
  class WordConfigProperty:
4670
4840
  def __init__(self, *, text: builtins.str) -> None:
4671
- '''A custom word config.
4841
+ '''A word to configure for the guardrail.
4672
4842
 
4673
- :param text: The custom word text.
4843
+ :param text: Text of the word configured for the guardrail to block.
4674
4844
 
4675
4845
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordconfig.html
4676
4846
  :exampleMetadata: fixture=_generated
@@ -4694,7 +4864,7 @@ class CfnGuardrail(
4694
4864
 
4695
4865
  @builtins.property
4696
4866
  def text(self) -> builtins.str:
4697
- '''The custom word text.
4867
+ '''Text of the word configured for the guardrail to block.
4698
4868
 
4699
4869
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordconfig.html#cfn-bedrock-guardrail-wordconfig-text
4700
4870
  '''
@@ -4728,10 +4898,10 @@ class CfnGuardrail(
4728
4898
  managed_word_lists_config: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnGuardrail.ManagedWordsConfigProperty", typing.Dict[builtins.str, typing.Any]]]]]] = None,
4729
4899
  words_config: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnGuardrail.WordConfigProperty", typing.Dict[builtins.str, typing.Any]]]]]] = None,
4730
4900
  ) -> None:
4731
- '''Word policy config for a guardrail.
4901
+ '''Contains details about the word policy to configured for the guardrail.
4732
4902
 
4733
- :param managed_word_lists_config: A config for the list of managed words.
4734
- :param words_config: List of custom word configs.
4903
+ :param managed_word_lists_config: A list of managed words to configure for the guardrail.
4904
+ :param words_config: A list of words to configure for the guardrail.
4735
4905
 
4736
4906
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordpolicyconfig.html
4737
4907
  :exampleMetadata: fixture=_generated
@@ -4765,7 +4935,7 @@ class CfnGuardrail(
4765
4935
  def managed_word_lists_config(
4766
4936
  self,
4767
4937
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnGuardrail.ManagedWordsConfigProperty"]]]]:
4768
- '''A config for the list of managed words.
4938
+ '''A list of managed words to configure for the guardrail.
4769
4939
 
4770
4940
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordpolicyconfig.html#cfn-bedrock-guardrail-wordpolicyconfig-managedwordlistsconfig
4771
4941
  '''
@@ -4776,7 +4946,7 @@ class CfnGuardrail(
4776
4946
  def words_config(
4777
4947
  self,
4778
4948
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnGuardrail.WordConfigProperty"]]]]:
4779
- '''List of custom word configs.
4949
+ '''A list of words to configure for the guardrail.
4780
4950
 
4781
4951
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordpolicyconfig.html#cfn-bedrock-guardrail-wordpolicyconfig-wordsconfig
4782
4952
  '''
@@ -4831,13 +5001,13 @@ class CfnGuardrailProps:
4831
5001
  :param blocked_input_messaging: The message to return when the guardrail blocks a prompt.
4832
5002
  :param blocked_outputs_messaging: The message to return when the guardrail blocks a model response.
4833
5003
  :param name: The name of the guardrail.
4834
- :param content_policy_config: Content policy config for a guardrail.
5004
+ :param content_policy_config: The content filter policies to configure for the guardrail.
4835
5005
  :param description: A description of the guardrail.
4836
- :param kms_key_arn: The ARN of the AWS KMS key used to encrypt the guardrail.
4837
- :param sensitive_information_policy_config: Sensitive information policy config for a guardrail.
4838
- :param tags: Metadata that you can assign to a guardrail as key-value pairs. For more information, see the following resources:. - `Tag naming limits and requirements <https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-conventions>`_ - `Tagging best practices <https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-best-practices>`_
4839
- :param topic_policy_config: Topic policy config for a guardrail.
4840
- :param word_policy_config: Word policy config for a guardrail.
5006
+ :param kms_key_arn: The ARN of the AWS KMS key that you use to encrypt the guardrail.
5007
+ :param sensitive_information_policy_config: The sensitive information policy to configure for the guardrail.
5008
+ :param tags: The tags that you want to attach to the guardrail.
5009
+ :param topic_policy_config: The topic policies to configure for the guardrail.
5010
+ :param word_policy_config: The word policy you configure for the guardrail.
4841
5011
 
4842
5012
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html
4843
5013
  :exampleMetadata: fixture=_generated
@@ -4967,7 +5137,7 @@ class CfnGuardrailProps:
4967
5137
  def content_policy_config(
4968
5138
  self,
4969
5139
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnGuardrail.ContentPolicyConfigProperty]]:
4970
- '''Content policy config for a guardrail.
5140
+ '''The content filter policies to configure for the guardrail.
4971
5141
 
4972
5142
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-contentpolicyconfig
4973
5143
  '''
@@ -4985,7 +5155,7 @@ class CfnGuardrailProps:
4985
5155
 
4986
5156
  @builtins.property
4987
5157
  def kms_key_arn(self) -> typing.Optional[builtins.str]:
4988
- '''The ARN of the AWS KMS key used to encrypt the guardrail.
5158
+ '''The ARN of the AWS KMS key that you use to encrypt the guardrail.
4989
5159
 
4990
5160
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-kmskeyarn
4991
5161
  '''
@@ -4996,7 +5166,7 @@ class CfnGuardrailProps:
4996
5166
  def sensitive_information_policy_config(
4997
5167
  self,
4998
5168
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnGuardrail.SensitiveInformationPolicyConfigProperty]]:
4999
- '''Sensitive information policy config for a guardrail.
5169
+ '''The sensitive information policy to configure for the guardrail.
5000
5170
 
5001
5171
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-sensitiveinformationpolicyconfig
5002
5172
  '''
@@ -5005,10 +5175,7 @@ class CfnGuardrailProps:
5005
5175
 
5006
5176
  @builtins.property
5007
5177
  def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
5008
- '''Metadata that you can assign to a guardrail as key-value pairs. For more information, see the following resources:.
5009
-
5010
- - `Tag naming limits and requirements <https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-conventions>`_
5011
- - `Tagging best practices <https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-best-practices>`_
5178
+ '''The tags that you want to attach to the guardrail.
5012
5179
 
5013
5180
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-tags
5014
5181
  '''
@@ -5019,7 +5186,7 @@ class CfnGuardrailProps:
5019
5186
  def topic_policy_config(
5020
5187
  self,
5021
5188
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnGuardrail.TopicPolicyConfigProperty]]:
5022
- '''Topic policy config for a guardrail.
5189
+ '''The topic policies to configure for the guardrail.
5023
5190
 
5024
5191
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-topicpolicyconfig
5025
5192
  '''
@@ -5030,7 +5197,7 @@ class CfnGuardrailProps:
5030
5197
  def word_policy_config(
5031
5198
  self,
5032
5199
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnGuardrail.WordPolicyConfigProperty]]:
5033
- '''Word policy config for a guardrail.
5200
+ '''The word policy you configure for the guardrail.
5034
5201
 
5035
5202
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-wordpolicyconfig
5036
5203
  '''
@@ -5088,7 +5255,7 @@ class CfnGuardrailVersion(
5088
5255
  '''
5089
5256
  :param scope: Scope in which this resource is defined.
5090
5257
  :param id: Construct identifier for this resource (unique in its scope).
5091
- :param guardrail_identifier: The unique identifier of the guardrail.
5258
+ :param guardrail_identifier: The unique identifier of the guardrail. This can be an ID or the ARN.
5092
5259
  :param description: A description of the guardrail version.
5093
5260
  '''
5094
5261
  if __debug__:
@@ -5134,7 +5301,7 @@ class CfnGuardrailVersion(
5134
5301
  @builtins.property
5135
5302
  @jsii.member(jsii_name="attrGuardrailArn")
5136
5303
  def attr_guardrail_arn(self) -> builtins.str:
5137
- '''The ARN of the guardrail that was created.
5304
+ '''The ARN of the guardrail.
5138
5305
 
5139
5306
  :cloudformationAttribute: GuardrailArn
5140
5307
  '''
@@ -5207,7 +5374,7 @@ class CfnGuardrailVersionProps:
5207
5374
  ) -> None:
5208
5375
  '''Properties for defining a ``CfnGuardrailVersion``.
5209
5376
 
5210
- :param guardrail_identifier: The unique identifier of the guardrail.
5377
+ :param guardrail_identifier: The unique identifier of the guardrail. This can be an ID or the ARN.
5211
5378
  :param description: A description of the guardrail version.
5212
5379
 
5213
5380
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrailversion.html
@@ -5240,6 +5407,8 @@ class CfnGuardrailVersionProps:
5240
5407
  def guardrail_identifier(self) -> builtins.str:
5241
5408
  '''The unique identifier of the guardrail.
5242
5409
 
5410
+ This can be an ID or the ARN.
5411
+
5243
5412
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrailversion.html#cfn-bedrock-guardrailversion-guardrailidentifier
5244
5413
  '''
5245
5414
  result = self._values.get("guardrail_identifier")