aws-cdk-lib 2.178.2__py3-none-any.whl → 2.179.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 (34) hide show
  1. aws_cdk/__init__.py +69 -35
  2. aws_cdk/_jsii/__init__.py +1 -2
  3. aws_cdk/_jsii/{aws-cdk-lib@2.178.2.jsii.tgz → aws-cdk-lib@2.179.0.jsii.tgz} +0 -0
  4. aws_cdk/aws_apigateway/__init__.py +170 -29
  5. aws_cdk/aws_apigatewayv2/__init__.py +151 -32
  6. aws_cdk/aws_apigatewayv2_integrations/__init__.py +348 -0
  7. aws_cdk/aws_applicationautoscaling/__init__.py +8 -8
  8. aws_cdk/aws_appsync/__init__.py +6 -4
  9. aws_cdk/aws_cloudfront/__init__.py +5 -5
  10. aws_cdk/aws_codebuild/__init__.py +216 -0
  11. aws_cdk/aws_codepipeline/__init__.py +89 -28
  12. aws_cdk/aws_codepipeline_actions/__init__.py +526 -62
  13. aws_cdk/aws_cognito/__init__.py +676 -20
  14. aws_cdk/aws_ec2/__init__.py +25 -9
  15. aws_cdk/aws_ecs/__init__.py +8 -8
  16. aws_cdk/aws_eks/__init__.py +555 -179
  17. aws_cdk/aws_elasticloadbalancingv2/__init__.py +99 -0
  18. aws_cdk/aws_events/__init__.py +9 -15
  19. aws_cdk/aws_events_targets/__init__.py +303 -16
  20. aws_cdk/aws_iam/__init__.py +3 -3
  21. aws_cdk/aws_ivs/__init__.py +241 -73
  22. aws_cdk/aws_logs/__init__.py +62 -13
  23. aws_cdk/aws_pinpoint/__init__.py +14 -9
  24. aws_cdk/aws_rds/__init__.py +168 -24
  25. aws_cdk/aws_s3/__init__.py +9 -9
  26. aws_cdk/aws_stepfunctions_tasks/__init__.py +127 -21
  27. aws_cdk/pipelines/__init__.py +2 -2
  28. {aws_cdk_lib-2.178.2.dist-info → aws_cdk_lib-2.179.0.dist-info}/METADATA +1 -2
  29. {aws_cdk_lib-2.178.2.dist-info → aws_cdk_lib-2.179.0.dist-info}/RECORD +33 -34
  30. aws_cdk/lambda_layer_kubectl/__init__.py +0 -107
  31. {aws_cdk_lib-2.178.2.dist-info → aws_cdk_lib-2.179.0.dist-info}/LICENSE +0 -0
  32. {aws_cdk_lib-2.178.2.dist-info → aws_cdk_lib-2.179.0.dist-info}/NOTICE +0 -0
  33. {aws_cdk_lib-2.178.2.dist-info → aws_cdk_lib-2.179.0.dist-info}/WHEEL +0 -0
  34. {aws_cdk_lib-2.178.2.dist-info → aws_cdk_lib-2.179.0.dist-info}/top_level.txt +0 -0
@@ -487,6 +487,28 @@ web_socket_api = apigwv2.WebSocketApi(self, "mywsapi",
487
487
  api_key_selection_expression=apigwv2.WebSocketApiKeySelectionExpression.HEADER_X_API_KEY
488
488
  )
489
489
  ```
490
+
491
+ ## Common Config
492
+
493
+ Common config for both HTTP API and WebSocket API
494
+
495
+ ### Route Settings
496
+
497
+ Represents a collection of route settings.
498
+
499
+ ```python
500
+ # api: apigwv2.HttpApi
501
+
502
+
503
+ apigwv2.HttpStage(self, "Stage",
504
+ http_api=api,
505
+ throttle=apigwv2.ThrottleSettings(
506
+ rate_limit=1000,
507
+ burst_limit=1000
508
+ ),
509
+ detailed_metrics_enabled=True
510
+ )
511
+ ```
490
512
  '''
491
513
  from pkgutil import extend_path
492
514
  __path__ = extend_path(__path__, __name__)
@@ -9807,25 +9829,36 @@ class HttpMethod(enum.Enum):
9807
9829
 
9808
9830
  Example::
9809
9831
 
9810
- from aws_cdk.aws_apigatewayv2_integrations import HttpUrlIntegration, HttpLambdaIntegration
9811
-
9812
- # book_store_default_fn: lambda.Function
9813
-
9832
+ from aws_cdk.aws_apigatewayv2_integrations import WebSocketAwsIntegration
9833
+ import aws_cdk.aws_dynamodb as dynamodb
9834
+ import aws_cdk.aws_iam as iam
9814
9835
 
9815
- get_books_integration = HttpUrlIntegration("GetBooksIntegration", "https://get-books-proxy.example.com")
9816
- book_store_default_integration = HttpLambdaIntegration("BooksIntegration", book_store_default_fn)
9836
+ # api_role: iam.Role
9837
+ # table: dynamodb.Table
9817
9838
 
9818
- http_api = apigwv2.HttpApi(self, "HttpApi")
9819
9839
 
9820
- http_api.add_routes(
9821
- path="/books",
9822
- methods=[apigwv2.HttpMethod.GET],
9823
- integration=get_books_integration
9840
+ web_socket_api = apigwv2.WebSocketApi(self, "mywsapi")
9841
+ apigwv2.WebSocketStage(self, "mystage",
9842
+ web_socket_api=web_socket_api,
9843
+ stage_name="dev",
9844
+ auto_deploy=True
9824
9845
  )
9825
- http_api.add_routes(
9826
- path="/books",
9827
- methods=[apigwv2.HttpMethod.ANY],
9828
- integration=book_store_default_integration
9846
+ web_socket_api.add_route("$connect",
9847
+ integration=WebSocketAwsIntegration("DynamodbPutItem",
9848
+ integration_uri=f"arn:aws:apigateway:{this.region}:dynamodb:action/PutItem",
9849
+ integration_method=apigwv2.HttpMethod.POST,
9850
+ credentials_role=api_role,
9851
+ request_templates={
9852
+ "application/json": JSON.stringify({
9853
+ "TableName": table.table_name,
9854
+ "Item": {
9855
+ "id": {
9856
+ "S": "$context.requestId"
9857
+ }
9858
+ }
9859
+ })
9860
+ }
9861
+ )
9829
9862
  )
9830
9863
  '''
9831
9864
 
@@ -10023,19 +10056,25 @@ class HttpRouteIntegration(
10023
10056
 
10024
10057
  Example::
10025
10058
 
10026
- from aws_cdk.aws_apigatewayv2_integrations import HttpAlbIntegration
10059
+ from aws_cdk.aws_apigatewayv2_integrations import HttpUrlIntegration, HttpLambdaIntegration
10027
10060
 
10028
- # lb: elbv2.ApplicationLoadBalancer
10061
+ # book_store_default_fn: lambda.Function
10029
10062
 
10030
- listener = lb.add_listener("listener", port=80)
10031
- listener.add_targets("target",
10032
- port=80
10033
- )
10034
10063
 
10035
- http_endpoint = apigwv2.HttpApi(self, "HttpProxyPrivateApi",
10036
- default_integration=HttpAlbIntegration("DefaultIntegration", listener,
10037
- parameter_mapping=apigwv2.ParameterMapping().custom("myKey", "myValue")
10038
- )
10064
+ get_books_integration = HttpUrlIntegration("GetBooksIntegration", "https://get-books-proxy.example.com")
10065
+ book_store_default_integration = HttpLambdaIntegration("BooksIntegration", book_store_default_fn)
10066
+
10067
+ http_api = apigwv2.HttpApi(self, "HttpApi")
10068
+
10069
+ http_api.add_routes(
10070
+ path="/books",
10071
+ methods=[apigwv2.HttpMethod.GET],
10072
+ integration=get_books_integration
10073
+ )
10074
+ http_api.add_routes(
10075
+ path="/books",
10076
+ methods=[apigwv2.HttpMethod.ANY],
10077
+ integration=book_store_default_integration
10039
10078
  )
10040
10079
  '''
10041
10080
 
@@ -12653,6 +12692,7 @@ class StageAttributes:
12653
12692
  name_mapping={
12654
12693
  "auto_deploy": "autoDeploy",
12655
12694
  "description": "description",
12695
+ "detailed_metrics_enabled": "detailedMetricsEnabled",
12656
12696
  "domain_mapping": "domainMapping",
12657
12697
  "throttle": "throttle",
12658
12698
  },
@@ -12663,6 +12703,7 @@ class StageOptions:
12663
12703
  *,
12664
12704
  auto_deploy: typing.Optional[builtins.bool] = None,
12665
12705
  description: typing.Optional[builtins.str] = None,
12706
+ detailed_metrics_enabled: typing.Optional[builtins.bool] = None,
12666
12707
  domain_mapping: typing.Optional[typing.Union[DomainMappingOptions, typing.Dict[builtins.str, typing.Any]]] = None,
12667
12708
  throttle: typing.Optional[typing.Union["ThrottleSettings", typing.Dict[builtins.str, typing.Any]]] = None,
12668
12709
  ) -> None:
@@ -12672,6 +12713,7 @@ class StageOptions:
12672
12713
 
12673
12714
  :param auto_deploy: Whether updates to an API automatically trigger a new deployment. Default: false
12674
12715
  :param description: The description for the API stage. Default: - no description
12716
+ :param detailed_metrics_enabled: Specifies whether detailed metrics are enabled. Default: false
12675
12717
  :param domain_mapping: The options for custom domain and api mapping. Default: - no custom domain and api mapping configuration
12676
12718
  :param throttle: Throttle settings for the routes of this stage. Default: - no throttling configuration
12677
12719
 
@@ -12688,6 +12730,7 @@ class StageOptions:
12688
12730
  stage_options = apigatewayv2.StageOptions(
12689
12731
  auto_deploy=False,
12690
12732
  description="description",
12733
+ detailed_metrics_enabled=False,
12691
12734
  domain_mapping=apigatewayv2.DomainMappingOptions(
12692
12735
  domain_name=domain_name,
12693
12736
 
@@ -12708,6 +12751,7 @@ class StageOptions:
12708
12751
  type_hints = typing.get_type_hints(_typecheckingstub__7d1ab9a2efdde27ab3aff279b986e4a558573396d5100c22c5a48bcbee4f320a)
12709
12752
  check_type(argname="argument auto_deploy", value=auto_deploy, expected_type=type_hints["auto_deploy"])
12710
12753
  check_type(argname="argument description", value=description, expected_type=type_hints["description"])
12754
+ check_type(argname="argument detailed_metrics_enabled", value=detailed_metrics_enabled, expected_type=type_hints["detailed_metrics_enabled"])
12711
12755
  check_type(argname="argument domain_mapping", value=domain_mapping, expected_type=type_hints["domain_mapping"])
12712
12756
  check_type(argname="argument throttle", value=throttle, expected_type=type_hints["throttle"])
12713
12757
  self._values: typing.Dict[builtins.str, typing.Any] = {}
@@ -12715,6 +12759,8 @@ class StageOptions:
12715
12759
  self._values["auto_deploy"] = auto_deploy
12716
12760
  if description is not None:
12717
12761
  self._values["description"] = description
12762
+ if detailed_metrics_enabled is not None:
12763
+ self._values["detailed_metrics_enabled"] = detailed_metrics_enabled
12718
12764
  if domain_mapping is not None:
12719
12765
  self._values["domain_mapping"] = domain_mapping
12720
12766
  if throttle is not None:
@@ -12738,6 +12784,15 @@ class StageOptions:
12738
12784
  result = self._values.get("description")
12739
12785
  return typing.cast(typing.Optional[builtins.str], result)
12740
12786
 
12787
+ @builtins.property
12788
+ def detailed_metrics_enabled(self) -> typing.Optional[builtins.bool]:
12789
+ '''Specifies whether detailed metrics are enabled.
12790
+
12791
+ :default: false
12792
+ '''
12793
+ result = self._values.get("detailed_metrics_enabled")
12794
+ return typing.cast(typing.Optional[builtins.bool], result)
12795
+
12741
12796
  @builtins.property
12742
12797
  def domain_mapping(self) -> typing.Optional[DomainMappingOptions]:
12743
12798
  '''The options for custom domain and api mapping.
@@ -12785,17 +12840,20 @@ class ThrottleSettings:
12785
12840
  :param burst_limit: The maximum API request rate limit over a time ranging from one to a few seconds. Default: none
12786
12841
  :param rate_limit: The API request steady-state rate limit (average requests per second over an extended period of time). Default: none
12787
12842
 
12788
- :exampleMetadata: fixture=_generated
12843
+ :exampleMetadata: infused
12789
12844
 
12790
12845
  Example::
12791
12846
 
12792
- # The code below shows an example of how to instantiate this type.
12793
- # The values are placeholders you should change.
12794
- from aws_cdk import aws_apigatewayv2 as apigatewayv2
12847
+ # api: apigwv2.HttpApi
12848
+
12795
12849
 
12796
- throttle_settings = apigatewayv2.ThrottleSettings(
12797
- burst_limit=123,
12798
- rate_limit=123
12850
+ apigwv2.HttpStage(self, "Stage",
12851
+ http_api=api,
12852
+ throttle=apigwv2.ThrottleSettings(
12853
+ rate_limit=1000,
12854
+ burst_limit=1000
12855
+ ),
12856
+ detailed_metrics_enabled=True
12799
12857
  )
12800
12858
  '''
12801
12859
  if __debug__:
@@ -15228,6 +15286,7 @@ class WebSocketStage(
15228
15286
  web_socket_api: IWebSocketApi,
15229
15287
  auto_deploy: typing.Optional[builtins.bool] = None,
15230
15288
  description: typing.Optional[builtins.str] = None,
15289
+ detailed_metrics_enabled: typing.Optional[builtins.bool] = None,
15231
15290
  domain_mapping: typing.Optional[typing.Union[DomainMappingOptions, typing.Dict[builtins.str, typing.Any]]] = None,
15232
15291
  throttle: typing.Optional[typing.Union[ThrottleSettings, typing.Dict[builtins.str, typing.Any]]] = None,
15233
15292
  ) -> None:
@@ -15238,6 +15297,7 @@ class WebSocketStage(
15238
15297
  :param web_socket_api: The WebSocket API to which this stage is associated.
15239
15298
  :param auto_deploy: Whether updates to an API automatically trigger a new deployment. Default: false
15240
15299
  :param description: The description for the API stage. Default: - no description
15300
+ :param detailed_metrics_enabled: Specifies whether detailed metrics are enabled. Default: false
15241
15301
  :param domain_mapping: The options for custom domain and api mapping. Default: - no custom domain and api mapping configuration
15242
15302
  :param throttle: Throttle settings for the routes of this stage. Default: - no throttling configuration
15243
15303
  '''
@@ -15250,6 +15310,7 @@ class WebSocketStage(
15250
15310
  web_socket_api=web_socket_api,
15251
15311
  auto_deploy=auto_deploy,
15252
15312
  description=description,
15313
+ detailed_metrics_enabled=detailed_metrics_enabled,
15253
15314
  domain_mapping=domain_mapping,
15254
15315
  throttle=throttle,
15255
15316
  )
@@ -15444,6 +15505,7 @@ class WebSocketStageAttributes(StageAttributes):
15444
15505
  name_mapping={
15445
15506
  "auto_deploy": "autoDeploy",
15446
15507
  "description": "description",
15508
+ "detailed_metrics_enabled": "detailedMetricsEnabled",
15447
15509
  "domain_mapping": "domainMapping",
15448
15510
  "throttle": "throttle",
15449
15511
  "stage_name": "stageName",
@@ -15456,6 +15518,7 @@ class WebSocketStageProps(StageOptions):
15456
15518
  *,
15457
15519
  auto_deploy: typing.Optional[builtins.bool] = None,
15458
15520
  description: typing.Optional[builtins.str] = None,
15521
+ detailed_metrics_enabled: typing.Optional[builtins.bool] = None,
15459
15522
  domain_mapping: typing.Optional[typing.Union[DomainMappingOptions, typing.Dict[builtins.str, typing.Any]]] = None,
15460
15523
  throttle: typing.Optional[typing.Union[ThrottleSettings, typing.Dict[builtins.str, typing.Any]]] = None,
15461
15524
  stage_name: builtins.str,
@@ -15465,6 +15528,7 @@ class WebSocketStageProps(StageOptions):
15465
15528
 
15466
15529
  :param auto_deploy: Whether updates to an API automatically trigger a new deployment. Default: false
15467
15530
  :param description: The description for the API stage. Default: - no description
15531
+ :param detailed_metrics_enabled: Specifies whether detailed metrics are enabled. Default: false
15468
15532
  :param domain_mapping: The options for custom domain and api mapping. Default: - no custom domain and api mapping configuration
15469
15533
  :param throttle: Throttle settings for the routes of this stage. Default: - no throttling configuration
15470
15534
  :param stage_name: The name of the stage.
@@ -15497,6 +15561,7 @@ class WebSocketStageProps(StageOptions):
15497
15561
  type_hints = typing.get_type_hints(_typecheckingstub__42c328a8780899b5d1949986febb2d9e9b3f4f2f6b8e4f03561cb02e5b407e77)
15498
15562
  check_type(argname="argument auto_deploy", value=auto_deploy, expected_type=type_hints["auto_deploy"])
15499
15563
  check_type(argname="argument description", value=description, expected_type=type_hints["description"])
15564
+ check_type(argname="argument detailed_metrics_enabled", value=detailed_metrics_enabled, expected_type=type_hints["detailed_metrics_enabled"])
15500
15565
  check_type(argname="argument domain_mapping", value=domain_mapping, expected_type=type_hints["domain_mapping"])
15501
15566
  check_type(argname="argument throttle", value=throttle, expected_type=type_hints["throttle"])
15502
15567
  check_type(argname="argument stage_name", value=stage_name, expected_type=type_hints["stage_name"])
@@ -15509,6 +15574,8 @@ class WebSocketStageProps(StageOptions):
15509
15574
  self._values["auto_deploy"] = auto_deploy
15510
15575
  if description is not None:
15511
15576
  self._values["description"] = description
15577
+ if detailed_metrics_enabled is not None:
15578
+ self._values["detailed_metrics_enabled"] = detailed_metrics_enabled
15512
15579
  if domain_mapping is not None:
15513
15580
  self._values["domain_mapping"] = domain_mapping
15514
15581
  if throttle is not None:
@@ -15532,6 +15599,15 @@ class WebSocketStageProps(StageOptions):
15532
15599
  result = self._values.get("description")
15533
15600
  return typing.cast(typing.Optional[builtins.str], result)
15534
15601
 
15602
+ @builtins.property
15603
+ def detailed_metrics_enabled(self) -> typing.Optional[builtins.bool]:
15604
+ '''Specifies whether detailed metrics are enabled.
15605
+
15606
+ :default: false
15607
+ '''
15608
+ result = self._values.get("detailed_metrics_enabled")
15609
+ return typing.cast(typing.Optional[builtins.bool], result)
15610
+
15535
15611
  @builtins.property
15536
15612
  def domain_mapping(self) -> typing.Optional[DomainMappingOptions]:
15537
15613
  '''The options for custom domain and api mapping.
@@ -16269,6 +16345,7 @@ class HttpApi(
16269
16345
  stage_name: typing.Optional[builtins.str] = None,
16270
16346
  auto_deploy: typing.Optional[builtins.bool] = None,
16271
16347
  description: typing.Optional[builtins.str] = None,
16348
+ detailed_metrics_enabled: typing.Optional[builtins.bool] = None,
16272
16349
  domain_mapping: typing.Optional[typing.Union[DomainMappingOptions, typing.Dict[builtins.str, typing.Any]]] = None,
16273
16350
  throttle: typing.Optional[typing.Union[ThrottleSettings, typing.Dict[builtins.str, typing.Any]]] = None,
16274
16351
  ) -> "HttpStage":
@@ -16278,6 +16355,7 @@ class HttpApi(
16278
16355
  :param stage_name: The name of the stage. See ``StageName`` class for more details. Default: '$default' the default stage of the API. This stage will have the URL at the root of the API endpoint.
16279
16356
  :param auto_deploy: Whether updates to an API automatically trigger a new deployment. Default: false
16280
16357
  :param description: The description for the API stage. Default: - no description
16358
+ :param detailed_metrics_enabled: Specifies whether detailed metrics are enabled. Default: false
16281
16359
  :param domain_mapping: The options for custom domain and api mapping. Default: - no custom domain and api mapping configuration
16282
16360
  :param throttle: Throttle settings for the routes of this stage. Default: - no throttling configuration
16283
16361
  '''
@@ -16288,6 +16366,7 @@ class HttpApi(
16288
16366
  stage_name=stage_name,
16289
16367
  auto_deploy=auto_deploy,
16290
16368
  description=description,
16369
+ detailed_metrics_enabled=detailed_metrics_enabled,
16291
16370
  domain_mapping=domain_mapping,
16292
16371
  throttle=throttle,
16293
16372
  )
@@ -16983,6 +17062,7 @@ class HttpStageAttributes(StageAttributes):
16983
17062
  name_mapping={
16984
17063
  "auto_deploy": "autoDeploy",
16985
17064
  "description": "description",
17065
+ "detailed_metrics_enabled": "detailedMetricsEnabled",
16986
17066
  "domain_mapping": "domainMapping",
16987
17067
  "throttle": "throttle",
16988
17068
  "stage_name": "stageName",
@@ -16994,6 +17074,7 @@ class HttpStageOptions(StageOptions):
16994
17074
  *,
16995
17075
  auto_deploy: typing.Optional[builtins.bool] = None,
16996
17076
  description: typing.Optional[builtins.str] = None,
17077
+ detailed_metrics_enabled: typing.Optional[builtins.bool] = None,
16997
17078
  domain_mapping: typing.Optional[typing.Union[DomainMappingOptions, typing.Dict[builtins.str, typing.Any]]] = None,
16998
17079
  throttle: typing.Optional[typing.Union[ThrottleSettings, typing.Dict[builtins.str, typing.Any]]] = None,
16999
17080
  stage_name: typing.Optional[builtins.str] = None,
@@ -17002,6 +17083,7 @@ class HttpStageOptions(StageOptions):
17002
17083
 
17003
17084
  :param auto_deploy: Whether updates to an API automatically trigger a new deployment. Default: false
17004
17085
  :param description: The description for the API stage. Default: - no description
17086
+ :param detailed_metrics_enabled: Specifies whether detailed metrics are enabled. Default: false
17005
17087
  :param domain_mapping: The options for custom domain and api mapping. Default: - no custom domain and api mapping configuration
17006
17088
  :param throttle: Throttle settings for the routes of this stage. Default: - no throttling configuration
17007
17089
  :param stage_name: The name of the stage. See ``StageName`` class for more details. Default: '$default' the default stage of the API. This stage will have the URL at the root of the API endpoint.
@@ -17032,6 +17114,7 @@ class HttpStageOptions(StageOptions):
17032
17114
  type_hints = typing.get_type_hints(_typecheckingstub__70c0bb0779b1636661ab1c2d695953c6dda7a5247d18a4bd7e045cc96d717a8a)
17033
17115
  check_type(argname="argument auto_deploy", value=auto_deploy, expected_type=type_hints["auto_deploy"])
17034
17116
  check_type(argname="argument description", value=description, expected_type=type_hints["description"])
17117
+ check_type(argname="argument detailed_metrics_enabled", value=detailed_metrics_enabled, expected_type=type_hints["detailed_metrics_enabled"])
17035
17118
  check_type(argname="argument domain_mapping", value=domain_mapping, expected_type=type_hints["domain_mapping"])
17036
17119
  check_type(argname="argument throttle", value=throttle, expected_type=type_hints["throttle"])
17037
17120
  check_type(argname="argument stage_name", value=stage_name, expected_type=type_hints["stage_name"])
@@ -17040,6 +17123,8 @@ class HttpStageOptions(StageOptions):
17040
17123
  self._values["auto_deploy"] = auto_deploy
17041
17124
  if description is not None:
17042
17125
  self._values["description"] = description
17126
+ if detailed_metrics_enabled is not None:
17127
+ self._values["detailed_metrics_enabled"] = detailed_metrics_enabled
17043
17128
  if domain_mapping is not None:
17044
17129
  self._values["domain_mapping"] = domain_mapping
17045
17130
  if throttle is not None:
@@ -17065,6 +17150,15 @@ class HttpStageOptions(StageOptions):
17065
17150
  result = self._values.get("description")
17066
17151
  return typing.cast(typing.Optional[builtins.str], result)
17067
17152
 
17153
+ @builtins.property
17154
+ def detailed_metrics_enabled(self) -> typing.Optional[builtins.bool]:
17155
+ '''Specifies whether detailed metrics are enabled.
17156
+
17157
+ :default: false
17158
+ '''
17159
+ result = self._values.get("detailed_metrics_enabled")
17160
+ return typing.cast(typing.Optional[builtins.bool], result)
17161
+
17068
17162
  @builtins.property
17069
17163
  def domain_mapping(self) -> typing.Optional[DomainMappingOptions]:
17070
17164
  '''The options for custom domain and api mapping.
@@ -17112,6 +17206,7 @@ class HttpStageOptions(StageOptions):
17112
17206
  name_mapping={
17113
17207
  "auto_deploy": "autoDeploy",
17114
17208
  "description": "description",
17209
+ "detailed_metrics_enabled": "detailedMetricsEnabled",
17115
17210
  "domain_mapping": "domainMapping",
17116
17211
  "throttle": "throttle",
17117
17212
  "stage_name": "stageName",
@@ -17124,6 +17219,7 @@ class HttpStageProps(HttpStageOptions):
17124
17219
  *,
17125
17220
  auto_deploy: typing.Optional[builtins.bool] = None,
17126
17221
  description: typing.Optional[builtins.str] = None,
17222
+ detailed_metrics_enabled: typing.Optional[builtins.bool] = None,
17127
17223
  domain_mapping: typing.Optional[typing.Union[DomainMappingOptions, typing.Dict[builtins.str, typing.Any]]] = None,
17128
17224
  throttle: typing.Optional[typing.Union[ThrottleSettings, typing.Dict[builtins.str, typing.Any]]] = None,
17129
17225
  stage_name: typing.Optional[builtins.str] = None,
@@ -17133,6 +17229,7 @@ class HttpStageProps(HttpStageOptions):
17133
17229
 
17134
17230
  :param auto_deploy: Whether updates to an API automatically trigger a new deployment. Default: false
17135
17231
  :param description: The description for the API stage. Default: - no description
17232
+ :param detailed_metrics_enabled: Specifies whether detailed metrics are enabled. Default: false
17136
17233
  :param domain_mapping: The options for custom domain and api mapping. Default: - no custom domain and api mapping configuration
17137
17234
  :param throttle: Throttle settings for the routes of this stage. Default: - no throttling configuration
17138
17235
  :param stage_name: The name of the stage. See ``StageName`` class for more details. Default: '$default' the default stage of the API. This stage will have the URL at the root of the API endpoint.
@@ -17159,6 +17256,7 @@ class HttpStageProps(HttpStageOptions):
17159
17256
  type_hints = typing.get_type_hints(_typecheckingstub__77d8b0adbb783021a6c7e33999d2a3a80e2414824d202954599bb4ad7f291721)
17160
17257
  check_type(argname="argument auto_deploy", value=auto_deploy, expected_type=type_hints["auto_deploy"])
17161
17258
  check_type(argname="argument description", value=description, expected_type=type_hints["description"])
17259
+ check_type(argname="argument detailed_metrics_enabled", value=detailed_metrics_enabled, expected_type=type_hints["detailed_metrics_enabled"])
17162
17260
  check_type(argname="argument domain_mapping", value=domain_mapping, expected_type=type_hints["domain_mapping"])
17163
17261
  check_type(argname="argument throttle", value=throttle, expected_type=type_hints["throttle"])
17164
17262
  check_type(argname="argument stage_name", value=stage_name, expected_type=type_hints["stage_name"])
@@ -17170,6 +17268,8 @@ class HttpStageProps(HttpStageOptions):
17170
17268
  self._values["auto_deploy"] = auto_deploy
17171
17269
  if description is not None:
17172
17270
  self._values["description"] = description
17271
+ if detailed_metrics_enabled is not None:
17272
+ self._values["detailed_metrics_enabled"] = detailed_metrics_enabled
17173
17273
  if domain_mapping is not None:
17174
17274
  self._values["domain_mapping"] = domain_mapping
17175
17275
  if throttle is not None:
@@ -17195,6 +17295,15 @@ class HttpStageProps(HttpStageOptions):
17195
17295
  result = self._values.get("description")
17196
17296
  return typing.cast(typing.Optional[builtins.str], result)
17197
17297
 
17298
+ @builtins.property
17299
+ def detailed_metrics_enabled(self) -> typing.Optional[builtins.bool]:
17300
+ '''Specifies whether detailed metrics are enabled.
17301
+
17302
+ :default: false
17303
+ '''
17304
+ result = self._values.get("detailed_metrics_enabled")
17305
+ return typing.cast(typing.Optional[builtins.bool], result)
17306
+
17198
17307
  @builtins.property
17199
17308
  def domain_mapping(self) -> typing.Optional[DomainMappingOptions]:
17200
17309
  '''The options for custom domain and api mapping.
@@ -18129,6 +18238,7 @@ class HttpStage(
18129
18238
  stage_name: typing.Optional[builtins.str] = None,
18130
18239
  auto_deploy: typing.Optional[builtins.bool] = None,
18131
18240
  description: typing.Optional[builtins.str] = None,
18241
+ detailed_metrics_enabled: typing.Optional[builtins.bool] = None,
18132
18242
  domain_mapping: typing.Optional[typing.Union[DomainMappingOptions, typing.Dict[builtins.str, typing.Any]]] = None,
18133
18243
  throttle: typing.Optional[typing.Union[ThrottleSettings, typing.Dict[builtins.str, typing.Any]]] = None,
18134
18244
  ) -> None:
@@ -18139,6 +18249,7 @@ class HttpStage(
18139
18249
  :param stage_name: The name of the stage. See ``StageName`` class for more details. Default: '$default' the default stage of the API. This stage will have the URL at the root of the API endpoint.
18140
18250
  :param auto_deploy: Whether updates to an API automatically trigger a new deployment. Default: false
18141
18251
  :param description: The description for the API stage. Default: - no description
18252
+ :param detailed_metrics_enabled: Specifies whether detailed metrics are enabled. Default: false
18142
18253
  :param domain_mapping: The options for custom domain and api mapping. Default: - no custom domain and api mapping configuration
18143
18254
  :param throttle: Throttle settings for the routes of this stage. Default: - no throttling configuration
18144
18255
  '''
@@ -18151,6 +18262,7 @@ class HttpStage(
18151
18262
  stage_name=stage_name,
18152
18263
  auto_deploy=auto_deploy,
18153
18264
  description=description,
18265
+ detailed_metrics_enabled=detailed_metrics_enabled,
18154
18266
  domain_mapping=domain_mapping,
18155
18267
  throttle=throttle,
18156
18268
  )
@@ -20394,6 +20506,7 @@ def _typecheckingstub__7d1ab9a2efdde27ab3aff279b986e4a558573396d5100c22c5a48bcbe
20394
20506
  *,
20395
20507
  auto_deploy: typing.Optional[builtins.bool] = None,
20396
20508
  description: typing.Optional[builtins.str] = None,
20509
+ detailed_metrics_enabled: typing.Optional[builtins.bool] = None,
20397
20510
  domain_mapping: typing.Optional[typing.Union[DomainMappingOptions, typing.Dict[builtins.str, typing.Any]]] = None,
20398
20511
  throttle: typing.Optional[typing.Union[ThrottleSettings, typing.Dict[builtins.str, typing.Any]]] = None,
20399
20512
  ) -> None:
@@ -20727,6 +20840,7 @@ def _typecheckingstub__64b576b4eaac9e08a38566f9968efb8de351df1daf6fe46d0fe7787da
20727
20840
  web_socket_api: IWebSocketApi,
20728
20841
  auto_deploy: typing.Optional[builtins.bool] = None,
20729
20842
  description: typing.Optional[builtins.str] = None,
20843
+ detailed_metrics_enabled: typing.Optional[builtins.bool] = None,
20730
20844
  domain_mapping: typing.Optional[typing.Union[DomainMappingOptions, typing.Dict[builtins.str, typing.Any]]] = None,
20731
20845
  throttle: typing.Optional[typing.Union[ThrottleSettings, typing.Dict[builtins.str, typing.Any]]] = None,
20732
20846
  ) -> None:
@@ -20778,6 +20892,7 @@ def _typecheckingstub__42c328a8780899b5d1949986febb2d9e9b3f4f2f6b8e4f03561cb02e5
20778
20892
  *,
20779
20893
  auto_deploy: typing.Optional[builtins.bool] = None,
20780
20894
  description: typing.Optional[builtins.str] = None,
20895
+ detailed_metrics_enabled: typing.Optional[builtins.bool] = None,
20781
20896
  domain_mapping: typing.Optional[typing.Union[DomainMappingOptions, typing.Dict[builtins.str, typing.Any]]] = None,
20782
20897
  throttle: typing.Optional[typing.Union[ThrottleSettings, typing.Dict[builtins.str, typing.Any]]] = None,
20783
20898
  stage_name: builtins.str,
@@ -20891,6 +21006,7 @@ def _typecheckingstub__f8917ad3a680cbc2c8ade65728d8549bf69f03ea4c9d0752e5dae7263
20891
21006
  stage_name: typing.Optional[builtins.str] = None,
20892
21007
  auto_deploy: typing.Optional[builtins.bool] = None,
20893
21008
  description: typing.Optional[builtins.str] = None,
21009
+ detailed_metrics_enabled: typing.Optional[builtins.bool] = None,
20894
21010
  domain_mapping: typing.Optional[typing.Union[DomainMappingOptions, typing.Dict[builtins.str, typing.Any]]] = None,
20895
21011
  throttle: typing.Optional[typing.Union[ThrottleSettings, typing.Dict[builtins.str, typing.Any]]] = None,
20896
21012
  ) -> None:
@@ -20962,6 +21078,7 @@ def _typecheckingstub__70c0bb0779b1636661ab1c2d695953c6dda7a5247d18a4bd7e045cc96
20962
21078
  *,
20963
21079
  auto_deploy: typing.Optional[builtins.bool] = None,
20964
21080
  description: typing.Optional[builtins.str] = None,
21081
+ detailed_metrics_enabled: typing.Optional[builtins.bool] = None,
20965
21082
  domain_mapping: typing.Optional[typing.Union[DomainMappingOptions, typing.Dict[builtins.str, typing.Any]]] = None,
20966
21083
  throttle: typing.Optional[typing.Union[ThrottleSettings, typing.Dict[builtins.str, typing.Any]]] = None,
20967
21084
  stage_name: typing.Optional[builtins.str] = None,
@@ -20973,6 +21090,7 @@ def _typecheckingstub__77d8b0adbb783021a6c7e33999d2a3a80e2414824d202954599bb4ad7
20973
21090
  *,
20974
21091
  auto_deploy: typing.Optional[builtins.bool] = None,
20975
21092
  description: typing.Optional[builtins.str] = None,
21093
+ detailed_metrics_enabled: typing.Optional[builtins.bool] = None,
20976
21094
  domain_mapping: typing.Optional[typing.Union[DomainMappingOptions, typing.Dict[builtins.str, typing.Any]]] = None,
20977
21095
  throttle: typing.Optional[typing.Union[ThrottleSettings, typing.Dict[builtins.str, typing.Any]]] = None,
20978
21096
  stage_name: typing.Optional[builtins.str] = None,
@@ -21038,6 +21156,7 @@ def _typecheckingstub__4573d7530f36463b1b12875197f2c49f968925d114c4ed7ac6b9ab04e
21038
21156
  stage_name: typing.Optional[builtins.str] = None,
21039
21157
  auto_deploy: typing.Optional[builtins.bool] = None,
21040
21158
  description: typing.Optional[builtins.str] = None,
21159
+ detailed_metrics_enabled: typing.Optional[builtins.bool] = None,
21041
21160
  domain_mapping: typing.Optional[typing.Union[DomainMappingOptions, typing.Dict[builtins.str, typing.Any]]] = None,
21042
21161
  throttle: typing.Optional[typing.Union[ThrottleSettings, typing.Dict[builtins.str, typing.Any]]] = None,
21043
21162
  ) -> None: