aws-cdk-lib 2.186.0__py3-none-any.whl → 2.187.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 +281 -116
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.186.0.jsii.tgz → aws-cdk-lib@2.187.0.jsii.tgz} +0 -0
- aws_cdk/aws_amplify/__init__.py +124 -0
- aws_cdk/aws_apigateway/__init__.py +48 -2
- aws_cdk/aws_appsync/__init__.py +14 -5
- aws_cdk/aws_bedrock/__init__.py +32 -22
- aws_cdk/aws_cassandra/__init__.py +2 -2
- aws_cdk/aws_cloudfront/__init__.py +11 -0
- aws_cdk/aws_cloudtrail/__init__.py +4 -18
- aws_cdk/aws_cloudwatch/__init__.py +50 -50
- aws_cdk/aws_codebuild/__init__.py +9 -0
- aws_cdk/aws_config/__init__.py +2 -5
- aws_cdk/aws_datazone/__init__.py +287 -226
- aws_cdk/aws_detective/__init__.py +3 -3
- aws_cdk/aws_dynamodb/__init__.py +37 -0
- aws_cdk/aws_ec2/__init__.py +154 -12
- aws_cdk/aws_ecr/__init__.py +143 -0
- aws_cdk/aws_ecr_assets/__init__.py +115 -4
- aws_cdk/aws_ecs/__init__.py +51 -0
- aws_cdk/aws_eks/__init__.py +114 -0
- aws_cdk/aws_events/__init__.py +8 -11
- aws_cdk/aws_forecast/__init__.py +1 -1
- aws_cdk/aws_fsx/__init__.py +2 -2
- aws_cdk/aws_gamelift/__init__.py +6 -6
- aws_cdk/aws_identitystore/__init__.py +16 -16
- aws_cdk/aws_iotsitewise/__init__.py +623 -0
- aws_cdk/aws_kms/__init__.py +10 -11
- aws_cdk/aws_lakeformation/__init__.py +3 -3
- aws_cdk/aws_lambda/__init__.py +105 -4
- aws_cdk/aws_lambda_event_sources/__init__.py +65 -3
- aws_cdk/aws_lambda_nodejs/__init__.py +5 -24
- aws_cdk/aws_lex/__init__.py +981 -5
- aws_cdk/aws_mediaconnect/__init__.py +714 -290
- aws_cdk/aws_mwaa/__init__.py +9 -9
- aws_cdk/aws_networkfirewall/__init__.py +44 -0
- aws_cdk/aws_omics/__init__.py +216 -0
- aws_cdk/aws_quicksight/__init__.py +244 -39
- aws_cdk/aws_rds/__init__.py +102 -10
- aws_cdk/aws_route53/__init__.py +2 -2
- aws_cdk/aws_route53recoverycontrol/__init__.py +43 -2
- aws_cdk/aws_s3_assets/__init__.py +70 -1
- aws_cdk/aws_s3_deployment/__init__.py +4 -0
- aws_cdk/aws_sagemaker/__init__.py +6 -4
- aws_cdk/aws_scheduler_targets/__init__.py +4 -16
- aws_cdk/aws_securitylake/__init__.py +2 -2
- aws_cdk/aws_servicecatalog/__init__.py +4 -0
- aws_cdk/aws_sns/__init__.py +1 -1
- aws_cdk/aws_stepfunctions/__init__.py +23 -17
- aws_cdk/aws_stepfunctions_tasks/__init__.py +4 -0
- aws_cdk/aws_synthetics/__init__.py +9 -0
- aws_cdk/aws_systemsmanagersap/__init__.py +150 -0
- aws_cdk/aws_wafv2/__init__.py +464 -1138
- aws_cdk/cloud_assembly_schema/__init__.py +60 -10
- aws_cdk/cx_api/__init__.py +15 -0
- aws_cdk/pipelines/__init__.py +20 -2
- {aws_cdk_lib-2.186.0.dist-info → aws_cdk_lib-2.187.0.dist-info}/METADATA +4 -4
- {aws_cdk_lib-2.186.0.dist-info → aws_cdk_lib-2.187.0.dist-info}/RECORD +62 -62
- {aws_cdk_lib-2.186.0.dist-info → aws_cdk_lib-2.187.0.dist-info}/WHEEL +1 -1
- {aws_cdk_lib-2.186.0.dist-info → aws_cdk_lib-2.187.0.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.186.0.dist-info → aws_cdk_lib-2.187.0.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.186.0.dist-info → aws_cdk_lib-2.187.0.dist-info}/top_level.txt +0 -0
aws_cdk/aws_appsync/__init__.py
CHANGED
|
@@ -7842,7 +7842,7 @@ class CfnDomainName(
|
|
|
7842
7842
|
:param certificate_arn: The Amazon Resource Name (ARN) of the certificate. This will be an AWS Certificate Manager certificate.
|
|
7843
7843
|
:param domain_name: The domain name.
|
|
7844
7844
|
:param description: The decription for your domain name.
|
|
7845
|
-
:param tags: A set of tags (key-value pairs) for this
|
|
7845
|
+
:param tags: A set of tags (key-value pairs) for this domain name.
|
|
7846
7846
|
'''
|
|
7847
7847
|
if __debug__:
|
|
7848
7848
|
type_hints = typing.get_type_hints(_typecheckingstub__678693553586e835af6ffdc6ac5860f81ffd96791de73368d44d41d3a220fa5b)
|
|
@@ -7908,7 +7908,7 @@ class CfnDomainName(
|
|
|
7908
7908
|
@builtins.property
|
|
7909
7909
|
@jsii.member(jsii_name="attrDomainNameArn")
|
|
7910
7910
|
def attr_domain_name_arn(self) -> builtins.str:
|
|
7911
|
-
'''The Amazon
|
|
7911
|
+
'''The Amazon resource name (ARN) of the domain name.
|
|
7912
7912
|
|
|
7913
7913
|
:cloudformationAttribute: DomainNameArn
|
|
7914
7914
|
'''
|
|
@@ -7976,7 +7976,7 @@ class CfnDomainName(
|
|
|
7976
7976
|
@builtins.property
|
|
7977
7977
|
@jsii.member(jsii_name="tags")
|
|
7978
7978
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
7979
|
-
'''A set of tags (key-value pairs) for this
|
|
7979
|
+
'''A set of tags (key-value pairs) for this domain name.'''
|
|
7980
7980
|
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tags"))
|
|
7981
7981
|
|
|
7982
7982
|
@tags.setter
|
|
@@ -8196,7 +8196,7 @@ class CfnDomainNameProps:
|
|
|
8196
8196
|
:param certificate_arn: The Amazon Resource Name (ARN) of the certificate. This will be an AWS Certificate Manager certificate.
|
|
8197
8197
|
:param domain_name: The domain name.
|
|
8198
8198
|
:param description: The decription for your domain name.
|
|
8199
|
-
:param tags: A set of tags (key-value pairs) for this
|
|
8199
|
+
:param tags: A set of tags (key-value pairs) for this domain name.
|
|
8200
8200
|
|
|
8201
8201
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-domainname.html
|
|
8202
8202
|
:exampleMetadata: fixture=_generated
|
|
@@ -8267,7 +8267,7 @@ class CfnDomainNameProps:
|
|
|
8267
8267
|
|
|
8268
8268
|
@builtins.property
|
|
8269
8269
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
8270
|
-
'''A set of tags (key-value pairs) for this
|
|
8270
|
+
'''A set of tags (key-value pairs) for this domain name.
|
|
8271
8271
|
|
|
8272
8272
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-domainname.html#cfn-appsync-domainname-tags
|
|
8273
8273
|
'''
|
|
@@ -13032,6 +13032,7 @@ class Code(metaclass=jsii.JSIIAbstractClass, jsii_type="aws-cdk-lib.aws_appsync.
|
|
|
13032
13032
|
path: builtins.str,
|
|
13033
13033
|
*,
|
|
13034
13034
|
deploy_time: typing.Optional[builtins.bool] = None,
|
|
13035
|
+
display_name: typing.Optional[builtins.str] = None,
|
|
13035
13036
|
readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
|
|
13036
13037
|
source_kms_key: typing.Optional[_IKey_5f11635f] = None,
|
|
13037
13038
|
asset_hash: typing.Optional[builtins.str] = None,
|
|
@@ -13045,6 +13046,7 @@ class Code(metaclass=jsii.JSIIAbstractClass, jsii_type="aws-cdk-lib.aws_appsync.
|
|
|
13045
13046
|
|
|
13046
13047
|
:param path: The path to the source code file.
|
|
13047
13048
|
:param deploy_time: Whether or not the asset needs to exist beyond deployment time; i.e. are copied over to a different location and not needed afterwards. Setting this property to true has an impact on the lifecycle of the asset, because we will assume that it is safe to delete after the CloudFormation deployment succeeds. For example, Lambda Function assets are copied over to Lambda during deployment. Therefore, it is not necessary to store the asset in S3, so we consider those deployTime assets. Default: false
|
|
13049
|
+
:param display_name: A display name for this asset. If supplied, the display name will be used in locations where the asset identifier is printed, like in the CLI progress information. If the same asset is added multiple times, the display name of the first occurrence is used. The default is the construct path of the Asset construct, with respect to the enclosing stack. If the asset is produced by a construct helper function (such as ``lambda.Code.fromAsset()``), this will look like ``MyFunction/Code``. We use the stack-relative construct path so that in the common case where you have multiple stacks with the same asset, we won't show something like ``/MyBetaStack/MyFunction/Code`` when you are actually deploying to production. Default: - Stack-relative construct path
|
|
13048
13050
|
:param readers: A list of principals that should be able to read this asset from S3. You can use ``asset.grantRead(principal)`` to grant read permissions later. Default: - No principals that can read file asset.
|
|
13049
13051
|
:param source_kms_key: The ARN of the KMS key used to encrypt the handler code. Default: - the default server-side encryption with Amazon S3 managed keys(SSE-S3) key will be used.
|
|
13050
13052
|
:param asset_hash: Specify a custom hash for this asset. If ``assetHashType`` is set it must be set to ``AssetHashType.CUSTOM``. For consistency, this custom hash will be SHA256 hashed and encoded as hex. The resulting hash will be the asset hash. NOTE: the hash is used in order to identify a specific revision of the asset, and used for optimizing and caching deployment activities related to this asset such as packaging, uploading to Amazon S3, etc. If you chose to customize the hash, you will need to make sure it is updated every time the asset changes, or otherwise it is possible that some deployments will not be invalidated. Default: - based on ``assetHashType``
|
|
@@ -13059,6 +13061,7 @@ class Code(metaclass=jsii.JSIIAbstractClass, jsii_type="aws-cdk-lib.aws_appsync.
|
|
|
13059
13061
|
check_type(argname="argument path", value=path, expected_type=type_hints["path"])
|
|
13060
13062
|
options = _AssetOptions_2aa69621(
|
|
13061
13063
|
deploy_time=deploy_time,
|
|
13064
|
+
display_name=display_name,
|
|
13062
13065
|
readers=readers,
|
|
13063
13066
|
source_kms_key=source_kms_key,
|
|
13064
13067
|
asset_hash=asset_hash,
|
|
@@ -19346,6 +19349,7 @@ class AssetCode(
|
|
|
19346
19349
|
working_directory="workingDirectory"
|
|
19347
19350
|
),
|
|
19348
19351
|
deploy_time=False,
|
|
19352
|
+
display_name="displayName",
|
|
19349
19353
|
exclude=["exclude"],
|
|
19350
19354
|
follow_symlinks=cdk.SymlinkFollowMode.NEVER,
|
|
19351
19355
|
ignore_mode=cdk.IgnoreMode.GLOB,
|
|
@@ -19359,6 +19363,7 @@ class AssetCode(
|
|
|
19359
19363
|
path: builtins.str,
|
|
19360
19364
|
*,
|
|
19361
19365
|
deploy_time: typing.Optional[builtins.bool] = None,
|
|
19366
|
+
display_name: typing.Optional[builtins.str] = None,
|
|
19362
19367
|
readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
|
|
19363
19368
|
source_kms_key: typing.Optional[_IKey_5f11635f] = None,
|
|
19364
19369
|
asset_hash: typing.Optional[builtins.str] = None,
|
|
@@ -19371,6 +19376,7 @@ class AssetCode(
|
|
|
19371
19376
|
'''
|
|
19372
19377
|
:param path: The path to the asset file.
|
|
19373
19378
|
:param deploy_time: Whether or not the asset needs to exist beyond deployment time; i.e. are copied over to a different location and not needed afterwards. Setting this property to true has an impact on the lifecycle of the asset, because we will assume that it is safe to delete after the CloudFormation deployment succeeds. For example, Lambda Function assets are copied over to Lambda during deployment. Therefore, it is not necessary to store the asset in S3, so we consider those deployTime assets. Default: false
|
|
19379
|
+
:param display_name: A display name for this asset. If supplied, the display name will be used in locations where the asset identifier is printed, like in the CLI progress information. If the same asset is added multiple times, the display name of the first occurrence is used. The default is the construct path of the Asset construct, with respect to the enclosing stack. If the asset is produced by a construct helper function (such as ``lambda.Code.fromAsset()``), this will look like ``MyFunction/Code``. We use the stack-relative construct path so that in the common case where you have multiple stacks with the same asset, we won't show something like ``/MyBetaStack/MyFunction/Code`` when you are actually deploying to production. Default: - Stack-relative construct path
|
|
19374
19380
|
:param readers: A list of principals that should be able to read this asset from S3. You can use ``asset.grantRead(principal)`` to grant read permissions later. Default: - No principals that can read file asset.
|
|
19375
19381
|
:param source_kms_key: The ARN of the KMS key used to encrypt the handler code. Default: - the default server-side encryption with Amazon S3 managed keys(SSE-S3) key will be used.
|
|
19376
19382
|
:param asset_hash: Specify a custom hash for this asset. If ``assetHashType`` is set it must be set to ``AssetHashType.CUSTOM``. For consistency, this custom hash will be SHA256 hashed and encoded as hex. The resulting hash will be the asset hash. NOTE: the hash is used in order to identify a specific revision of the asset, and used for optimizing and caching deployment activities related to this asset such as packaging, uploading to Amazon S3, etc. If you chose to customize the hash, you will need to make sure it is updated every time the asset changes, or otherwise it is possible that some deployments will not be invalidated. Default: - based on ``assetHashType``
|
|
@@ -19385,6 +19391,7 @@ class AssetCode(
|
|
|
19385
19391
|
check_type(argname="argument path", value=path, expected_type=type_hints["path"])
|
|
19386
19392
|
options = _AssetOptions_2aa69621(
|
|
19387
19393
|
deploy_time=deploy_time,
|
|
19394
|
+
display_name=display_name,
|
|
19388
19395
|
readers=readers,
|
|
19389
19396
|
source_kms_key=source_kms_key,
|
|
19390
19397
|
asset_hash=asset_hash,
|
|
@@ -24362,6 +24369,7 @@ def _typecheckingstub__8eafa9f4fd31cdfcc23e497d115c1733ce980674eb036dad379eb9102
|
|
|
24362
24369
|
path: builtins.str,
|
|
24363
24370
|
*,
|
|
24364
24371
|
deploy_time: typing.Optional[builtins.bool] = None,
|
|
24372
|
+
display_name: typing.Optional[builtins.str] = None,
|
|
24365
24373
|
readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
|
|
24366
24374
|
source_kms_key: typing.Optional[_IKey_5f11635f] = None,
|
|
24367
24375
|
asset_hash: typing.Optional[builtins.str] = None,
|
|
@@ -25182,6 +25190,7 @@ def _typecheckingstub__f64c3b5b60096d2f072c0237f4540425eb18b7539e311bcd346760100
|
|
|
25182
25190
|
path: builtins.str,
|
|
25183
25191
|
*,
|
|
25184
25192
|
deploy_time: typing.Optional[builtins.bool] = None,
|
|
25193
|
+
display_name: typing.Optional[builtins.str] = None,
|
|
25185
25194
|
readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
|
|
25186
25195
|
source_kms_key: typing.Optional[_IKey_5f11635f] = None,
|
|
25187
25196
|
asset_hash: typing.Optional[builtins.str] = None,
|
aws_cdk/aws_bedrock/__init__.py
CHANGED
|
@@ -7432,7 +7432,9 @@ class CfnDataSource(
|
|
|
7432
7432
|
def attr_data_source_configuration_web_configuration_crawler_configuration_user_agent_header(
|
|
7433
7433
|
self,
|
|
7434
7434
|
) -> builtins.str:
|
|
7435
|
-
'''
|
|
7435
|
+
'''A string used for identifying the crawler or bot when it accesses a web server.
|
|
7436
|
+
|
|
7437
|
+
The user agent header value consists of the ``bedrockbot`` , UUID, and a user agent suffix for your crawler (if one is provided). By default, it is set to ``bedrockbot_UUID`` . You can optionally append a custom suffix to ``bedrockbot_UUID`` to allowlist a specific user agent permitted to access your source URLs.
|
|
7436
7438
|
|
|
7437
7439
|
:cloudformationAttribute: DataSourceConfiguration.WebConfiguration.CrawlerConfiguration.UserAgentHeader
|
|
7438
7440
|
'''
|
|
@@ -7754,10 +7756,10 @@ class CfnDataSource(
|
|
|
7754
7756
|
enrichment_strategy_configuration: typing.Union[_IResolvable_da3f097b, typing.Union["CfnDataSource.EnrichmentStrategyConfigurationProperty", typing.Dict[builtins.str, typing.Any]]],
|
|
7755
7757
|
model_arn: builtins.str,
|
|
7756
7758
|
) -> None:
|
|
7757
|
-
'''
|
|
7759
|
+
'''Context enrichment configuration is used to provide additional context to the RAG application using Amazon Bedrock foundation models.
|
|
7758
7760
|
|
|
7759
|
-
:param enrichment_strategy_configuration:
|
|
7760
|
-
:param model_arn: The model
|
|
7761
|
+
:param enrichment_strategy_configuration: The enrichment stategy used to provide additional context. For example, Neptune GraphRAG uses Amazon Bedrock foundation models to perform chunk entity extraction.
|
|
7762
|
+
:param model_arn: The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.
|
|
7761
7763
|
|
|
7762
7764
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-bedrockfoundationmodelcontextenrichmentconfiguration.html
|
|
7763
7765
|
:exampleMetadata: fixture=_generated
|
|
@@ -7788,7 +7790,9 @@ class CfnDataSource(
|
|
|
7788
7790
|
def enrichment_strategy_configuration(
|
|
7789
7791
|
self,
|
|
7790
7792
|
) -> typing.Union[_IResolvable_da3f097b, "CfnDataSource.EnrichmentStrategyConfigurationProperty"]:
|
|
7791
|
-
'''
|
|
7793
|
+
'''The enrichment stategy used to provide additional context.
|
|
7794
|
+
|
|
7795
|
+
For example, Neptune GraphRAG uses Amazon Bedrock foundation models to perform chunk entity extraction.
|
|
7792
7796
|
|
|
7793
7797
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-bedrockfoundationmodelcontextenrichmentconfiguration.html#cfn-bedrock-datasource-bedrockfoundationmodelcontextenrichmentconfiguration-enrichmentstrategyconfiguration
|
|
7794
7798
|
'''
|
|
@@ -7798,7 +7802,7 @@ class CfnDataSource(
|
|
|
7798
7802
|
|
|
7799
7803
|
@builtins.property
|
|
7800
7804
|
def model_arn(self) -> builtins.str:
|
|
7801
|
-
'''The model
|
|
7805
|
+
'''The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.
|
|
7802
7806
|
|
|
7803
7807
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-bedrockfoundationmodelcontextenrichmentconfiguration.html#cfn-bedrock-datasource-bedrockfoundationmodelcontextenrichmentconfiguration-modelarn
|
|
7804
7808
|
'''
|
|
@@ -8257,10 +8261,10 @@ class CfnDataSource(
|
|
|
8257
8261
|
type: builtins.str,
|
|
8258
8262
|
bedrock_foundation_model_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDataSource.BedrockFoundationModelContextEnrichmentConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
8259
8263
|
) -> None:
|
|
8260
|
-
'''
|
|
8264
|
+
'''Context enrichment configuration is used to provide additional context to the RAG application.
|
|
8261
8265
|
|
|
8262
|
-
:param type:
|
|
8263
|
-
:param bedrock_foundation_model_configuration:
|
|
8266
|
+
:param type: The method used for context enrichment. It must be Amazon Bedrock foundation models.
|
|
8267
|
+
:param bedrock_foundation_model_configuration: The configuration of the Amazon Bedrock foundation model used for context enrichment.
|
|
8264
8268
|
|
|
8265
8269
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-contextenrichmentconfiguration.html
|
|
8266
8270
|
:exampleMetadata: fixture=_generated
|
|
@@ -8295,7 +8299,9 @@ class CfnDataSource(
|
|
|
8295
8299
|
|
|
8296
8300
|
@builtins.property
|
|
8297
8301
|
def type(self) -> builtins.str:
|
|
8298
|
-
'''
|
|
8302
|
+
'''The method used for context enrichment.
|
|
8303
|
+
|
|
8304
|
+
It must be Amazon Bedrock foundation models.
|
|
8299
8305
|
|
|
8300
8306
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-contextenrichmentconfiguration.html#cfn-bedrock-datasource-contextenrichmentconfiguration-type
|
|
8301
8307
|
'''
|
|
@@ -8307,7 +8313,7 @@ class CfnDataSource(
|
|
|
8307
8313
|
def bedrock_foundation_model_configuration(
|
|
8308
8314
|
self,
|
|
8309
8315
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataSource.BedrockFoundationModelContextEnrichmentConfigurationProperty"]]:
|
|
8310
|
-
'''
|
|
8316
|
+
'''The configuration of the Amazon Bedrock foundation model used for context enrichment.
|
|
8311
8317
|
|
|
8312
8318
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-contextenrichmentconfiguration.html#cfn-bedrock-datasource-contextenrichmentconfiguration-bedrockfoundationmodelconfiguration
|
|
8313
8319
|
'''
|
|
@@ -8783,9 +8789,9 @@ class CfnDataSource(
|
|
|
8783
8789
|
)
|
|
8784
8790
|
class EnrichmentStrategyConfigurationProperty:
|
|
8785
8791
|
def __init__(self, *, method: builtins.str) -> None:
|
|
8786
|
-
'''
|
|
8792
|
+
'''The strategy used for performing context enrichment.
|
|
8787
8793
|
|
|
8788
|
-
:param method:
|
|
8794
|
+
:param method: The method used for the context enrichment strategy.
|
|
8789
8795
|
|
|
8790
8796
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-enrichmentstrategyconfiguration.html
|
|
8791
8797
|
:exampleMetadata: fixture=_generated
|
|
@@ -8809,7 +8815,7 @@ class CfnDataSource(
|
|
|
8809
8815
|
|
|
8810
8816
|
@builtins.property
|
|
8811
8817
|
def method(self) -> builtins.str:
|
|
8812
|
-
'''
|
|
8818
|
+
'''The method used for the context enrichment strategy.
|
|
8813
8819
|
|
|
8814
8820
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-enrichmentstrategyconfiguration.html#cfn-bedrock-datasource-enrichmentstrategyconfiguration-method
|
|
8815
8821
|
'''
|
|
@@ -10645,7 +10651,7 @@ class CfnDataSource(
|
|
|
10645
10651
|
'''Contains details about how to ingest the documents in a data source.
|
|
10646
10652
|
|
|
10647
10653
|
:param chunking_configuration: Details about how to chunk the documents in the data source. A *chunk* refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
|
|
10648
|
-
:param context_enrichment_configuration:
|
|
10654
|
+
:param context_enrichment_configuration: The context enrichment configuration used for ingestion of the data into the vector store.
|
|
10649
10655
|
:param custom_transformation_configuration: A custom document transformer for parsed data source documents.
|
|
10650
10656
|
:param parsing_configuration: Configurations for a parser to use for parsing documents in your data source. If you exclude this field, the default parser will be used.
|
|
10651
10657
|
|
|
@@ -10757,7 +10763,7 @@ class CfnDataSource(
|
|
|
10757
10763
|
def context_enrichment_configuration(
|
|
10758
10764
|
self,
|
|
10759
10765
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataSource.ContextEnrichmentConfigurationProperty"]]:
|
|
10760
|
-
'''
|
|
10766
|
+
'''The context enrichment configuration used for ingestion of the data into the vector store.
|
|
10761
10767
|
|
|
10762
10768
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-vectoringestionconfiguration.html#cfn-bedrock-datasource-vectoringestionconfiguration-contextenrichmentconfiguration
|
|
10763
10769
|
'''
|
|
@@ -10830,8 +10836,8 @@ class CfnDataSource(
|
|
|
10830
10836
|
:param exclusion_filters: A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
|
|
10831
10837
|
:param inclusion_filters: A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
|
|
10832
10838
|
:param scope: The scope of what is crawled for your URLs. You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL "https://docs.aws.amazon.com/bedrock/latest/userguide/" and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain "aws.amazon.com" can also include sub domain "docs.aws.amazon.com".
|
|
10833
|
-
:param user_agent:
|
|
10834
|
-
:param user_agent_header: The
|
|
10839
|
+
:param user_agent: Returns the user agent suffix for your web crawler.
|
|
10840
|
+
:param user_agent_header: A string used for identifying the crawler or bot when it accesses a web server. The user agent header value consists of the ``bedrockbot`` , UUID, and a user agent suffix for your crawler (if one is provided). By default, it is set to ``bedrockbot_UUID`` . You can optionally append a custom suffix to ``bedrockbot_UUID`` to allowlist a specific user agent permitted to access your source URLs.
|
|
10835
10841
|
|
|
10836
10842
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-webcrawlerconfiguration.html
|
|
10837
10843
|
:exampleMetadata: fixture=_generated
|
|
@@ -10922,7 +10928,7 @@ class CfnDataSource(
|
|
|
10922
10928
|
|
|
10923
10929
|
@builtins.property
|
|
10924
10930
|
def user_agent(self) -> typing.Optional[builtins.str]:
|
|
10925
|
-
'''
|
|
10931
|
+
'''Returns the user agent suffix for your web crawler.
|
|
10926
10932
|
|
|
10927
10933
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-webcrawlerconfiguration.html#cfn-bedrock-datasource-webcrawlerconfiguration-useragent
|
|
10928
10934
|
'''
|
|
@@ -10931,7 +10937,9 @@ class CfnDataSource(
|
|
|
10931
10937
|
|
|
10932
10938
|
@builtins.property
|
|
10933
10939
|
def user_agent_header(self) -> typing.Optional[builtins.str]:
|
|
10934
|
-
'''
|
|
10940
|
+
'''A string used for identifying the crawler or bot when it accesses a web server.
|
|
10941
|
+
|
|
10942
|
+
The user agent header value consists of the ``bedrockbot`` , UUID, and a user agent suffix for your crawler (if one is provided). By default, it is set to ``bedrockbot_UUID`` . You can optionally append a custom suffix to ``bedrockbot_UUID`` to allowlist a specific user agent permitted to access your source URLs.
|
|
10935
10943
|
|
|
10936
10944
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-webcrawlerconfiguration.html#cfn-bedrock-datasource-webcrawlerconfiguration-useragentheader
|
|
10937
10945
|
'''
|
|
@@ -10965,7 +10973,7 @@ class CfnDataSource(
|
|
|
10965
10973
|
|
|
10966
10974
|
You should be authorized to crawl the URLs.
|
|
10967
10975
|
|
|
10968
|
-
:param max_pages:
|
|
10976
|
+
:param max_pages: The max number of web pages crawled from your source URLs, up to 25,000 pages. If the web pages exceed this limit, the data source sync will fail and no web pages will be ingested.
|
|
10969
10977
|
:param rate_limit: The max rate at which pages are crawled, up to 300 per minute per host.
|
|
10970
10978
|
|
|
10971
10979
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-webcrawlerlimits.html
|
|
@@ -10994,7 +11002,9 @@ class CfnDataSource(
|
|
|
10994
11002
|
|
|
10995
11003
|
@builtins.property
|
|
10996
11004
|
def max_pages(self) -> typing.Optional[jsii.Number]:
|
|
10997
|
-
'''
|
|
11005
|
+
'''The max number of web pages crawled from your source URLs, up to 25,000 pages.
|
|
11006
|
+
|
|
11007
|
+
If the web pages exceed this limit, the data source sync will fail and no web pages will be ingested.
|
|
10998
11008
|
|
|
10999
11009
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-webcrawlerlimits.html#cfn-bedrock-datasource-webcrawlerlimits-maxpages
|
|
11000
11010
|
'''
|
|
@@ -263,7 +263,7 @@ class CfnKeyspace(
|
|
|
263
263
|
|
|
264
264
|
For more information about multi-Region replication, see `Multi-Region replication <https://docs.aws.amazon.com/keyspaces/latest/devguide/multiRegion-replication.html>`_ in the *Amazon Keyspaces Developer Guide* .
|
|
265
265
|
|
|
266
|
-
:param region_list: Specifies the AWS Regions that the keyspace is replicated in. You must specify at least two
|
|
266
|
+
:param region_list: Specifies the AWS Regions that the keyspace is replicated in. You must specify at least two Regions, including the Region that the keyspace is being created in.
|
|
267
267
|
:param replication_strategy: The options are:. - ``SINGLE_REGION`` (optional) - ``MULTI_REGION`` If no value is specified, the default is ``SINGLE_REGION`` . If ``MULTI_REGION`` is specified, ``RegionList`` is required.
|
|
268
268
|
|
|
269
269
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-keyspace-replicationspecification.html
|
|
@@ -294,7 +294,7 @@ class CfnKeyspace(
|
|
|
294
294
|
def region_list(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
295
295
|
'''Specifies the AWS Regions that the keyspace is replicated in.
|
|
296
296
|
|
|
297
|
-
You must specify at least two
|
|
297
|
+
You must specify at least two Regions, including the Region that the keyspace is being created in.
|
|
298
298
|
|
|
299
299
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-keyspace-replicationspecification.html#cfn-cassandra-keyspace-replicationspecification-regionlist
|
|
300
300
|
'''
|
|
@@ -19123,6 +19123,7 @@ class ImportSource(
|
|
|
19123
19123
|
path: builtins.str,
|
|
19124
19124
|
*,
|
|
19125
19125
|
deploy_time: typing.Optional[builtins.bool] = None,
|
|
19126
|
+
display_name: typing.Optional[builtins.str] = None,
|
|
19126
19127
|
readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
|
|
19127
19128
|
source_kms_key: typing.Optional[_IKey_5f11635f] = None,
|
|
19128
19129
|
asset_hash: typing.Optional[builtins.str] = None,
|
|
@@ -19136,6 +19137,7 @@ class ImportSource(
|
|
|
19136
19137
|
|
|
19137
19138
|
:param path: the path to the local file.
|
|
19138
19139
|
:param deploy_time: Whether or not the asset needs to exist beyond deployment time; i.e. are copied over to a different location and not needed afterwards. Setting this property to true has an impact on the lifecycle of the asset, because we will assume that it is safe to delete after the CloudFormation deployment succeeds. For example, Lambda Function assets are copied over to Lambda during deployment. Therefore, it is not necessary to store the asset in S3, so we consider those deployTime assets. Default: false
|
|
19140
|
+
:param display_name: A display name for this asset. If supplied, the display name will be used in locations where the asset identifier is printed, like in the CLI progress information. If the same asset is added multiple times, the display name of the first occurrence is used. The default is the construct path of the Asset construct, with respect to the enclosing stack. If the asset is produced by a construct helper function (such as ``lambda.Code.fromAsset()``), this will look like ``MyFunction/Code``. We use the stack-relative construct path so that in the common case where you have multiple stacks with the same asset, we won't show something like ``/MyBetaStack/MyFunction/Code`` when you are actually deploying to production. Default: - Stack-relative construct path
|
|
19139
19141
|
:param readers: A list of principals that should be able to read this asset from S3. You can use ``asset.grantRead(principal)`` to grant read permissions later. Default: - No principals that can read file asset.
|
|
19140
19142
|
:param source_kms_key: The ARN of the KMS key used to encrypt the handler code. Default: - the default server-side encryption with Amazon S3 managed keys(SSE-S3) key will be used.
|
|
19141
19143
|
:param asset_hash: Specify a custom hash for this asset. If ``assetHashType`` is set it must be set to ``AssetHashType.CUSTOM``. For consistency, this custom hash will be SHA256 hashed and encoded as hex. The resulting hash will be the asset hash. NOTE: the hash is used in order to identify a specific revision of the asset, and used for optimizing and caching deployment activities related to this asset such as packaging, uploading to Amazon S3, etc. If you chose to customize the hash, you will need to make sure it is updated every time the asset changes, or otherwise it is possible that some deployments will not be invalidated. Default: - based on ``assetHashType``
|
|
@@ -19150,6 +19152,7 @@ class ImportSource(
|
|
|
19150
19152
|
check_type(argname="argument path", value=path, expected_type=type_hints["path"])
|
|
19151
19153
|
options = _AssetOptions_2aa69621(
|
|
19152
19154
|
deploy_time=deploy_time,
|
|
19155
|
+
display_name=display_name,
|
|
19153
19156
|
readers=readers,
|
|
19154
19157
|
source_kms_key=source_kms_key,
|
|
19155
19158
|
asset_hash=asset_hash,
|
|
@@ -19253,6 +19256,7 @@ class InlineImportSource(
|
|
|
19253
19256
|
working_directory="workingDirectory"
|
|
19254
19257
|
),
|
|
19255
19258
|
deploy_time=False,
|
|
19259
|
+
display_name="displayName",
|
|
19256
19260
|
exclude=["exclude"],
|
|
19257
19261
|
follow_symlinks=cdk.SymlinkFollowMode.NEVER,
|
|
19258
19262
|
ignore_mode=cdk.IgnoreMode.GLOB,
|
|
@@ -23513,6 +23517,7 @@ class S3ImportSource(
|
|
|
23513
23517
|
working_directory="workingDirectory"
|
|
23514
23518
|
),
|
|
23515
23519
|
deploy_time=False,
|
|
23520
|
+
display_name="displayName",
|
|
23516
23521
|
exclude=["exclude"],
|
|
23517
23522
|
follow_symlinks=cdk.SymlinkFollowMode.NEVER,
|
|
23518
23523
|
ignore_mode=cdk.IgnoreMode.GLOB,
|
|
@@ -25226,6 +25231,7 @@ class AssetImportSource(
|
|
|
25226
25231
|
working_directory="workingDirectory"
|
|
25227
25232
|
),
|
|
25228
25233
|
deploy_time=False,
|
|
25234
|
+
display_name="displayName",
|
|
25229
25235
|
exclude=["exclude"],
|
|
25230
25236
|
follow_symlinks=cdk.SymlinkFollowMode.NEVER,
|
|
25231
25237
|
ignore_mode=cdk.IgnoreMode.GLOB,
|
|
@@ -25239,6 +25245,7 @@ class AssetImportSource(
|
|
|
25239
25245
|
path: builtins.str,
|
|
25240
25246
|
*,
|
|
25241
25247
|
deploy_time: typing.Optional[builtins.bool] = None,
|
|
25248
|
+
display_name: typing.Optional[builtins.str] = None,
|
|
25242
25249
|
readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
|
|
25243
25250
|
source_kms_key: typing.Optional[_IKey_5f11635f] = None,
|
|
25244
25251
|
asset_hash: typing.Optional[builtins.str] = None,
|
|
@@ -25251,6 +25258,7 @@ class AssetImportSource(
|
|
|
25251
25258
|
'''
|
|
25252
25259
|
:param path: the path to the local file.
|
|
25253
25260
|
:param deploy_time: Whether or not the asset needs to exist beyond deployment time; i.e. are copied over to a different location and not needed afterwards. Setting this property to true has an impact on the lifecycle of the asset, because we will assume that it is safe to delete after the CloudFormation deployment succeeds. For example, Lambda Function assets are copied over to Lambda during deployment. Therefore, it is not necessary to store the asset in S3, so we consider those deployTime assets. Default: false
|
|
25261
|
+
:param display_name: A display name for this asset. If supplied, the display name will be used in locations where the asset identifier is printed, like in the CLI progress information. If the same asset is added multiple times, the display name of the first occurrence is used. The default is the construct path of the Asset construct, with respect to the enclosing stack. If the asset is produced by a construct helper function (such as ``lambda.Code.fromAsset()``), this will look like ``MyFunction/Code``. We use the stack-relative construct path so that in the common case where you have multiple stacks with the same asset, we won't show something like ``/MyBetaStack/MyFunction/Code`` when you are actually deploying to production. Default: - Stack-relative construct path
|
|
25254
25262
|
:param readers: A list of principals that should be able to read this asset from S3. You can use ``asset.grantRead(principal)`` to grant read permissions later. Default: - No principals that can read file asset.
|
|
25255
25263
|
:param source_kms_key: The ARN of the KMS key used to encrypt the handler code. Default: - the default server-side encryption with Amazon S3 managed keys(SSE-S3) key will be used.
|
|
25256
25264
|
:param asset_hash: Specify a custom hash for this asset. If ``assetHashType`` is set it must be set to ``AssetHashType.CUSTOM``. For consistency, this custom hash will be SHA256 hashed and encoded as hex. The resulting hash will be the asset hash. NOTE: the hash is used in order to identify a specific revision of the asset, and used for optimizing and caching deployment activities related to this asset such as packaging, uploading to Amazon S3, etc. If you chose to customize the hash, you will need to make sure it is updated every time the asset changes, or otherwise it is possible that some deployments will not be invalidated. Default: - based on ``assetHashType``
|
|
@@ -25265,6 +25273,7 @@ class AssetImportSource(
|
|
|
25265
25273
|
check_type(argname="argument path", value=path, expected_type=type_hints["path"])
|
|
25266
25274
|
options = _AssetOptions_2aa69621(
|
|
25267
25275
|
deploy_time=deploy_time,
|
|
25276
|
+
display_name=display_name,
|
|
25268
25277
|
readers=readers,
|
|
25269
25278
|
source_kms_key=source_kms_key,
|
|
25270
25279
|
asset_hash=asset_hash,
|
|
@@ -28824,6 +28833,7 @@ def _typecheckingstub__f5d4750ca4d7703f815ca46be8b91e46ea0b813f42846026dff63e00f
|
|
|
28824
28833
|
path: builtins.str,
|
|
28825
28834
|
*,
|
|
28826
28835
|
deploy_time: typing.Optional[builtins.bool] = None,
|
|
28836
|
+
display_name: typing.Optional[builtins.str] = None,
|
|
28827
28837
|
readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
|
|
28828
28838
|
source_kms_key: typing.Optional[_IKey_5f11635f] = None,
|
|
28829
28839
|
asset_hash: typing.Optional[builtins.str] = None,
|
|
@@ -29496,6 +29506,7 @@ def _typecheckingstub__62441d3d3228ae5fb69aaca12e603944f07f9335dae80f70ce3b04e8e
|
|
|
29496
29506
|
path: builtins.str,
|
|
29497
29507
|
*,
|
|
29498
29508
|
deploy_time: typing.Optional[builtins.bool] = None,
|
|
29509
|
+
display_name: typing.Optional[builtins.str] = None,
|
|
29499
29510
|
readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
|
|
29500
29511
|
source_kms_key: typing.Optional[_IKey_5f11635f] = None,
|
|
29501
29512
|
asset_hash: typing.Optional[builtins.str] = None,
|
|
@@ -1980,7 +1980,7 @@ class CfnEventDataStore(
|
|
|
1980
1980
|
) -> None:
|
|
1981
1981
|
'''A single selector statement in an advanced event selector.
|
|
1982
1982
|
|
|
1983
|
-
:param field: A field in a CloudTrail event record on which to filter events to be logged. For event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS , the field is used only for selecting events as filtering is not supported. For CloudTrail management events, supported fields include ``eventCategory`` (required), ``eventSource`` , and ``readOnly`` . The following additional fields are available for event data stores: ``eventName`` , ``eventType`` , ``sessionCredentialFromConsole`` , and ``userIdentity.arn`` . For CloudTrail data events, supported fields include ``eventCategory`` (required), ``resources.type`` (required), ``eventName`` , ``readOnly`` , and ``resources.ARN`` . The following additional fields are available for event data stores: ``eventSource`` , ``eventType`` , ``sessionCredentialFromConsole`` , and ``userIdentity.arn`` . For CloudTrail network activity events, supported fields include ``eventCategory`` (required), ``eventSource`` (required), ``eventName`` , ``errorCode`` , and ``vpcEndpointId`` . For event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS , the only supported field is ``eventCategory`` . .. epigraph:: Selectors don't support the use of wildcards like ``*`` . To match multiple values with a single condition, you may use ``StartsWith`` , ``EndsWith`` , ``NotStartsWith`` , or ``NotEndsWith`` to explicitly match the beginning or end of the event field. - *``readOnly``* - This is an optional field that is only used for management events and data events. This field can be set to ``Equals`` with a value of ``true`` or ``false`` . If you do not add this field, CloudTrail logs both ``read`` and ``write`` events. A value of ``true`` logs only ``read`` events. A value of ``false`` logs only ``write`` events. - *``eventSource``* - This field is only used for management events, data events (for event data stores only), and network activity events. For management events for trails, this is an optional field that can be set to ``NotEquals`` ``kms.amazonaws.com`` to exclude KMS management events, or ``NotEquals`` ``rdsdata.amazonaws.com`` to exclude RDS management events. For management and data events for event data stores, you can use it to include or exclude any event source and can use any operator. For network activity events, this is a required field that only uses the ``Equals`` operator. Set this field to the event source for which you want to log network activity events. If you want to log network activity events for multiple event sources, you must create a separate field selector for each event source.
|
|
1983
|
+
:param field: A field in a CloudTrail event record on which to filter events to be logged. For event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS , the field is used only for selecting events as filtering is not supported. For CloudTrail management events, supported fields include ``eventCategory`` (required), ``eventSource`` , and ``readOnly`` . The following additional fields are available for event data stores: ``eventName`` , ``eventType`` , ``sessionCredentialFromConsole`` , and ``userIdentity.arn`` . For CloudTrail data events, supported fields include ``eventCategory`` (required), ``resources.type`` (required), ``eventName`` , ``readOnly`` , and ``resources.ARN`` . The following additional fields are available for event data stores: ``eventSource`` , ``eventType`` , ``sessionCredentialFromConsole`` , and ``userIdentity.arn`` . For CloudTrail network activity events, supported fields include ``eventCategory`` (required), ``eventSource`` (required), ``eventName`` , ``errorCode`` , and ``vpcEndpointId`` . For event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS , the only supported field is ``eventCategory`` . .. epigraph:: Selectors don't support the use of wildcards like ``*`` . To match multiple values with a single condition, you may use ``StartsWith`` , ``EndsWith`` , ``NotStartsWith`` , or ``NotEndsWith`` to explicitly match the beginning or end of the event field. - *``readOnly``* - This is an optional field that is only used for management events and data events. This field can be set to ``Equals`` with a value of ``true`` or ``false`` . If you do not add this field, CloudTrail logs both ``read`` and ``write`` events. A value of ``true`` logs only ``read`` events. A value of ``false`` logs only ``write`` events. - *``eventSource``* - This field is only used for management events, data events (for event data stores only), and network activity events. For management events for trails, this is an optional field that can be set to ``NotEquals`` ``kms.amazonaws.com`` to exclude KMS management events, or ``NotEquals`` ``rdsdata.amazonaws.com`` to exclude RDS management events. For management and data events for event data stores, you can use it to include or exclude any event source and can use any operator. For network activity events, this is a required field that only uses the ``Equals`` operator. Set this field to the event source for which you want to log network activity events. If you want to log network activity events for multiple event sources, you must create a separate field selector for each event source. For a list of services supporting network activity events, see `Logging network activity events <https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-network-events-with-cloudtrail.html>`_ in the *AWS CloudTrail User Guide* . - *``eventName``* - This is an optional field that is only used for data events, management events (for event data stores only), and network activity events. You can use any operator with ``eventName`` . You can use it to filter in or filter out specific events. You can have multiple values for this field, separated by commas. - *``eventCategory``* - This field is required and must be set to ``Equals`` . - For CloudTrail management events, the value must be ``Management`` . - For CloudTrail data events, the value must be ``Data`` . - For CloudTrail network activity events, the value must be ``NetworkActivity`` . The following are used only for event data stores: - For CloudTrail Insights events, the value must be ``Insight`` . - For AWS Config configuration items, the value must be ``ConfigurationItem`` . - For Audit Manager evidence, the value must be ``Evidence`` . - For events outside of AWS , the value must be ``ActivityAuditLog`` . - *``eventType``* - This is an optional field available only for event data stores, which is used to filter management and data events on the event type. For information about available event types, see `CloudTrail record contents <https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-event-reference-record-contents.html#ct-event-type>`_ in the *AWS CloudTrail user guide* . - *``errorCode``* - This field is only used to filter CloudTrail network activity events and is optional. This is the error code to filter on. Currently, the only valid ``errorCode`` is ``VpceAccessDenied`` . ``errorCode`` can only use the ``Equals`` operator. - *``sessionCredentialFromConsole``* - This is an optional field available only for event data stores, which is used to filter management and data events based on whether the events originated from an AWS Management Console session. ``sessionCredentialFromConsole`` can only use the ``Equals`` and ``NotEquals`` operators. - *``resources.type``* - This field is required for CloudTrail data events. ``resources.type`` can only use the ``Equals`` operator. For a list of available resource types for data events, see `Data events <https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#logging-data-events>`_ in the *AWS CloudTrail User Guide* . You can have only one ``resources.type`` field per selector. To log events on more than one resource type, add another selector. - *``resources.ARN``* - The ``resources.ARN`` is an optional field for data events. You can use any operator with ``resources.ARN`` , but if you use ``Equals`` or ``NotEquals`` , the value must exactly match the ARN of a valid resource of the type you've specified in the template as the value of resources.type. To log all data events for all objects in a specific S3 bucket, use the ``StartsWith`` operator, and include only the bucket ARN as the matching value. For more information about the ARN formats of data event resources, see `Actions, resources, and condition keys for AWS services <https://docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html>`_ in the *Service Authorization Reference* . .. epigraph:: You can't use the ``resources.ARN`` field to filter resource types that do not have ARNs. - *``userIdentity.arn``* - This is an optional field available only for event data stores, which is used to filter management and data events on the userIdentity ARN. You can use any operator with ``userIdentity.arn`` . For more information on the userIdentity element, see `CloudTrail userIdentity element <https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-event-reference-user-identity.html>`_ in the *AWS CloudTrail User Guide* . - *``vpcEndpointId``* - This field is only used to filter CloudTrail network activity events and is optional. This field identifies the VPC endpoint that the request passed through. You can use any operator with ``vpcEndpointId`` .
|
|
1984
1984
|
:param ends_with: An operator that includes events that match the last few characters of the event record field specified as the value of ``Field`` .
|
|
1985
1985
|
:param equal_to: An operator that includes events that match the exact value of the event record field specified as the value of ``Field`` . This is the only valid operator that you can use with the ``readOnly`` , ``eventCategory`` , and ``resources.type`` fields.
|
|
1986
1986
|
:param not_ends_with: An operator that excludes events that match the last few characters of the event record field specified as the value of ``Field`` .
|
|
@@ -2058,15 +2058,8 @@ class CfnEventDataStore(
|
|
|
2058
2058
|
|
|
2059
2059
|
For management and data events for event data stores, you can use it to include or exclude any event source and can use any operator.
|
|
2060
2060
|
|
|
2061
|
-
For network activity events, this is a required field that only uses the ``Equals`` operator. Set this field to the event source for which you want to log network activity events. If you want to log network activity events for multiple event sources, you must create a separate field selector for each event source.
|
|
2061
|
+
For network activity events, this is a required field that only uses the ``Equals`` operator. Set this field to the event source for which you want to log network activity events. If you want to log network activity events for multiple event sources, you must create a separate field selector for each event source. For a list of services supporting network activity events, see `Logging network activity events <https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-network-events-with-cloudtrail.html>`_ in the *AWS CloudTrail User Guide* .
|
|
2062
2062
|
|
|
2063
|
-
The following are valid values for network activity events:
|
|
2064
|
-
|
|
2065
|
-
- ``cloudtrail.amazonaws.com``
|
|
2066
|
-
- ``ec2.amazonaws.com``
|
|
2067
|
-
- ``kms.amazonaws.com``
|
|
2068
|
-
- ``s3.amazonaws.com``
|
|
2069
|
-
- ``secretsmanager.amazonaws.com``
|
|
2070
2063
|
- *``eventName``* - This is an optional field that is only used for data events, management events (for event data stores only), and network activity events. You can use any operator with ``eventName`` . You can use it to filter in or filter out specific events. You can have multiple values for this field, separated by commas.
|
|
2071
2064
|
- *``eventCategory``* - This field is required and must be set to ``Equals`` .
|
|
2072
2065
|
- For CloudTrail management events, the value must be ``Management`` .
|
|
@@ -3386,7 +3379,7 @@ class CfnTrail(
|
|
|
3386
3379
|
) -> None:
|
|
3387
3380
|
'''A single selector statement in an advanced event selector.
|
|
3388
3381
|
|
|
3389
|
-
:param field: A field in a CloudTrail event record on which to filter events to be logged. For event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS , the field is used only for selecting events as filtering is not supported. For CloudTrail management events, supported fields include ``eventCategory`` (required), ``eventSource`` , and ``readOnly`` . The following additional fields are available for event data stores: ``eventName`` , ``eventType`` , ``sessionCredentialFromConsole`` , and ``userIdentity.arn`` . For CloudTrail data events, supported fields include ``eventCategory`` (required), ``resources.type`` (required), ``eventName`` , ``readOnly`` , and ``resources.ARN`` . The following additional fields are available for event data stores: ``eventSource`` , ``eventType`` , ``sessionCredentialFromConsole`` , and ``userIdentity.arn`` . For CloudTrail network activity events, supported fields include ``eventCategory`` (required), ``eventSource`` (required), ``eventName`` , ``errorCode`` , and ``vpcEndpointId`` . For event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS , the only supported field is ``eventCategory`` . .. epigraph:: Selectors don't support the use of wildcards like ``*`` . To match multiple values with a single condition, you may use ``StartsWith`` , ``EndsWith`` , ``NotStartsWith`` , or ``NotEndsWith`` to explicitly match the beginning or end of the event field. - *``readOnly``* - This is an optional field that is only used for management events and data events. This field can be set to ``Equals`` with a value of ``true`` or ``false`` . If you do not add this field, CloudTrail logs both ``read`` and ``write`` events. A value of ``true`` logs only ``read`` events. A value of ``false`` logs only ``write`` events. - *``eventSource``* - This field is only used for management events, data events (for event data stores only), and network activity events. For management events for trails, this is an optional field that can be set to ``NotEquals`` ``kms.amazonaws.com`` to exclude KMS management events, or ``NotEquals`` ``rdsdata.amazonaws.com`` to exclude RDS management events. For management and data events for event data stores, you can use it to include or exclude any event source and can use any operator. For network activity events, this is a required field that only uses the ``Equals`` operator. Set this field to the event source for which you want to log network activity events. If you want to log network activity events for multiple event sources, you must create a separate field selector for each event source.
|
|
3382
|
+
:param field: A field in a CloudTrail event record on which to filter events to be logged. For event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS , the field is used only for selecting events as filtering is not supported. For CloudTrail management events, supported fields include ``eventCategory`` (required), ``eventSource`` , and ``readOnly`` . The following additional fields are available for event data stores: ``eventName`` , ``eventType`` , ``sessionCredentialFromConsole`` , and ``userIdentity.arn`` . For CloudTrail data events, supported fields include ``eventCategory`` (required), ``resources.type`` (required), ``eventName`` , ``readOnly`` , and ``resources.ARN`` . The following additional fields are available for event data stores: ``eventSource`` , ``eventType`` , ``sessionCredentialFromConsole`` , and ``userIdentity.arn`` . For CloudTrail network activity events, supported fields include ``eventCategory`` (required), ``eventSource`` (required), ``eventName`` , ``errorCode`` , and ``vpcEndpointId`` . For event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS , the only supported field is ``eventCategory`` . .. epigraph:: Selectors don't support the use of wildcards like ``*`` . To match multiple values with a single condition, you may use ``StartsWith`` , ``EndsWith`` , ``NotStartsWith`` , or ``NotEndsWith`` to explicitly match the beginning or end of the event field. - *``readOnly``* - This is an optional field that is only used for management events and data events. This field can be set to ``Equals`` with a value of ``true`` or ``false`` . If you do not add this field, CloudTrail logs both ``read`` and ``write`` events. A value of ``true`` logs only ``read`` events. A value of ``false`` logs only ``write`` events. - *``eventSource``* - This field is only used for management events, data events (for event data stores only), and network activity events. For management events for trails, this is an optional field that can be set to ``NotEquals`` ``kms.amazonaws.com`` to exclude KMS management events, or ``NotEquals`` ``rdsdata.amazonaws.com`` to exclude RDS management events. For management and data events for event data stores, you can use it to include or exclude any event source and can use any operator. For network activity events, this is a required field that only uses the ``Equals`` operator. Set this field to the event source for which you want to log network activity events. If you want to log network activity events for multiple event sources, you must create a separate field selector for each event source. For a list of services supporting network activity events, see `Logging network activity events <https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-network-events-with-cloudtrail.html>`_ in the *AWS CloudTrail User Guide* . - *``eventName``* - This is an optional field that is only used for data events, management events (for event data stores only), and network activity events. You can use any operator with ``eventName`` . You can use it to filter in or filter out specific events. You can have multiple values for this field, separated by commas. - *``eventCategory``* - This field is required and must be set to ``Equals`` . - For CloudTrail management events, the value must be ``Management`` . - For CloudTrail data events, the value must be ``Data`` . - For CloudTrail network activity events, the value must be ``NetworkActivity`` . The following are used only for event data stores: - For CloudTrail Insights events, the value must be ``Insight`` . - For AWS Config configuration items, the value must be ``ConfigurationItem`` . - For Audit Manager evidence, the value must be ``Evidence`` . - For events outside of AWS , the value must be ``ActivityAuditLog`` . - *``eventType``* - This is an optional field available only for event data stores, which is used to filter management and data events on the event type. For information about available event types, see `CloudTrail record contents <https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-event-reference-record-contents.html#ct-event-type>`_ in the *AWS CloudTrail user guide* . - *``errorCode``* - This field is only used to filter CloudTrail network activity events and is optional. This is the error code to filter on. Currently, the only valid ``errorCode`` is ``VpceAccessDenied`` . ``errorCode`` can only use the ``Equals`` operator. - *``sessionCredentialFromConsole``* - This is an optional field available only for event data stores, which is used to filter management and data events based on whether the events originated from an AWS Management Console session. ``sessionCredentialFromConsole`` can only use the ``Equals`` and ``NotEquals`` operators. - *``resources.type``* - This field is required for CloudTrail data events. ``resources.type`` can only use the ``Equals`` operator. For a list of available resource types for data events, see `Data events <https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#logging-data-events>`_ in the *AWS CloudTrail User Guide* . You can have only one ``resources.type`` field per selector. To log events on more than one resource type, add another selector. - *``resources.ARN``* - The ``resources.ARN`` is an optional field for data events. You can use any operator with ``resources.ARN`` , but if you use ``Equals`` or ``NotEquals`` , the value must exactly match the ARN of a valid resource of the type you've specified in the template as the value of resources.type. To log all data events for all objects in a specific S3 bucket, use the ``StartsWith`` operator, and include only the bucket ARN as the matching value. For more information about the ARN formats of data event resources, see `Actions, resources, and condition keys for AWS services <https://docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html>`_ in the *Service Authorization Reference* . .. epigraph:: You can't use the ``resources.ARN`` field to filter resource types that do not have ARNs. - *``userIdentity.arn``* - This is an optional field available only for event data stores, which is used to filter management and data events on the userIdentity ARN. You can use any operator with ``userIdentity.arn`` . For more information on the userIdentity element, see `CloudTrail userIdentity element <https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-event-reference-user-identity.html>`_ in the *AWS CloudTrail User Guide* . - *``vpcEndpointId``* - This field is only used to filter CloudTrail network activity events and is optional. This field identifies the VPC endpoint that the request passed through. You can use any operator with ``vpcEndpointId`` .
|
|
3390
3383
|
:param ends_with: An operator that includes events that match the last few characters of the event record field specified as the value of ``Field`` .
|
|
3391
3384
|
:param equal_to: An operator that includes events that match the exact value of the event record field specified as the value of ``Field`` . This is the only valid operator that you can use with the ``readOnly`` , ``eventCategory`` , and ``resources.type`` fields.
|
|
3392
3385
|
:param not_ends_with: An operator that excludes events that match the last few characters of the event record field specified as the value of ``Field`` .
|
|
@@ -3464,15 +3457,8 @@ class CfnTrail(
|
|
|
3464
3457
|
|
|
3465
3458
|
For management and data events for event data stores, you can use it to include or exclude any event source and can use any operator.
|
|
3466
3459
|
|
|
3467
|
-
For network activity events, this is a required field that only uses the ``Equals`` operator. Set this field to the event source for which you want to log network activity events. If you want to log network activity events for multiple event sources, you must create a separate field selector for each event source.
|
|
3468
|
-
|
|
3469
|
-
The following are valid values for network activity events:
|
|
3460
|
+
For network activity events, this is a required field that only uses the ``Equals`` operator. Set this field to the event source for which you want to log network activity events. If you want to log network activity events for multiple event sources, you must create a separate field selector for each event source. For a list of services supporting network activity events, see `Logging network activity events <https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-network-events-with-cloudtrail.html>`_ in the *AWS CloudTrail User Guide* .
|
|
3470
3461
|
|
|
3471
|
-
- ``cloudtrail.amazonaws.com``
|
|
3472
|
-
- ``ec2.amazonaws.com``
|
|
3473
|
-
- ``kms.amazonaws.com``
|
|
3474
|
-
- ``s3.amazonaws.com``
|
|
3475
|
-
- ``secretsmanager.amazonaws.com``
|
|
3476
3462
|
- *``eventName``* - This is an optional field that is only used for data events, management events (for event data stores only), and network activity events. You can use any operator with ``eventName`` . You can use it to filter in or filter out specific events. You can have multiple values for this field, separated by commas.
|
|
3477
3463
|
- *``eventCategory``* - This field is required and must be set to ``Equals`` .
|
|
3478
3464
|
- For CloudTrail management events, the value must be ``Management`` .
|