@propulsionworks/cloudformation 0.0.2 → 0.1.0

package/out/exports/resources.generated/aws-autoscaling-scheduledaction.d.ts

@@ -0,0 +1,60 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+export type AutoScalingScheduledAction = ResourceDefinitionWithAttributes<"AWS::AutoScaling::ScheduledAction", AutoScalingScheduledActionProps, AutoScalingScheduledActionAttribs>;
+/**
+ * The `AWS::AutoScaling::ScheduledAction` resource specifies an Amazon EC2 Auto Scaling scheduled action so that the Auto Scaling group can change the number of instances available for your application in response to predictable load changes.
+ *
+ * When you update a stack with an Auto Scaling group and scheduled action, CloudFormation always sets the min size, max size, and desired capacity properties of your group to the values that are defined in the `AWS::AutoScaling::AutoScalingGroup` section of your template. However, you might not want CloudFormation to do that when you have a scheduled action in effect. You can use an [UpdatePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html) to prevent CloudFormation from changing the min size, max size, or desired capacity property values during a stack update unless you modified the individual values in your template. If you have rolling updates enabled, before you can update the Auto Scaling group, you must suspend scheduled actions by specifying an [UpdatePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html) for the Auto Scaling group. You can find a sample update policy for rolling updates in [Configure Amazon EC2 Auto Scaling resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-ec2-auto-scaling.html) .
+ *
+ * For more information, see [Scheduled scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/schedule_time.html) and [Suspending and resuming scaling processes](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html) in the *Amazon EC2 Auto Scaling User Guide* .
+ */
+export type AutoScalingScheduledActionProps = {
+    /**
+     * The name of the Auto Scaling group.
+     */
+    AutoScalingGroupName: string;
+    /**
+     * The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain. It can scale beyond this capacity if you add more scaling conditions.
+     *
+     * > You must specify at least one of the following properties: `MaxSize` , `MinSize` , or `DesiredCapacity` .
+     */
+    DesiredCapacity?: number | undefined;
+    /**
+     * The date and time for the recurring schedule to end, in UTC. For example, `"2021-06-01T00:00:00Z"` .
+     */
+    EndTime?: string | undefined;
+    /**
+     * The maximum size of the Auto Scaling group.
+     */
+    MaxSize?: number | undefined;
+    /**
+     * The minimum size of the Auto Scaling group.
+     */
+    MinSize?: number | undefined;
+    /**
+     * The recurring schedule for this action. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, `"30 0 1 1,6,12 *"` ). For more information about this format, see [Crontab](https://docs.aws.amazon.com/http://crontab.org) .
+     *
+     * When `StartTime` and `EndTime` are specified with `Recurrence` , they form the boundaries of when the recurring action starts and stops.
+     *
+     * Cron expressions use Universal Coordinated Time (UTC) by default.
+     */
+    Recurrence?: string | undefined;
+    /**
+     * The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for example, `"2021-06-01T00:00:00Z"` ).
+     *
+     * If you specify `Recurrence` and `StartTime` , Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.
+     */
+    StartTime?: string | undefined;
+    /**
+     * Specifies the time zone for a cron expression. If a time zone is not provided, UTC is used by default.
+     *
+     * Valid values are the canonical names of the IANA time zones, derived from the IANA Time Zone Database (such as `Etc/GMT+9` or `Pacific/Tahiti` ). For more information, see [https://en.wikipedia.org/wiki/List_of_tz_database_time_zones](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) .
+     */
+    TimeZone?: string | undefined;
+};
+export type AutoScalingScheduledActionAttribs = {
+    /**
+     * Returns the name of a scheduled action.
+     */
+    ScheduledActionName: string;
+};
+//# sourceMappingURL=aws-autoscaling-scheduledaction.d.ts.map

package/out/exports/resources.generated/aws-autoscaling-warmpool.d.ts

@@ -0,0 +1,51 @@
+import type { ResourceDefinition } from "../main.ts";
+export type AutoScalingWarmPool = ResourceDefinition<"AWS::AutoScaling::WarmPool", AutoScalingWarmPoolProps>;
+/**
+ * The `AWS::AutoScaling::WarmPool` resource creates a pool of pre-initialized EC2 instances that sits alongside the Auto Scaling group. Whenever your application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new desired capacity.
+ *
+ * When you create a warm pool, you can define a minimum size. When your Auto Scaling group scales out and the size of the warm pool shrinks, Amazon EC2 Auto Scaling launches new instances into the warm pool to maintain its minimum size.
+ *
+ * For more information, see [Warm pools for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html) in the *Amazon EC2 Auto Scaling User Guide* .
+ *
+ * > CloudFormation supports the `UpdatePolicy` attribute for Auto Scaling groups. During an update, if `UpdatePolicy` is set to `AutoScalingRollingUpdate` , CloudFormation replaces `InService` instances only. Instances in the warm pool are not replaced. The difference in which instances are replaced can potentially result in different instance configurations after the stack update completes. If `UpdatePolicy` is set to `AutoScalingReplacingUpdate` , you do not encounter this issue because CloudFormation replaces both the Auto Scaling group and the warm pool.
+ */
+export type AutoScalingWarmPoolProps = {
+    /**
+     * The name of the Auto Scaling group.
+     */
+    AutoScalingGroupName: string;
+    /**
+     * Indicates whether instances in the Auto Scaling group can be returned to the warm pool on scale in. The default is to terminate instances in the Auto Scaling group when the group scales in.
+     */
+    InstanceReusePolicy?: InstanceReusePolicy | undefined;
+    /**
+     * Specifies the maximum number of instances that are allowed to be in the warm pool or in any state except `Terminated` for the Auto Scaling group. This is an optional property. Specify it only if you do not want the warm pool size to be determined by the difference between the group's maximum capacity and its desired capacity.
+     *
+     * > If a value for `MaxGroupPreparedCapacity` is not specified, Amazon EC2 Auto Scaling launches and maintains the difference between the group's maximum capacity and its desired capacity. If you specify a value for `MaxGroupPreparedCapacity` , Amazon EC2 Auto Scaling uses the difference between the `MaxGroupPreparedCapacity` and the desired capacity instead.
+     * >
+     * > The size of the warm pool is dynamic. Only when `MaxGroupPreparedCapacity` and `MinSize` are set to the same value does the warm pool have an absolute size.
+     *
+     * If the desired capacity of the Auto Scaling group is higher than the `MaxGroupPreparedCapacity` , the capacity of the warm pool is 0, unless you specify a value for `MinSize` . To remove a value that you previously set, include the property but specify -1 for the value.
+     */
+    MaxGroupPreparedCapacity?: number | undefined;
+    /**
+     * Specifies the minimum number of instances to maintain in the warm pool. This helps you to ensure that there is always a certain number of warmed instances available to handle traffic spikes. Defaults to 0 if not specified.
+     */
+    MinSize?: number | undefined;
+    /**
+     * Sets the instance state to transition to after the lifecycle actions are complete. Default is `Stopped` .
+     */
+    PoolState?: string | undefined;
+};
+/**
+ * A structure that specifies an instance reuse policy for the `InstanceReusePolicy` property of the [AWS::AutoScaling::WarmPool](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-warmpool.html) resource.
+ *
+ * For more information, see [Warm pools for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html) in the *Amazon EC2 Auto Scaling User Guide* .
+ */
+export type InstanceReusePolicy = {
+    /**
+     * Specifies whether instances in the Auto Scaling group can be returned to the warm pool on scale in.
+     */
+    ReuseOnScaleIn?: boolean | undefined;
+};
+//# sourceMappingURL=aws-autoscaling-warmpool.d.ts.map

package/out/exports/resources.generated/aws-autoscalingplans-scalingplan.d.ts

@@ -0,0 +1,331 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+export type AutoScalingPlansScalingPlan = ResourceDefinitionWithAttributes<"AWS::AutoScalingPlans::ScalingPlan", AutoScalingPlansScalingPlanProps, AutoScalingPlansScalingPlanAttribs>;
+/**
+ * The `AWS::AutoScalingPlans::ScalingPlan` resource defines an AWS Auto Scaling scaling plan. A scaling plan is used to scale application resources to size them appropriately to ensure that enough resource is available in the application at peak times and to reduce allocated resource during periods of low utilization. The following resources can be added to a scaling plan:
+ *
+ * - Amazon EC2 Auto Scaling groups
+ * - Amazon EC2 Spot Fleet requests
+ * - Amazon ECS services
+ * - Amazon DynamoDB tables and global secondary indexes
+ * - Amazon Aurora Replicas
+ *
+ * For more information, see the [Scaling Plans User Guide](https://docs.aws.amazon.com/autoscaling/plans/userguide/what-is-a-scaling-plan.html)
+ */
+export type AutoScalingPlansScalingPlanProps = {
+    /**
+     * A CloudFormation stack or a set of tags. You can create one scaling plan per application source. The `ApplicationSource` property must be present to ensure interoperability with the AWS Auto Scaling console.
+     */
+    ApplicationSource: ApplicationSource;
+    /**
+     * The scaling instructions.
+     */
+    ScalingInstructions: ScalingInstruction[];
+};
+export type AutoScalingPlansScalingPlanAttribs = {
+    Id: string;
+    ScalingPlanName: string;
+    ScalingPlanVersion: string;
+};
+/**
+ * `ApplicationSource` is a property of [ScalingPlan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscalingplans-scalingplan.html) that specifies the application source to use with a scaling plan. You can create one scaling plan per application source.
+ */
+export type ApplicationSource = {
+    /**
+     * The Amazon Resource Name (ARN) of a CloudFormation stack.
+     *
+     * You must specify either a `CloudFormationStackARN` or `TagFilters` .
+     */
+    CloudFormationStackARN?: string | undefined;
+    /**
+     * A set of tag filters (keys and values). Each tag filter specified must contain a key with values as optional. Each scaling plan can include up to 50 keys, and each key can include up to 20 values.
+     *
+     * Tags are part of the syntax that you use to specify the resources you want returned when configuring a scaling plan from the AWS Auto Scaling console. You do not need to specify valid tag filter values when you create a scaling plan with CloudFormation. The `Key` and `Values` properties can accept any value as long as the combination of values is unique across scaling plans. However, if you also want to use the AWS Auto Scaling console to edit the scaling plan, then you must specify valid values.
+     *
+     * You must specify either a `CloudFormationStackARN` or `TagFilters` .
+     */
+    TagFilters?: TagFilter[] | undefined;
+};
+/**
+ * `CustomizedLoadMetricSpecification` is a subproperty of [ScalingInstruction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html) that specifies a customized load metric for predictive scaling to use with a scaling plan.
+ *
+ * For predictive scaling to work with a customized load metric specification, AWS Auto Scaling needs access to the `Sum` and `Average` statistics that CloudWatch computes from metric data.
+ *
+ * When you choose a load metric, make sure that the required `Sum` and `Average` statistics for your metric are available in CloudWatch and that they provide relevant data for predictive scaling. The `Sum` statistic must represent the total load on the resource, and the `Average` statistic must represent the average load per capacity unit of the resource. For example, there is a metric that counts the number of requests processed by your Auto Scaling group. If the `Sum` statistic represents the total request count processed by the group, then the `Average` statistic for the specified metric must represent the average request count processed by each instance of the group.
+ *
+ * If you publish your own metrics, you can aggregate the data points at a given interval and then publish the aggregated data points to CloudWatch. Before AWS Auto Scaling generates the forecast, it sums up all the metric data points that occurred within each hour to match the granularity period that is used in the forecast (60 minutes).
+ *
+ * For information about terminology, available metrics, or how to publish new metrics, see [Amazon CloudWatch Concepts](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html) in the *Amazon CloudWatch User Guide* .
+ *
+ * After creating your scaling plan, you can use the AWS Auto Scaling console to visualize forecasts for the specified metric. For more information, see [View scaling information for a resource](https://docs.aws.amazon.com/autoscaling/plans/userguide/gs-create-scaling-plan.html#gs-view-resource) in the *Scaling Plans User Guide* .
+ */
+export type CustomizedLoadMetricSpecification = {
+    /**
+     * The dimensions of the metric.
+     *
+     * Conditional: If you published your metric with dimensions, you must specify the same dimensions in your customized load metric specification.
+     */
+    Dimensions?: MetricDimension[] | undefined;
+    /**
+     * The name of the metric.
+     */
+    MetricName: string;
+    /**
+     * The namespace of the metric.
+     */
+    Namespace: string;
+    /**
+     * The statistic of the metric.
+     *
+     * *Allowed Values* : `Sum`
+     */
+    Statistic: string;
+    /**
+     * The unit of the metric.
+     */
+    Unit?: string | undefined;
+};
+/**
+ * `CustomizedScalingMetricSpecification` is a subproperty of [TargetTrackingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html) that specifies a customized scaling metric for a target tracking configuration to use with a scaling plan.
+ *
+ * To create your customized scaling metric specification:
+ *
+ * - Add values for each required property 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* .
+ * - 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.
+ *
+ * For information about terminology, available metrics, or how to publish new metrics, see [Amazon CloudWatch Concepts](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html) in the *Amazon CloudWatch User Guide* .
+ */
+export type CustomizedScalingMetricSpecification = {
+    /**
+     * The dimensions of the metric.
+     *
+     * Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
+     */
+    Dimensions?: MetricDimension[] | undefined;
+    /**
+     * The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the [Metrics](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) .
+     */
+    MetricName: string;
+    /**
+     * The namespace of the metric.
+     */
+    Namespace: string;
+    /**
+     * The statistic of the metric.
+     */
+    Statistic: string;
+    /**
+     * 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* .
+     */
+    Unit?: string | undefined;
+};
+/**
+ * `MetricDimension` is a subproperty of [CustomizedScalingMetricSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedscalingmetricspecification.html) that specifies a dimension for a customized metric to use with a scaling plan. Dimensions are arbitrary name/value pairs that can be associated with a CloudWatch metric. Duplicate dimensions are not allowed.
+ */
+export type MetricDimension = {
+    /**
+     * The name of the dimension.
+     */
+    Name: string;
+    /**
+     * The value of the dimension.
+     */
+    Value: string;
+};
+/**
+ * `PredefinedLoadMetricSpecification` is a subproperty of [ScalingInstruction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html) that specifies a predefined load metric for predictive scaling to use with a scaling plan.
+ *
+ * After creating your scaling plan, you can use the AWS Auto Scaling console to visualize forecasts for the specified metric. For more information, see [View scaling information for a resource](https://docs.aws.amazon.com/autoscaling/plans/userguide/gs-create-scaling-plan.html#gs-view-resource) in the *Scaling Plans User Guide* .
+ */
+export type PredefinedLoadMetricSpecification = {
+    /**
+     * The metric type.
+     */
+    PredefinedLoadMetricType: string;
+    /**
+     * Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is `ALBTargetGroupRequestCount` and there is a target group for an Application Load Balancer attached to the Auto Scaling group.
+     *
+     * 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 is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where:
+     *
+     * - app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
+     * - targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
+     *
+     * This is an example: app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d.
+     *
+     * 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.
+     */
+    ResourceLabel?: string | undefined;
+};
+/**
+ * `PredefinedScalingMetricSpecification` is a subproperty of [TargetTrackingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html) that specifies a customized scaling metric for a target tracking configuration to use with a scaling plan.
+ */
+export type PredefinedScalingMetricSpecification = {
+    /**
+     * The metric type. The `ALBRequestCountPerTarget` metric type applies only to Auto Scaling groups, Spot Fleet requests, and ECS services.
+     */
+    PredefinedScalingMetricType: string;
+    /**
+     * 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 for an Application Load Balancer attached to the Auto Scaling group, Spot Fleet request, or ECS service.
+     *
+     * 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 is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where:
+     *
+     * - app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
+     * - targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
+     *
+     * This is an example: app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d.
+     *
+     * 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.
+     */
+    ResourceLabel?: string | undefined;
+};
+/**
+ * `ScalingInstruction` is a property of [ScalingPlan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscalingplans-scalingplan.html) that specifies the scaling instruction for a scalable resource in a scaling plan. Each scaling instruction applies to one resource.
+ *
+ * AWS Auto Scaling creates target tracking scaling policies based on the scaling instructions. Target tracking scaling policies adjust the capacity of your scalable resource as required to maintain resource utilization at the target value that you specified.
+ *
+ * AWS Auto Scaling also configures predictive scaling for your Amazon EC2 Auto Scaling groups using a subset of properties, including the load metric, the scaling metric, the target value for the scaling metric, the predictive scaling mode (forecast and scale or forecast only), and the desired behavior when the forecast capacity exceeds the maximum capacity of the resource. With predictive scaling, AWS Auto Scaling generates forecasts with traffic predictions for the two days ahead and schedules scaling actions that proactively add and remove resource capacity to match the forecast.
+ *
+ * > We recommend waiting a minimum of 24 hours after creating an Auto Scaling group to configure predictive scaling. At minimum, there must be 24 hours of historical data to generate a forecast. For more information, see [Best practices for scaling plans](https://docs.aws.amazon.com/autoscaling/plans/userguide/gs-best-practices.html) in the *Scaling Plans User Guide* .
+ */
+export type ScalingInstruction = {
+    /**
+     * The customized load metric to use for predictive scaling. This property or a *PredefinedLoadMetricSpecification* is required when configuring predictive scaling, and cannot be used otherwise.
+     */
+    CustomizedLoadMetricSpecification?: CustomizedLoadMetricSpecification | undefined;
+    /**
+     * Controls whether dynamic scaling is disabled. When dynamic scaling is enabled, AWS Auto Scaling creates target tracking scaling policies based on the specified target tracking configurations.
+     *
+     * The default is enabled ( `false` ).
+     */
+    DisableDynamicScaling?: boolean | undefined;
+    /**
+     * The maximum capacity of the resource. The exception to this upper limit is if you specify a non-default setting for *PredictiveScalingMaxCapacityBehavior* .
+     */
+    MaxCapacity: number;
+    /**
+     * The minimum capacity of the resource.
+     */
+    MinCapacity: number;
+    /**
+     * The predefined load metric to use for predictive scaling. This property or a *CustomizedLoadMetricSpecification* is required when configuring predictive scaling, and cannot be used otherwise.
+     */
+    PredefinedLoadMetricSpecification?: PredefinedLoadMetricSpecification | undefined;
+    /**
+     * Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity specified for the resource. The default value is `SetForecastCapacityToMaxCapacity` .
+     *
+     * The following are possible values:
+     *
+     * - `SetForecastCapacityToMaxCapacity` - AWS Auto Scaling cannot scale resource capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit.
+     * - `SetMaxCapacityToForecastCapacity` - AWS Auto Scaling can scale resource capacity higher than the maximum capacity to equal but not exceed forecast capacity.
+     * - `SetMaxCapacityAboveForecastCapacity` - AWS Auto Scaling can scale resource capacity higher than the maximum capacity by a specified buffer value. The intention is to give the target tracking scaling policy extra capacity if unexpected traffic occurs.
+     *
+     * Valid only when configuring predictive scaling.
+     */
+    PredictiveScalingMaxCapacityBehavior?: string | undefined;
+    /**
+     * 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. With a 10 percent buffer, if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.
+     *
+     * Valid only when configuring predictive scaling. Required if *PredictiveScalingMaxCapacityBehavior* is set to `SetMaxCapacityAboveForecastCapacity` , and cannot be used otherwise.
+     *
+     * The range is 1-100.
+     */
+    PredictiveScalingMaxCapacityBuffer?: number | undefined;
+    /**
+     * The predictive scaling mode. The default value is `ForecastAndScale` . Otherwise, AWS Auto Scaling forecasts capacity but does not apply any scheduled scaling actions based on the capacity forecast.
+     */
+    PredictiveScalingMode?: string | undefined;
+    /**
+     * The ID of the resource. This string consists of the resource type and unique identifier.
+     *
+     * - Auto Scaling group - The resource type is `autoScalingGroup` and the unique identifier is the name of the Auto Scaling group. Example: `autoScalingGroup/my-asg` .
+     * - ECS service - The resource type is `service` and the unique identifier is the cluster name and service name. Example: `service/default/sample-webapp` .
+     * - Spot Fleet request - 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` .
+     * - DynamoDB table - The resource type is `table` and the unique identifier is the resource ID. Example: `table/my-table` .
+     * - DynamoDB global secondary index - The resource type is `index` and the unique identifier is the resource ID. 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` .
+     */
+    ResourceId: string;
+    /**
+     * The scalable dimension associated with the resource.
+     *
+     * - `autoscaling:autoScalingGroup:DesiredCapacity` - The desired capacity of an Auto Scaling group.
+     * - `ecs:service:DesiredCount` - The desired task count of an ECS service.
+     * - `ec2:spot-fleet-request:TargetCapacity` - The target capacity of a Spot Fleet request.
+     * - `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.
+     */
+    ScalableDimension: string;
+    /**
+     * Controls whether a resource's externally created scaling policies are deleted and new target tracking scaling policies created. The default value is `KeepExternalPolicies` .
+     *
+     * Valid only when configuring dynamic scaling.
+     */
+    ScalingPolicyUpdateBehavior?: string | undefined;
+    /**
+     * The amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out. For example, if the forecast says to add capacity at 10:00 AM, and the buffer time is 5 minutes, then the run time of the corresponding scheduled scaling action will be 9:55 AM. The intention is to give resources time to be provisioned. For example, it can take a few minutes to launch an EC2 instance. The actual amount of time required depends on several factors, such as the size of the instance and whether there are startup scripts to complete.
+     *
+     * The value must be less than the forecast interval duration of 3600 seconds (60 minutes). The default is 300 seconds.
+     *
+     * Valid only when configuring predictive scaling.
+     */
+    ScheduledActionBufferTime?: number | undefined;
+    /**
+     * The namespace of the AWS service.
+     */
+    ServiceNamespace: string;
+    /**
+     * The target tracking configurations (up to 10). Each of these structures must specify a unique scaling metric and a target value for the metric.
+     */
+    TargetTrackingConfigurations: TargetTrackingConfiguration[];
+};
+/**
+ * `TagFilter` is a subproperty of [ApplicationSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-applicationsource.html) that specifies a tag for an application source to use with a scaling plan.
+ */
+export type TagFilter = {
+    /**
+     * The tag key.
+     */
+    Key: string;
+    /**
+     * The tag values (0 to 20).
+     */
+    Values?: string[] | undefined;
+};
+/**
+ * `TargetTrackingConfiguration` is a subproperty of [ScalingInstruction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html) that specifies a target tracking configuration for a scalable resource.
+ */
+export type TargetTrackingConfiguration = {
+    /**
+     * A customized metric. You can specify either a predefined metric or a customized metric.
+     */
+    CustomizedScalingMetricSpecification?: CustomizedScalingMetricSpecification | undefined;
+    /**
+     * 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 doesn't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable resource.
+     *
+     * The default value is `false` .
+     */
+    DisableScaleIn?: boolean | undefined;
+    /**
+     * The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This value is used only if the resource is an Auto Scaling group.
+     */
+    EstimatedInstanceWarmup?: number | undefined;
+    /**
+     * A predefined metric. You can specify either a predefined metric or a customized metric.
+     */
+    PredefinedScalingMetricSpecification?: PredefinedScalingMetricSpecification | undefined;
+    /**
+     * The amount of time, in seconds, after a scale-in activity completes before another scale in activity can start. This value is not used if the scalable resource is an Auto Scaling group.
+     */
+    ScaleInCooldown?: number | undefined;
+    /**
+     * The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start. This value is not used if the scalable resource is an Auto Scaling group.
+     */
+    ScaleOutCooldown?: number | undefined;
+    /**
+     * The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360.
+     */
+    TargetValue: number;
+};
+//# sourceMappingURL=aws-autoscalingplans-scalingplan.d.ts.map

package/out/exports/resources.generated/aws-b2bi-capability.d.ts

@@ -0,0 +1,123 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type B2BICapability = ResourceDefinitionWithAttributes<"AWS::B2BI::Capability", B2BICapabilityProps, B2BICapabilityAttribs>;
+/**
+ * Instantiates a capability based on the specified parameters. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
+ */
+export type B2BICapabilityProps = {
+    /**
+     * Specifies a structure that contains the details for a capability.
+     */
+    Configuration: CapabilityConfiguration;
+    /**
+     * Specifies one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. Each item contains the name of the bucket and the key, to identify the document's location.
+     */
+    InstructionsDocuments?: S3Location[] | undefined;
+    /**
+     * The display name of the capability.
+     * @minLength 1
+     * @maxLength 254
+     */
+    Name: string;
+    /**
+     * Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.
+     */
+    Tags?: Tag[] | undefined;
+    /**
+     * Returns the type of the capability. Currently, only `edi` is supported.
+     */
+    Type: CapabilityType;
+};
+export type B2BICapabilityAttribs = {
+    /**
+     * Returns an Amazon Resource Name (ARN) for a specific AWS resource, such as a capability, partnership, profile, or transformer.
+     * @minLength 1
+     * @maxLength 255
+     */
+    CapabilityArn: string;
+    /**
+     * Returns a system-assigned unique identifier for the capability.
+     * @minLength 1
+     * @maxLength 64
+     * @pattern ^[a-zA-Z0-9_-]+$
+     */
+    CapabilityId: string;
+    /**
+     * Returns a timestamp for creation date and time of the capability.
+     * @format date-time
+     */
+    CreatedAt: string;
+    /**
+     * Returns a timestamp that identifies the most recent date and time that the capability was modified.
+     * @format date-time
+     */
+    ModifiedAt: string;
+};
+/**
+ * A capability object. Currently, only EDI (electronic data interchange) capabilities are supported. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
+ */
+export type CapabilityConfiguration = {
+    Edi: EdiConfiguration;
+};
+export type CapabilityDirection = "INBOUND" | "OUTBOUND";
+export type CapabilityType = "edi";
+/**
+ * Specifies the details for the EDI (electronic data interchange) transformation.
+ */
+export type EdiConfiguration = {
+    /**
+     * Specifies whether this is capability is for inbound or outbound transformations.
+     */
+    CapabilityDirection?: CapabilityDirection | undefined;
+    /**
+     * Contains the Amazon S3 bucket and prefix for the location of the input file, which is contained in an `S3Location` object.
+     */
+    InputLocation: S3Location;
+    /**
+     * Contains the Amazon S3 bucket and prefix for the location of the output file, which is contained in an `S3Location` object.
+     */
+    OutputLocation: S3Location;
+    /**
+     * Returns the system-assigned unique identifier for the transformer.
+     * @minLength 1
+     * @maxLength 64
+     * @pattern ^[a-zA-Z0-9_-]+$
+     */
+    TransformerId: string;
+    /**
+     * Returns the type of the capability. Currently, only `edi` is supported.
+     */
+    Type: EdiType;
+};
+export type EdiType = {
+    X12Details: X12Details;
+};
+/**
+ * Specifies the details for the Amazon S3 file location that is being used with AWS B2B Data Interchange. File locations in Amazon S3 are identified using a combination of the bucket and key.
+ */
+export type S3Location = {
+    /**
+     * Specifies the name of the Amazon S3 bucket.
+     * @minLength 3
+     * @maxLength 63
+     */
+    BucketName?: string | undefined;
+    /**
+     * Specifies the Amazon S3 key for the file location.
+     * @minLength 0
+     * @maxLength 1024
+     */
+    Key?: string | undefined;
+};
+export type X12Details = {
+    /**
+     * Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
+     */
+    TransactionSet?: X12TransactionSet | undefined;
+    /**
+     * Returns the version to use for the specified X12 transaction set.
+     */
+    Version?: X12Version | undefined;
+};
+export type X12TransactionSet = "X12_100" | "X12_101" | "X12_102" | "X12_103" | "X12_104" | "X12_105" | "X12_106" | "X12_107" | "X12_108" | "X12_109" | "X12_110" | "X12_111" | "X12_112" | "X12_113" | "X12_120" | "X12_121" | "X12_124" | "X12_125" | "X12_126" | "X12_127" | "X12_128" | "X12_129" | "X12_130" | "X12_131" | "X12_132" | "X12_133" | "X12_135" | "X12_138" | "X12_139" | "X12_140" | "X12_141" | "X12_142" | "X12_143" | "X12_144" | "X12_146" | "X12_147" | "X12_148" | "X12_149" | "X12_150" | "X12_151" | "X12_152" | "X12_153" | "X12_154" | "X12_155" | "X12_157" | "X12_158" | "X12_159" | "X12_160" | "X12_161" | "X12_163" | "X12_170" | "X12_175" | "X12_176" | "X12_179" | "X12_180" | "X12_185" | "X12_186" | "X12_187" | "X12_188" | "X12_189" | "X12_190" | "X12_191" | "X12_194" | "X12_195" | "X12_196" | "X12_197" | "X12_198" | "X12_199" | "X12_200" | "X12_201" | "X12_202" | "X12_203" | "X12_204" | "X12_205" | "X12_206" | "X12_210" | "X12_211" | "X12_212" | "X12_213" | "X12_214" | "X12_215" | "X12_216" | "X12_217" | "X12_218" | "X12_219" | "X12_220" | "X12_222" | "X12_223" | "X12_224" | "X12_225" | "X12_227" | "X12_228" | "X12_240" | "X12_242" | "X12_244" | "X12_245" | "X12_248" | "X12_249" | "X12_250" | "X12_251" | "X12_252" | "X12_255" | "X12_256" | "X12_259" | "X12_260" | "X12_261" | "X12_262" | "X12_263" | "X12_264" | "X12_265" | "X12_266" | "X12_267" | "X12_268" | "X12_269" | "X12_270" | "X12_271" | "X12_272" | "X12_273" | "X12_274" | "X12_275" | "X12_276" | "X12_277" | "X12_278" | "X12_280" | "X12_283" | "X12_284" | "X12_285" | "X12_286" | "X12_288" | "X12_290" | "X12_300" | "X12_301" | "X12_303" | "X12_304" | "X12_309" | "X12_310" | "X12_311" | "X12_312" | "X12_313" | "X12_315" | "X12_317" | "X12_319" | "X12_322" | "X12_323" | "X12_324" | "X12_325" | "X12_326" | "X12_350" | "X12_352" | "X12_353" | "X12_354" | "X12_355" | "X12_356" | "X12_357" | "X12_358" | "X12_361" | "X12_362" | "X12_404" | "X12_410" | "X12_412" | "X12_414" | "X12_417" | "X12_418" | "X12_419" | "X12_420" | "X12_421" | "X12_422" | "X12_423" | "X12_424" | "X12_425" | "X12_426" | "X12_429" | "X12_431" | "X12_432" | "X12_433" | "X12_434" | "X12_435" | "X12_436" | "X12_437" | "X12_440" | "X12_451" | "X12_452" | "X12_453" | "X12_455" | "X12_456" | "X12_460" | "X12_463" | "X12_466" | "X12_468" | "X12_470" | "X12_475" | "X12_485" | "X12_486" | "X12_490" | "X12_492" | "X12_494" | "X12_500" | "X12_501" | "X12_503" | "X12_504" | "X12_511" | "X12_517" | "X12_521" | "X12_527" | "X12_536" | "X12_540" | "X12_561" | "X12_567" | "X12_568" | "X12_601" | "X12_602" | "X12_620" | "X12_625" | "X12_650" | "X12_715" | "X12_753" | "X12_754" | "X12_805" | "X12_806" | "X12_810" | "X12_811" | "X12_812" | "X12_813" | "X12_814" | "X12_815" | "X12_816" | "X12_818" | "X12_819" | "X12_820" | "X12_821" | "X12_822" | "X12_823" | "X12_824" | "X12_826" | "X12_827" | "X12_828" | "X12_829" | "X12_830" | "X12_831" | "X12_832" | "X12_833" | "X12_834" | "X12_835" | "X12_836" | "X12_837" | "X12_838" | "X12_839" | "X12_840" | "X12_841" | "X12_842" | "X12_843" | "X12_844" | "X12_845" | "X12_846" | "X12_847" | "X12_848" | "X12_849" | "X12_850" | "X12_851" | "X12_852" | "X12_853" | "X12_854" | "X12_855" | "X12_856" | "X12_857" | "X12_858" | "X12_859" | "X12_860" | "X12_861" | "X12_862" | "X12_863" | "X12_864" | "X12_865" | "X12_866" | "X12_867" | "X12_868" | "X12_869" | "X12_870" | "X12_871" | "X12_872" | "X12_873" | "X12_874" | "X12_875" | "X12_876" | "X12_877" | "X12_878" | "X12_879" | "X12_880" | "X12_881" | "X12_882" | "X12_883" | "X12_884" | "X12_885" | "X12_886" | "X12_887" | "X12_888" | "X12_889" | "X12_891" | "X12_893" | "X12_894" | "X12_895" | "X12_896" | "X12_920" | "X12_924" | "X12_925" | "X12_926" | "X12_928" | "X12_940" | "X12_943" | "X12_944" | "X12_945" | "X12_947" | "X12_980" | "X12_990" | "X12_993" | "X12_996" | "X12_997" | "X12_998" | "X12_999" | "X12_270_X279" | "X12_271_X279" | "X12_275_X210" | "X12_275_X211" | "X12_276_X212" | "X12_277_X212" | "X12_277_X214" | "X12_277_X364" | "X12_278_X217" | "X12_820_X218" | "X12_820_X306" | "X12_824_X186" | "X12_834_X220" | "X12_834_X307" | "X12_834_X318" | "X12_835_X221" | "X12_837_X222" | "X12_837_X223" | "X12_837_X224" | "X12_837_X291" | "X12_837_X292" | "X12_837_X298" | "X12_999_X231";
+export type X12Version = "VERSION_4010" | "VERSION_4030" | "VERSION_4050" | "VERSION_4060" | "VERSION_5010" | "VERSION_5010_HIPAA";
+//# sourceMappingURL=aws-b2bi-capability.d.ts.map