aws-cdk-lib 2.171.1__py3-none-any.whl → 2.173.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 +528 -161
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.171.1.jsii.tgz → aws-cdk-lib@2.173.0.jsii.tgz} +0 -0
- aws_cdk/aws_amazonmq/__init__.py +40 -40
- aws_cdk/aws_apigateway/__init__.py +1357 -120
- aws_cdk/aws_applicationautoscaling/__init__.py +141 -66
- aws_cdk/aws_appsync/__init__.py +163 -139
- aws_cdk/aws_autoscaling/__init__.py +96 -30
- aws_cdk/aws_bedrock/__init__.py +80 -44
- aws_cdk/aws_chatbot/__init__.py +803 -2
- aws_cdk/aws_cleanrooms/__init__.py +4 -6
- aws_cdk/aws_cloudformation/__init__.py +240 -159
- aws_cdk/aws_cloudfront/__init__.py +15 -7
- aws_cdk/aws_cloudtrail/__init__.py +802 -13
- aws_cdk/aws_cloudwatch/__init__.py +51 -14
- aws_cdk/aws_codebuild/__init__.py +39 -0
- aws_cdk/aws_codepipeline/__init__.py +4 -4
- aws_cdk/aws_cognito/__init__.py +1032 -43
- aws_cdk/aws_config/__init__.py +13 -10
- aws_cdk/aws_connect/__init__.py +454 -23
- aws_cdk/aws_connectcampaignsv2/__init__.py +187 -176
- aws_cdk/aws_customerprofiles/__init__.py +3148 -0
- aws_cdk/aws_docdb/__init__.py +128 -0
- aws_cdk/aws_dynamodb/__init__.py +256 -0
- aws_cdk/aws_ec2/__init__.py +976 -27
- aws_cdk/aws_ecs/__init__.py +37 -20
- aws_cdk/aws_eks/__init__.py +771 -0
- aws_cdk/aws_elasticache/__init__.py +22 -22
- aws_cdk/aws_elasticloadbalancingv2/__init__.py +441 -177
- aws_cdk/aws_events/__init__.py +550 -30
- aws_cdk/aws_fsx/__init__.py +134 -10
- aws_cdk/aws_imagebuilder/__init__.py +8 -8
- aws_cdk/aws_invoicing/__init__.py +651 -0
- aws_cdk/aws_iot/__init__.py +70 -26
- aws_cdk/aws_iotfleetwise/__init__.py +1033 -382
- aws_cdk/aws_iotsitewise/__init__.py +158 -0
- aws_cdk/aws_ivs/__init__.py +43 -31
- aws_cdk/aws_kendra/__init__.py +4 -0
- aws_cdk/aws_lakeformation/__init__.py +2 -1
- aws_cdk/aws_lambda/__init__.py +272 -164
- aws_cdk/aws_lambda_event_sources/__init__.py +2 -1
- aws_cdk/aws_lambda_nodejs/__init__.py +11 -11
- aws_cdk/aws_logs/__init__.py +532 -0
- aws_cdk/aws_m2/__init__.py +289 -0
- aws_cdk/aws_mediaconnect/__init__.py +24 -14
- aws_cdk/aws_medialive/__init__.py +2359 -5
- aws_cdk/aws_mediapackage/__init__.py +3 -9
- aws_cdk/aws_mediapackagev2/__init__.py +19 -17
- aws_cdk/aws_memorydb/__init__.py +664 -4
- aws_cdk/aws_mwaa/__init__.py +6 -6
- aws_cdk/aws_opensearchserverless/__init__.py +249 -1
- aws_cdk/aws_pipes/__init__.py +14 -30
- aws_cdk/aws_qbusiness/__init__.py +2021 -67
- aws_cdk/aws_quicksight/__init__.py +8270 -10
- aws_cdk/aws_rbin/__init__.py +53 -34
- aws_cdk/aws_rds/__init__.py +170 -8
- aws_cdk/aws_resourcegroups/__init__.py +362 -4
- aws_cdk/aws_route53/__init__.py +1177 -10
- aws_cdk/aws_route53_targets/__init__.py +297 -91
- aws_cdk/aws_route53resolver/__init__.py +19 -8
- aws_cdk/aws_s3/__init__.py +4 -4
- aws_cdk/aws_s3express/__init__.py +421 -9
- aws_cdk/aws_sagemaker/__init__.py +905 -119
- aws_cdk/aws_secretsmanager/__init__.py +20 -6
- aws_cdk/aws_securityhub/__init__.py +64 -32
- aws_cdk/aws_servicediscovery/__init__.py +43 -0
- aws_cdk/aws_ses/__init__.py +188 -41
- aws_cdk/aws_stepfunctions_tasks/__init__.py +190 -35
- aws_cdk/aws_synthetics/__init__.py +7 -5
- aws_cdk/aws_vpclattice/__init__.py +1479 -122
- aws_cdk/aws_wisdom/__init__.py +8509 -1502
- aws_cdk/aws_workspacesweb/__init__.py +1081 -0
- {aws_cdk_lib-2.171.1.dist-info → aws_cdk_lib-2.173.0.dist-info}/METADATA +1 -1
- {aws_cdk_lib-2.171.1.dist-info → aws_cdk_lib-2.173.0.dist-info}/RECORD +78 -77
- {aws_cdk_lib-2.171.1.dist-info → aws_cdk_lib-2.173.0.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.171.1.dist-info → aws_cdk_lib-2.173.0.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.171.1.dist-info → aws_cdk_lib-2.173.0.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.171.1.dist-info → aws_cdk_lib-2.173.0.dist-info}/top_level.txt +0 -0
|
@@ -2607,7 +2607,7 @@ class CfnAutoScalingGroup(
|
|
|
2607
2607
|
:param availability_zone_impairment_policy: The Availability Zone impairment policy.
|
|
2608
2608
|
:param availability_zones: A list of Availability Zones where instances in the Auto Scaling group can be created. Used for launching into the default VPC subnet in each Availability Zone when not using the ``VPCZoneIdentifier`` property, or for attaching a network interface when an existing network interface ID is specified in a launch template.
|
|
2609
2609
|
:param capacity_rebalance: Indicates whether Capacity Rebalancing is enabled. Otherwise, Capacity Rebalancing is disabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of interruption. After launching a new instance, it then terminates an old instance. For more information, see `Use Capacity Rebalancing to handle Amazon EC2 Spot Interruptions <https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-capacity-rebalancing.html>`_ in the in the *Amazon EC2 Auto Scaling User Guide* .
|
|
2610
|
-
:param capacity_reservation_specification:
|
|
2610
|
+
:param capacity_reservation_specification: The capacity reservation specification.
|
|
2611
2611
|
:param context: Reserved.
|
|
2612
2612
|
:param cooldown: *Only needed if you use simple scaling policies.*. The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see `Scaling cooldowns for Amazon EC2 Auto Scaling <https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scaling-cooldowns.html>`_ in the *Amazon EC2 Auto Scaling User Guide* . Default: ``300`` seconds
|
|
2613
2613
|
:param default_instance_warmup: The amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the ``InService`` state. During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see `Set the default instance warmup for an Auto Scaling group <https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-default-instance-warmup.html>`_ in the *Amazon EC2 Auto Scaling User Guide* . .. epigraph:: To manage various warm-up settings at the group level, we recommend that you set the default instance warmup, *even if it is set to 0 seconds* . To remove a value that you previously set, include the property but specify ``-1`` for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of ``0`` or other nominal value. Default: None
|
|
@@ -2838,6 +2838,7 @@ class CfnAutoScalingGroup(
|
|
|
2838
2838
|
def capacity_reservation_specification(
|
|
2839
2839
|
self,
|
|
2840
2840
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAutoScalingGroup.CapacityReservationSpecificationProperty"]]:
|
|
2841
|
+
'''The capacity reservation specification.'''
|
|
2841
2842
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAutoScalingGroup.CapacityReservationSpecificationProperty"]], jsii.get(self, "capacityReservationSpecification"))
|
|
2842
2843
|
|
|
2843
2844
|
@capacity_reservation_specification.setter
|
|
@@ -3631,8 +3632,13 @@ class CfnAutoScalingGroup(
|
|
|
3631
3632
|
*,
|
|
3632
3633
|
cpu: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnAutoScalingGroup.CpuPerformanceFactorRequestProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
3633
3634
|
) -> None:
|
|
3634
|
-
'''
|
|
3635
|
-
|
|
3635
|
+
'''The baseline performance to consider, using an instance family as a baseline reference.
|
|
3636
|
+
|
|
3637
|
+
The instance family establishes the lowest acceptable level of performance. Auto Scaling uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application.
|
|
3638
|
+
|
|
3639
|
+
Currently, this parameter only supports CPU performance as a baseline performance factor. For example, specifying ``c6i`` uses the CPU performance of the ``c6i`` family as the baseline reference.
|
|
3640
|
+
|
|
3641
|
+
:param cpu: The CPU performance to consider, using an instance family as the baseline reference.
|
|
3636
3642
|
|
|
3637
3643
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-baselineperformancefactorsrequest.html
|
|
3638
3644
|
:exampleMetadata: fixture=_generated
|
|
@@ -3662,7 +3668,8 @@ class CfnAutoScalingGroup(
|
|
|
3662
3668
|
def cpu(
|
|
3663
3669
|
self,
|
|
3664
3670
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAutoScalingGroup.CpuPerformanceFactorRequestProperty"]]:
|
|
3665
|
-
'''
|
|
3671
|
+
'''The CPU performance to consider, using an instance family as the baseline reference.
|
|
3672
|
+
|
|
3666
3673
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-baselineperformancefactorsrequest.html#cfn-autoscaling-autoscalinggroup-baselineperformancefactorsrequest-cpu
|
|
3667
3674
|
'''
|
|
3668
3675
|
result = self._values.get("cpu")
|
|
@@ -3694,9 +3701,12 @@ class CfnAutoScalingGroup(
|
|
|
3694
3701
|
capacity_reservation_preference: builtins.str,
|
|
3695
3702
|
capacity_reservation_target: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnAutoScalingGroup.CapacityReservationTargetProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
3696
3703
|
) -> None:
|
|
3697
|
-
'''
|
|
3698
|
-
|
|
3699
|
-
|
|
3704
|
+
'''Describes the Capacity Reservation preference and targeting options.
|
|
3705
|
+
|
|
3706
|
+
If you specify ``open`` or ``none`` for ``CapacityReservationPreference`` , do not specify a ``CapacityReservationTarget`` .
|
|
3707
|
+
|
|
3708
|
+
:param capacity_reservation_preference: The capacity reservation preference. The following options are available:. - ``capacity-reservations-only`` - Auto Scaling will only launch instances into a Capacity Reservation or Capacity Reservation resource group. If capacity isn't available, instances will fail to launch. - ``capacity-reservations-first`` - Auto Scaling will try to launch instances into a Capacity Reservation or Capacity Reservation resource group first. If capacity isn't available, instances will run in On-Demand capacity. - ``none`` - Auto Scaling will not launch instances into a Capacity Reservation. Instances will run in On-Demand capacity. - ``default`` - Auto Scaling uses the Capacity Reservation preference from your launch template or an open Capacity Reservation.
|
|
3709
|
+
:param capacity_reservation_target: Describes a target Capacity Reservation or Capacity Reservation resource group.
|
|
3700
3710
|
|
|
3701
3711
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-capacityreservationspecification.html
|
|
3702
3712
|
:exampleMetadata: fixture=_generated
|
|
@@ -3729,7 +3739,13 @@ class CfnAutoScalingGroup(
|
|
|
3729
3739
|
|
|
3730
3740
|
@builtins.property
|
|
3731
3741
|
def capacity_reservation_preference(self) -> builtins.str:
|
|
3732
|
-
'''
|
|
3742
|
+
'''The capacity reservation preference. The following options are available:.
|
|
3743
|
+
|
|
3744
|
+
- ``capacity-reservations-only`` - Auto Scaling will only launch instances into a Capacity Reservation or Capacity Reservation resource group. If capacity isn't available, instances will fail to launch.
|
|
3745
|
+
- ``capacity-reservations-first`` - Auto Scaling will try to launch instances into a Capacity Reservation or Capacity Reservation resource group first. If capacity isn't available, instances will run in On-Demand capacity.
|
|
3746
|
+
- ``none`` - Auto Scaling will not launch instances into a Capacity Reservation. Instances will run in On-Demand capacity.
|
|
3747
|
+
- ``default`` - Auto Scaling uses the Capacity Reservation preference from your launch template or an open Capacity Reservation.
|
|
3748
|
+
|
|
3733
3749
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-capacityreservationspecification.html#cfn-autoscaling-autoscalinggroup-capacityreservationspecification-capacityreservationpreference
|
|
3734
3750
|
'''
|
|
3735
3751
|
result = self._values.get("capacity_reservation_preference")
|
|
@@ -3740,7 +3756,8 @@ class CfnAutoScalingGroup(
|
|
|
3740
3756
|
def capacity_reservation_target(
|
|
3741
3757
|
self,
|
|
3742
3758
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAutoScalingGroup.CapacityReservationTargetProperty"]]:
|
|
3743
|
-
'''
|
|
3759
|
+
'''Describes a target Capacity Reservation or Capacity Reservation resource group.
|
|
3760
|
+
|
|
3744
3761
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-capacityreservationspecification.html#cfn-autoscaling-autoscalinggroup-capacityreservationspecification-capacityreservationtarget
|
|
3745
3762
|
'''
|
|
3746
3763
|
result = self._values.get("capacity_reservation_target")
|
|
@@ -3772,9 +3789,12 @@ class CfnAutoScalingGroup(
|
|
|
3772
3789
|
capacity_reservation_ids: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
3773
3790
|
capacity_reservation_resource_group_arns: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
3774
3791
|
) -> None:
|
|
3775
|
-
'''
|
|
3776
|
-
|
|
3777
|
-
|
|
3792
|
+
'''The target for the Capacity Reservation.
|
|
3793
|
+
|
|
3794
|
+
Specify Capacity Reservations IDs or Capacity Reservation resource group ARNs.
|
|
3795
|
+
|
|
3796
|
+
:param capacity_reservation_ids: The Capacity Reservation IDs to launch instances into.
|
|
3797
|
+
:param capacity_reservation_resource_group_arns: The resource group ARNs of the Capacity Reservation to launch instances into.
|
|
3778
3798
|
|
|
3779
3799
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-capacityreservationtarget.html
|
|
3780
3800
|
:exampleMetadata: fixture=_generated
|
|
@@ -3804,7 +3824,8 @@ class CfnAutoScalingGroup(
|
|
|
3804
3824
|
def capacity_reservation_ids(
|
|
3805
3825
|
self,
|
|
3806
3826
|
) -> typing.Optional[typing.List[builtins.str]]:
|
|
3807
|
-
'''
|
|
3827
|
+
'''The Capacity Reservation IDs to launch instances into.
|
|
3828
|
+
|
|
3808
3829
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-capacityreservationtarget.html#cfn-autoscaling-autoscalinggroup-capacityreservationtarget-capacityreservationids
|
|
3809
3830
|
'''
|
|
3810
3831
|
result = self._values.get("capacity_reservation_ids")
|
|
@@ -3814,7 +3835,8 @@ class CfnAutoScalingGroup(
|
|
|
3814
3835
|
def capacity_reservation_resource_group_arns(
|
|
3815
3836
|
self,
|
|
3816
3837
|
) -> typing.Optional[typing.List[builtins.str]]:
|
|
3817
|
-
'''
|
|
3838
|
+
'''The resource group ARNs of the Capacity Reservation to launch instances into.
|
|
3839
|
+
|
|
3818
3840
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-capacityreservationtarget.html#cfn-autoscaling-autoscalinggroup-capacityreservationtarget-capacityreservationresourcegrouparns
|
|
3819
3841
|
'''
|
|
3820
3842
|
result = self._values.get("capacity_reservation_resource_group_arns")
|
|
@@ -3842,8 +3864,9 @@ class CfnAutoScalingGroup(
|
|
|
3842
3864
|
*,
|
|
3843
3865
|
references: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnAutoScalingGroup.PerformanceFactorReferenceRequestProperty", typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
3844
3866
|
) -> None:
|
|
3845
|
-
'''
|
|
3846
|
-
|
|
3867
|
+
'''The CPU performance to consider, using an instance family as the baseline reference.
|
|
3868
|
+
|
|
3869
|
+
:param references: Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture differences. .. epigraph:: Currently only one instance family can be specified in the list.
|
|
3847
3870
|
|
|
3848
3871
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-cpuperformancefactorrequest.html
|
|
3849
3872
|
:exampleMetadata: fixture=_generated
|
|
@@ -3871,7 +3894,13 @@ class CfnAutoScalingGroup(
|
|
|
3871
3894
|
def references(
|
|
3872
3895
|
self,
|
|
3873
3896
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnAutoScalingGroup.PerformanceFactorReferenceRequestProperty"]]]]:
|
|
3874
|
-
'''
|
|
3897
|
+
'''Specify an instance family to use as the baseline reference for CPU performance.
|
|
3898
|
+
|
|
3899
|
+
All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture differences.
|
|
3900
|
+
.. epigraph::
|
|
3901
|
+
|
|
3902
|
+
Currently only one instance family can be specified in the list.
|
|
3903
|
+
|
|
3875
3904
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-cpuperformancefactorrequest.html#cfn-autoscaling-autoscalinggroup-cpuperformancefactorrequest-references
|
|
3876
3905
|
'''
|
|
3877
3906
|
result = self._values.get("references")
|
|
@@ -4061,7 +4090,7 @@ class CfnAutoScalingGroup(
|
|
|
4061
4090
|
:param allowed_instance_types: The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes. You can use strings with one or more wild cards, represented by an asterisk ( ``*`` ), to allow an instance type, size, or generation. The following are examples: ``m5.8xlarge`` , ``c5*.*`` , ``m5a.*`` , ``r*`` , ``*3*`` . For example, if you specify ``c5*`` , Amazon EC2 Auto Scaling will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*`` , Amazon EC2 Auto Scaling will allow all the M5a instance types, but not the M5n instance types. .. epigraph:: If you specify ``AllowedInstanceTypes`` , you can't specify ``ExcludedInstanceTypes`` . Default: All instance types
|
|
4062
4091
|
:param bare_metal: Indicates whether bare metal instance types are included, excluded, or required. Default: ``excluded``
|
|
4063
4092
|
:param baseline_ebs_bandwidth_mbps: The minimum and maximum baseline bandwidth performance for an instance type, in Mbps. For more information, see `Amazon EBS–optimized instances <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html>`_ in the *Amazon EC2 User Guide for Linux Instances* . Default: No minimum or maximum limits
|
|
4064
|
-
:param baseline_performance_factors:
|
|
4093
|
+
:param baseline_performance_factors: The baseline performance factors for the instance requirements.
|
|
4065
4094
|
:param burstable_performance: Indicates whether burstable performance instance types are included, excluded, or required. For more information, see `Burstable performance instances <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html>`_ in the *Amazon EC2 User Guide for Linux Instances* . Default: ``excluded``
|
|
4066
4095
|
:param cpu_manufacturers: Lists which specific CPU manufacturers to include. - For instance types with Intel CPUs, specify ``intel`` . - For instance types with AMD CPUs, specify ``amd`` . - For instance types with AWS CPUs, specify ``amazon-web-services`` . .. epigraph:: Don't confuse the CPU hardware manufacturer with the CPU hardware architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. Default: Any manufacturer
|
|
4067
4096
|
:param excluded_instance_types: The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk ( ``*`` ), to exclude an instance family, type, size, or generation. The following are examples: ``m5.8xlarge`` , ``c5*.*`` , ``m5a.*`` , ``r*`` , ``*3*`` . For example, if you specify ``c5*`` , you are excluding the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*`` , Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n instance types. .. epigraph:: If you specify ``ExcludedInstanceTypes`` , you can't specify ``AllowedInstanceTypes`` . Default: No excluded instance types
|
|
@@ -4333,7 +4362,8 @@ class CfnAutoScalingGroup(
|
|
|
4333
4362
|
def baseline_performance_factors(
|
|
4334
4363
|
self,
|
|
4335
4364
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAutoScalingGroup.BaselinePerformanceFactorsRequestProperty"]]:
|
|
4336
|
-
'''
|
|
4365
|
+
'''The baseline performance factors for the instance requirements.
|
|
4366
|
+
|
|
4337
4367
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancerequirements.html#cfn-autoscaling-autoscalinggroup-instancerequirements-baselineperformancefactors
|
|
4338
4368
|
'''
|
|
4339
4369
|
result = self._values.get("baseline_performance_factors")
|
|
@@ -6072,8 +6102,14 @@ class CfnAutoScalingGroup(
|
|
|
6072
6102
|
*,
|
|
6073
6103
|
instance_family: typing.Optional[builtins.str] = None,
|
|
6074
6104
|
) -> None:
|
|
6075
|
-
'''
|
|
6076
|
-
|
|
6105
|
+
'''Specify an instance family to use as the baseline reference for CPU performance.
|
|
6106
|
+
|
|
6107
|
+
All instance types that All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture differences.
|
|
6108
|
+
.. epigraph::
|
|
6109
|
+
|
|
6110
|
+
Currently only one instance family can be specified in the list.
|
|
6111
|
+
|
|
6112
|
+
:param instance_family: The instance family to use as a baseline reference. .. epigraph:: Make sure that you specify the correct value for the instance family. The instance family is everything before the period (.) in the instance type name. For example, in the instance ``c6i.large`` , the instance family is ``c6i`` , not ``c6`` . For more information, see `Amazon EC2 instance type naming conventions <https://docs.aws.amazon.com/ec2/latest/instancetypes/instance-type-names.html>`_ in *Amazon EC2 Instance Types* . The following instance types are *not supported* for performance protection. - ``c1`` - ``g3| g3s`` - ``hpc7g`` - ``m1| m2`` - ``mac1 | mac2 | mac2-m1ultra | mac2-m2 | mac2-m2pro`` - ``p3dn | p4d | p5`` - ``t1`` - ``u-12tb1 | u-18tb1 | u-24tb1 | u-3tb1 | u-6tb1 | u-9tb1 | u7i-12tb | u7in-16tb | u7in-24tb | u7in-32tb`` If you performance protection by specifying a supported instance family, the returned instance types will exclude the preceding unsupported instance families. If you specify an unsupported instance family as a value for baseline performance, the API returns an empty response.
|
|
6077
6113
|
|
|
6078
6114
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-performancefactorreferencerequest.html
|
|
6079
6115
|
:exampleMetadata: fixture=_generated
|
|
@@ -6097,7 +6133,27 @@ class CfnAutoScalingGroup(
|
|
|
6097
6133
|
|
|
6098
6134
|
@builtins.property
|
|
6099
6135
|
def instance_family(self) -> typing.Optional[builtins.str]:
|
|
6100
|
-
'''
|
|
6136
|
+
'''The instance family to use as a baseline reference.
|
|
6137
|
+
|
|
6138
|
+
.. epigraph::
|
|
6139
|
+
|
|
6140
|
+
Make sure that you specify the correct value for the instance family. The instance family is everything before the period (.) in the instance type name. For example, in the instance ``c6i.large`` , the instance family is ``c6i`` , not ``c6`` . For more information, see `Amazon EC2 instance type naming conventions <https://docs.aws.amazon.com/ec2/latest/instancetypes/instance-type-names.html>`_ in *Amazon EC2 Instance Types* .
|
|
6141
|
+
|
|
6142
|
+
The following instance types are *not supported* for performance protection.
|
|
6143
|
+
|
|
6144
|
+
- ``c1``
|
|
6145
|
+
- ``g3| g3s``
|
|
6146
|
+
- ``hpc7g``
|
|
6147
|
+
- ``m1| m2``
|
|
6148
|
+
- ``mac1 | mac2 | mac2-m1ultra | mac2-m2 | mac2-m2pro``
|
|
6149
|
+
- ``p3dn | p4d | p5``
|
|
6150
|
+
- ``t1``
|
|
6151
|
+
- ``u-12tb1 | u-18tb1 | u-24tb1 | u-3tb1 | u-6tb1 | u-9tb1 | u7i-12tb | u7in-16tb | u7in-24tb | u7in-32tb``
|
|
6152
|
+
|
|
6153
|
+
If you performance protection by specifying a supported instance family, the returned instance types will exclude the preceding unsupported instance families.
|
|
6154
|
+
|
|
6155
|
+
If you specify an unsupported instance family as a value for baseline performance, the API returns an empty response.
|
|
6156
|
+
|
|
6101
6157
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-performancefactorreferencerequest.html#cfn-autoscaling-autoscalinggroup-performancefactorreferencerequest-instancefamily
|
|
6102
6158
|
'''
|
|
6103
6159
|
result = self._values.get("instance_family")
|
|
@@ -6533,7 +6589,7 @@ class CfnAutoScalingGroupProps:
|
|
|
6533
6589
|
:param availability_zone_impairment_policy: The Availability Zone impairment policy.
|
|
6534
6590
|
:param availability_zones: A list of Availability Zones where instances in the Auto Scaling group can be created. Used for launching into the default VPC subnet in each Availability Zone when not using the ``VPCZoneIdentifier`` property, or for attaching a network interface when an existing network interface ID is specified in a launch template.
|
|
6535
6591
|
:param capacity_rebalance: Indicates whether Capacity Rebalancing is enabled. Otherwise, Capacity Rebalancing is disabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of interruption. After launching a new instance, it then terminates an old instance. For more information, see `Use Capacity Rebalancing to handle Amazon EC2 Spot Interruptions <https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-capacity-rebalancing.html>`_ in the in the *Amazon EC2 Auto Scaling User Guide* .
|
|
6536
|
-
:param capacity_reservation_specification:
|
|
6592
|
+
:param capacity_reservation_specification: The capacity reservation specification.
|
|
6537
6593
|
:param context: Reserved.
|
|
6538
6594
|
:param cooldown: *Only needed if you use simple scaling policies.*. The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see `Scaling cooldowns for Amazon EC2 Auto Scaling <https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scaling-cooldowns.html>`_ in the *Amazon EC2 Auto Scaling User Guide* . Default: ``300`` seconds
|
|
6539
6595
|
:param default_instance_warmup: The amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the ``InService`` state. During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see `Set the default instance warmup for an Auto Scaling group <https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-default-instance-warmup.html>`_ in the *Amazon EC2 Auto Scaling User Guide* . .. epigraph:: To manage various warm-up settings at the group level, we recommend that you set the default instance warmup, *even if it is set to 0 seconds* . To remove a value that you previously set, include the property but specify ``-1`` for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of ``0`` or other nominal value. Default: None
|
|
@@ -6956,7 +7012,8 @@ class CfnAutoScalingGroupProps:
|
|
|
6956
7012
|
def capacity_reservation_specification(
|
|
6957
7013
|
self,
|
|
6958
7014
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnAutoScalingGroup.CapacityReservationSpecificationProperty]]:
|
|
6959
|
-
'''
|
|
7015
|
+
'''The capacity reservation specification.
|
|
7016
|
+
|
|
6960
7017
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-capacityreservationspecification
|
|
6961
7018
|
'''
|
|
6962
7019
|
result = self._values.get("capacity_reservation_specification")
|
|
@@ -9570,7 +9627,7 @@ class CfnScalingPolicy(
|
|
|
9570
9627
|
:param metric_name: The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the `Metric <https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html>`_ object that is returned by a call to `ListMetrics <https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html>`_ .
|
|
9571
9628
|
:param metrics: The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions.
|
|
9572
9629
|
:param namespace: The namespace of the metric.
|
|
9573
|
-
:param period:
|
|
9630
|
+
:param period: The period of the metric in seconds. The default value is 60. Accepted values are 10, 30, and 60. For high resolution metric, set the value to less than 60. For more information, see `Create a target tracking policy using high-resolution metrics for faster response <https://docs.aws.amazon.com/autoscaling/ec2/userguide/policy-creating-high-resolution-metrics.html>`_ .
|
|
9574
9631
|
:param statistic: The statistic of the metric.
|
|
9575
9632
|
:param unit: The unit of the metric. For a complete list of the units that CloudWatch supports, see the `MetricDatum <https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html>`_ data type in the *Amazon CloudWatch API Reference* .
|
|
9576
9633
|
|
|
@@ -9694,7 +9751,10 @@ class CfnScalingPolicy(
|
|
|
9694
9751
|
|
|
9695
9752
|
@builtins.property
|
|
9696
9753
|
def period(self) -> typing.Optional[jsii.Number]:
|
|
9697
|
-
'''
|
|
9754
|
+
'''The period of the metric in seconds.
|
|
9755
|
+
|
|
9756
|
+
The default value is 60. Accepted values are 10, 30, and 60. For high resolution metric, set the value to less than 60. For more information, see `Create a target tracking policy using high-resolution metrics for faster response <https://docs.aws.amazon.com/autoscaling/ec2/userguide/policy-creating-high-resolution-metrics.html>`_ .
|
|
9757
|
+
|
|
9698
9758
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-customizedmetricspecification.html#cfn-autoscaling-scalingpolicy-customizedmetricspecification-period
|
|
9699
9759
|
'''
|
|
9700
9760
|
result = self._values.get("period")
|
|
@@ -11655,7 +11715,7 @@ class CfnScalingPolicy(
|
|
|
11655
11715
|
:param expression: The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the ``Id`` of the other metrics to refer to those metrics, and can also use the ``Id`` of other expressions to use the result of those expressions. Conditional: Within each ``TargetTrackingMetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat`` , but not both.
|
|
11656
11716
|
:param label: A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents.
|
|
11657
11717
|
:param metric_stat: Information about the metric data to return. Conditional: Within each ``TargetTrackingMetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat`` , but not both.
|
|
11658
|
-
:param period:
|
|
11718
|
+
:param period: The period of the metric in seconds. The default value is 60. Accepted values are 10, 30, and 60. For high resolution metric, set the value to less than 60. For more information, see `Create a target tracking policy using high-resolution metrics for faster response <https://docs.aws.amazon.com/autoscaling/ec2/userguide/policy-creating-high-resolution-metrics.html>`_ .
|
|
11659
11719
|
:param return_data: Indicates whether to return the timestamps and raw data values of this metric. If you use any math expressions, specify ``true`` for this value for only the final math expression that the metric specification is based on. You must specify ``false`` for ``ReturnData`` for all the other metrics and expressions used in the metric specification. If you are only retrieving metrics and not performing any math expressions, do not specify anything for ``ReturnData`` . This sets it to its default ( ``true`` ).
|
|
11660
11720
|
|
|
11661
11721
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingmetricdataquery.html
|
|
@@ -11767,7 +11827,10 @@ class CfnScalingPolicy(
|
|
|
11767
11827
|
|
|
11768
11828
|
@builtins.property
|
|
11769
11829
|
def period(self) -> typing.Optional[jsii.Number]:
|
|
11770
|
-
'''
|
|
11830
|
+
'''The period of the metric in seconds.
|
|
11831
|
+
|
|
11832
|
+
The default value is 60. Accepted values are 10, 30, and 60. For high resolution metric, set the value to less than 60. For more information, see `Create a target tracking policy using high-resolution metrics for faster response <https://docs.aws.amazon.com/autoscaling/ec2/userguide/policy-creating-high-resolution-metrics.html>`_ .
|
|
11833
|
+
|
|
11771
11834
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingmetricdataquery.html#cfn-autoscaling-scalingpolicy-targettrackingmetricdataquery-period
|
|
11772
11835
|
'''
|
|
11773
11836
|
result = self._values.get("period")
|
|
@@ -11826,7 +11889,7 @@ class CfnScalingPolicy(
|
|
|
11826
11889
|
|
|
11827
11890
|
:param metric: The metric to use.
|
|
11828
11891
|
:param stat: The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in `Statistics <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic>`_ in the *Amazon CloudWatch User Guide* . The most commonly used metric for scaling is ``Average`` .
|
|
11829
|
-
:param period:
|
|
11892
|
+
:param period: The period of the metric in seconds. The default value is 60. Accepted values are 10, 30, and 60. For high resolution metric, set the value to less than 60. For more information, see `Create a target tracking policy using high-resolution metrics for faster response <https://docs.aws.amazon.com/autoscaling/ec2/userguide/policy-creating-high-resolution-metrics.html>`_ .
|
|
11830
11893
|
:param unit: The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the `MetricDatum <https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html>`_ data type in the *Amazon CloudWatch API Reference* .
|
|
11831
11894
|
|
|
11832
11895
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingmetricstat.html
|
|
@@ -11899,7 +11962,10 @@ class CfnScalingPolicy(
|
|
|
11899
11962
|
|
|
11900
11963
|
@builtins.property
|
|
11901
11964
|
def period(self) -> typing.Optional[jsii.Number]:
|
|
11902
|
-
'''
|
|
11965
|
+
'''The period of the metric in seconds.
|
|
11966
|
+
|
|
11967
|
+
The default value is 60. Accepted values are 10, 30, and 60. For high resolution metric, set the value to less than 60. For more information, see `Create a target tracking policy using high-resolution metrics for faster response <https://docs.aws.amazon.com/autoscaling/ec2/userguide/policy-creating-high-resolution-metrics.html>`_ .
|
|
11968
|
+
|
|
11903
11969
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingmetricstat.html#cfn-autoscaling-scalingpolicy-targettrackingmetricstat-period
|
|
11904
11970
|
'''
|
|
11905
11971
|
result = self._values.get("period")
|
aws_cdk/aws_bedrock/__init__.py
CHANGED
|
@@ -635,10 +635,10 @@ class CfnAgent(
|
|
|
635
635
|
) -> None:
|
|
636
636
|
'''Contains details about the OpenAPI schema for the action group.
|
|
637
637
|
|
|
638
|
-
For more information, see `Action group OpenAPI schemas <https://docs.aws.amazon.com
|
|
638
|
+
For more information, see `Action group OpenAPI schemas <https://docs.aws.amazon.com//bedrock/latest/userguide/agents-api-schema.html>`_ . You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.
|
|
639
639
|
|
|
640
|
-
:param payload: The JSON or YAML-formatted payload defining the OpenAPI schema for the action group.
|
|
641
|
-
:param s3: Contains details about the S3 object containing the OpenAPI schema for the action group.
|
|
640
|
+
:param payload: The JSON or YAML-formatted payload defining the OpenAPI schema for the action group.
|
|
641
|
+
:param s3: Contains details about the S3 object containing the OpenAPI schema for the action group.
|
|
642
642
|
|
|
643
643
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-apischema.html
|
|
644
644
|
:exampleMetadata: fixture=_generated
|
|
@@ -671,8 +671,6 @@ class CfnAgent(
|
|
|
671
671
|
def payload(self) -> typing.Optional[builtins.str]:
|
|
672
672
|
'''The JSON or YAML-formatted payload defining the OpenAPI schema for the action group.
|
|
673
673
|
|
|
674
|
-
For more information, see `Action group OpenAPI schemas <https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html>`_ .
|
|
675
|
-
|
|
676
674
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-apischema.html#cfn-bedrock-agent-apischema-payload
|
|
677
675
|
'''
|
|
678
676
|
result = self._values.get("payload")
|
|
@@ -684,8 +682,6 @@ class CfnAgent(
|
|
|
684
682
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAgent.S3IdentifierProperty"]]:
|
|
685
683
|
'''Contains details about the S3 object containing the OpenAPI schema for the action group.
|
|
686
684
|
|
|
687
|
-
For more information, see `Action group OpenAPI schemas <https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html>`_ .
|
|
688
|
-
|
|
689
685
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-apischema.html#cfn-bedrock-agent-apischema-s3
|
|
690
686
|
'''
|
|
691
687
|
result = self._values.get("s3")
|
|
@@ -716,7 +712,7 @@ class CfnAgent(
|
|
|
716
712
|
) -> None:
|
|
717
713
|
'''Contains details about the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
|
|
718
714
|
|
|
719
|
-
:param custom_control: To return the action group invocation results directly in the ``
|
|
715
|
+
:param custom_control: To return the action group invocation results directly in the ``InvokeInlineAgent`` response, specify ``RETURN_CONTROL`` .
|
|
720
716
|
:param lambda_: The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
|
|
721
717
|
|
|
722
718
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-actiongroupexecutor.html
|
|
@@ -745,7 +741,7 @@ class CfnAgent(
|
|
|
745
741
|
|
|
746
742
|
@builtins.property
|
|
747
743
|
def custom_control(self) -> typing.Optional[builtins.str]:
|
|
748
|
-
'''To return the action group invocation results directly in the ``
|
|
744
|
+
'''To return the action group invocation results directly in the ``InvokeInlineAgent`` response, specify ``RETURN_CONTROL`` .
|
|
749
745
|
|
|
750
746
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-actiongroupexecutor.html#cfn-bedrock-agent-actiongroupexecutor-customcontrol
|
|
751
747
|
'''
|
|
@@ -799,14 +795,14 @@ class CfnAgent(
|
|
|
799
795
|
parent_action_group_signature: typing.Optional[builtins.str] = None,
|
|
800
796
|
skip_resource_in_use_check_on_delete: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
|
|
801
797
|
) -> None:
|
|
802
|
-
'''Contains details
|
|
798
|
+
'''Contains details of the inline agent's action group.
|
|
803
799
|
|
|
804
800
|
:param action_group_name: The name of the action group.
|
|
805
801
|
:param action_group_executor: The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
|
|
806
802
|
:param action_group_state: Specifies whether the action group is available for the agent to invoke or not when sending an `InvokeAgent <https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html>`_ request.
|
|
807
|
-
:param api_schema: Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see `Action group OpenAPI schemas <https://docs.aws.amazon.com
|
|
808
|
-
:param description:
|
|
809
|
-
:param function_schema:
|
|
803
|
+
:param api_schema: Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see `Action group OpenAPI schemas <https://docs.aws.amazon.com//bedrock/latest/userguide/agents-api-schema.html>`_ .
|
|
804
|
+
:param description: A description of the action group.
|
|
805
|
+
:param function_schema: Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
|
|
810
806
|
:param parent_action_group_signature: If this field is set as ``AMAZON.UserInput`` , the agent can request the user for additional information when trying to complete a task. The ``description`` , ``apiSchema`` , and ``actionGroupExecutor`` fields must be blank for this action group. During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an `Observation <https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html>`_ reprompting the user for more information.
|
|
811
807
|
:param skip_resource_in_use_check_on_delete: Specifies whether to delete the resource even if it's in use. By default, this value is ``false`` . Default: - false
|
|
812
808
|
|
|
@@ -921,7 +917,7 @@ class CfnAgent(
|
|
|
921
917
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAgent.APISchemaProperty"]]:
|
|
922
918
|
'''Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema.
|
|
923
919
|
|
|
924
|
-
For more information, see `Action group OpenAPI schemas <https://docs.aws.amazon.com
|
|
920
|
+
For more information, see `Action group OpenAPI schemas <https://docs.aws.amazon.com//bedrock/latest/userguide/agents-api-schema.html>`_ .
|
|
925
921
|
|
|
926
922
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html#cfn-bedrock-agent-agentactiongroup-apischema
|
|
927
923
|
'''
|
|
@@ -930,7 +926,7 @@ class CfnAgent(
|
|
|
930
926
|
|
|
931
927
|
@builtins.property
|
|
932
928
|
def description(self) -> typing.Optional[builtins.str]:
|
|
933
|
-
'''
|
|
929
|
+
'''A description of the action group.
|
|
934
930
|
|
|
935
931
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html#cfn-bedrock-agent-agentactiongroup-description
|
|
936
932
|
'''
|
|
@@ -941,9 +937,7 @@ class CfnAgent(
|
|
|
941
937
|
def function_schema(
|
|
942
938
|
self,
|
|
943
939
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAgent.FunctionSchemaProperty"]]:
|
|
944
|
-
'''
|
|
945
|
-
|
|
946
|
-
Each function represents an action in an action group.
|
|
940
|
+
'''Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
|
|
947
941
|
|
|
948
942
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html#cfn-bedrock-agent-agentactiongroup-functionschema
|
|
949
943
|
'''
|
|
@@ -1202,17 +1196,7 @@ class CfnAgent(
|
|
|
1202
1196
|
*,
|
|
1203
1197
|
functions: typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnAgent.FunctionProperty", typing.Dict[builtins.str, typing.Any]]]]],
|
|
1204
1198
|
) -> None:
|
|
1205
|
-
'''
|
|
1206
|
-
|
|
1207
|
-
Each function represents an action in an action group.
|
|
1208
|
-
|
|
1209
|
-
This data type is used in the following API operations:
|
|
1210
|
-
|
|
1211
|
-
- `CreateAgentActionGroup request <https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_RequestSyntax>`_
|
|
1212
|
-
- `CreateAgentActionGroup response <https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_ResponseSyntax>`_
|
|
1213
|
-
- `UpdateAgentActionGroup request <https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_RequestSyntax>`_
|
|
1214
|
-
- `UpdateAgentActionGroup response <https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_ResponseSyntax>`_
|
|
1215
|
-
- `GetAgentActionGroup response <https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetAgentActionGroup.html#API_agent_GetAgentActionGroup_ResponseSyntax>`_
|
|
1199
|
+
'''Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
|
|
1216
1200
|
|
|
1217
1201
|
:param functions: A list of functions that each define an action in the action group.
|
|
1218
1202
|
|
|
@@ -1500,14 +1484,6 @@ class CfnAgent(
|
|
|
1500
1484
|
) -> None:
|
|
1501
1485
|
'''Contains details about a parameter in a function for an action group.
|
|
1502
1486
|
|
|
1503
|
-
This data type is used in the following API operations:
|
|
1504
|
-
|
|
1505
|
-
- `CreateAgentActionGroup request <https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_RequestSyntax>`_
|
|
1506
|
-
- `CreateAgentActionGroup response <https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_ResponseSyntax>`_
|
|
1507
|
-
- `UpdateAgentActionGroup request <https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_RequestSyntax>`_
|
|
1508
|
-
- `UpdateAgentActionGroup response <https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_ResponseSyntax>`_
|
|
1509
|
-
- `GetAgentActionGroup response <https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetAgentActionGroup.html#API_agent_GetAgentActionGroup_ResponseSyntax>`_
|
|
1510
|
-
|
|
1511
1487
|
:param type: The data type of the parameter.
|
|
1512
1488
|
:param description: A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.
|
|
1513
1489
|
:param required: Whether the parameter is required for the agent to complete the function for action group invocation.
|
|
@@ -1616,7 +1592,7 @@ class CfnAgent(
|
|
|
1616
1592
|
:param inference_configuration: Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the ``promptType`` . For more information, see `Inference parameters for foundation models <https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html>`_ .
|
|
1617
1593
|
:param parser_mode: Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the ``promptType`` . If you set the field as ``OVERRIDEN`` , the ``overrideLambda`` field in the `PromptOverrideConfiguration <https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html>`_ must be specified with the ARN of a Lambda function.
|
|
1618
1594
|
:param prompt_creation_mode: Specifies whether to override the default prompt template for this ``promptType`` . Set this value to ``OVERRIDDEN`` to use the prompt that you provide in the ``basePromptTemplate`` . If you leave it as ``DEFAULT`` , the agent uses a default prompt template.
|
|
1619
|
-
:param prompt_state: Specifies whether to allow the agent to carry out the step specified in the ``promptType`` . If you set this value to ``DISABLED`` , the agent skips that step. The default state for each ``promptType`` is as follows. - ``PRE_PROCESSING`` – ``ENABLED`` - ``ORCHESTRATION`` – ``ENABLED`` - ``KNOWLEDGE_BASE_RESPONSE_GENERATION`` – ``ENABLED`` - ``POST_PROCESSING`` – ``DISABLED``
|
|
1595
|
+
:param prompt_state: Specifies whether to allow the inline agent to carry out the step specified in the ``promptType`` . If you set this value to ``DISABLED`` , the agent skips that step. The default state for each ``promptType`` is as follows. - ``PRE_PROCESSING`` – ``ENABLED`` - ``ORCHESTRATION`` – ``ENABLED`` - ``KNOWLEDGE_BASE_RESPONSE_GENERATION`` – ``ENABLED`` - ``POST_PROCESSING`` – ``DISABLED``
|
|
1620
1596
|
:param prompt_type: The step in the agent sequence that this prompt configuration applies to.
|
|
1621
1597
|
|
|
1622
1598
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-promptconfiguration.html
|
|
@@ -1713,7 +1689,7 @@ class CfnAgent(
|
|
|
1713
1689
|
|
|
1714
1690
|
@builtins.property
|
|
1715
1691
|
def prompt_state(self) -> typing.Optional[builtins.str]:
|
|
1716
|
-
'''Specifies whether to allow the agent to carry out the step specified in the ``promptType`` .
|
|
1692
|
+
'''Specifies whether to allow the inline agent to carry out the step specified in the ``promptType`` .
|
|
1717
1693
|
|
|
1718
1694
|
If you set this value to ``DISABLED`` , the agent skips that step. The default state for each ``promptType`` is as follows.
|
|
1719
1695
|
|
|
@@ -16779,7 +16755,7 @@ class CfnKnowledgeBase(
|
|
|
16779
16755
|
:param name: The name of the knowledge base.
|
|
16780
16756
|
:param role_arn: The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
|
|
16781
16757
|
:param storage_configuration: Contains details about the storage configuration of the knowledge base.
|
|
16782
|
-
:param description: The description of the knowledge base.
|
|
16758
|
+
:param description: The description of the knowledge base associated with the inline agent.
|
|
16783
16759
|
:param tags: Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:. - `Tag naming limits and requirements <https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-conventions>`_ - `Tagging best practices <https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-best-practices>`_
|
|
16784
16760
|
'''
|
|
16785
16761
|
if __debug__:
|
|
@@ -16857,7 +16833,7 @@ class CfnKnowledgeBase(
|
|
|
16857
16833
|
@builtins.property
|
|
16858
16834
|
@jsii.member(jsii_name="attrKnowledgeBaseId")
|
|
16859
16835
|
def attr_knowledge_base_id(self) -> builtins.str:
|
|
16860
|
-
'''The unique identifier
|
|
16836
|
+
'''The unique identifier for a knowledge base associated with the inline agent.
|
|
16861
16837
|
|
|
16862
16838
|
:cloudformationAttribute: KnowledgeBaseId
|
|
16863
16839
|
'''
|
|
@@ -16957,7 +16933,7 @@ class CfnKnowledgeBase(
|
|
|
16957
16933
|
@builtins.property
|
|
16958
16934
|
@jsii.member(jsii_name="description")
|
|
16959
16935
|
def description(self) -> typing.Optional[builtins.str]:
|
|
16960
|
-
'''The description of the knowledge base.'''
|
|
16936
|
+
'''The description of the knowledge base associated with the inline agent.'''
|
|
16961
16937
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "description"))
|
|
16962
16938
|
|
|
16963
16939
|
@description.setter
|
|
@@ -18059,7 +18035,7 @@ class CfnKnowledgeBaseProps:
|
|
|
18059
18035
|
:param name: The name of the knowledge base.
|
|
18060
18036
|
:param role_arn: The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
|
|
18061
18037
|
:param storage_configuration: Contains details about the storage configuration of the knowledge base.
|
|
18062
|
-
:param description: The description of the knowledge base.
|
|
18038
|
+
:param description: The description of the knowledge base associated with the inline agent.
|
|
18063
18039
|
:param tags: Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:. - `Tag naming limits and requirements <https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-conventions>`_ - `Tagging best practices <https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-best-practices>`_
|
|
18064
18040
|
|
|
18065
18041
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-knowledgebase.html
|
|
@@ -18197,7 +18173,7 @@ class CfnKnowledgeBaseProps:
|
|
|
18197
18173
|
|
|
18198
18174
|
@builtins.property
|
|
18199
18175
|
def description(self) -> typing.Optional[builtins.str]:
|
|
18200
|
-
'''The description of the knowledge base.
|
|
18176
|
+
'''The description of the knowledge base associated with the inline agent.
|
|
18201
18177
|
|
|
18202
18178
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-knowledgebase.html#cfn-bedrock-knowledgebase-description
|
|
18203
18179
|
'''
|
|
@@ -20243,6 +20219,60 @@ class FoundationModelIdentifier(
|
|
|
20243
20219
|
'''Base model "ai21.j2-ultra-v1:0:8k".'''
|
|
20244
20220
|
return typing.cast("FoundationModelIdentifier", jsii.sget(cls, "AI21_LABS_JURASSIC_2_ULTRA_V1_0_8K"))
|
|
20245
20221
|
|
|
20222
|
+
@jsii.python.classproperty
|
|
20223
|
+
@jsii.member(jsii_name="AMAZON_NOVA_CANVAS_V1_0")
|
|
20224
|
+
def AMAZON_NOVA_CANVAS_V1_0(cls) -> "FoundationModelIdentifier":
|
|
20225
|
+
'''Base model "amazon.nova-canvas-v1:0".'''
|
|
20226
|
+
return typing.cast("FoundationModelIdentifier", jsii.sget(cls, "AMAZON_NOVA_CANVAS_V1_0"))
|
|
20227
|
+
|
|
20228
|
+
@jsii.python.classproperty
|
|
20229
|
+
@jsii.member(jsii_name="AMAZON_NOVA_LITE_V1_0")
|
|
20230
|
+
def AMAZON_NOVA_LITE_V1_0(cls) -> "FoundationModelIdentifier":
|
|
20231
|
+
'''Base model "amazon.nova-lite-v1:0".'''
|
|
20232
|
+
return typing.cast("FoundationModelIdentifier", jsii.sget(cls, "AMAZON_NOVA_LITE_V1_0"))
|
|
20233
|
+
|
|
20234
|
+
@jsii.python.classproperty
|
|
20235
|
+
@jsii.member(jsii_name="AMAZON_NOVA_LITE_V1_0_300_K")
|
|
20236
|
+
def AMAZON_NOVA_LITE_V1_0_300_K(cls) -> "FoundationModelIdentifier":
|
|
20237
|
+
'''Base model "amazon.nova-lite-v1:0:300k".'''
|
|
20238
|
+
return typing.cast("FoundationModelIdentifier", jsii.sget(cls, "AMAZON_NOVA_LITE_V1_0_300_K"))
|
|
20239
|
+
|
|
20240
|
+
@jsii.python.classproperty
|
|
20241
|
+
@jsii.member(jsii_name="AMAZON_NOVA_MICRO_V1_0")
|
|
20242
|
+
def AMAZON_NOVA_MICRO_V1_0(cls) -> "FoundationModelIdentifier":
|
|
20243
|
+
'''Base model "amazon.nova-micro-v1:0".'''
|
|
20244
|
+
return typing.cast("FoundationModelIdentifier", jsii.sget(cls, "AMAZON_NOVA_MICRO_V1_0"))
|
|
20245
|
+
|
|
20246
|
+
@jsii.python.classproperty
|
|
20247
|
+
@jsii.member(jsii_name="AMAZON_NOVA_MICRO_V1_0_128_K")
|
|
20248
|
+
def AMAZON_NOVA_MICRO_V1_0_128_K(cls) -> "FoundationModelIdentifier":
|
|
20249
|
+
'''Base model "amazon.nova-micro-v1:0:128k".'''
|
|
20250
|
+
return typing.cast("FoundationModelIdentifier", jsii.sget(cls, "AMAZON_NOVA_MICRO_V1_0_128_K"))
|
|
20251
|
+
|
|
20252
|
+
@jsii.python.classproperty
|
|
20253
|
+
@jsii.member(jsii_name="AMAZON_NOVA_PRO_V1_0")
|
|
20254
|
+
def AMAZON_NOVA_PRO_V1_0(cls) -> "FoundationModelIdentifier":
|
|
20255
|
+
'''Base model "amazon.nova-pro-v1:0".'''
|
|
20256
|
+
return typing.cast("FoundationModelIdentifier", jsii.sget(cls, "AMAZON_NOVA_PRO_V1_0"))
|
|
20257
|
+
|
|
20258
|
+
@jsii.python.classproperty
|
|
20259
|
+
@jsii.member(jsii_name="AMAZON_NOVA_PRO_V1_0_300_K")
|
|
20260
|
+
def AMAZON_NOVA_PRO_V1_0_300_K(cls) -> "FoundationModelIdentifier":
|
|
20261
|
+
'''Base model "amazon.nova-pro-v1:0:300k".'''
|
|
20262
|
+
return typing.cast("FoundationModelIdentifier", jsii.sget(cls, "AMAZON_NOVA_PRO_V1_0_300_K"))
|
|
20263
|
+
|
|
20264
|
+
@jsii.python.classproperty
|
|
20265
|
+
@jsii.member(jsii_name="AMAZON_NOVA_REEL_V1_0")
|
|
20266
|
+
def AMAZON_NOVA_REEL_V1_0(cls) -> "FoundationModelIdentifier":
|
|
20267
|
+
'''Base model "amazon.nova-reel-v1:0".'''
|
|
20268
|
+
return typing.cast("FoundationModelIdentifier", jsii.sget(cls, "AMAZON_NOVA_REEL_V1_0"))
|
|
20269
|
+
|
|
20270
|
+
@jsii.python.classproperty
|
|
20271
|
+
@jsii.member(jsii_name="AMAZON_RERANK_V1")
|
|
20272
|
+
def AMAZON_RERANK_V1(cls) -> "FoundationModelIdentifier":
|
|
20273
|
+
'''Base model "amazon.rerank-v1:0".'''
|
|
20274
|
+
return typing.cast("FoundationModelIdentifier", jsii.sget(cls, "AMAZON_RERANK_V1"))
|
|
20275
|
+
|
|
20246
20276
|
@jsii.python.classproperty
|
|
20247
20277
|
@jsii.member(jsii_name="AMAZON_TITAN_EMBED_G1_TEXT_02")
|
|
20248
20278
|
def AMAZON_TITAN_EMBED_G1_TEXT_02(cls) -> "FoundationModelIdentifier":
|
|
@@ -20530,6 +20560,12 @@ class FoundationModelIdentifier(
|
|
|
20530
20560
|
'''Base model "cohere.embed-multilingual-v3:0:512".'''
|
|
20531
20561
|
return typing.cast("FoundationModelIdentifier", jsii.sget(cls, "COHERE_EMBED_MULTILINGUAL_V3_0_512"))
|
|
20532
20562
|
|
|
20563
|
+
@jsii.python.classproperty
|
|
20564
|
+
@jsii.member(jsii_name="COHERE_RERANK_V3_5")
|
|
20565
|
+
def COHERE_RERANK_V3_5(cls) -> "FoundationModelIdentifier":
|
|
20566
|
+
'''Base model "cohere.rerank-v3-5:0".'''
|
|
20567
|
+
return typing.cast("FoundationModelIdentifier", jsii.sget(cls, "COHERE_RERANK_V3_5"))
|
|
20568
|
+
|
|
20533
20569
|
@jsii.python.classproperty
|
|
20534
20570
|
@jsii.member(jsii_name="META_LLAMA_2_13B_CHAT_V1_0_4K")
|
|
20535
20571
|
def META_LLAMA_2_13_B_CHAT_V1_0_4_K(cls) -> "FoundationModelIdentifier":
|