aws-cdk-lib 2.140.0__py3-none-any.whl → 2.142.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 +9 -1
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.140.0.jsii.tgz → aws-cdk-lib@2.142.0.jsii.tgz} +0 -0
- aws_cdk/aws_appsync/__init__.py +224 -94
- aws_cdk/aws_autoscaling/__init__.py +109 -25
- aws_cdk/aws_bedrock/__init__.py +51 -41
- aws_cdk/aws_cloudfront/__init__.py +34 -78
- aws_cdk/aws_cloudtrail/__init__.py +13 -4
- aws_cdk/aws_codepipeline/__init__.py +364 -27
- aws_cdk/aws_connectcampaigns/__init__.py +2 -2
- aws_cdk/aws_datasync/__init__.py +51 -56
- aws_cdk/aws_docdb/__init__.py +181 -4
- aws_cdk/aws_dynamodb/__init__.py +410 -0
- aws_cdk/aws_ec2/__init__.py +91 -42
- aws_cdk/aws_ecr/__init__.py +32 -7
- aws_cdk/aws_ecs/__init__.py +65 -18
- aws_cdk/aws_eks/__init__.py +36 -3
- aws_cdk/aws_entityresolution/__init__.py +6 -2
- aws_cdk/aws_events/__init__.py +46 -25
- aws_cdk/aws_events_targets/__init__.py +341 -0
- aws_cdk/aws_fms/__init__.py +7 -7
- aws_cdk/aws_gamelift/__init__.py +261 -160
- aws_cdk/aws_iam/__init__.py +13 -8
- aws_cdk/aws_ivs/__init__.py +1 -3
- aws_cdk/aws_kms/__init__.py +11 -5
- aws_cdk/aws_lambda_nodejs/__init__.py +3 -0
- aws_cdk/aws_location/__init__.py +8 -4
- aws_cdk/aws_logs/__init__.py +6 -6
- aws_cdk/aws_oam/__init__.py +45 -11
- aws_cdk/aws_omics/__init__.py +4 -4
- aws_cdk/aws_paymentcryptography/__init__.py +128 -48
- aws_cdk/aws_pinpoint/__init__.py +7 -5
- aws_cdk/aws_qbusiness/__init__.py +620 -294
- aws_cdk/aws_quicksight/__init__.py +103 -40
- aws_cdk/aws_rds/__init__.py +80 -16
- aws_cdk/aws_route53profiles/__init__.py +49 -49
- aws_cdk/aws_s3/__init__.py +9 -2
- aws_cdk/aws_sagemaker/__init__.py +30 -30
- aws_cdk/aws_servicecatalog/__init__.py +27 -4
- aws_cdk/aws_ses/__init__.py +9 -9
- aws_cdk/aws_stepfunctions_tasks/__init__.py +7 -6
- aws_cdk/aws_transfer/__init__.py +4 -4
- aws_cdk/aws_voiceid/__init__.py +2 -2
- {aws_cdk_lib-2.140.0.dist-info → aws_cdk_lib-2.142.0.dist-info}/METADATA +10 -2
- {aws_cdk_lib-2.140.0.dist-info → aws_cdk_lib-2.142.0.dist-info}/RECORD +49 -49
- {aws_cdk_lib-2.140.0.dist-info → aws_cdk_lib-2.142.0.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.140.0.dist-info → aws_cdk_lib-2.142.0.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.140.0.dist-info → aws_cdk_lib-2.142.0.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.140.0.dist-info → aws_cdk_lib-2.142.0.dist-info}/top_level.txt +0 -0
|
@@ -24,7 +24,8 @@ autoscaling.AutoScalingGroup(self, "ASG",
|
|
|
24
24
|
Creating an `AutoScalingGroup` from a Launch Configuration has been deprecated. All new accounts created after December 31, 2023 will no longer be able to create Launch Configurations. With the `@aws-cdk/aws-autoscaling:generateLaunchTemplateInsteadOfLaunchConfig` feature flag set to true, `AutoScalingGroup` properties used to create a Launch Configuration will now be used to create a `LaunchTemplate` using a [Launch Configuration to `LaunchTemplate` mapping](https://docs.aws.amazon.com/autoscaling/ec2/userguide/migrate-launch-configurations-with-cloudformation.html#launch-configuration-mapping-reference). Specifically, the following `AutoScalingGroup` properties will be used to generate a `LaunchTemplate`:
|
|
25
25
|
|
|
26
26
|
* machineImage
|
|
27
|
-
* keyName
|
|
27
|
+
* keyName (deprecated, prefer keyPair)
|
|
28
|
+
* keyPair
|
|
28
29
|
* instanceType
|
|
29
30
|
* instanceMonitoring
|
|
30
31
|
* securityGroup
|
|
@@ -753,6 +754,31 @@ autoscaling.AutoScalingGroup(self, "ASG",
|
|
|
753
754
|
)
|
|
754
755
|
```
|
|
755
756
|
|
|
757
|
+
## Configuring KeyPair for instances
|
|
758
|
+
|
|
759
|
+
You can use a keyPair to build your asg when you decide not to use a ready-made LanchTemplate.
|
|
760
|
+
|
|
761
|
+
To configure KeyPair for an autoscaling group, pass the `keyPair` as a prop:
|
|
762
|
+
|
|
763
|
+
```python
|
|
764
|
+
# vpc: ec2.Vpc
|
|
765
|
+
# instance_type: ec2.InstanceType
|
|
766
|
+
# machine_image: ec2.IMachineImage
|
|
767
|
+
|
|
768
|
+
|
|
769
|
+
my_key_pair = ec2.KeyPair(self, "MyKeyPair")
|
|
770
|
+
|
|
771
|
+
autoscaling.AutoScalingGroup(self, "ASG",
|
|
772
|
+
vpc=vpc,
|
|
773
|
+
instance_type=instance_type,
|
|
774
|
+
machine_image=machine_image,
|
|
775
|
+
|
|
776
|
+
# ...
|
|
777
|
+
|
|
778
|
+
key_pair=my_key_pair
|
|
779
|
+
)
|
|
780
|
+
```
|
|
781
|
+
|
|
756
782
|
## Future work
|
|
757
783
|
|
|
758
784
|
* [ ] CloudWatch Events (impossible to add currently as the AutoScalingGroup ARN is
|
|
@@ -794,6 +820,7 @@ from ..aws_ec2 import (
|
|
|
794
820
|
CloudFormationInit as _CloudFormationInit_2bb1d1b2,
|
|
795
821
|
Connections as _Connections_0f31fce8,
|
|
796
822
|
IConnectable as _IConnectable_10015a05,
|
|
823
|
+
IKeyPair as _IKeyPair_bc344eda,
|
|
797
824
|
ILaunchTemplate as _ILaunchTemplate_f32c0fd7,
|
|
798
825
|
IMachineImage as _IMachineImage_0e8bd50b,
|
|
799
826
|
ISecurityGroup as _ISecurityGroup_acf8a799,
|
|
@@ -11884,6 +11911,7 @@ class CfnWarmPoolProps:
|
|
|
11884
11911
|
"ignore_unmodified_size_properties": "ignoreUnmodifiedSizeProperties",
|
|
11885
11912
|
"instance_monitoring": "instanceMonitoring",
|
|
11886
11913
|
"key_name": "keyName",
|
|
11914
|
+
"key_pair": "keyPair",
|
|
11887
11915
|
"max_capacity": "maxCapacity",
|
|
11888
11916
|
"max_instance_lifetime": "maxInstanceLifetime",
|
|
11889
11917
|
"min_capacity": "minCapacity",
|
|
@@ -11915,6 +11943,7 @@ class CommonAutoScalingGroupProps:
|
|
|
11915
11943
|
ignore_unmodified_size_properties: typing.Optional[builtins.bool] = None,
|
|
11916
11944
|
instance_monitoring: typing.Optional["Monitoring"] = None,
|
|
11917
11945
|
key_name: typing.Optional[builtins.str] = None,
|
|
11946
|
+
key_pair: typing.Optional[_IKeyPair_bc344eda] = None,
|
|
11918
11947
|
max_capacity: typing.Optional[jsii.Number] = None,
|
|
11919
11948
|
max_instance_lifetime: typing.Optional[_Duration_4839e8c3] = None,
|
|
11920
11949
|
min_capacity: typing.Optional[jsii.Number] = None,
|
|
@@ -11945,7 +11974,8 @@ class CommonAutoScalingGroupProps:
|
|
|
11945
11974
|
:param health_check: Configuration for health checks. Default: - HealthCheck.ec2 with no grace period
|
|
11946
11975
|
:param ignore_unmodified_size_properties: If the ASG has scheduled actions, don't reset unchanged group sizes. Only used if the ASG has scheduled actions (which may scale your ASG up or down regardless of cdk deployments). If true, the size of the group will only be reset if it has been changed in the CDK app. If false, the sizes will always be changed back to what they were in the CDK app on deployment. Default: true
|
|
11947
11976
|
:param instance_monitoring: Controls whether instances in this group are launched with detailed or basic monitoring. When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and your account is charged a fee. When you disable detailed monitoring, CloudWatch generates metrics every 5 minutes. ``launchTemplate`` and ``mixedInstancesPolicy`` must not be specified when this property is specified Default: - Monitoring.DETAILED
|
|
11948
|
-
:param key_name: Name of SSH keypair to grant access to instances. ``launchTemplate`` and ``mixedInstancesPolicy`` must not be specified when this property is specified Default: - No SSH access will be possible.
|
|
11977
|
+
:param key_name: (deprecated) Name of SSH keypair to grant access to instances. ``launchTemplate`` and ``mixedInstancesPolicy`` must not be specified when this property is specified You can either specify ``keyPair`` or ``keyName``, not both. Default: - No SSH access will be possible.
|
|
11978
|
+
:param key_pair: The SSH keypair to grant access to the instance. Feature flag ``AUTOSCALING_GENERATE_LAUNCH_TEMPLATE`` must be enabled to use this property. ``launchTemplate`` and ``mixedInstancesPolicy`` must not be specified when this property is specified. You can either specify ``keyPair`` or ``keyName``, not both. Default: - No SSH access will be possible.
|
|
11949
11979
|
:param max_capacity: Maximum number of instances in the fleet. Default: desiredCapacity
|
|
11950
11980
|
:param max_instance_lifetime: The maximum amount of time that an instance can be in service. The maximum duration applies to all current and future instances in the group. As an instance approaches its maximum duration, it is terminated and replaced, and cannot be used again. You must specify a value of at least 604,800 seconds (7 days). To clear a previously set value, leave this property undefined. Default: none
|
|
11951
11981
|
:param min_capacity: Minimum number of instances in the fleet. Default: 1
|
|
@@ -11973,6 +12003,7 @@ class CommonAutoScalingGroupProps:
|
|
|
11973
12003
|
# block_device_volume: autoscaling.BlockDeviceVolume
|
|
11974
12004
|
# group_metrics: autoscaling.GroupMetrics
|
|
11975
12005
|
# health_check: autoscaling.HealthCheck
|
|
12006
|
+
# key_pair: ec2.KeyPair
|
|
11976
12007
|
# scaling_events: autoscaling.ScalingEvents
|
|
11977
12008
|
# signals: autoscaling.Signals
|
|
11978
12009
|
# subnet: ec2.Subnet
|
|
@@ -11997,6 +12028,7 @@ class CommonAutoScalingGroupProps:
|
|
|
11997
12028
|
ignore_unmodified_size_properties=False,
|
|
11998
12029
|
instance_monitoring=autoscaling.Monitoring.BASIC,
|
|
11999
12030
|
key_name="keyName",
|
|
12031
|
+
key_pair=key_pair,
|
|
12000
12032
|
max_capacity=123,
|
|
12001
12033
|
max_instance_lifetime=cdk.Duration.minutes(30),
|
|
12002
12034
|
min_capacity=123,
|
|
@@ -12040,6 +12072,7 @@ class CommonAutoScalingGroupProps:
|
|
|
12040
12072
|
check_type(argname="argument ignore_unmodified_size_properties", value=ignore_unmodified_size_properties, expected_type=type_hints["ignore_unmodified_size_properties"])
|
|
12041
12073
|
check_type(argname="argument instance_monitoring", value=instance_monitoring, expected_type=type_hints["instance_monitoring"])
|
|
12042
12074
|
check_type(argname="argument key_name", value=key_name, expected_type=type_hints["key_name"])
|
|
12075
|
+
check_type(argname="argument key_pair", value=key_pair, expected_type=type_hints["key_pair"])
|
|
12043
12076
|
check_type(argname="argument max_capacity", value=max_capacity, expected_type=type_hints["max_capacity"])
|
|
12044
12077
|
check_type(argname="argument max_instance_lifetime", value=max_instance_lifetime, expected_type=type_hints["max_instance_lifetime"])
|
|
12045
12078
|
check_type(argname="argument min_capacity", value=min_capacity, expected_type=type_hints["min_capacity"])
|
|
@@ -12079,6 +12112,8 @@ class CommonAutoScalingGroupProps:
|
|
|
12079
12112
|
self._values["instance_monitoring"] = instance_monitoring
|
|
12080
12113
|
if key_name is not None:
|
|
12081
12114
|
self._values["key_name"] = key_name
|
|
12115
|
+
if key_pair is not None:
|
|
12116
|
+
self._values["key_pair"] = key_pair
|
|
12082
12117
|
if max_capacity is not None:
|
|
12083
12118
|
self._values["max_capacity"] = max_capacity
|
|
12084
12119
|
if max_instance_lifetime is not None:
|
|
@@ -12265,15 +12300,36 @@ class CommonAutoScalingGroupProps:
|
|
|
12265
12300
|
|
|
12266
12301
|
@builtins.property
|
|
12267
12302
|
def key_name(self) -> typing.Optional[builtins.str]:
|
|
12268
|
-
'''Name of SSH keypair to grant access to instances.
|
|
12303
|
+
'''(deprecated) Name of SSH keypair to grant access to instances.
|
|
12269
12304
|
|
|
12270
12305
|
``launchTemplate`` and ``mixedInstancesPolicy`` must not be specified when this property is specified
|
|
12271
12306
|
|
|
12307
|
+
You can either specify ``keyPair`` or ``keyName``, not both.
|
|
12308
|
+
|
|
12272
12309
|
:default: - No SSH access will be possible.
|
|
12310
|
+
|
|
12311
|
+
:deprecated: - Use ``keyPair`` instead - https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2-readme.html#using-an-existing-ec2-key-pair
|
|
12312
|
+
|
|
12313
|
+
:stability: deprecated
|
|
12273
12314
|
'''
|
|
12274
12315
|
result = self._values.get("key_name")
|
|
12275
12316
|
return typing.cast(typing.Optional[builtins.str], result)
|
|
12276
12317
|
|
|
12318
|
+
@builtins.property
|
|
12319
|
+
def key_pair(self) -> typing.Optional[_IKeyPair_bc344eda]:
|
|
12320
|
+
'''The SSH keypair to grant access to the instance.
|
|
12321
|
+
|
|
12322
|
+
Feature flag ``AUTOSCALING_GENERATE_LAUNCH_TEMPLATE`` must be enabled to use this property.
|
|
12323
|
+
|
|
12324
|
+
``launchTemplate`` and ``mixedInstancesPolicy`` must not be specified when this property is specified.
|
|
12325
|
+
|
|
12326
|
+
You can either specify ``keyPair`` or ``keyName``, not both.
|
|
12327
|
+
|
|
12328
|
+
:default: - No SSH access will be possible.
|
|
12329
|
+
'''
|
|
12330
|
+
result = self._values.get("key_pair")
|
|
12331
|
+
return typing.cast(typing.Optional[_IKeyPair_bc344eda], result)
|
|
12332
|
+
|
|
12277
12333
|
@builtins.property
|
|
12278
12334
|
def max_capacity(self) -> typing.Optional[jsii.Number]:
|
|
12279
12335
|
'''Maximum number of instances in the fleet.
|
|
@@ -16376,7 +16432,7 @@ class StepScalingAction(
|
|
|
16376
16432
|
:param id: -
|
|
16377
16433
|
:param auto_scaling_group: The auto scaling group.
|
|
16378
16434
|
:param adjustment_type: How the adjustment numbers are interpreted. Default: ChangeInCapacity
|
|
16379
|
-
:param cooldown: Period after a scaling completes before another scaling activity can start. Default: The default cooldown configured on the AutoScalingGroup
|
|
16435
|
+
:param cooldown: (deprecated) Period after a scaling completes before another scaling activity can start. Default: The default cooldown configured on the AutoScalingGroup
|
|
16380
16436
|
:param estimated_instance_warmup: Estimated time until a newly launched instance can send metrics to CloudWatch. Default: Same as the cooldown
|
|
16381
16437
|
:param metric_aggregation_type: The aggregation type for the CloudWatch metrics. Default: Average
|
|
16382
16438
|
:param min_adjustment_magnitude: Minimum absolute number to adjust capacity with as result of percentage scaling. Only when using AdjustmentType = PercentChangeInCapacity, this number controls the minimum absolute effect size. Default: No minimum scaling effect
|
|
@@ -16450,7 +16506,7 @@ class StepScalingActionProps:
|
|
|
16450
16506
|
|
|
16451
16507
|
:param auto_scaling_group: The auto scaling group.
|
|
16452
16508
|
:param adjustment_type: How the adjustment numbers are interpreted. Default: ChangeInCapacity
|
|
16453
|
-
:param cooldown: Period after a scaling completes before another scaling activity can start. Default: The default cooldown configured on the AutoScalingGroup
|
|
16509
|
+
:param cooldown: (deprecated) Period after a scaling completes before another scaling activity can start. Default: The default cooldown configured on the AutoScalingGroup
|
|
16454
16510
|
:param estimated_instance_warmup: Estimated time until a newly launched instance can send metrics to CloudWatch. Default: Same as the cooldown
|
|
16455
16511
|
:param metric_aggregation_type: The aggregation type for the CloudWatch metrics. Default: Average
|
|
16456
16512
|
:param min_adjustment_magnitude: Minimum absolute number to adjust capacity with as result of percentage scaling. Only when using AdjustmentType = PercentChangeInCapacity, this number controls the minimum absolute effect size. Default: No minimum scaling effect
|
|
@@ -16517,9 +16573,13 @@ class StepScalingActionProps:
|
|
|
16517
16573
|
|
|
16518
16574
|
@builtins.property
|
|
16519
16575
|
def cooldown(self) -> typing.Optional[_Duration_4839e8c3]:
|
|
16520
|
-
'''Period after a scaling completes before another scaling activity can start.
|
|
16576
|
+
'''(deprecated) Period after a scaling completes before another scaling activity can start.
|
|
16521
16577
|
|
|
16522
16578
|
:default: The default cooldown configured on the AutoScalingGroup
|
|
16579
|
+
|
|
16580
|
+
:deprecated: cooldown is not valid with step scaling action
|
|
16581
|
+
|
|
16582
|
+
:stability: deprecated
|
|
16523
16583
|
'''
|
|
16524
16584
|
result = self._values.get("cooldown")
|
|
16525
16585
|
return typing.cast(typing.Optional[_Duration_4839e8c3], result)
|
|
@@ -17627,24 +17687,15 @@ class AutoScalingGroup(
|
|
|
17627
17687
|
|
|
17628
17688
|
Example::
|
|
17629
17689
|
|
|
17630
|
-
#
|
|
17631
|
-
#
|
|
17632
|
-
# machine_image: ec2.IMachineImage
|
|
17633
|
-
|
|
17634
|
-
|
|
17635
|
-
autoscaling.AutoScalingGroup(self, "ASG",
|
|
17636
|
-
vpc=vpc,
|
|
17637
|
-
instance_type=instance_type,
|
|
17638
|
-
machine_image=machine_image,
|
|
17690
|
+
# cluster: eks.Cluster
|
|
17691
|
+
# asg: autoscaling.AutoScalingGroup
|
|
17639
17692
|
|
|
17640
|
-
|
|
17641
|
-
|
|
17642
|
-
|
|
17643
|
-
ec2.InitFile.from_string("/etc/my_instance", "This got written during instance startup")),
|
|
17644
|
-
signals=autoscaling.Signals.wait_for_all(
|
|
17645
|
-
timeout=Duration.minutes(10)
|
|
17646
|
-
)
|
|
17693
|
+
imported_cluster = eks.Cluster.from_cluster_attributes(self, "ImportedCluster",
|
|
17694
|
+
cluster_name=cluster.cluster_name,
|
|
17695
|
+
cluster_security_group_id=cluster.cluster_security_group_id
|
|
17647
17696
|
)
|
|
17697
|
+
|
|
17698
|
+
imported_cluster.connect_auto_scaling_group_capacity(asg)
|
|
17648
17699
|
'''
|
|
17649
17700
|
|
|
17650
17701
|
def __init__(
|
|
@@ -17678,6 +17729,7 @@ class AutoScalingGroup(
|
|
|
17678
17729
|
ignore_unmodified_size_properties: typing.Optional[builtins.bool] = None,
|
|
17679
17730
|
instance_monitoring: typing.Optional[Monitoring] = None,
|
|
17680
17731
|
key_name: typing.Optional[builtins.str] = None,
|
|
17732
|
+
key_pair: typing.Optional[_IKeyPair_bc344eda] = None,
|
|
17681
17733
|
max_capacity: typing.Optional[jsii.Number] = None,
|
|
17682
17734
|
max_instance_lifetime: typing.Optional[_Duration_4839e8c3] = None,
|
|
17683
17735
|
min_capacity: typing.Optional[jsii.Number] = None,
|
|
@@ -17719,7 +17771,8 @@ class AutoScalingGroup(
|
|
|
17719
17771
|
:param health_check: Configuration for health checks. Default: - HealthCheck.ec2 with no grace period
|
|
17720
17772
|
:param ignore_unmodified_size_properties: If the ASG has scheduled actions, don't reset unchanged group sizes. Only used if the ASG has scheduled actions (which may scale your ASG up or down regardless of cdk deployments). If true, the size of the group will only be reset if it has been changed in the CDK app. If false, the sizes will always be changed back to what they were in the CDK app on deployment. Default: true
|
|
17721
17773
|
:param instance_monitoring: Controls whether instances in this group are launched with detailed or basic monitoring. When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and your account is charged a fee. When you disable detailed monitoring, CloudWatch generates metrics every 5 minutes. ``launchTemplate`` and ``mixedInstancesPolicy`` must not be specified when this property is specified Default: - Monitoring.DETAILED
|
|
17722
|
-
:param key_name: Name of SSH keypair to grant access to instances. ``launchTemplate`` and ``mixedInstancesPolicy`` must not be specified when this property is specified Default: - No SSH access will be possible.
|
|
17774
|
+
:param key_name: (deprecated) Name of SSH keypair to grant access to instances. ``launchTemplate`` and ``mixedInstancesPolicy`` must not be specified when this property is specified You can either specify ``keyPair`` or ``keyName``, not both. Default: - No SSH access will be possible.
|
|
17775
|
+
:param key_pair: The SSH keypair to grant access to the instance. Feature flag ``AUTOSCALING_GENERATE_LAUNCH_TEMPLATE`` must be enabled to use this property. ``launchTemplate`` and ``mixedInstancesPolicy`` must not be specified when this property is specified. You can either specify ``keyPair`` or ``keyName``, not both. Default: - No SSH access will be possible.
|
|
17723
17776
|
:param max_capacity: Maximum number of instances in the fleet. Default: desiredCapacity
|
|
17724
17777
|
:param max_instance_lifetime: The maximum amount of time that an instance can be in service. The maximum duration applies to all current and future instances in the group. As an instance approaches its maximum duration, it is terminated and replaced, and cannot be used again. You must specify a value of at least 604,800 seconds (7 days). To clear a previously set value, leave this property undefined. Default: none
|
|
17725
17778
|
:param min_capacity: Minimum number of instances in the fleet. Default: 1
|
|
@@ -17764,6 +17817,7 @@ class AutoScalingGroup(
|
|
|
17764
17817
|
ignore_unmodified_size_properties=ignore_unmodified_size_properties,
|
|
17765
17818
|
instance_monitoring=instance_monitoring,
|
|
17766
17819
|
key_name=key_name,
|
|
17820
|
+
key_pair=key_pair,
|
|
17767
17821
|
max_capacity=max_capacity,
|
|
17768
17822
|
max_instance_lifetime=max_instance_lifetime,
|
|
17769
17823
|
min_capacity=min_capacity,
|
|
@@ -18356,6 +18410,7 @@ class AutoScalingGroup(
|
|
|
18356
18410
|
"ignore_unmodified_size_properties": "ignoreUnmodifiedSizeProperties",
|
|
18357
18411
|
"instance_monitoring": "instanceMonitoring",
|
|
18358
18412
|
"key_name": "keyName",
|
|
18413
|
+
"key_pair": "keyPair",
|
|
18359
18414
|
"max_capacity": "maxCapacity",
|
|
18360
18415
|
"max_instance_lifetime": "maxInstanceLifetime",
|
|
18361
18416
|
"min_capacity": "minCapacity",
|
|
@@ -18400,6 +18455,7 @@ class AutoScalingGroupProps(CommonAutoScalingGroupProps):
|
|
|
18400
18455
|
ignore_unmodified_size_properties: typing.Optional[builtins.bool] = None,
|
|
18401
18456
|
instance_monitoring: typing.Optional[Monitoring] = None,
|
|
18402
18457
|
key_name: typing.Optional[builtins.str] = None,
|
|
18458
|
+
key_pair: typing.Optional[_IKeyPair_bc344eda] = None,
|
|
18403
18459
|
max_capacity: typing.Optional[jsii.Number] = None,
|
|
18404
18460
|
max_instance_lifetime: typing.Optional[_Duration_4839e8c3] = None,
|
|
18405
18461
|
min_capacity: typing.Optional[jsii.Number] = None,
|
|
@@ -18440,7 +18496,8 @@ class AutoScalingGroupProps(CommonAutoScalingGroupProps):
|
|
|
18440
18496
|
:param health_check: Configuration for health checks. Default: - HealthCheck.ec2 with no grace period
|
|
18441
18497
|
:param ignore_unmodified_size_properties: If the ASG has scheduled actions, don't reset unchanged group sizes. Only used if the ASG has scheduled actions (which may scale your ASG up or down regardless of cdk deployments). If true, the size of the group will only be reset if it has been changed in the CDK app. If false, the sizes will always be changed back to what they were in the CDK app on deployment. Default: true
|
|
18442
18498
|
:param instance_monitoring: Controls whether instances in this group are launched with detailed or basic monitoring. When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and your account is charged a fee. When you disable detailed monitoring, CloudWatch generates metrics every 5 minutes. ``launchTemplate`` and ``mixedInstancesPolicy`` must not be specified when this property is specified Default: - Monitoring.DETAILED
|
|
18443
|
-
:param key_name: Name of SSH keypair to grant access to instances. ``launchTemplate`` and ``mixedInstancesPolicy`` must not be specified when this property is specified Default: - No SSH access will be possible.
|
|
18499
|
+
:param key_name: (deprecated) Name of SSH keypair to grant access to instances. ``launchTemplate`` and ``mixedInstancesPolicy`` must not be specified when this property is specified You can either specify ``keyPair`` or ``keyName``, not both. Default: - No SSH access will be possible.
|
|
18500
|
+
:param key_pair: The SSH keypair to grant access to the instance. Feature flag ``AUTOSCALING_GENERATE_LAUNCH_TEMPLATE`` must be enabled to use this property. ``launchTemplate`` and ``mixedInstancesPolicy`` must not be specified when this property is specified. You can either specify ``keyPair`` or ``keyName``, not both. Default: - No SSH access will be possible.
|
|
18444
18501
|
:param max_capacity: Maximum number of instances in the fleet. Default: desiredCapacity
|
|
18445
18502
|
:param max_instance_lifetime: The maximum amount of time that an instance can be in service. The maximum duration applies to all current and future instances in the group. As an instance approaches its maximum duration, it is terminated and replaced, and cannot be used again. You must specify a value of at least 604,800 seconds (7 days). To clear a previously set value, leave this property undefined. Default: none
|
|
18446
18503
|
:param min_capacity: Minimum number of instances in the fleet. Default: 1
|
|
@@ -18511,6 +18568,7 @@ class AutoScalingGroupProps(CommonAutoScalingGroupProps):
|
|
|
18511
18568
|
check_type(argname="argument ignore_unmodified_size_properties", value=ignore_unmodified_size_properties, expected_type=type_hints["ignore_unmodified_size_properties"])
|
|
18512
18569
|
check_type(argname="argument instance_monitoring", value=instance_monitoring, expected_type=type_hints["instance_monitoring"])
|
|
18513
18570
|
check_type(argname="argument key_name", value=key_name, expected_type=type_hints["key_name"])
|
|
18571
|
+
check_type(argname="argument key_pair", value=key_pair, expected_type=type_hints["key_pair"])
|
|
18514
18572
|
check_type(argname="argument max_capacity", value=max_capacity, expected_type=type_hints["max_capacity"])
|
|
18515
18573
|
check_type(argname="argument max_instance_lifetime", value=max_instance_lifetime, expected_type=type_hints["max_instance_lifetime"])
|
|
18516
18574
|
check_type(argname="argument min_capacity", value=min_capacity, expected_type=type_hints["min_capacity"])
|
|
@@ -18565,6 +18623,8 @@ class AutoScalingGroupProps(CommonAutoScalingGroupProps):
|
|
|
18565
18623
|
self._values["instance_monitoring"] = instance_monitoring
|
|
18566
18624
|
if key_name is not None:
|
|
18567
18625
|
self._values["key_name"] = key_name
|
|
18626
|
+
if key_pair is not None:
|
|
18627
|
+
self._values["key_pair"] = key_pair
|
|
18568
18628
|
if max_capacity is not None:
|
|
18569
18629
|
self._values["max_capacity"] = max_capacity
|
|
18570
18630
|
if max_instance_lifetime is not None:
|
|
@@ -18775,15 +18835,36 @@ class AutoScalingGroupProps(CommonAutoScalingGroupProps):
|
|
|
18775
18835
|
|
|
18776
18836
|
@builtins.property
|
|
18777
18837
|
def key_name(self) -> typing.Optional[builtins.str]:
|
|
18778
|
-
'''Name of SSH keypair to grant access to instances.
|
|
18838
|
+
'''(deprecated) Name of SSH keypair to grant access to instances.
|
|
18779
18839
|
|
|
18780
18840
|
``launchTemplate`` and ``mixedInstancesPolicy`` must not be specified when this property is specified
|
|
18781
18841
|
|
|
18842
|
+
You can either specify ``keyPair`` or ``keyName``, not both.
|
|
18843
|
+
|
|
18782
18844
|
:default: - No SSH access will be possible.
|
|
18845
|
+
|
|
18846
|
+
:deprecated: - Use ``keyPair`` instead - https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2-readme.html#using-an-existing-ec2-key-pair
|
|
18847
|
+
|
|
18848
|
+
:stability: deprecated
|
|
18783
18849
|
'''
|
|
18784
18850
|
result = self._values.get("key_name")
|
|
18785
18851
|
return typing.cast(typing.Optional[builtins.str], result)
|
|
18786
18852
|
|
|
18853
|
+
@builtins.property
|
|
18854
|
+
def key_pair(self) -> typing.Optional[_IKeyPair_bc344eda]:
|
|
18855
|
+
'''The SSH keypair to grant access to the instance.
|
|
18856
|
+
|
|
18857
|
+
Feature flag ``AUTOSCALING_GENERATE_LAUNCH_TEMPLATE`` must be enabled to use this property.
|
|
18858
|
+
|
|
18859
|
+
``launchTemplate`` and ``mixedInstancesPolicy`` must not be specified when this property is specified.
|
|
18860
|
+
|
|
18861
|
+
You can either specify ``keyPair`` or ``keyName``, not both.
|
|
18862
|
+
|
|
18863
|
+
:default: - No SSH access will be possible.
|
|
18864
|
+
'''
|
|
18865
|
+
result = self._values.get("key_pair")
|
|
18866
|
+
return typing.cast(typing.Optional[_IKeyPair_bc344eda], result)
|
|
18867
|
+
|
|
18787
18868
|
@builtins.property
|
|
18788
18869
|
def max_capacity(self) -> typing.Optional[jsii.Number]:
|
|
18789
18870
|
'''Maximum number of instances in the fleet.
|
|
@@ -20873,6 +20954,7 @@ def _typecheckingstub__e7df3cbef8de53a463241b6e60846fac6e519118c7118785f8f4efb6d
|
|
|
20873
20954
|
ignore_unmodified_size_properties: typing.Optional[builtins.bool] = None,
|
|
20874
20955
|
instance_monitoring: typing.Optional[Monitoring] = None,
|
|
20875
20956
|
key_name: typing.Optional[builtins.str] = None,
|
|
20957
|
+
key_pair: typing.Optional[_IKeyPair_bc344eda] = None,
|
|
20876
20958
|
max_capacity: typing.Optional[jsii.Number] = None,
|
|
20877
20959
|
max_instance_lifetime: typing.Optional[_Duration_4839e8c3] = None,
|
|
20878
20960
|
min_capacity: typing.Optional[jsii.Number] = None,
|
|
@@ -21418,6 +21500,7 @@ def _typecheckingstub__82981fc74407321badee3133fda3bd0a016f4ab7634f761219c1c808c
|
|
|
21418
21500
|
ignore_unmodified_size_properties: typing.Optional[builtins.bool] = None,
|
|
21419
21501
|
instance_monitoring: typing.Optional[Monitoring] = None,
|
|
21420
21502
|
key_name: typing.Optional[builtins.str] = None,
|
|
21503
|
+
key_pair: typing.Optional[_IKeyPair_bc344eda] = None,
|
|
21421
21504
|
max_capacity: typing.Optional[jsii.Number] = None,
|
|
21422
21505
|
max_instance_lifetime: typing.Optional[_Duration_4839e8c3] = None,
|
|
21423
21506
|
min_capacity: typing.Optional[jsii.Number] = None,
|
|
@@ -21624,6 +21707,7 @@ def _typecheckingstub__186ff14d58334848486a7ecd802c6b72a1b76f272f25349712b95361e
|
|
|
21624
21707
|
ignore_unmodified_size_properties: typing.Optional[builtins.bool] = None,
|
|
21625
21708
|
instance_monitoring: typing.Optional[Monitoring] = None,
|
|
21626
21709
|
key_name: typing.Optional[builtins.str] = None,
|
|
21710
|
+
key_pair: typing.Optional[_IKeyPair_bc344eda] = None,
|
|
21627
21711
|
max_capacity: typing.Optional[jsii.Number] = None,
|
|
21628
21712
|
max_instance_lifetime: typing.Optional[_Duration_4839e8c3] = None,
|
|
21629
21713
|
min_capacity: typing.Optional[jsii.Number] = None,
|
aws_cdk/aws_bedrock/__init__.py
CHANGED
|
@@ -984,11 +984,11 @@ class CfnAgent(
|
|
|
984
984
|
top_k: typing.Optional[jsii.Number] = None,
|
|
985
985
|
top_p: typing.Optional[jsii.Number] = None,
|
|
986
986
|
) -> None:
|
|
987
|
-
'''
|
|
987
|
+
'''Specifications about the inference parameters that were provided alongside the prompt.
|
|
988
988
|
|
|
989
|
-
For more information, see `Inference parameters for foundation models <https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html>`_ .
|
|
989
|
+
These are specified in the `PromptOverrideConfiguration <https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html>`_ object that was set when the agent was created or updated. For more information, see `Inference parameters for foundation models <https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html>`_ .
|
|
990
990
|
|
|
991
|
-
:param maximum_length: The maximum number of tokens
|
|
991
|
+
:param maximum_length: The maximum number of tokens allowed in the generated response.
|
|
992
992
|
:param stop_sequences: A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.
|
|
993
993
|
:param temperature: The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.
|
|
994
994
|
:param top_k: While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for ``topK`` is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set ``topK`` to 50, the model selects the next token from among the top 50 most likely choices.
|
|
@@ -1032,7 +1032,7 @@ class CfnAgent(
|
|
|
1032
1032
|
|
|
1033
1033
|
@builtins.property
|
|
1034
1034
|
def maximum_length(self) -> typing.Optional[jsii.Number]:
|
|
1035
|
-
'''The maximum number of tokens
|
|
1035
|
+
'''The maximum number of tokens allowed in the generated response.
|
|
1036
1036
|
|
|
1037
1037
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-inferenceconfiguration.html#cfn-bedrock-agent-inferenceconfiguration-maximumlength
|
|
1038
1038
|
'''
|
|
@@ -2381,7 +2381,7 @@ class CfnDataSource(
|
|
|
2381
2381
|
:param data_source_configuration: Contains details about how the data source is stored.
|
|
2382
2382
|
:param knowledge_base_id: The unique identifier of the knowledge base to which the data source belongs.
|
|
2383
2383
|
:param name: The name of the data source.
|
|
2384
|
-
:param data_deletion_policy: The deletion policy for
|
|
2384
|
+
:param data_deletion_policy: The data deletion policy for a data source.
|
|
2385
2385
|
:param description: The description of the data source.
|
|
2386
2386
|
:param server_side_encryption_configuration: Contains details about the configuration of the server-side encryption.
|
|
2387
2387
|
:param vector_ingestion_configuration: Contains details about how to ingest the documents in the data source.
|
|
@@ -2465,7 +2465,7 @@ class CfnDataSource(
|
|
|
2465
2465
|
@builtins.property
|
|
2466
2466
|
@jsii.member(jsii_name="attrFailureReasons")
|
|
2467
2467
|
def attr_failure_reasons(self) -> typing.List[builtins.str]:
|
|
2468
|
-
'''The
|
|
2468
|
+
'''The detailed reasons on the failure to delete a data source.
|
|
2469
2469
|
|
|
2470
2470
|
:cloudformationAttribute: FailureReasons
|
|
2471
2471
|
'''
|
|
@@ -2532,7 +2532,7 @@ class CfnDataSource(
|
|
|
2532
2532
|
@builtins.property
|
|
2533
2533
|
@jsii.member(jsii_name="dataDeletionPolicy")
|
|
2534
2534
|
def data_deletion_policy(self) -> typing.Optional[builtins.str]:
|
|
2535
|
-
'''The deletion policy for
|
|
2535
|
+
'''The data deletion policy for a data source.'''
|
|
2536
2536
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "dataDeletionPolicy"))
|
|
2537
2537
|
|
|
2538
2538
|
@data_deletion_policy.setter
|
|
@@ -2856,7 +2856,7 @@ class CfnDataSource(
|
|
|
2856
2856
|
'''Contains information about the S3 configuration of the data source.
|
|
2857
2857
|
|
|
2858
2858
|
:param bucket_arn: The Amazon Resource Name (ARN) of the bucket that contains the data source.
|
|
2859
|
-
:param bucket_owner_account_id: The account ID for the
|
|
2859
|
+
:param bucket_owner_account_id: The bucket account owner ID for the S3 bucket.
|
|
2860
2860
|
:param inclusion_prefixes: A list of S3 prefixes that define the object containing the data sources. For more information, see `Organizing objects using prefixes <https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html>`_ .
|
|
2861
2861
|
|
|
2862
2862
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-s3datasourceconfiguration.html
|
|
@@ -2901,7 +2901,7 @@ class CfnDataSource(
|
|
|
2901
2901
|
|
|
2902
2902
|
@builtins.property
|
|
2903
2903
|
def bucket_owner_account_id(self) -> typing.Optional[builtins.str]:
|
|
2904
|
-
'''The account ID for the
|
|
2904
|
+
'''The bucket account owner ID for the S3 bucket.
|
|
2905
2905
|
|
|
2906
2906
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-s3datasourceconfiguration.html#cfn-bedrock-datasource-s3datasourceconfiguration-bucketowneraccountid
|
|
2907
2907
|
'''
|
|
@@ -3083,7 +3083,7 @@ class CfnDataSourceProps:
|
|
|
3083
3083
|
:param data_source_configuration: Contains details about how the data source is stored.
|
|
3084
3084
|
:param knowledge_base_id: The unique identifier of the knowledge base to which the data source belongs.
|
|
3085
3085
|
:param name: The name of the data source.
|
|
3086
|
-
:param data_deletion_policy: The deletion policy for
|
|
3086
|
+
:param data_deletion_policy: The data deletion policy for a data source.
|
|
3087
3087
|
:param description: The description of the data source.
|
|
3088
3088
|
:param server_side_encryption_configuration: Contains details about the configuration of the server-side encryption.
|
|
3089
3089
|
:param vector_ingestion_configuration: Contains details about how to ingest the documents in the data source.
|
|
@@ -3187,7 +3187,7 @@ class CfnDataSourceProps:
|
|
|
3187
3187
|
|
|
3188
3188
|
@builtins.property
|
|
3189
3189
|
def data_deletion_policy(self) -> typing.Optional[builtins.str]:
|
|
3190
|
-
'''The deletion policy for
|
|
3190
|
+
'''The data deletion policy for a data source.
|
|
3191
3191
|
|
|
3192
3192
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-datasource.html#cfn-bedrock-datasource-datadeletionpolicy
|
|
3193
3193
|
'''
|
|
@@ -3243,7 +3243,9 @@ class CfnGuardrail(
|
|
|
3243
3243
|
metaclass=jsii.JSIIMeta,
|
|
3244
3244
|
jsii_type="aws-cdk-lib.aws_bedrock.CfnGuardrail",
|
|
3245
3245
|
):
|
|
3246
|
-
'''
|
|
3246
|
+
'''Creates a guardrail to block topics and to implement safeguards for your generative AI applications.
|
|
3247
|
+
|
|
3248
|
+
You can configure denied topics to disallow undesirable topics and content filters to block harmful content in model inputs and responses. For more information, see `Guardrails for Amazon Bedrock <https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails.html>`_ in the *Amazon Bedrock User Guide*
|
|
3247
3249
|
|
|
3248
3250
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html
|
|
3249
3251
|
:cloudformationResource: AWS::Bedrock::Guardrail
|
|
@@ -3328,14 +3330,14 @@ class CfnGuardrail(
|
|
|
3328
3330
|
'''
|
|
3329
3331
|
:param scope: Scope in which this resource is defined.
|
|
3330
3332
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
3331
|
-
:param blocked_input_messaging:
|
|
3332
|
-
:param blocked_outputs_messaging:
|
|
3333
|
-
:param name:
|
|
3333
|
+
:param blocked_input_messaging: The message to return when the guardrail blocks a prompt.
|
|
3334
|
+
:param blocked_outputs_messaging: The message to return when the guardrail blocks a model response.
|
|
3335
|
+
:param name: The name of the guardrail.
|
|
3334
3336
|
:param content_policy_config: Content policy config for a guardrail.
|
|
3335
|
-
:param description:
|
|
3336
|
-
:param kms_key_arn: The KMS key
|
|
3337
|
+
:param description: A description of the guardrail.
|
|
3338
|
+
:param kms_key_arn: The ARN of the AWS KMS key used to encrypt the guardrail.
|
|
3337
3339
|
:param sensitive_information_policy_config: Sensitive information policy config for a guardrail.
|
|
3338
|
-
:param tags:
|
|
3340
|
+
:param tags: Metadata that you can assign to a guardrail as key-value pairs. For more information, see the following resources:. - `Tag naming limits and requirements <https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-conventions>`_ - `Tagging best practices <https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-best-practices>`_
|
|
3339
3341
|
:param topic_policy_config: Topic policy config for a guardrail.
|
|
3340
3342
|
:param word_policy_config: Word policy config for a guardrail.
|
|
3341
3343
|
'''
|
|
@@ -3391,7 +3393,7 @@ class CfnGuardrail(
|
|
|
3391
3393
|
@builtins.property
|
|
3392
3394
|
@jsii.member(jsii_name="attrCreatedAt")
|
|
3393
3395
|
def attr_created_at(self) -> builtins.str:
|
|
3394
|
-
'''
|
|
3396
|
+
'''The date and time at which the guardrail was created.
|
|
3395
3397
|
|
|
3396
3398
|
:cloudformationAttribute: CreatedAt
|
|
3397
3399
|
'''
|
|
@@ -3409,7 +3411,9 @@ class CfnGuardrail(
|
|
|
3409
3411
|
@builtins.property
|
|
3410
3412
|
@jsii.member(jsii_name="attrGuardrailArn")
|
|
3411
3413
|
def attr_guardrail_arn(self) -> builtins.str:
|
|
3412
|
-
'''
|
|
3414
|
+
'''The Amazon Resource Name (ARN) of the guardrail.
|
|
3415
|
+
|
|
3416
|
+
This a the primary identifier for the guardrail.
|
|
3413
3417
|
|
|
3414
3418
|
:cloudformationAttribute: GuardrailArn
|
|
3415
3419
|
'''
|
|
@@ -3418,7 +3422,7 @@ class CfnGuardrail(
|
|
|
3418
3422
|
@builtins.property
|
|
3419
3423
|
@jsii.member(jsii_name="attrGuardrailId")
|
|
3420
3424
|
def attr_guardrail_id(self) -> builtins.str:
|
|
3421
|
-
'''
|
|
3425
|
+
'''The unique identifier of the guardrail.
|
|
3422
3426
|
|
|
3423
3427
|
:cloudformationAttribute: GuardrailId
|
|
3424
3428
|
'''
|
|
@@ -3445,7 +3449,7 @@ class CfnGuardrail(
|
|
|
3445
3449
|
@builtins.property
|
|
3446
3450
|
@jsii.member(jsii_name="attrUpdatedAt")
|
|
3447
3451
|
def attr_updated_at(self) -> builtins.str:
|
|
3448
|
-
'''
|
|
3452
|
+
'''The date and time at which the guardrail was last updated.
|
|
3449
3453
|
|
|
3450
3454
|
:cloudformationAttribute: UpdatedAt
|
|
3451
3455
|
'''
|
|
@@ -3454,7 +3458,7 @@ class CfnGuardrail(
|
|
|
3454
3458
|
@builtins.property
|
|
3455
3459
|
@jsii.member(jsii_name="attrVersion")
|
|
3456
3460
|
def attr_version(self) -> builtins.str:
|
|
3457
|
-
'''
|
|
3461
|
+
'''The version of the guardrail.
|
|
3458
3462
|
|
|
3459
3463
|
:cloudformationAttribute: Version
|
|
3460
3464
|
'''
|
|
@@ -3474,7 +3478,7 @@ class CfnGuardrail(
|
|
|
3474
3478
|
@builtins.property
|
|
3475
3479
|
@jsii.member(jsii_name="blockedInputMessaging")
|
|
3476
3480
|
def blocked_input_messaging(self) -> builtins.str:
|
|
3477
|
-
'''
|
|
3481
|
+
'''The message to return when the guardrail blocks a prompt.'''
|
|
3478
3482
|
return typing.cast(builtins.str, jsii.get(self, "blockedInputMessaging"))
|
|
3479
3483
|
|
|
3480
3484
|
@blocked_input_messaging.setter
|
|
@@ -3487,7 +3491,7 @@ class CfnGuardrail(
|
|
|
3487
3491
|
@builtins.property
|
|
3488
3492
|
@jsii.member(jsii_name="blockedOutputsMessaging")
|
|
3489
3493
|
def blocked_outputs_messaging(self) -> builtins.str:
|
|
3490
|
-
'''
|
|
3494
|
+
'''The message to return when the guardrail blocks a model response.'''
|
|
3491
3495
|
return typing.cast(builtins.str, jsii.get(self, "blockedOutputsMessaging"))
|
|
3492
3496
|
|
|
3493
3497
|
@blocked_outputs_messaging.setter
|
|
@@ -3500,7 +3504,7 @@ class CfnGuardrail(
|
|
|
3500
3504
|
@builtins.property
|
|
3501
3505
|
@jsii.member(jsii_name="name")
|
|
3502
3506
|
def name(self) -> builtins.str:
|
|
3503
|
-
'''
|
|
3507
|
+
'''The name of the guardrail.'''
|
|
3504
3508
|
return typing.cast(builtins.str, jsii.get(self, "name"))
|
|
3505
3509
|
|
|
3506
3510
|
@name.setter
|
|
@@ -3531,7 +3535,7 @@ class CfnGuardrail(
|
|
|
3531
3535
|
@builtins.property
|
|
3532
3536
|
@jsii.member(jsii_name="description")
|
|
3533
3537
|
def description(self) -> typing.Optional[builtins.str]:
|
|
3534
|
-
'''
|
|
3538
|
+
'''A description of the guardrail.'''
|
|
3535
3539
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "description"))
|
|
3536
3540
|
|
|
3537
3541
|
@description.setter
|
|
@@ -3544,7 +3548,7 @@ class CfnGuardrail(
|
|
|
3544
3548
|
@builtins.property
|
|
3545
3549
|
@jsii.member(jsii_name="kmsKeyArn")
|
|
3546
3550
|
def kms_key_arn(self) -> typing.Optional[builtins.str]:
|
|
3547
|
-
'''The KMS key
|
|
3551
|
+
'''The ARN of the AWS KMS key used to encrypt the guardrail.'''
|
|
3548
3552
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "kmsKeyArn"))
|
|
3549
3553
|
|
|
3550
3554
|
@kms_key_arn.setter
|
|
@@ -3575,7 +3579,10 @@ class CfnGuardrail(
|
|
|
3575
3579
|
@builtins.property
|
|
3576
3580
|
@jsii.member(jsii_name="tags")
|
|
3577
3581
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
3578
|
-
'''
|
|
3582
|
+
'''Metadata that you can assign to a guardrail as key-value pairs.
|
|
3583
|
+
|
|
3584
|
+
For more information, see the following resources:.
|
|
3585
|
+
'''
|
|
3579
3586
|
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tags"))
|
|
3580
3587
|
|
|
3581
3588
|
@tags.setter
|
|
@@ -4426,14 +4433,14 @@ class CfnGuardrailProps:
|
|
|
4426
4433
|
) -> None:
|
|
4427
4434
|
'''Properties for defining a ``CfnGuardrail``.
|
|
4428
4435
|
|
|
4429
|
-
:param blocked_input_messaging:
|
|
4430
|
-
:param blocked_outputs_messaging:
|
|
4431
|
-
:param name:
|
|
4436
|
+
:param blocked_input_messaging: The message to return when the guardrail blocks a prompt.
|
|
4437
|
+
:param blocked_outputs_messaging: The message to return when the guardrail blocks a model response.
|
|
4438
|
+
:param name: The name of the guardrail.
|
|
4432
4439
|
:param content_policy_config: Content policy config for a guardrail.
|
|
4433
|
-
:param description:
|
|
4434
|
-
:param kms_key_arn: The KMS key
|
|
4440
|
+
:param description: A description of the guardrail.
|
|
4441
|
+
:param kms_key_arn: The ARN of the AWS KMS key used to encrypt the guardrail.
|
|
4435
4442
|
:param sensitive_information_policy_config: Sensitive information policy config for a guardrail.
|
|
4436
|
-
:param tags:
|
|
4443
|
+
:param tags: Metadata that you can assign to a guardrail as key-value pairs. For more information, see the following resources:. - `Tag naming limits and requirements <https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-conventions>`_ - `Tagging best practices <https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-best-practices>`_
|
|
4437
4444
|
:param topic_policy_config: Topic policy config for a guardrail.
|
|
4438
4445
|
:param word_policy_config: Word policy config for a guardrail.
|
|
4439
4446
|
|
|
@@ -4533,7 +4540,7 @@ class CfnGuardrailProps:
|
|
|
4533
4540
|
|
|
4534
4541
|
@builtins.property
|
|
4535
4542
|
def blocked_input_messaging(self) -> builtins.str:
|
|
4536
|
-
'''
|
|
4543
|
+
'''The message to return when the guardrail blocks a prompt.
|
|
4537
4544
|
|
|
4538
4545
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-blockedinputmessaging
|
|
4539
4546
|
'''
|
|
@@ -4543,7 +4550,7 @@ class CfnGuardrailProps:
|
|
|
4543
4550
|
|
|
4544
4551
|
@builtins.property
|
|
4545
4552
|
def blocked_outputs_messaging(self) -> builtins.str:
|
|
4546
|
-
'''
|
|
4553
|
+
'''The message to return when the guardrail blocks a model response.
|
|
4547
4554
|
|
|
4548
4555
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-blockedoutputsmessaging
|
|
4549
4556
|
'''
|
|
@@ -4553,7 +4560,7 @@ class CfnGuardrailProps:
|
|
|
4553
4560
|
|
|
4554
4561
|
@builtins.property
|
|
4555
4562
|
def name(self) -> builtins.str:
|
|
4556
|
-
'''
|
|
4563
|
+
'''The name of the guardrail.
|
|
4557
4564
|
|
|
4558
4565
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-name
|
|
4559
4566
|
'''
|
|
@@ -4574,7 +4581,7 @@ class CfnGuardrailProps:
|
|
|
4574
4581
|
|
|
4575
4582
|
@builtins.property
|
|
4576
4583
|
def description(self) -> typing.Optional[builtins.str]:
|
|
4577
|
-
'''
|
|
4584
|
+
'''A description of the guardrail.
|
|
4578
4585
|
|
|
4579
4586
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-description
|
|
4580
4587
|
'''
|
|
@@ -4583,7 +4590,7 @@ class CfnGuardrailProps:
|
|
|
4583
4590
|
|
|
4584
4591
|
@builtins.property
|
|
4585
4592
|
def kms_key_arn(self) -> typing.Optional[builtins.str]:
|
|
4586
|
-
'''The KMS key
|
|
4593
|
+
'''The ARN of the AWS KMS key used to encrypt the guardrail.
|
|
4587
4594
|
|
|
4588
4595
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-kmskeyarn
|
|
4589
4596
|
'''
|
|
@@ -4603,7 +4610,10 @@ class CfnGuardrailProps:
|
|
|
4603
4610
|
|
|
4604
4611
|
@builtins.property
|
|
4605
4612
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
4606
|
-
'''
|
|
4613
|
+
'''Metadata that you can assign to a guardrail as key-value pairs. For more information, see the following resources:.
|
|
4614
|
+
|
|
4615
|
+
- `Tag naming limits and requirements <https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-conventions>`_
|
|
4616
|
+
- `Tagging best practices <https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-best-practices>`_
|
|
4607
4617
|
|
|
4608
4618
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-tags
|
|
4609
4619
|
'''
|