@awboost/cfn-resource-types 0.1.117 → 0.1.118
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.
- package/lib/AWS-ApplicationAutoScaling-ScalingPolicy.d.ts +142 -64
- package/lib/AWS-ApplicationAutoScaling-ScalingPolicy.js +2 -1
- package/lib/AWS-Bedrock-KnowledgeBase.d.ts +105 -2
- package/lib/AWS-ECR-RepositoryCreationTemplate.d.ts +6 -0
- package/lib/AWS-EKS-Cluster.d.ts +15 -0
- package/lib/AWS-GlobalAccelerator-CrossAccountAttachment.d.ts +2 -1
- package/lib/AWS-RDS-DBCluster.d.ts +2 -2
- package/lib/AWS-RDS-DBInstance.d.ts +1 -2
- package/lib/AWS-SecretsManager-ResourcePolicy.d.ts +15 -1
- package/package.json +1 -1
|
@@ -1,40 +1,80 @@
|
|
|
1
1
|
import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
|
|
2
2
|
import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
|
|
3
3
|
/**
|
|
4
|
-
*
|
|
4
|
+
* The ``AWS::ApplicationAutoScaling::ScalingPolicy`` resource defines a scaling policy that Application Auto Scaling uses to adjust the capacity of a scalable target.
|
|
5
|
+
For more information, see [Target tracking scaling policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) and [Step scaling policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) in the *Application Auto Scaling User Guide*.
|
|
5
6
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html}
|
|
6
7
|
*/
|
|
7
8
|
export type ApplicationAutoScalingScalingPolicyProperties = {
|
|
8
9
|
/**
|
|
9
10
|
* The name of the scaling policy.
|
|
10
|
-
|
|
11
|
-
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.
|
|
11
|
+
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.
|
|
12
12
|
*/
|
|
13
13
|
PolicyName: string;
|
|
14
14
|
/**
|
|
15
15
|
* The scaling policy type.
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
TargetTrackingScaling Not supported for Amazon EMR
|
|
20
|
-
|
|
21
|
-
StepScaling Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune.
|
|
16
|
+
The following policy types are supported:
|
|
17
|
+
``TargetTrackingScaling``—Not supported for Amazon EMR
|
|
18
|
+
``StepScaling``—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune.
|
|
22
19
|
*/
|
|
23
20
|
PolicyType: string;
|
|
24
21
|
/**
|
|
25
|
-
|
|
26
|
-
|
|
22
|
+
* The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
|
|
23
|
+
+ ECS service - The resource type is ``service`` and the unique identifier is the cluster name and service name. Example: ``service/my-cluster/my-service``.
|
|
24
|
+
+ 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``.
|
|
25
|
+
+ 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``.
|
|
26
|
+
+ AppStream 2.0 fleet - The resource type is ``fleet`` and the unique identifier is the fleet name. Example: ``fleet/sample-fleet``.
|
|
27
|
+
+ DynamoDB table - The resource type is ``table`` and the unique identifier is the table name. Example: ``table/my-table``.
|
|
28
|
+
+ 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``.
|
|
29
|
+
+ Aurora DB cluster - The resource type is ``cluster`` and the unique identifier is the cluster name. Example: ``cluster:my-db-cluster``.
|
|
30
|
+
+ SageMaker endpoint variant - The resource type is ``variant`` and the unique identifier is the resource ID. Example: ``endpoint/my-end-point/variant/KMeansClustering``.
|
|
31
|
+
+ 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).
|
|
32
|
+
+ 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``.
|
|
33
|
+
+ 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``.
|
|
34
|
+
+ 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``.
|
|
35
|
+
+ Amazon Keyspaces table - The resource type is ``table`` and the unique identifier is the table name. Example: ``keyspace/mykeyspace/table/mytable``.
|
|
36
|
+
+ 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``.
|
|
37
|
+
+ Amazon ElastiCache replication group - The resource type is ``replication-group`` and the unique identifier is the replication group name. Example: ``replication-group/mycluster``.
|
|
38
|
+
+ Neptune cluster - The resource type is ``cluster`` and the unique identifier is the cluster name. Example: ``cluster:mycluster``.
|
|
39
|
+
+ SageMaker serverless endpoint - The resource type is ``variant`` and the unique identifier is the resource ID. Example: ``endpoint/my-end-point/variant/KMeansClustering``.
|
|
40
|
+
+ SageMaker inference component - The resource type is ``inference-component`` and the unique identifier is the resource ID. Example: ``inference-component/my-inference-component``.
|
|
41
|
+
+ Pool of WorkSpaces - The resource type is ``workspacespool`` and the unique identifier is the pool ID. Example: ``workspacespool/wspool-123456``.
|
|
42
|
+
*/
|
|
27
43
|
ResourceId?: string;
|
|
28
44
|
/**
|
|
29
|
-
|
|
30
|
-
|
|
45
|
+
* The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
|
|
46
|
+
+ ``ecs:service:DesiredCount`` - The task count of an ECS service.
|
|
47
|
+
+ ``elasticmapreduce:instancegroup:InstanceCount`` - The instance count of an EMR Instance Group.
|
|
48
|
+
+ ``ec2:spot-fleet-request:TargetCapacity`` - The target capacity of a Spot Fleet.
|
|
49
|
+
+ ``appstream:fleet:DesiredCapacity`` - The capacity of an AppStream 2.0 fleet.
|
|
50
|
+
+ ``dynamodb:table:ReadCapacityUnits`` - The provisioned read capacity for a DynamoDB table.
|
|
51
|
+
+ ``dynamodb:table:WriteCapacityUnits`` - The provisioned write capacity for a DynamoDB table.
|
|
52
|
+
+ ``dynamodb:index:ReadCapacityUnits`` - The provisioned read capacity for a DynamoDB global secondary index.
|
|
53
|
+
+ ``dynamodb:index:WriteCapacityUnits`` - The provisioned write capacity for a DynamoDB global secondary index.
|
|
54
|
+
+ ``rds:cluster:ReadReplicaCount`` - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
|
|
55
|
+
+ ``sagemaker:variant:DesiredInstanceCount`` - The number of EC2 instances for a SageMaker model endpoint variant.
|
|
56
|
+
+ ``custom-resource:ResourceType:Property`` - The scalable dimension for a custom resource provided by your own application or service.
|
|
57
|
+
+ ``comprehend:document-classifier-endpoint:DesiredInferenceUnits`` - The number of inference units for an Amazon Comprehend document classification endpoint.
|
|
58
|
+
+ ``comprehend:entity-recognizer-endpoint:DesiredInferenceUnits`` - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
|
|
59
|
+
+ ``lambda:function:ProvisionedConcurrency`` - The provisioned concurrency for a Lambda function.
|
|
60
|
+
+ ``cassandra:table:ReadCapacityUnits`` - The provisioned read capacity for an Amazon Keyspaces table.
|
|
61
|
+
+ ``cassandra:table:WriteCapacityUnits`` - The provisioned write capacity for an Amazon Keyspaces table.
|
|
62
|
+
+ ``kafka:broker-storage:VolumeSize`` - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
|
|
63
|
+
+ ``elasticache:replication-group:NodeGroups`` - The number of node groups for an Amazon ElastiCache replication group.
|
|
64
|
+
+ ``elasticache:replication-group:Replicas`` - The number of replicas per node group for an Amazon ElastiCache replication group.
|
|
65
|
+
+ ``neptune:cluster:ReadReplicaCount`` - The count of read replicas in an Amazon Neptune DB cluster.
|
|
66
|
+
+ ``sagemaker:variant:DesiredProvisionedConcurrency`` - The provisioned concurrency for a SageMaker serverless endpoint.
|
|
67
|
+
+ ``sagemaker:inference-component:DesiredCopyCount`` - The number of copies across an endpoint for a SageMaker inference component.
|
|
68
|
+
+ ``workspaces:workspacespool:DesiredUserSessions`` - The number of user sessions for the WorkSpaces in the pool.
|
|
69
|
+
*/
|
|
31
70
|
ScalableDimension?: string;
|
|
32
71
|
/**
|
|
33
|
-
|
|
34
|
-
|
|
72
|
+
* 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.
|
|
73
|
+
You must specify either the ``ScalingTargetId`` property, or the ``ResourceId``, ``ScalableDimension``, and ``ServiceNamespace`` properties, but not both.
|
|
74
|
+
*/
|
|
35
75
|
ScalingTargetId?: string;
|
|
36
76
|
/**
|
|
37
|
-
* The namespace of the AWS service that provides the resource, or a custom-resource
|
|
77
|
+
* The namespace of the AWS service that provides the resource, or a ``custom-resource``.
|
|
38
78
|
*/
|
|
39
79
|
ServiceNamespace?: string;
|
|
40
80
|
/**
|
|
@@ -51,23 +91,29 @@ export type ApplicationAutoScalingScalingPolicyProperties = {
|
|
|
51
91
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#aws-resource-applicationautoscaling-scalingpolicy-return-values}
|
|
52
92
|
*/
|
|
53
93
|
export type ApplicationAutoScalingScalingPolicyAttributes = {
|
|
54
|
-
/**
|
|
55
|
-
* ARN is a read only property for the resource.
|
|
56
|
-
*/
|
|
57
94
|
Arn: string;
|
|
58
95
|
};
|
|
59
96
|
/**
|
|
60
97
|
* Type definition for `AWS::ApplicationAutoScaling::ScalingPolicy.CustomizedMetricSpecification`.
|
|
61
|
-
*
|
|
98
|
+
* Contains customized metric specification information for a target tracking scaling policy for Application Auto Scaling.
|
|
99
|
+
For information about the available metrics for a service, see [services that publish CloudWatch metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) in the *Amazon CloudWatch User Guide*.
|
|
100
|
+
To create your customized metric specification:
|
|
101
|
+
+ Add values for each required parameter from CloudWatch. You can use an existing metric, or a new metric that you create. To use your own metric, you must first publish the metric to CloudWatch. For more information, see [Publish custom metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html) in the *Amazon CloudWatch User Guide*.
|
|
102
|
+
+ Choose a metric that changes proportionally with capacity. The value of the metric should increase or decrease in inverse proportion to the number of capacity units. That is, the value of the metric should decrease when capacity increases, and increase when capacity decreases.
|
|
103
|
+
|
|
104
|
+
For an example of how creating new metrics can be useful, see [Scaling based on Amazon SQS](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-using-sqs-queue.html) in the *Amazon EC2 Auto Scaling User Guide*. This topic mentions Auto Scaling groups, but the same scenario for Amazon SQS can apply to the target tracking scaling policies that you create for a Spot Fleet by using Application Auto Scaling.
|
|
105
|
+
For more information about the CloudWatch terminology below, see [Amazon CloudWatch concepts](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html).
|
|
106
|
+
``CustomizedMetricSpecification`` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingScalingPolicyConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html) property type.
|
|
62
107
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-customizedmetricspecification.html}
|
|
63
108
|
*/
|
|
64
109
|
export type CustomizedMetricSpecification = {
|
|
65
110
|
/**
|
|
66
|
-
|
|
67
|
-
|
|
111
|
+
* The dimensions of the metric.
|
|
112
|
+
Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
|
|
113
|
+
*/
|
|
68
114
|
Dimensions?: MetricDimension[];
|
|
69
115
|
/**
|
|
70
|
-
* The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metric object that
|
|
116
|
+
* The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the [Metric](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html) object that's returned by a call to [ListMetrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html).
|
|
71
117
|
*/
|
|
72
118
|
MetricName?: string;
|
|
73
119
|
/**
|
|
@@ -83,13 +129,13 @@ export type CustomizedMetricSpecification = {
|
|
|
83
129
|
*/
|
|
84
130
|
Statistic?: string;
|
|
85
131
|
/**
|
|
86
|
-
* The unit of the metric. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference
|
|
132
|
+
* The unit of the metric. For a complete list of the units that CloudWatch supports, see the [MetricDatum](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) data type in the *Amazon CloudWatch API Reference*.
|
|
87
133
|
*/
|
|
88
134
|
Unit?: string;
|
|
89
135
|
};
|
|
90
136
|
/**
|
|
91
137
|
* Type definition for `AWS::ApplicationAutoScaling::ScalingPolicy.MetricDimension`.
|
|
92
|
-
*
|
|
138
|
+
* ``MetricDimension`` specifies a name/value pair that is part of the identity of a CloudWatch metric for the ``Dimensions`` property of the [AWS::ApplicationAutoScaling::ScalingPolicy CustomizedMetricSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-customizedmetricspecification.html) property type. Duplicate dimensions are not allowed.
|
|
93
139
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-metricdimension.html}
|
|
94
140
|
*/
|
|
95
141
|
export type MetricDimension = {
|
|
@@ -104,96 +150,120 @@ export type MetricDimension = {
|
|
|
104
150
|
};
|
|
105
151
|
/**
|
|
106
152
|
* Type definition for `AWS::ApplicationAutoScaling::ScalingPolicy.PredefinedMetricSpecification`.
|
|
107
|
-
*
|
|
153
|
+
* Contains predefined metric specification information for a target tracking scaling policy for Application Auto Scaling.
|
|
154
|
+
``PredefinedMetricSpecification`` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingScalingPolicyConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html) property type.
|
|
108
155
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predefinedmetricspecification.html}
|
|
109
156
|
*/
|
|
110
157
|
export type PredefinedMetricSpecification = {
|
|
111
158
|
/**
|
|
112
|
-
* The metric type. The ALBRequestCountPerTarget metric type applies only to Spot
|
|
159
|
+
* The metric type. The ``ALBRequestCountPerTarget`` metric type applies only to Spot fleet requests and ECS services.
|
|
113
160
|
*/
|
|
114
161
|
PredefinedMetricType: string;
|
|
115
162
|
/**
|
|
116
|
-
|
|
117
|
-
|
|
163
|
+
* Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ``ALBRequestCountPerTarget`` and there is a target group attached to the Spot Fleet or ECS service.
|
|
164
|
+
You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:
|
|
165
|
+
``app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff``.
|
|
166
|
+
Where:
|
|
167
|
+
+ app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
|
|
168
|
+
+ targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
|
|
169
|
+
|
|
170
|
+
To find the ARN for an Application Load Balancer, use the [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) API operation. To find the ARN for the target group, use the [DescribeTargetGroups](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) API operation.
|
|
171
|
+
*/
|
|
118
172
|
ResourceLabel?: string;
|
|
119
173
|
};
|
|
120
174
|
/**
|
|
121
175
|
* Type definition for `AWS::ApplicationAutoScaling::ScalingPolicy.StepAdjustment`.
|
|
122
|
-
*
|
|
176
|
+
* ``StepAdjustment`` specifies a step adjustment for the ``StepAdjustments`` property of the [AWS::ApplicationAutoScaling::ScalingPolicy StepScalingPolicyConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration.html) property type.
|
|
177
|
+
For the following examples, suppose that you have an alarm with a breach threshold of 50:
|
|
178
|
+
+ To trigger a step adjustment when the metric is greater than or equal to 50 and less than 60, specify a lower bound of 0 and an upper bound of 10.
|
|
179
|
+
+ To trigger a step adjustment when the metric is greater than 40 and less than or equal to 50, specify a lower bound of -10 and an upper bound of 0.
|
|
180
|
+
|
|
181
|
+
For more information, see [Step adjustments](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html#as-scaling-steps) in the *Application Auto Scaling User Guide*.
|
|
182
|
+
You can find a sample template snippet in the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#aws-resource-applicationautoscaling-scalingpolicy--examples) section of the ``AWS::ApplicationAutoScaling::ScalingPolicy`` documentation.
|
|
123
183
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepadjustment.html}
|
|
124
184
|
*/
|
|
125
185
|
export type StepAdjustment = {
|
|
126
186
|
/**
|
|
127
|
-
|
|
128
|
-
|
|
187
|
+
* The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.
|
|
188
|
+
You must specify at least one upper or lower bound.
|
|
189
|
+
*/
|
|
129
190
|
MetricIntervalLowerBound?: number;
|
|
130
191
|
/**
|
|
131
|
-
|
|
132
|
-
|
|
192
|
+
* The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.
|
|
193
|
+
You must specify at least one upper or lower bound.
|
|
194
|
+
*/
|
|
133
195
|
MetricIntervalUpperBound?: number;
|
|
134
196
|
/**
|
|
135
|
-
* The amount by which to scale
|
|
197
|
+
* The amount by which to scale. The adjustment is based on the value that you specified in the ``AdjustmentType`` property (either an absolute number or a percentage). A positive value adds to the current capacity and a negative number subtracts from the current capacity.
|
|
136
198
|
*/
|
|
137
199
|
ScalingAdjustment: number;
|
|
138
200
|
};
|
|
139
201
|
/**
|
|
140
202
|
* Type definition for `AWS::ApplicationAutoScaling::ScalingPolicy.StepScalingPolicyConfiguration`.
|
|
141
|
-
*
|
|
203
|
+
* ``StepScalingPolicyConfiguration`` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html) resource that specifies a step scaling policy configuration for Application Auto Scaling.
|
|
204
|
+
For more information, see [Step scaling policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) in the *Application Auto Scaling User Guide*.
|
|
142
205
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration.html}
|
|
143
206
|
*/
|
|
144
207
|
export type StepScalingPolicyConfiguration = {
|
|
145
208
|
/**
|
|
146
|
-
* Specifies
|
|
209
|
+
* Specifies whether the ``ScalingAdjustment`` value in the ``StepAdjustment`` property is an absolute number or a percentage of the current capacity.
|
|
147
210
|
*/
|
|
148
211
|
AdjustmentType?: string;
|
|
149
212
|
/**
|
|
150
|
-
* The amount of time, in seconds, to wait for a previous scaling activity to take effect.
|
|
213
|
+
* The amount of time, in seconds, to wait for a previous scaling activity to take effect. If not specified, the default value is 300. For more information, see [Cooldown period](https://docs.aws.amazon.com/autoscaling/application/userguide/step-scaling-policy-overview.html#step-scaling-cooldown) in the *Application Auto Scaling User Guide*.
|
|
151
214
|
*/
|
|
152
215
|
Cooldown?: number;
|
|
153
216
|
/**
|
|
154
|
-
* The aggregation type for the CloudWatch metrics. Valid values are Minimum
|
|
217
|
+
* The aggregation type for the CloudWatch metrics. Valid values are ``Minimum``, ``Maximum``, and ``Average``. If the aggregation type is null, the value is treated as ``Average``.
|
|
155
218
|
*/
|
|
156
219
|
MetricAggregationType?: string;
|
|
157
220
|
/**
|
|
158
|
-
* The minimum value to scale by when the adjustment type is PercentChangeInCapacity.
|
|
221
|
+
* The minimum value to scale by when the adjustment type is ``PercentChangeInCapacity``. For example, suppose that you create a step scaling policy to scale out an Amazon ECS service by 25 percent and you specify a ``MinAdjustmentMagnitude`` of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a ``MinAdjustmentMagnitude`` of 2, Application Auto Scaling scales out the service by 2 tasks.
|
|
159
222
|
*/
|
|
160
223
|
MinAdjustmentMagnitude?: number;
|
|
161
224
|
/**
|
|
162
|
-
|
|
163
|
-
|
|
225
|
+
* A set of adjustments that enable you to scale based on the size of the alarm breach.
|
|
226
|
+
At least one step adjustment is required if you are adding a new step scaling policy configuration.
|
|
227
|
+
*/
|
|
164
228
|
StepAdjustments?: StepAdjustment[];
|
|
165
229
|
};
|
|
166
230
|
/**
|
|
167
231
|
* Type definition for `AWS::ApplicationAutoScaling::ScalingPolicy.TargetTrackingMetric`.
|
|
168
|
-
* Represents a specific metric.
|
|
232
|
+
* Represents a specific metric for a target tracking scaling policy for Application Auto Scaling.
|
|
233
|
+
Metric is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingMetricStat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricstat.html) property type.
|
|
169
234
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetric.html}
|
|
170
235
|
*/
|
|
171
236
|
export type TargetTrackingMetric = {
|
|
172
237
|
/**
|
|
173
|
-
|
|
174
|
-
|
|
238
|
+
* The dimensions for the metric. For the list of available dimensions, see the AWS documentation available from the table in [services that publish CloudWatch metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) in the *Amazon CloudWatch User Guide*.
|
|
239
|
+
Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
|
|
240
|
+
*/
|
|
175
241
|
Dimensions?: TargetTrackingMetricDimension[];
|
|
176
242
|
/**
|
|
177
243
|
* The name of the metric.
|
|
178
244
|
*/
|
|
179
245
|
MetricName?: string;
|
|
180
246
|
/**
|
|
181
|
-
* The namespace of the metric.
|
|
247
|
+
* The namespace of the metric. For more information, see the table in [services that publish CloudWatch metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) in the *Amazon CloudWatch User Guide*.
|
|
182
248
|
*/
|
|
183
249
|
Namespace?: string;
|
|
184
250
|
};
|
|
185
251
|
/**
|
|
186
252
|
* Type definition for `AWS::ApplicationAutoScaling::ScalingPolicy.TargetTrackingMetricDataQuery`.
|
|
187
253
|
* The metric data to return. 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.
|
|
254
|
+
You can call for a single metric or perform math expressions on multiple metrics. Any expressions used in a metric specification must eventually return a single time series.
|
|
255
|
+
For more information and examples, see [Create a target tracking scaling policy for Application Auto Scaling using metric math](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking-metric-math.html) in the *Application Auto Scaling User Guide*.
|
|
256
|
+
``TargetTrackingMetricDataQuery`` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy CustomizedMetricSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-customizedmetricspecification.html) property type.
|
|
188
257
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricdataquery.html}
|
|
189
258
|
*/
|
|
190
259
|
export type TargetTrackingMetricDataQuery = {
|
|
191
260
|
/**
|
|
192
|
-
|
|
193
|
-
|
|
261
|
+
* 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.
|
|
262
|
+
Conditional: Within each ``TargetTrackingMetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat``, but not both.
|
|
263
|
+
*/
|
|
194
264
|
Expression?: string;
|
|
195
265
|
/**
|
|
196
|
-
* A short name that identifies the object's results in the response.
|
|
266
|
+
* 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.
|
|
197
267
|
*/
|
|
198
268
|
Id?: string;
|
|
199
269
|
/**
|
|
@@ -201,17 +271,20 @@ export type TargetTrackingMetricDataQuery = {
|
|
|
201
271
|
*/
|
|
202
272
|
Label?: string;
|
|
203
273
|
/**
|
|
204
|
-
|
|
205
|
-
|
|
274
|
+
* Information about the metric data to return.
|
|
275
|
+
Conditional: Within each ``MetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat``, but not both.
|
|
276
|
+
*/
|
|
206
277
|
MetricStat?: TargetTrackingMetricStat;
|
|
207
278
|
/**
|
|
208
|
-
|
|
209
|
-
|
|
279
|
+
* Indicates whether to return the timestamps and raw data values of this metric.
|
|
280
|
+
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.
|
|
281
|
+
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``).
|
|
282
|
+
*/
|
|
210
283
|
ReturnData?: boolean;
|
|
211
284
|
};
|
|
212
285
|
/**
|
|
213
286
|
* Type definition for `AWS::ApplicationAutoScaling::ScalingPolicy.TargetTrackingMetricDimension`.
|
|
214
|
-
*
|
|
287
|
+
* ``TargetTrackingMetricDimension`` specifies a name/value pair that is part of the identity of a CloudWatch metric for the ``Dimensions`` property of the [AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingMetric](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetric.html) property type. Duplicate dimensions are not allowed.
|
|
215
288
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricdimension.html}
|
|
216
289
|
*/
|
|
217
290
|
export type TargetTrackingMetricDimension = {
|
|
@@ -226,26 +299,30 @@ export type TargetTrackingMetricDimension = {
|
|
|
226
299
|
};
|
|
227
300
|
/**
|
|
228
301
|
* Type definition for `AWS::ApplicationAutoScaling::ScalingPolicy.TargetTrackingMetricStat`.
|
|
229
|
-
* This structure defines the CloudWatch metric to return, along with the statistic
|
|
302
|
+
* This structure defines the CloudWatch metric to return, along with the statistic and unit.
|
|
303
|
+
``TargetTrackingMetricStat`` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingMetricDataQuery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricdataquery.html) property type.
|
|
304
|
+
For more information about the CloudWatch terminology below, see [Amazon CloudWatch concepts](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html) in the *Amazon CloudWatch User Guide*.
|
|
230
305
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricstat.html}
|
|
231
306
|
*/
|
|
232
307
|
export type TargetTrackingMetricStat = {
|
|
233
308
|
/**
|
|
234
|
-
* The CloudWatch metric to return, including the metric name, namespace, and dimensions.
|
|
309
|
+
* 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).
|
|
235
310
|
*/
|
|
236
311
|
Metric?: TargetTrackingMetric;
|
|
237
312
|
/**
|
|
238
|
-
|
|
239
|
-
|
|
313
|
+
* 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*.
|
|
314
|
+
The most commonly used metric for scaling is ``Average``.
|
|
315
|
+
*/
|
|
240
316
|
Stat?: string;
|
|
241
317
|
/**
|
|
242
|
-
* The unit to use for the returned data points.
|
|
318
|
+
* 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*.
|
|
243
319
|
*/
|
|
244
320
|
Unit?: string;
|
|
245
321
|
};
|
|
246
322
|
/**
|
|
247
323
|
* Type definition for `AWS::ApplicationAutoScaling::ScalingPolicy.TargetTrackingScalingPolicyConfiguration`.
|
|
248
|
-
*
|
|
324
|
+
* ``TargetTrackingScalingPolicyConfiguration`` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html) resource that specifies a target tracking scaling policy configuration for Application Auto Scaling. Use a target tracking scaling policy to adjust the capacity of the specified scalable target in response to actual workloads, so that resource utilization remains at or near the target utilization value.
|
|
325
|
+
For more information, see [Target tracking scaling policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) in the *Application Auto Scaling User Guide*.
|
|
249
326
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html}
|
|
250
327
|
*/
|
|
251
328
|
export type TargetTrackingScalingPolicyConfiguration = {
|
|
@@ -254,7 +331,7 @@ export type TargetTrackingScalingPolicyConfiguration = {
|
|
|
254
331
|
*/
|
|
255
332
|
CustomizedMetricSpecification?: CustomizedMetricSpecification;
|
|
256
333
|
/**
|
|
257
|
-
* Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true
|
|
334
|
+
* Indicates whether scale in by the target tracking scaling policy is disabled. If the value is ``true``, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is ``false``.
|
|
258
335
|
*/
|
|
259
336
|
DisableScaleIn?: boolean;
|
|
260
337
|
/**
|
|
@@ -262,11 +339,11 @@ export type TargetTrackingScalingPolicyConfiguration = {
|
|
|
262
339
|
*/
|
|
263
340
|
PredefinedMetricSpecification?: PredefinedMetricSpecification;
|
|
264
341
|
/**
|
|
265
|
-
* The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start.
|
|
342
|
+
* The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. For more information and for default values, see [Define cooldown periods](https://docs.aws.amazon.com/autoscaling/application/userguide/target-tracking-scaling-policy-overview.html#target-tracking-cooldown) in the *Application Auto Scaling User Guide*.
|
|
266
343
|
*/
|
|
267
344
|
ScaleInCooldown?: number;
|
|
268
345
|
/**
|
|
269
|
-
* The amount of time, in seconds, to wait for a previous scale-out activity to take effect.
|
|
346
|
+
* The amount of time, in seconds, to wait for a previous scale-out activity to take effect. For more information and for default values, see [Define cooldown periods](https://docs.aws.amazon.com/autoscaling/application/userguide/target-tracking-scaling-policy-overview.html#target-tracking-cooldown) in the *Application Auto Scaling User Guide*.
|
|
270
347
|
*/
|
|
271
348
|
ScaleOutCooldown?: number;
|
|
272
349
|
/**
|
|
@@ -275,7 +352,8 @@ export type TargetTrackingScalingPolicyConfiguration = {
|
|
|
275
352
|
TargetValue: number;
|
|
276
353
|
};
|
|
277
354
|
/**
|
|
278
|
-
*
|
|
355
|
+
* The ``AWS::ApplicationAutoScaling::ScalingPolicy`` resource defines a scaling policy that Application Auto Scaling uses to adjust the capacity of a scalable target.
|
|
356
|
+
For more information, see [Target tracking scaling policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) and [Step scaling policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) in the *Application Auto Scaling User Guide*.
|
|
279
357
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html}
|
|
280
358
|
*/
|
|
281
359
|
export declare class ApplicationAutoScalingScalingPolicy extends $Resource<"AWS::ApplicationAutoScaling::ScalingPolicy", ApplicationAutoScalingScalingPolicyProperties, ApplicationAutoScalingScalingPolicyAttributes> {
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* The ``AWS::ApplicationAutoScaling::ScalingPolicy`` resource defines a scaling policy that Application Auto Scaling uses to adjust the capacity of a scalable target.
|
|
4
|
+
For more information, see [Target tracking scaling policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) and [Step scaling policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) in the *Application Auto Scaling User Guide*.
|
|
4
5
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html}
|
|
5
6
|
*/
|
|
6
7
|
export class ApplicationAutoScalingScalingPolicy extends $Resource {
|
|
@@ -70,6 +70,30 @@ export type BedrockKnowledgeBaseAttributes = {
|
|
|
70
70
|
*/
|
|
71
71
|
UpdatedAt: string;
|
|
72
72
|
};
|
|
73
|
+
/**
|
|
74
|
+
* Type definition for `AWS::Bedrock::KnowledgeBase.BedrockEmbeddingModelConfiguration`.
|
|
75
|
+
* The vector configuration details for the Bedrock embeddings model.
|
|
76
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-bedrockembeddingmodelconfiguration.html}
|
|
77
|
+
*/
|
|
78
|
+
export type BedrockEmbeddingModelConfiguration = {
|
|
79
|
+
/**
|
|
80
|
+
* The dimensions details for the vector configuration used on the Bedrock embeddings model.
|
|
81
|
+
* @min `0`
|
|
82
|
+
* @max `4096`
|
|
83
|
+
*/
|
|
84
|
+
Dimensions?: number;
|
|
85
|
+
};
|
|
86
|
+
/**
|
|
87
|
+
* Type definition for `AWS::Bedrock::KnowledgeBase.EmbeddingModelConfiguration`.
|
|
88
|
+
* The embeddings model configuration details for the vector model used in Knowledge Base.
|
|
89
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-embeddingmodelconfiguration.html}
|
|
90
|
+
*/
|
|
91
|
+
export type EmbeddingModelConfiguration = {
|
|
92
|
+
/**
|
|
93
|
+
* The vector configuration details for the Bedrock embeddings model.
|
|
94
|
+
*/
|
|
95
|
+
BedrockEmbeddingModelConfiguration?: BedrockEmbeddingModelConfiguration;
|
|
96
|
+
};
|
|
73
97
|
/**
|
|
74
98
|
* Type definition for `AWS::Bedrock::KnowledgeBase.KnowledgeBaseConfiguration`.
|
|
75
99
|
* Contains details about the embeddings model used for the knowledge base.
|
|
@@ -96,13 +120,84 @@ export type KnowledgeBaseStatus = "CREATING" | "ACTIVE" | "DELETING" | "UPDATING
|
|
|
96
120
|
* The storage type of a knowledge base.
|
|
97
121
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-knowledgebasestoragetype.html}
|
|
98
122
|
*/
|
|
99
|
-
export type KnowledgeBaseStorageType = "OPENSEARCH_SERVERLESS" | "PINECONE" | "RDS";
|
|
123
|
+
export type KnowledgeBaseStorageType = "OPENSEARCH_SERVERLESS" | "PINECONE" | "RDS" | "MONGO_DB_ATLAS";
|
|
100
124
|
/**
|
|
101
125
|
* Type definition for `AWS::Bedrock::KnowledgeBase.KnowledgeBaseType`.
|
|
102
126
|
* The type of a knowledge base.
|
|
103
127
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-knowledgebasetype.html}
|
|
104
128
|
*/
|
|
105
129
|
export type KnowledgeBaseType = "VECTOR";
|
|
130
|
+
/**
|
|
131
|
+
* Type definition for `AWS::Bedrock::KnowledgeBase.MongoDbAtlasConfiguration`.
|
|
132
|
+
* Contains the storage configuration of the knowledge base in MongoDb Atlas Cloud.
|
|
133
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-mongodbatlasconfiguration.html}
|
|
134
|
+
*/
|
|
135
|
+
export type MongoDbAtlasConfiguration = {
|
|
136
|
+
/**
|
|
137
|
+
* Name of the collection within MongoDB Atlas.
|
|
138
|
+
* @maxLength `63`
|
|
139
|
+
* @pattern `^.*$`
|
|
140
|
+
*/
|
|
141
|
+
CollectionName: string;
|
|
142
|
+
/**
|
|
143
|
+
* The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon Mongo database.
|
|
144
|
+
* @pattern `^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$`
|
|
145
|
+
*/
|
|
146
|
+
CredentialsSecretArn: string;
|
|
147
|
+
/**
|
|
148
|
+
* Name of the database within MongoDB Atlas.
|
|
149
|
+
* @maxLength `63`
|
|
150
|
+
* @pattern `^.*$`
|
|
151
|
+
*/
|
|
152
|
+
DatabaseName: string;
|
|
153
|
+
/**
|
|
154
|
+
* MongoDB Atlas endpoint.
|
|
155
|
+
* @maxLength `2048`
|
|
156
|
+
* @pattern `^[a-zA-Z0-9_-]+\.[a-zA-Z0-9_-]+\.mongodb\.net$`
|
|
157
|
+
*/
|
|
158
|
+
Endpoint: string;
|
|
159
|
+
/**
|
|
160
|
+
* MongoDB Atlas endpoint service name.
|
|
161
|
+
* @maxLength `255`
|
|
162
|
+
* @pattern `^(?:arn:aws(?:-us-gov|-cn|-iso|-iso-[a-z])*:.+:.*:\d+:.+/.+$|[a-zA-Z0-9*]+[a-zA-Z0-9._-]*)$`
|
|
163
|
+
*/
|
|
164
|
+
EndpointServiceName?: string;
|
|
165
|
+
/**
|
|
166
|
+
* Contains the names of the fields to which to map information about the vector store.
|
|
167
|
+
*/
|
|
168
|
+
FieldMapping: MongoDbAtlasFieldMapping;
|
|
169
|
+
/**
|
|
170
|
+
* Name of a MongoDB Atlas index.
|
|
171
|
+
* @maxLength `2048`
|
|
172
|
+
* @pattern `^.*$`
|
|
173
|
+
*/
|
|
174
|
+
VectorIndexName: string;
|
|
175
|
+
};
|
|
176
|
+
/**
|
|
177
|
+
* Type definition for `AWS::Bedrock::KnowledgeBase.MongoDbAtlasFieldMapping`.
|
|
178
|
+
* Contains the names of the fields to which to map information about the vector store.
|
|
179
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-mongodbatlasfieldmapping.html}
|
|
180
|
+
*/
|
|
181
|
+
export type MongoDbAtlasFieldMapping = {
|
|
182
|
+
/**
|
|
183
|
+
* The name of the field in which Amazon Bedrock stores metadata about the vector store.
|
|
184
|
+
* @maxLength `2048`
|
|
185
|
+
* @pattern `^.*$`
|
|
186
|
+
*/
|
|
187
|
+
MetadataField: string;
|
|
188
|
+
/**
|
|
189
|
+
* The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
|
|
190
|
+
* @maxLength `2048`
|
|
191
|
+
* @pattern `^.*$`
|
|
192
|
+
*/
|
|
193
|
+
TextField: string;
|
|
194
|
+
/**
|
|
195
|
+
* The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
|
|
196
|
+
* @maxLength `2048`
|
|
197
|
+
* @pattern `^.*$`
|
|
198
|
+
*/
|
|
199
|
+
VectorField: string;
|
|
200
|
+
};
|
|
106
201
|
/**
|
|
107
202
|
* Type definition for `AWS::Bedrock::KnowledgeBase.OpenSearchServerlessConfiguration`.
|
|
108
203
|
* Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
|
|
@@ -268,6 +363,10 @@ export type RdsFieldMapping = {
|
|
|
268
363
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-storageconfiguration.html}
|
|
269
364
|
*/
|
|
270
365
|
export type StorageConfiguration = {
|
|
366
|
+
/**
|
|
367
|
+
* Contains the storage configuration of the knowledge base in MongoDb Atlas Cloud.
|
|
368
|
+
*/
|
|
369
|
+
MongoDbAtlasConfiguration?: MongoDbAtlasConfiguration;
|
|
271
370
|
/**
|
|
272
371
|
* Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
|
|
273
372
|
*/
|
|
@@ -301,9 +400,13 @@ export type VectorKnowledgeBaseConfiguration = {
|
|
|
301
400
|
* The ARN of the model used to create vector embeddings for the knowledge base.
|
|
302
401
|
* @minLength `20`
|
|
303
402
|
* @maxLength `2048`
|
|
304
|
-
* @pattern `^(arn:aws(-[^:]+)?:
|
|
403
|
+
* @pattern `^(arn:aws(-[^:]+)?:[a-z0-9-]+:[a-z0-9-]{1,20}:[0-9]{0,12}:[a-zA-Z0-9-:/._+]+)$`
|
|
305
404
|
*/
|
|
306
405
|
EmbeddingModelArn: string;
|
|
406
|
+
/**
|
|
407
|
+
* The embeddings model configuration details for the vector model used in Knowledge Base.
|
|
408
|
+
*/
|
|
409
|
+
EmbeddingModelConfiguration?: EmbeddingModelConfiguration;
|
|
307
410
|
};
|
|
308
411
|
/**
|
|
309
412
|
* Definition of AWS::Bedrock::KnowledgeBase Resource Type
|
|
@@ -9,6 +9,12 @@ export type ECRRepositoryCreationTemplateProperties = {
|
|
|
9
9
|
* A list of enumerable Strings representing the repository creation scenarios that the template will apply towards.
|
|
10
10
|
*/
|
|
11
11
|
AppliedFor: AppliedForItem[];
|
|
12
|
+
/**
|
|
13
|
+
* The ARN of the role to be assumed by ECR. This role must be in the same account as the registry that you are configuring.
|
|
14
|
+
* @maxLength `2048`
|
|
15
|
+
* @pattern `^arn:aws[-a-z0-9]*:iam::[0-9]{12}:role/[A-Za-z0-9+=,-.@_]*$`
|
|
16
|
+
*/
|
|
17
|
+
CustomRoleArn?: string;
|
|
12
18
|
/**
|
|
13
19
|
* The description of the template.
|
|
14
20
|
* @minLength `0`
|
package/lib/AWS-EKS-Cluster.d.ts
CHANGED
|
@@ -46,6 +46,10 @@ export type EKSClusterProperties = {
|
|
|
46
46
|
* An array of key-value pairs to apply to this resource.
|
|
47
47
|
*/
|
|
48
48
|
Tags?: Tag[];
|
|
49
|
+
/**
|
|
50
|
+
* An object representing the Upgrade Policy to use for the cluster.
|
|
51
|
+
*/
|
|
52
|
+
UpgradePolicy?: UpgradePolicy;
|
|
49
53
|
/**
|
|
50
54
|
* The desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used.
|
|
51
55
|
* @pattern `1\.\d\d`
|
|
@@ -259,6 +263,17 @@ export type Tag = {
|
|
|
259
263
|
*/
|
|
260
264
|
Value: string;
|
|
261
265
|
};
|
|
266
|
+
/**
|
|
267
|
+
* Type definition for `AWS::EKS::Cluster.UpgradePolicy`.
|
|
268
|
+
* An object representing the Upgrade Policy to use for the cluster.
|
|
269
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-upgradepolicy.html}
|
|
270
|
+
*/
|
|
271
|
+
export type UpgradePolicy = {
|
|
272
|
+
/**
|
|
273
|
+
* Specify the support type for your cluster.
|
|
274
|
+
*/
|
|
275
|
+
SupportType?: "STANDARD" | "EXTENDED";
|
|
276
|
+
};
|
|
262
277
|
/**
|
|
263
278
|
* Resource type definition for `AWS::EKS::Cluster`.
|
|
264
279
|
* An object representing an Amazon EKS cluster.
|
|
@@ -38,7 +38,8 @@ export type GlobalAcceleratorCrossAccountAttachmentAttributes = {
|
|
|
38
38
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-globalaccelerator-crossaccountattachment-resource.html}
|
|
39
39
|
*/
|
|
40
40
|
export type Resource = {
|
|
41
|
-
|
|
41
|
+
Cidr?: string;
|
|
42
|
+
EndpointId?: string;
|
|
42
43
|
Region?: string;
|
|
43
44
|
};
|
|
44
45
|
/**
|
|
@@ -371,7 +371,7 @@ export type RDSDBClusterProperties = {
|
|
|
371
371
|
PreferredMaintenanceWindow?: string;
|
|
372
372
|
/**
|
|
373
373
|
* Specifies whether the DB cluster is publicly accessible.
|
|
374
|
-
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the
|
|
374
|
+
When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
|
|
375
375
|
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
|
|
376
376
|
Valid for Cluster Type: Multi-AZ DB clusters only
|
|
377
377
|
Default: The default behavior varies depending on whether ``DBSubnetGroupName`` is specified.
|
|
@@ -529,7 +529,7 @@ export type RDSDBClusterAttributes = {
|
|
|
529
529
|
*/
|
|
530
530
|
MasterUserSecret: {
|
|
531
531
|
/**
|
|
532
|
-
* The Amazon Resource Name (ARN) of the secret.
|
|
532
|
+
* The Amazon Resource Name (ARN) of the secret. This parameter is a return value that you can retrieve using the ``Fn::GetAtt`` intrinsic function. For more information, see [Return values](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#aws-resource-rds-dbcluster-return-values).
|
|
533
533
|
*/
|
|
534
534
|
SecretArn: string;
|
|
535
535
|
};
|
|
@@ -270,7 +270,6 @@ export type RDSDBInstanceProperties = {
|
|
|
270
270
|
+ ``DBClusterIdentifier``
|
|
271
271
|
+ ``DBName``
|
|
272
272
|
+ ``DeleteAutomatedBackups``
|
|
273
|
-
+ ``EnablePerformanceInsights``
|
|
274
273
|
+ ``KmsKeyId``
|
|
275
274
|
+ ``MasterUsername``
|
|
276
275
|
+ ``MasterUserPassword``
|
|
@@ -821,7 +820,7 @@ export type RDSDBInstanceAttributes = {
|
|
|
821
820
|
*/
|
|
822
821
|
MasterUserSecret: {
|
|
823
822
|
/**
|
|
824
|
-
* The Amazon Resource Name (ARN) of the secret.
|
|
823
|
+
* The Amazon Resource Name (ARN) of the secret. This parameter is a return value that you can retrieve using the ``Fn::GetAtt`` intrinsic function. For more information, see [Return values](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#aws-resource-rds-dbinstance-return-values).
|
|
825
824
|
*/
|
|
826
825
|
SecretArn: string;
|
|
827
826
|
};
|
|
@@ -5,8 +5,19 @@ import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-
|
|
|
5
5
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-resourcepolicy.html}
|
|
6
6
|
*/
|
|
7
7
|
export type SecretsManagerResourcePolicyProperties = {
|
|
8
|
+
/**
|
|
9
|
+
* Specifies whether to block resource-based policies that allow broad access to the secret.
|
|
10
|
+
*/
|
|
8
11
|
BlockPublicPolicy?: boolean;
|
|
9
|
-
|
|
12
|
+
/**
|
|
13
|
+
* A JSON-formatted string for an AWS resource-based policy.
|
|
14
|
+
*/
|
|
15
|
+
ResourcePolicy: string | Record<string, any>;
|
|
16
|
+
/**
|
|
17
|
+
* The ARN or name of the secret to attach the resource-based policy.
|
|
18
|
+
* @minLength `1`
|
|
19
|
+
* @maxLength `2048`
|
|
20
|
+
*/
|
|
10
21
|
SecretId: string;
|
|
11
22
|
};
|
|
12
23
|
/**
|
|
@@ -14,6 +25,9 @@ export type SecretsManagerResourcePolicyProperties = {
|
|
|
14
25
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-resourcepolicy.html#aws-resource-secretsmanager-resourcepolicy-return-values}
|
|
15
26
|
*/
|
|
16
27
|
export type SecretsManagerResourcePolicyAttributes = {
|
|
28
|
+
/**
|
|
29
|
+
* The Arn of the secret.
|
|
30
|
+
*/
|
|
17
31
|
Id: string;
|
|
18
32
|
};
|
|
19
33
|
/**
|