aws-cdk-lib 2.172.0__py3-none-any.whl → 2.173.1__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 +57 -0
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.172.0.jsii.tgz → aws-cdk-lib@2.173.1.jsii.tgz} +0 -0
- aws_cdk/aws_amazonmq/__init__.py +40 -40
- aws_cdk/aws_apigateway/__init__.py +111 -64
- aws_cdk/aws_applicationautoscaling/__init__.py +141 -66
- aws_cdk/aws_appsync/__init__.py +4 -3
- aws_cdk/aws_autoscaling/__init__.py +15 -6
- aws_cdk/aws_bedrock/__init__.py +32 -44
- aws_cdk/aws_chatbot/__init__.py +72 -46
- aws_cdk/aws_cleanrooms/__init__.py +4 -6
- aws_cdk/aws_cloudfront/__init__.py +4 -2
- aws_cdk/aws_cloudtrail/__init__.py +104 -68
- 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 +221 -53
- aws_cdk/aws_config/__init__.py +13 -10
- aws_cdk/aws_connect/__init__.py +25 -23
- aws_cdk/aws_connectcampaignsv2/__init__.py +187 -176
- aws_cdk/aws_docdb/__init__.py +128 -0
- aws_cdk/aws_dynamodb/__init__.py +256 -0
- aws_cdk/aws_ec2/__init__.py +130 -48
- aws_cdk/aws_ecs/__init__.py +25 -13
- aws_cdk/aws_eks/__init__.py +86 -24
- aws_cdk/aws_elasticache/__init__.py +22 -22
- aws_cdk/aws_elasticloadbalancingv2/__init__.py +138 -128
- aws_cdk/aws_events/__init__.py +39 -26
- 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 +28 -22
- aws_cdk/aws_iotfleetwise/__init__.py +473 -332
- aws_cdk/aws_iotsitewise/__init__.py +6 -4
- 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 +258 -156
- aws_cdk/aws_logs/__init__.py +532 -0
- aws_cdk/aws_m2/__init__.py +15 -15
- 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_qbusiness/__init__.py +2018 -66
- aws_cdk/aws_rds/__init__.py +30 -0
- aws_cdk/aws_resourcegroups/__init__.py +26 -17
- aws_cdk/aws_route53/__init__.py +1177 -10
- aws_cdk/aws_route53_targets/__init__.py +224 -100
- aws_cdk/aws_route53resolver/__init__.py +4 -2
- aws_cdk/aws_s3/__init__.py +4 -4
- aws_cdk/aws_s3express/__init__.py +30 -19
- aws_cdk/aws_sagemaker/__init__.py +783 -9
- 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 +109 -0
- 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 +2698 -232
- aws_cdk/aws_workspacesweb/__init__.py +118 -61
- {aws_cdk_lib-2.172.0.dist-info → aws_cdk_lib-2.173.1.dist-info}/METADATA +1 -1
- {aws_cdk_lib-2.172.0.dist-info → aws_cdk_lib-2.173.1.dist-info}/RECORD +69 -68
- {aws_cdk_lib-2.172.0.dist-info → aws_cdk_lib-2.173.1.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.172.0.dist-info → aws_cdk_lib-2.173.1.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.172.0.dist-info → aws_cdk_lib-2.173.1.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.172.0.dist-info → aws_cdk_lib-2.173.1.dist-info}/top_level.txt +0 -0
|
@@ -2206,7 +2206,7 @@ class CfnScalingPolicy(
|
|
|
2206
2206
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
2207
2207
|
:param policy_name: The name of the scaling policy. Updates to the name of a target tracking scaling policy are not supported, unless you also update the metric used for scaling. To change only a target tracking scaling policy's name, first delete the policy by removing the existing ``AWS::ApplicationAutoScaling::ScalingPolicy`` resource from the template and updating the stack. Then, recreate the resource with the same settings and a different name.
|
|
2208
2208
|
:param policy_type: The scaling policy type. The following policy types are supported: ``TargetTrackingScaling`` —Not supported for Amazon EMR ``StepScaling`` —Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune.
|
|
2209
|
-
:param predictive_scaling_policy_configuration:
|
|
2209
|
+
:param predictive_scaling_policy_configuration: The predictive scaling policy configuration.
|
|
2210
2210
|
:param resource_id: The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. - ECS service - The resource type is ``service`` and the unique identifier is the cluster name and service name. Example: ``service/my-cluster/my-service`` . - Spot Fleet - The resource type is ``spot-fleet-request`` and the unique identifier is the Spot Fleet request ID. Example: ``spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE`` . - EMR cluster - The resource type is ``instancegroup`` and the unique identifier is the cluster ID and instance group ID. Example: ``instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0`` . - AppStream 2.0 fleet - The resource type is ``fleet`` and the unique identifier is the fleet name. Example: ``fleet/sample-fleet`` . - DynamoDB table - The resource type is ``table`` and the unique identifier is the table name. Example: ``table/my-table`` . - DynamoDB global secondary index - The resource type is ``index`` and the unique identifier is the index name. Example: ``table/my-table/index/my-table-index`` . - Aurora DB cluster - The resource type is ``cluster`` and the unique identifier is the cluster name. Example: ``cluster:my-db-cluster`` . - SageMaker endpoint variant - The resource type is ``variant`` and the unique identifier is the resource ID. Example: ``endpoint/my-end-point/variant/KMeansClustering`` . - Custom resources are not supported with a resource type. This parameter must specify the ``OutputValue`` from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our `GitHub repository <https://docs.aws.amazon.com/https://github.com/aws/aws-auto-scaling-custom-resource>`_ . - Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: ``arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE`` . - Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: ``arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE`` . - Lambda provisioned concurrency - The resource type is ``function`` and the unique identifier is the function name with a function version or alias name suffix that is not ``$LATEST`` . Example: ``function:my-function:prod`` or ``function:my-function:1`` . - Amazon Keyspaces table - The resource type is ``table`` and the unique identifier is the table name. Example: ``keyspace/mykeyspace/table/mytable`` . - Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: ``arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5`` . - Amazon ElastiCache replication group - The resource type is ``replication-group`` and the unique identifier is the replication group name. Example: ``replication-group/mycluster`` . - Neptune cluster - The resource type is ``cluster`` and the unique identifier is the cluster name. Example: ``cluster:mycluster`` . - SageMaker serverless endpoint - The resource type is ``variant`` and the unique identifier is the resource ID. Example: ``endpoint/my-end-point/variant/KMeansClustering`` . - SageMaker inference component - The resource type is ``inference-component`` and the unique identifier is the resource ID. Example: ``inference-component/my-inference-component`` . - Pool of WorkSpaces - The resource type is ``workspacespool`` and the unique identifier is the pool ID. Example: ``workspacespool/wspool-123456`` .
|
|
2211
2211
|
:param scalable_dimension: The scalable dimension. This string consists of the service namespace, resource type, and scaling property. - ``ecs:service:DesiredCount`` - The task count of an ECS service. - ``elasticmapreduce:instancegroup:InstanceCount`` - The instance count of an EMR Instance Group. - ``ec2:spot-fleet-request:TargetCapacity`` - The target capacity of a Spot Fleet. - ``appstream:fleet:DesiredCapacity`` - The capacity of an AppStream 2.0 fleet. - ``dynamodb:table:ReadCapacityUnits`` - The provisioned read capacity for a DynamoDB table. - ``dynamodb:table:WriteCapacityUnits`` - The provisioned write capacity for a DynamoDB table. - ``dynamodb:index:ReadCapacityUnits`` - The provisioned read capacity for a DynamoDB global secondary index. - ``dynamodb:index:WriteCapacityUnits`` - The provisioned write capacity for a DynamoDB global secondary index. - ``rds:cluster:ReadReplicaCount`` - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. - ``sagemaker:variant:DesiredInstanceCount`` - The number of EC2 instances for a SageMaker model endpoint variant. - ``custom-resource:ResourceType:Property`` - The scalable dimension for a custom resource provided by your own application or service. - ``comprehend:document-classifier-endpoint:DesiredInferenceUnits`` - The number of inference units for an Amazon Comprehend document classification endpoint. - ``comprehend:entity-recognizer-endpoint:DesiredInferenceUnits`` - The number of inference units for an Amazon Comprehend entity recognizer endpoint. - ``lambda:function:ProvisionedConcurrency`` - The provisioned concurrency for a Lambda function. - ``cassandra:table:ReadCapacityUnits`` - The provisioned read capacity for an Amazon Keyspaces table. - ``cassandra:table:WriteCapacityUnits`` - The provisioned write capacity for an Amazon Keyspaces table. - ``kafka:broker-storage:VolumeSize`` - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster. - ``elasticache:replication-group:NodeGroups`` - The number of node groups for an Amazon ElastiCache replication group. - ``elasticache:replication-group:Replicas`` - The number of replicas per node group for an Amazon ElastiCache replication group. - ``neptune:cluster:ReadReplicaCount`` - The count of read replicas in an Amazon Neptune DB cluster. - ``sagemaker:variant:DesiredProvisionedConcurrency`` - The provisioned concurrency for a SageMaker serverless endpoint. - ``sagemaker:inference-component:DesiredCopyCount`` - The number of copies across an endpoint for a SageMaker inference component. - ``workspaces:workspacespool:DesiredUserSessions`` - The number of user sessions for the WorkSpaces in the pool.
|
|
2212
2212
|
:param scaling_target_id: The CloudFormation-generated ID of an Application Auto Scaling scalable target. For more information about the ID, see the Return Value section of the ``AWS::ApplicationAutoScaling::ScalableTarget`` resource. .. epigraph:: You must specify either the ``ScalingTargetId`` property, or the ``ResourceId`` , ``ScalableDimension`` , and ``ServiceNamespace`` properties, but not both.
|
|
@@ -2307,6 +2307,7 @@ class CfnScalingPolicy(
|
|
|
2307
2307
|
def predictive_scaling_policy_configuration(
|
|
2308
2308
|
self,
|
|
2309
2309
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnScalingPolicy.PredictiveScalingPolicyConfigurationProperty"]]:
|
|
2310
|
+
'''The predictive scaling policy configuration.'''
|
|
2310
2311
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnScalingPolicy.PredictiveScalingPolicyConfigurationProperty"]], jsii.get(self, "predictiveScalingPolicyConfiguration"))
|
|
2311
2312
|
|
|
2312
2313
|
@predictive_scaling_policy_configuration.setter
|
|
@@ -2762,8 +2763,9 @@ class CfnScalingPolicy(
|
|
|
2762
2763
|
*,
|
|
2763
2764
|
metric_data_queries: typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnScalingPolicy.PredictiveScalingMetricDataQueryProperty", typing.Dict[builtins.str, typing.Any]]]]],
|
|
2764
2765
|
) -> None:
|
|
2765
|
-
'''
|
|
2766
|
-
|
|
2766
|
+
'''Represents a CloudWatch metric of your choosing for a predictive scaling policy.
|
|
2767
|
+
|
|
2768
|
+
:param metric_data_queries: One or more metric data queries to provide data points for a metric specification.
|
|
2767
2769
|
|
|
2768
2770
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingcustomizedcapacitymetric.html
|
|
2769
2771
|
:exampleMetadata: fixture=_generated
|
|
@@ -2806,7 +2808,8 @@ class CfnScalingPolicy(
|
|
|
2806
2808
|
def metric_data_queries(
|
|
2807
2809
|
self,
|
|
2808
2810
|
) -> typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnScalingPolicy.PredictiveScalingMetricDataQueryProperty"]]]:
|
|
2809
|
-
'''
|
|
2811
|
+
'''One or more metric data queries to provide data points for a metric specification.
|
|
2812
|
+
|
|
2810
2813
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingcustomizedcapacitymetric.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingcustomizedcapacitymetric-metricdataqueries
|
|
2811
2814
|
'''
|
|
2812
2815
|
result = self._values.get("metric_data_queries")
|
|
@@ -2835,7 +2838,8 @@ class CfnScalingPolicy(
|
|
|
2835
2838
|
*,
|
|
2836
2839
|
metric_data_queries: typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnScalingPolicy.PredictiveScalingMetricDataQueryProperty", typing.Dict[builtins.str, typing.Any]]]]],
|
|
2837
2840
|
) -> None:
|
|
2838
|
-
'''
|
|
2841
|
+
'''The customized load metric specification.
|
|
2842
|
+
|
|
2839
2843
|
:param metric_data_queries:
|
|
2840
2844
|
|
|
2841
2845
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingcustomizedloadmetric.html
|
|
@@ -2909,7 +2913,7 @@ class CfnScalingPolicy(
|
|
|
2909
2913
|
metric_data_queries: typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnScalingPolicy.PredictiveScalingMetricDataQueryProperty", typing.Dict[builtins.str, typing.Any]]]]],
|
|
2910
2914
|
) -> None:
|
|
2911
2915
|
'''
|
|
2912
|
-
:param metric_data_queries:
|
|
2916
|
+
:param metric_data_queries: One or more metric data queries to provide data points for a metric specification.
|
|
2913
2917
|
|
|
2914
2918
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingcustomizedscalingmetric.html
|
|
2915
2919
|
:exampleMetadata: fixture=_generated
|
|
@@ -2952,7 +2956,8 @@ class CfnScalingPolicy(
|
|
|
2952
2956
|
def metric_data_queries(
|
|
2953
2957
|
self,
|
|
2954
2958
|
) -> typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnScalingPolicy.PredictiveScalingMetricDataQueryProperty"]]]:
|
|
2955
|
-
'''
|
|
2959
|
+
'''One or more metric data queries to provide data points for a metric specification.
|
|
2960
|
+
|
|
2956
2961
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingcustomizedscalingmetric.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingcustomizedscalingmetric-metricdataqueries
|
|
2957
2962
|
'''
|
|
2958
2963
|
result = self._values.get("metric_data_queries")
|
|
@@ -2991,12 +2996,15 @@ class CfnScalingPolicy(
|
|
|
2991
2996
|
metric_stat: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnScalingPolicy.PredictiveScalingMetricStatProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
2992
2997
|
return_data: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
|
|
2993
2998
|
) -> None:
|
|
2994
|
-
'''
|
|
2995
|
-
|
|
2996
|
-
|
|
2999
|
+
'''The metric data to return.
|
|
3000
|
+
|
|
3001
|
+
Also defines whether this call is returning data for one metric only, or whether it is performing a math expression on the values of returned metric statistics to create a new time series. A time series is a series of data points, each of which is associated with a timestamp.
|
|
3002
|
+
|
|
3003
|
+
: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 ``MetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat`` , but not both.
|
|
3004
|
+
:param id: A short name that identifies the object's results in the response. This name must be unique among all ``MetricDataQuery`` objects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter.
|
|
2997
3005
|
: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.
|
|
2998
|
-
:param metric_stat:
|
|
2999
|
-
:param return_data: Indicates whether to return the timestamps and raw data values of this metric.
|
|
3006
|
+
:param metric_stat: Information about the metric data to return. Conditional: Within each ``MetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat`` , but not both.
|
|
3007
|
+
: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`` ).
|
|
3000
3008
|
|
|
3001
3009
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricdataquery.html
|
|
3002
3010
|
:exampleMetadata: fixture=_generated
|
|
@@ -3049,6 +3057,10 @@ class CfnScalingPolicy(
|
|
|
3049
3057
|
def expression(self) -> typing.Optional[builtins.str]:
|
|
3050
3058
|
'''The math expression to perform on the returned data, if this object is performing a math expression.
|
|
3051
3059
|
|
|
3060
|
+
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.
|
|
3061
|
+
|
|
3062
|
+
Conditional: Within each ``MetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat`` , but not both.
|
|
3063
|
+
|
|
3052
3064
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricdataquery.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingmetricdataquery-expression
|
|
3053
3065
|
'''
|
|
3054
3066
|
result = self._values.get("expression")
|
|
@@ -3058,6 +3070,8 @@ class CfnScalingPolicy(
|
|
|
3058
3070
|
def id(self) -> typing.Optional[builtins.str]:
|
|
3059
3071
|
'''A short name that identifies the object's results in the response.
|
|
3060
3072
|
|
|
3073
|
+
This name must be unique among all ``MetricDataQuery`` objects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter.
|
|
3074
|
+
|
|
3061
3075
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricdataquery.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingmetricdataquery-id
|
|
3062
3076
|
'''
|
|
3063
3077
|
result = self._values.get("id")
|
|
@@ -3078,7 +3092,10 @@ class CfnScalingPolicy(
|
|
|
3078
3092
|
def metric_stat(
|
|
3079
3093
|
self,
|
|
3080
3094
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnScalingPolicy.PredictiveScalingMetricStatProperty"]]:
|
|
3081
|
-
'''
|
|
3095
|
+
'''Information about the metric data to return.
|
|
3096
|
+
|
|
3097
|
+
Conditional: Within each ``MetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat`` , but not both.
|
|
3098
|
+
|
|
3082
3099
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricdataquery.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingmetricdataquery-metricstat
|
|
3083
3100
|
'''
|
|
3084
3101
|
result = self._values.get("metric_stat")
|
|
@@ -3090,6 +3107,10 @@ class CfnScalingPolicy(
|
|
|
3090
3107
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
3091
3108
|
'''Indicates whether to return the timestamps and raw data values of this metric.
|
|
3092
3109
|
|
|
3110
|
+
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.
|
|
3111
|
+
|
|
3112
|
+
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`` ).
|
|
3113
|
+
|
|
3093
3114
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricdataquery.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingmetricdataquery-returndata
|
|
3094
3115
|
'''
|
|
3095
3116
|
result = self._values.get("return_data")
|
|
@@ -3118,7 +3139,8 @@ class CfnScalingPolicy(
|
|
|
3118
3139
|
name: typing.Optional[builtins.str] = None,
|
|
3119
3140
|
value: typing.Optional[builtins.str] = None,
|
|
3120
3141
|
) -> None:
|
|
3121
|
-
'''
|
|
3142
|
+
'''Describes the dimension of a metric.
|
|
3143
|
+
|
|
3122
3144
|
:param name: The name of the dimension.
|
|
3123
3145
|
:param value: The value of the dimension.
|
|
3124
3146
|
|
|
@@ -3192,8 +3214,9 @@ class CfnScalingPolicy(
|
|
|
3192
3214
|
metric_name: typing.Optional[builtins.str] = None,
|
|
3193
3215
|
namespace: typing.Optional[builtins.str] = None,
|
|
3194
3216
|
) -> None:
|
|
3195
|
-
'''
|
|
3196
|
-
|
|
3217
|
+
'''Describes the scaling metric.
|
|
3218
|
+
|
|
3219
|
+
:param dimensions: Describes the dimensions of the metric.
|
|
3197
3220
|
:param metric_name: The name of the metric.
|
|
3198
3221
|
:param namespace: The namespace of the metric.
|
|
3199
3222
|
|
|
@@ -3232,7 +3255,7 @@ class CfnScalingPolicy(
|
|
|
3232
3255
|
def dimensions(
|
|
3233
3256
|
self,
|
|
3234
3257
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnScalingPolicy.PredictiveScalingMetricDimensionProperty"]]]]:
|
|
3235
|
-
'''
|
|
3258
|
+
'''Describes the dimensions of the metric.
|
|
3236
3259
|
|
|
3237
3260
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetric.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingmetric-dimensions
|
|
3238
3261
|
'''
|
|
@@ -3293,14 +3316,17 @@ class CfnScalingPolicy(
|
|
|
3293
3316
|
predefined_metric_pair_specification: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnScalingPolicy.PredictiveScalingPredefinedMetricPairProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
3294
3317
|
predefined_scaling_metric_specification: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnScalingPolicy.PredictiveScalingPredefinedScalingMetricProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
3295
3318
|
) -> None:
|
|
3296
|
-
'''
|
|
3297
|
-
|
|
3298
|
-
|
|
3299
|
-
|
|
3300
|
-
:param
|
|
3301
|
-
:param
|
|
3302
|
-
:param
|
|
3303
|
-
:param
|
|
3319
|
+
'''This structure specifies the metrics and target utilization settings for a predictive scaling policy.
|
|
3320
|
+
|
|
3321
|
+
You must specify either a metric pair, or a load metric and a scaling metric individually. Specifying a metric pair instead of individual metrics provides a simpler way to configure metrics for a scaling policy. You choose the metric pair, and the policy automatically knows the correct sum and average statistics to use for the load metric and the scaling metric.
|
|
3322
|
+
|
|
3323
|
+
:param target_value: Specifies the target utilization.
|
|
3324
|
+
:param customized_capacity_metric_specification: The customized capacity metric specification.
|
|
3325
|
+
:param customized_load_metric_specification: The customized load metric specification.
|
|
3326
|
+
:param customized_scaling_metric_specification: The customized scaling metric specification.
|
|
3327
|
+
:param predefined_load_metric_specification: The predefined load metric specification.
|
|
3328
|
+
:param predefined_metric_pair_specification: The predefined metric pair specification that determines the appropriate scaling metric and load metric to use.
|
|
3329
|
+
:param predefined_scaling_metric_specification: The predefined scaling metric specification.
|
|
3304
3330
|
|
|
3305
3331
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricspecification.html
|
|
3306
3332
|
:exampleMetadata: fixture=_generated
|
|
@@ -3422,7 +3448,8 @@ class CfnScalingPolicy(
|
|
|
3422
3448
|
|
|
3423
3449
|
@builtins.property
|
|
3424
3450
|
def target_value(self) -> jsii.Number:
|
|
3425
|
-
'''
|
|
3451
|
+
'''Specifies the target utilization.
|
|
3452
|
+
|
|
3426
3453
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricspecification.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingmetricspecification-targetvalue
|
|
3427
3454
|
'''
|
|
3428
3455
|
result = self._values.get("target_value")
|
|
@@ -3433,7 +3460,8 @@ class CfnScalingPolicy(
|
|
|
3433
3460
|
def customized_capacity_metric_specification(
|
|
3434
3461
|
self,
|
|
3435
3462
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnScalingPolicy.PredictiveScalingCustomizedCapacityMetricProperty"]]:
|
|
3436
|
-
'''
|
|
3463
|
+
'''The customized capacity metric specification.
|
|
3464
|
+
|
|
3437
3465
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricspecification.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingmetricspecification-customizedcapacitymetricspecification
|
|
3438
3466
|
'''
|
|
3439
3467
|
result = self._values.get("customized_capacity_metric_specification")
|
|
@@ -3443,7 +3471,8 @@ class CfnScalingPolicy(
|
|
|
3443
3471
|
def customized_load_metric_specification(
|
|
3444
3472
|
self,
|
|
3445
3473
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnScalingPolicy.PredictiveScalingCustomizedLoadMetricProperty"]]:
|
|
3446
|
-
'''
|
|
3474
|
+
'''The customized load metric specification.
|
|
3475
|
+
|
|
3447
3476
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricspecification.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingmetricspecification-customizedloadmetricspecification
|
|
3448
3477
|
'''
|
|
3449
3478
|
result = self._values.get("customized_load_metric_specification")
|
|
@@ -3453,7 +3482,8 @@ class CfnScalingPolicy(
|
|
|
3453
3482
|
def customized_scaling_metric_specification(
|
|
3454
3483
|
self,
|
|
3455
3484
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnScalingPolicy.PredictiveScalingCustomizedScalingMetricProperty"]]:
|
|
3456
|
-
'''
|
|
3485
|
+
'''The customized scaling metric specification.
|
|
3486
|
+
|
|
3457
3487
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricspecification.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingmetricspecification-customizedscalingmetricspecification
|
|
3458
3488
|
'''
|
|
3459
3489
|
result = self._values.get("customized_scaling_metric_specification")
|
|
@@ -3463,7 +3493,8 @@ class CfnScalingPolicy(
|
|
|
3463
3493
|
def predefined_load_metric_specification(
|
|
3464
3494
|
self,
|
|
3465
3495
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnScalingPolicy.PredictiveScalingPredefinedLoadMetricProperty"]]:
|
|
3466
|
-
'''
|
|
3496
|
+
'''The predefined load metric specification.
|
|
3497
|
+
|
|
3467
3498
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricspecification.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingmetricspecification-predefinedloadmetricspecification
|
|
3468
3499
|
'''
|
|
3469
3500
|
result = self._values.get("predefined_load_metric_specification")
|
|
@@ -3473,7 +3504,8 @@ class CfnScalingPolicy(
|
|
|
3473
3504
|
def predefined_metric_pair_specification(
|
|
3474
3505
|
self,
|
|
3475
3506
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnScalingPolicy.PredictiveScalingPredefinedMetricPairProperty"]]:
|
|
3476
|
-
'''
|
|
3507
|
+
'''The predefined metric pair specification that determines the appropriate scaling metric and load metric to use.
|
|
3508
|
+
|
|
3477
3509
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricspecification.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingmetricspecification-predefinedmetricpairspecification
|
|
3478
3510
|
'''
|
|
3479
3511
|
result = self._values.get("predefined_metric_pair_specification")
|
|
@@ -3483,7 +3515,8 @@ class CfnScalingPolicy(
|
|
|
3483
3515
|
def predefined_scaling_metric_specification(
|
|
3484
3516
|
self,
|
|
3485
3517
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnScalingPolicy.PredictiveScalingPredefinedScalingMetricProperty"]]:
|
|
3486
|
-
'''
|
|
3518
|
+
'''The predefined scaling metric specification.
|
|
3519
|
+
|
|
3487
3520
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricspecification.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingmetricspecification-predefinedscalingmetricspecification
|
|
3488
3521
|
'''
|
|
3489
3522
|
result = self._values.get("predefined_scaling_metric_specification")
|
|
@@ -3513,10 +3546,11 @@ class CfnScalingPolicy(
|
|
|
3513
3546
|
stat: typing.Optional[builtins.str] = None,
|
|
3514
3547
|
unit: typing.Optional[builtins.str] = None,
|
|
3515
3548
|
) -> None:
|
|
3516
|
-
'''
|
|
3517
|
-
|
|
3518
|
-
:param
|
|
3519
|
-
:param
|
|
3549
|
+
'''This structure defines the CloudWatch metric to return, along with the statistic and unit.
|
|
3550
|
+
|
|
3551
|
+
:param metric: The CloudWatch metric to return, including the metric name, namespace, and dimensions. 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>`_ .
|
|
3552
|
+
: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 metrics for predictive scaling are ``Average`` and ``Sum`` .
|
|
3553
|
+
: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* .
|
|
3520
3554
|
|
|
3521
3555
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricstat.html
|
|
3522
3556
|
:exampleMetadata: fixture=_generated
|
|
@@ -3557,7 +3591,10 @@ class CfnScalingPolicy(
|
|
|
3557
3591
|
def metric(
|
|
3558
3592
|
self,
|
|
3559
3593
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnScalingPolicy.PredictiveScalingMetricProperty"]]:
|
|
3560
|
-
'''
|
|
3594
|
+
'''The CloudWatch metric to return, including the metric name, namespace, and dimensions.
|
|
3595
|
+
|
|
3596
|
+
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>`_ .
|
|
3597
|
+
|
|
3561
3598
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricstat.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingmetricstat-metric
|
|
3562
3599
|
'''
|
|
3563
3600
|
result = self._values.get("metric")
|
|
@@ -3567,7 +3604,9 @@ class CfnScalingPolicy(
|
|
|
3567
3604
|
def stat(self) -> typing.Optional[builtins.str]:
|
|
3568
3605
|
'''The statistic to return.
|
|
3569
3606
|
|
|
3570
|
-
It can include any CloudWatch statistic or extended statistic.
|
|
3607
|
+
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* .
|
|
3608
|
+
|
|
3609
|
+
The most commonly used metrics for predictive scaling are ``Average`` and ``Sum`` .
|
|
3571
3610
|
|
|
3572
3611
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricstat.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingmetricstat-stat
|
|
3573
3612
|
'''
|
|
@@ -3578,6 +3617,8 @@ class CfnScalingPolicy(
|
|
|
3578
3617
|
def unit(self) -> typing.Optional[builtins.str]:
|
|
3579
3618
|
'''The unit to use for the returned data points.
|
|
3580
3619
|
|
|
3620
|
+
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* .
|
|
3621
|
+
|
|
3581
3622
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricstat.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingmetricstat-unit
|
|
3582
3623
|
'''
|
|
3583
3624
|
result = self._values.get("unit")
|
|
@@ -3615,12 +3656,13 @@ class CfnScalingPolicy(
|
|
|
3615
3656
|
mode: typing.Optional[builtins.str] = None,
|
|
3616
3657
|
scheduling_buffer_time: typing.Optional[jsii.Number] = None,
|
|
3617
3658
|
) -> None:
|
|
3618
|
-
'''
|
|
3619
|
-
|
|
3620
|
-
:param
|
|
3621
|
-
:param
|
|
3622
|
-
:param
|
|
3623
|
-
:param
|
|
3659
|
+
'''Represents a predictive scaling policy configuration.
|
|
3660
|
+
|
|
3661
|
+
:param metric_specifications: This structure includes the metrics and target utilization to use for predictive scaling. This is an array, but we currently only support a single metric specification. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric.
|
|
3662
|
+
:param max_capacity_breach_behavior: Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to ``HonorMaxCapacity`` if not specified.
|
|
3663
|
+
:param max_capacity_buffer: The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55. Required if the ``MaxCapacityBreachBehavior`` property is set to ``IncreaseMaxCapacity`` , and cannot be used otherwise.
|
|
3664
|
+
:param mode: The predictive scaling mode. Defaults to ``ForecastOnly`` if not specified.
|
|
3665
|
+
:param scheduling_buffer_time: The amount of time, in seconds, that the start time can be advanced. The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified.
|
|
3624
3666
|
|
|
3625
3667
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingpolicyconfiguration.html
|
|
3626
3668
|
:exampleMetadata: fixture=_generated
|
|
@@ -3746,7 +3788,10 @@ class CfnScalingPolicy(
|
|
|
3746
3788
|
def metric_specifications(
|
|
3747
3789
|
self,
|
|
3748
3790
|
) -> typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnScalingPolicy.PredictiveScalingMetricSpecificationProperty"]]]:
|
|
3749
|
-
'''
|
|
3791
|
+
'''This structure includes the metrics and target utilization to use for predictive scaling.
|
|
3792
|
+
|
|
3793
|
+
This is an array, but we currently only support a single metric specification. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric.
|
|
3794
|
+
|
|
3750
3795
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingpolicyconfiguration-metricspecifications
|
|
3751
3796
|
'''
|
|
3752
3797
|
result = self._values.get("metric_specifications")
|
|
@@ -3755,7 +3800,10 @@ class CfnScalingPolicy(
|
|
|
3755
3800
|
|
|
3756
3801
|
@builtins.property
|
|
3757
3802
|
def max_capacity_breach_behavior(self) -> typing.Optional[builtins.str]:
|
|
3758
|
-
'''
|
|
3803
|
+
'''Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity.
|
|
3804
|
+
|
|
3805
|
+
Defaults to ``HonorMaxCapacity`` if not specified.
|
|
3806
|
+
|
|
3759
3807
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingpolicyconfiguration-maxcapacitybreachbehavior
|
|
3760
3808
|
'''
|
|
3761
3809
|
result = self._values.get("max_capacity_breach_behavior")
|
|
@@ -3763,7 +3811,12 @@ class CfnScalingPolicy(
|
|
|
3763
3811
|
|
|
3764
3812
|
@builtins.property
|
|
3765
3813
|
def max_capacity_buffer(self) -> typing.Optional[jsii.Number]:
|
|
3766
|
-
'''
|
|
3814
|
+
'''The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity.
|
|
3815
|
+
|
|
3816
|
+
The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.
|
|
3817
|
+
|
|
3818
|
+
Required if the ``MaxCapacityBreachBehavior`` property is set to ``IncreaseMaxCapacity`` , and cannot be used otherwise.
|
|
3819
|
+
|
|
3767
3820
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingpolicyconfiguration-maxcapacitybuffer
|
|
3768
3821
|
'''
|
|
3769
3822
|
result = self._values.get("max_capacity_buffer")
|
|
@@ -3771,7 +3824,10 @@ class CfnScalingPolicy(
|
|
|
3771
3824
|
|
|
3772
3825
|
@builtins.property
|
|
3773
3826
|
def mode(self) -> typing.Optional[builtins.str]:
|
|
3774
|
-
'''
|
|
3827
|
+
'''The predictive scaling mode.
|
|
3828
|
+
|
|
3829
|
+
Defaults to ``ForecastOnly`` if not specified.
|
|
3830
|
+
|
|
3775
3831
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingpolicyconfiguration-mode
|
|
3776
3832
|
'''
|
|
3777
3833
|
result = self._values.get("mode")
|
|
@@ -3779,7 +3835,10 @@ class CfnScalingPolicy(
|
|
|
3779
3835
|
|
|
3780
3836
|
@builtins.property
|
|
3781
3837
|
def scheduling_buffer_time(self) -> typing.Optional[jsii.Number]:
|
|
3782
|
-
'''
|
|
3838
|
+
'''The amount of time, in seconds, that the start time can be advanced.
|
|
3839
|
+
|
|
3840
|
+
The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified.
|
|
3841
|
+
|
|
3783
3842
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingpolicyconfiguration-schedulingbuffertime
|
|
3784
3843
|
'''
|
|
3785
3844
|
result = self._values.get("scheduling_buffer_time")
|
|
@@ -3811,9 +3870,12 @@ class CfnScalingPolicy(
|
|
|
3811
3870
|
predefined_metric_type: builtins.str,
|
|
3812
3871
|
resource_label: typing.Optional[builtins.str] = None,
|
|
3813
3872
|
) -> None:
|
|
3814
|
-
'''
|
|
3815
|
-
|
|
3816
|
-
|
|
3873
|
+
'''Describes a load metric for a predictive scaling policy.
|
|
3874
|
+
|
|
3875
|
+
When returned in the output of ``DescribePolicies`` , it indicates that a predictive scaling policy uses individually specified load and scaling metrics instead of a metric pair.
|
|
3876
|
+
|
|
3877
|
+
:param predefined_metric_type: The metric type.
|
|
3878
|
+
:param resource_label: A label that uniquely identifies a target group.
|
|
3817
3879
|
|
|
3818
3880
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingpredefinedloadmetric.html
|
|
3819
3881
|
:exampleMetadata: fixture=_generated
|
|
@@ -3843,7 +3905,8 @@ class CfnScalingPolicy(
|
|
|
3843
3905
|
|
|
3844
3906
|
@builtins.property
|
|
3845
3907
|
def predefined_metric_type(self) -> builtins.str:
|
|
3846
|
-
'''
|
|
3908
|
+
'''The metric type.
|
|
3909
|
+
|
|
3847
3910
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingpredefinedloadmetric.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingpredefinedloadmetric-predefinedmetrictype
|
|
3848
3911
|
'''
|
|
3849
3912
|
result = self._values.get("predefined_metric_type")
|
|
@@ -3852,7 +3915,8 @@ class CfnScalingPolicy(
|
|
|
3852
3915
|
|
|
3853
3916
|
@builtins.property
|
|
3854
3917
|
def resource_label(self) -> typing.Optional[builtins.str]:
|
|
3855
|
-
'''
|
|
3918
|
+
'''A label that uniquely identifies a target group.
|
|
3919
|
+
|
|
3856
3920
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingpredefinedloadmetric.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingpredefinedloadmetric-resourcelabel
|
|
3857
3921
|
'''
|
|
3858
3922
|
result = self._values.get("resource_label")
|
|
@@ -3884,9 +3948,10 @@ class CfnScalingPolicy(
|
|
|
3884
3948
|
predefined_metric_type: builtins.str,
|
|
3885
3949
|
resource_label: typing.Optional[builtins.str] = None,
|
|
3886
3950
|
) -> None:
|
|
3887
|
-
'''
|
|
3888
|
-
|
|
3889
|
-
:param
|
|
3951
|
+
'''Represents a metric pair for a predictive scaling policy.
|
|
3952
|
+
|
|
3953
|
+
:param predefined_metric_type: Indicates which metrics to use. There are two different types of metrics for each metric type: one is a load metric and one is a scaling metric.
|
|
3954
|
+
:param resource_label: A label that uniquely identifies a specific target group from which to determine the total and average request count.
|
|
3890
3955
|
|
|
3891
3956
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingpredefinedmetricpair.html
|
|
3892
3957
|
:exampleMetadata: fixture=_generated
|
|
@@ -3916,7 +3981,10 @@ class CfnScalingPolicy(
|
|
|
3916
3981
|
|
|
3917
3982
|
@builtins.property
|
|
3918
3983
|
def predefined_metric_type(self) -> builtins.str:
|
|
3919
|
-
'''
|
|
3984
|
+
'''Indicates which metrics to use.
|
|
3985
|
+
|
|
3986
|
+
There are two different types of metrics for each metric type: one is a load metric and one is a scaling metric.
|
|
3987
|
+
|
|
3920
3988
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingpredefinedmetricpair.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingpredefinedmetricpair-predefinedmetrictype
|
|
3921
3989
|
'''
|
|
3922
3990
|
result = self._values.get("predefined_metric_type")
|
|
@@ -3925,7 +3993,8 @@ class CfnScalingPolicy(
|
|
|
3925
3993
|
|
|
3926
3994
|
@builtins.property
|
|
3927
3995
|
def resource_label(self) -> typing.Optional[builtins.str]:
|
|
3928
|
-
'''
|
|
3996
|
+
'''A label that uniquely identifies a specific target group from which to determine the total and average request count.
|
|
3997
|
+
|
|
3929
3998
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingpredefinedmetricpair.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingpredefinedmetricpair-resourcelabel
|
|
3930
3999
|
'''
|
|
3931
4000
|
result = self._values.get("resource_label")
|
|
@@ -3957,9 +4026,12 @@ class CfnScalingPolicy(
|
|
|
3957
4026
|
predefined_metric_type: builtins.str,
|
|
3958
4027
|
resource_label: typing.Optional[builtins.str] = None,
|
|
3959
4028
|
) -> None:
|
|
3960
|
-
'''
|
|
3961
|
-
|
|
3962
|
-
|
|
4029
|
+
'''Describes a scaling metric for a predictive scaling policy.
|
|
4030
|
+
|
|
4031
|
+
When returned in the output of ``DescribePolicies`` , it indicates that a predictive scaling policy uses individually specified load and scaling metrics instead of a metric pair.
|
|
4032
|
+
|
|
4033
|
+
:param predefined_metric_type: The metric type.
|
|
4034
|
+
:param resource_label: A label that uniquely identifies a specific target group from which to determine the average request count.
|
|
3963
4035
|
|
|
3964
4036
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingpredefinedscalingmetric.html
|
|
3965
4037
|
:exampleMetadata: fixture=_generated
|
|
@@ -3989,7 +4061,8 @@ class CfnScalingPolicy(
|
|
|
3989
4061
|
|
|
3990
4062
|
@builtins.property
|
|
3991
4063
|
def predefined_metric_type(self) -> builtins.str:
|
|
3992
|
-
'''
|
|
4064
|
+
'''The metric type.
|
|
4065
|
+
|
|
3993
4066
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingpredefinedscalingmetric.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingpredefinedscalingmetric-predefinedmetrictype
|
|
3994
4067
|
'''
|
|
3995
4068
|
result = self._values.get("predefined_metric_type")
|
|
@@ -3998,7 +4071,8 @@ class CfnScalingPolicy(
|
|
|
3998
4071
|
|
|
3999
4072
|
@builtins.property
|
|
4000
4073
|
def resource_label(self) -> typing.Optional[builtins.str]:
|
|
4001
|
-
'''
|
|
4074
|
+
'''A label that uniquely identifies a specific target group from which to determine the average request count.
|
|
4075
|
+
|
|
4002
4076
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingpredefinedscalingmetric.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingpredefinedscalingmetric-resourcelabel
|
|
4003
4077
|
'''
|
|
4004
4078
|
result = self._values.get("resource_label")
|
|
@@ -4927,7 +5001,7 @@ class CfnScalingPolicyProps:
|
|
|
4927
5001
|
|
|
4928
5002
|
:param policy_name: The name of the scaling policy. Updates to the name of a target tracking scaling policy are not supported, unless you also update the metric used for scaling. To change only a target tracking scaling policy's name, first delete the policy by removing the existing ``AWS::ApplicationAutoScaling::ScalingPolicy`` resource from the template and updating the stack. Then, recreate the resource with the same settings and a different name.
|
|
4929
5003
|
:param policy_type: The scaling policy type. The following policy types are supported: ``TargetTrackingScaling`` —Not supported for Amazon EMR ``StepScaling`` —Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune.
|
|
4930
|
-
:param predictive_scaling_policy_configuration:
|
|
5004
|
+
:param predictive_scaling_policy_configuration: The predictive scaling policy configuration.
|
|
4931
5005
|
:param resource_id: The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. - ECS service - The resource type is ``service`` and the unique identifier is the cluster name and service name. Example: ``service/my-cluster/my-service`` . - Spot Fleet - The resource type is ``spot-fleet-request`` and the unique identifier is the Spot Fleet request ID. Example: ``spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE`` . - EMR cluster - The resource type is ``instancegroup`` and the unique identifier is the cluster ID and instance group ID. Example: ``instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0`` . - AppStream 2.0 fleet - The resource type is ``fleet`` and the unique identifier is the fleet name. Example: ``fleet/sample-fleet`` . - DynamoDB table - The resource type is ``table`` and the unique identifier is the table name. Example: ``table/my-table`` . - DynamoDB global secondary index - The resource type is ``index`` and the unique identifier is the index name. Example: ``table/my-table/index/my-table-index`` . - Aurora DB cluster - The resource type is ``cluster`` and the unique identifier is the cluster name. Example: ``cluster:my-db-cluster`` . - SageMaker endpoint variant - The resource type is ``variant`` and the unique identifier is the resource ID. Example: ``endpoint/my-end-point/variant/KMeansClustering`` . - Custom resources are not supported with a resource type. This parameter must specify the ``OutputValue`` from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our `GitHub repository <https://docs.aws.amazon.com/https://github.com/aws/aws-auto-scaling-custom-resource>`_ . - Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: ``arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE`` . - Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: ``arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE`` . - Lambda provisioned concurrency - The resource type is ``function`` and the unique identifier is the function name with a function version or alias name suffix that is not ``$LATEST`` . Example: ``function:my-function:prod`` or ``function:my-function:1`` . - Amazon Keyspaces table - The resource type is ``table`` and the unique identifier is the table name. Example: ``keyspace/mykeyspace/table/mytable`` . - Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: ``arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5`` . - Amazon ElastiCache replication group - The resource type is ``replication-group`` and the unique identifier is the replication group name. Example: ``replication-group/mycluster`` . - Neptune cluster - The resource type is ``cluster`` and the unique identifier is the cluster name. Example: ``cluster:mycluster`` . - SageMaker serverless endpoint - The resource type is ``variant`` and the unique identifier is the resource ID. Example: ``endpoint/my-end-point/variant/KMeansClustering`` . - SageMaker inference component - The resource type is ``inference-component`` and the unique identifier is the resource ID. Example: ``inference-component/my-inference-component`` . - Pool of WorkSpaces - The resource type is ``workspacespool`` and the unique identifier is the pool ID. Example: ``workspacespool/wspool-123456`` .
|
|
4932
5006
|
:param scalable_dimension: The scalable dimension. This string consists of the service namespace, resource type, and scaling property. - ``ecs:service:DesiredCount`` - The task count of an ECS service. - ``elasticmapreduce:instancegroup:InstanceCount`` - The instance count of an EMR Instance Group. - ``ec2:spot-fleet-request:TargetCapacity`` - The target capacity of a Spot Fleet. - ``appstream:fleet:DesiredCapacity`` - The capacity of an AppStream 2.0 fleet. - ``dynamodb:table:ReadCapacityUnits`` - The provisioned read capacity for a DynamoDB table. - ``dynamodb:table:WriteCapacityUnits`` - The provisioned write capacity for a DynamoDB table. - ``dynamodb:index:ReadCapacityUnits`` - The provisioned read capacity for a DynamoDB global secondary index. - ``dynamodb:index:WriteCapacityUnits`` - The provisioned write capacity for a DynamoDB global secondary index. - ``rds:cluster:ReadReplicaCount`` - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. - ``sagemaker:variant:DesiredInstanceCount`` - The number of EC2 instances for a SageMaker model endpoint variant. - ``custom-resource:ResourceType:Property`` - The scalable dimension for a custom resource provided by your own application or service. - ``comprehend:document-classifier-endpoint:DesiredInferenceUnits`` - The number of inference units for an Amazon Comprehend document classification endpoint. - ``comprehend:entity-recognizer-endpoint:DesiredInferenceUnits`` - The number of inference units for an Amazon Comprehend entity recognizer endpoint. - ``lambda:function:ProvisionedConcurrency`` - The provisioned concurrency for a Lambda function. - ``cassandra:table:ReadCapacityUnits`` - The provisioned read capacity for an Amazon Keyspaces table. - ``cassandra:table:WriteCapacityUnits`` - The provisioned write capacity for an Amazon Keyspaces table. - ``kafka:broker-storage:VolumeSize`` - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster. - ``elasticache:replication-group:NodeGroups`` - The number of node groups for an Amazon ElastiCache replication group. - ``elasticache:replication-group:Replicas`` - The number of replicas per node group for an Amazon ElastiCache replication group. - ``neptune:cluster:ReadReplicaCount`` - The count of read replicas in an Amazon Neptune DB cluster. - ``sagemaker:variant:DesiredProvisionedConcurrency`` - The provisioned concurrency for a SageMaker serverless endpoint. - ``sagemaker:inference-component:DesiredCopyCount`` - The number of copies across an endpoint for a SageMaker inference component. - ``workspaces:workspacespool:DesiredUserSessions`` - The number of user sessions for the WorkSpaces in the pool.
|
|
4933
5007
|
:param scaling_target_id: The CloudFormation-generated ID of an Application Auto Scaling scalable target. For more information about the ID, see the Return Value section of the ``AWS::ApplicationAutoScaling::ScalableTarget`` resource. .. epigraph:: You must specify either the ``ScalingTargetId`` property, or the ``ResourceId`` , ``ScalableDimension`` , and ``ServiceNamespace`` properties, but not both.
|
|
@@ -5163,7 +5237,8 @@ class CfnScalingPolicyProps:
|
|
|
5163
5237
|
def predictive_scaling_policy_configuration(
|
|
5164
5238
|
self,
|
|
5165
5239
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnScalingPolicy.PredictiveScalingPolicyConfigurationProperty]]:
|
|
5166
|
-
'''
|
|
5240
|
+
'''The predictive scaling policy configuration.
|
|
5241
|
+
|
|
5167
5242
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingpolicyconfiguration
|
|
5168
5243
|
'''
|
|
5169
5244
|
result = self._values.get("predictive_scaling_policy_configuration")
|
aws_cdk/aws_appsync/__init__.py
CHANGED
|
@@ -4900,7 +4900,7 @@ class CfnDataSource(
|
|
|
4900
4900
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
4901
4901
|
:param api_id: Unique AWS AppSync GraphQL API identifier where this data source will be created.
|
|
4902
4902
|
:param name: Friendly name for you to identify your AppSync data source after creation.
|
|
4903
|
-
:param type: The type of the data source. - *AWS_LAMBDA* : The data source is an AWS Lambda function. - *AMAZON_DYNAMODB* : The data source is an Amazon DynamoDB table. - *AMAZON_ELASTICSEARCH* : The data source is an Amazon OpenSearch Service domain. - *AMAZON_EVENTBRIDGE* : The data source is an Amazon EventBridge event bus. - *AMAZON_OPENSEARCH_SERVICE* : The data source is an Amazon OpenSearch Service domain. - *NONE* : There is no data source. This type is used when you wish to invoke a GraphQL operation without connecting to a data source, such as performing data transformation with resolvers or triggering a subscription to be invoked from a mutation. - *HTTP* : The data source is an HTTP endpoint. - *RELATIONAL_DATABASE* : The data source is a relational database.
|
|
4903
|
+
:param type: The type of the data source. - *AWS_LAMBDA* : The data source is an AWS Lambda function. - *AMAZON_DYNAMODB* : The data source is an Amazon DynamoDB table. - *AMAZON_ELASTICSEARCH* : The data source is an Amazon OpenSearch Service domain. - *AMAZON_EVENTBRIDGE* : The data source is an Amazon EventBridge event bus. - *AMAZON_OPENSEARCH_SERVICE* : The data source is an Amazon OpenSearch Service domain. - *AMAZON_BEDROCK_RUNTIME* : The data source is the Amazon Bedrock runtime. - *NONE* : There is no data source. This type is used when you wish to invoke a GraphQL operation without connecting to a data source, such as performing data transformation with resolvers or triggering a subscription to be invoked from a mutation. - *HTTP* : The data source is an HTTP endpoint. - *RELATIONAL_DATABASE* : The data source is a relational database.
|
|
4904
4904
|
:param description: The description of the data source.
|
|
4905
4905
|
:param dynamo_db_config: AWS Region and TableName for an Amazon DynamoDB table in your account.
|
|
4906
4906
|
:param elasticsearch_config:
|
|
@@ -6168,7 +6168,7 @@ class CfnDataSourceProps:
|
|
|
6168
6168
|
|
|
6169
6169
|
:param api_id: Unique AWS AppSync GraphQL API identifier where this data source will be created.
|
|
6170
6170
|
:param name: Friendly name for you to identify your AppSync data source after creation.
|
|
6171
|
-
:param type: The type of the data source. - *AWS_LAMBDA* : The data source is an AWS Lambda function. - *AMAZON_DYNAMODB* : The data source is an Amazon DynamoDB table. - *AMAZON_ELASTICSEARCH* : The data source is an Amazon OpenSearch Service domain. - *AMAZON_EVENTBRIDGE* : The data source is an Amazon EventBridge event bus. - *AMAZON_OPENSEARCH_SERVICE* : The data source is an Amazon OpenSearch Service domain. - *NONE* : There is no data source. This type is used when you wish to invoke a GraphQL operation without connecting to a data source, such as performing data transformation with resolvers or triggering a subscription to be invoked from a mutation. - *HTTP* : The data source is an HTTP endpoint. - *RELATIONAL_DATABASE* : The data source is a relational database.
|
|
6171
|
+
:param type: The type of the data source. - *AWS_LAMBDA* : The data source is an AWS Lambda function. - *AMAZON_DYNAMODB* : The data source is an Amazon DynamoDB table. - *AMAZON_ELASTICSEARCH* : The data source is an Amazon OpenSearch Service domain. - *AMAZON_EVENTBRIDGE* : The data source is an Amazon EventBridge event bus. - *AMAZON_OPENSEARCH_SERVICE* : The data source is an Amazon OpenSearch Service domain. - *AMAZON_BEDROCK_RUNTIME* : The data source is the Amazon Bedrock runtime. - *NONE* : There is no data source. This type is used when you wish to invoke a GraphQL operation without connecting to a data source, such as performing data transformation with resolvers or triggering a subscription to be invoked from a mutation. - *HTTP* : The data source is an HTTP endpoint. - *RELATIONAL_DATABASE* : The data source is a relational database.
|
|
6172
6172
|
:param description: The description of the data source.
|
|
6173
6173
|
:param dynamo_db_config: AWS Region and TableName for an Amazon DynamoDB table in your account.
|
|
6174
6174
|
:param elasticsearch_config:
|
|
@@ -6325,6 +6325,7 @@ class CfnDataSourceProps:
|
|
|
6325
6325
|
- *AMAZON_ELASTICSEARCH* : The data source is an Amazon OpenSearch Service domain.
|
|
6326
6326
|
- *AMAZON_EVENTBRIDGE* : The data source is an Amazon EventBridge event bus.
|
|
6327
6327
|
- *AMAZON_OPENSEARCH_SERVICE* : The data source is an Amazon OpenSearch Service domain.
|
|
6328
|
+
- *AMAZON_BEDROCK_RUNTIME* : The data source is the Amazon Bedrock runtime.
|
|
6328
6329
|
- *NONE* : There is no data source. This type is used when you wish to invoke a GraphQL operation without connecting to a data source, such as performing data transformation with resolvers or triggering a subscription to be invoked from a mutation.
|
|
6329
6330
|
- *HTTP* : The data source is an HTTP endpoint.
|
|
6330
6331
|
- *RELATIONAL_DATABASE* : The data source is a relational database.
|
|
@@ -11499,7 +11500,7 @@ class Code(metaclass=jsii.JSIIAbstractClass, jsii_type="aws-cdk-lib.aws_appsync.
|
|
|
11499
11500
|
def from_inline(cls, code: builtins.str) -> "InlineCode":
|
|
11500
11501
|
'''Inline code for AppSync function.
|
|
11501
11502
|
|
|
11502
|
-
:param code: The actual handler code (
|
|
11503
|
+
:param code: The actual handler code (the resulting zip file cannot exceed 4MB).
|
|
11503
11504
|
|
|
11504
11505
|
:return: ``InlineCode`` with inline code.
|
|
11505
11506
|
'''
|