@pulumi/aws-native 0.99.1-alpha.1711140610 → 0.100.0
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/autoscaling/autoScalingGroup.d.ts +227 -1
- package/autoscaling/autoScalingGroup.js +3 -1
- package/autoscaling/autoScalingGroup.js.map +1 -1
- package/autoscaling/getAutoScalingGroup.d.ts +119 -2
- package/autoscaling/getAutoScalingGroup.js +6 -2
- package/autoscaling/getAutoScalingGroup.js.map +1 -1
- package/datasync/getTask.d.ts +1 -0
- package/datasync/getTask.js.map +1 -1
- package/datasync/task.d.ts +2 -0
- package/datasync/task.js +2 -0
- package/datasync/task.js.map +1 -1
- package/ec2/getNetworkInterface.d.ts +4 -0
- package/ec2/getNetworkInterface.js.map +1 -1
- package/ec2/networkInterface.d.ts +4 -0
- package/ec2/networkInterface.js +2 -0
- package/ec2/networkInterface.js.map +1 -1
- package/elasticloadbalancingv2/getListenerRule.d.ts +16 -2
- package/elasticloadbalancingv2/getListenerRule.js +4 -2
- package/elasticloadbalancingv2/getListenerRule.js.map +1 -1
- package/elasticloadbalancingv2/listenerRule.d.ts +32 -1
- package/elasticloadbalancingv2/listenerRule.js +2 -1
- package/elasticloadbalancingv2/listenerRule.js.map +1 -1
- package/fis/experimentTemplate.js +1 -1
- package/fis/experimentTemplate.js.map +1 -1
- package/kafkaconnect/connector.d.ts +8 -0
- package/kafkaconnect/connector.js +2 -0
- package/kafkaconnect/connector.js.map +1 -1
- package/kafkaconnect/getConnector.d.ts +4 -0
- package/kafkaconnect/getConnector.js.map +1 -1
- package/lambda/getUrl.d.ts +1 -1
- package/lambda/url.d.ts +2 -2
- package/package.json +2 -2
- package/package.json.dev +1 -1
- package/ssm/getParameter.d.ts +0 -1
- package/ssm/getParameter.js.map +1 -1
- package/ssm/parameter.d.ts +0 -2
- package/ssm/parameter.js.map +1 -1
- package/types/enums/datasync/index.d.ts +14 -0
- package/types/enums/datasync/index.js +7 -1
- package/types/enums/datasync/index.js.map +1 -1
- package/types/enums/lambda/index.d.ts +1 -1
- package/types/enums/ssm/index.d.ts +0 -1
- package/types/enums/ssm/index.js.map +1 -1
- package/types/input.d.ts +773 -5
- package/types/output.d.ts +773 -5
package/types/output.d.ts
CHANGED
|
@@ -3559,119 +3559,571 @@ export declare namespace auditmanager {
|
|
|
3559
3559
|
}
|
|
3560
3560
|
}
|
|
3561
3561
|
export declare namespace autoscaling {
|
|
3562
|
+
/**
|
|
3563
|
+
* ``AcceleratorCountRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum number of accelerators for an instance type.
|
|
3564
|
+
*/
|
|
3562
3565
|
interface AutoScalingGroupAcceleratorCountRequest {
|
|
3566
|
+
/**
|
|
3567
|
+
* The maximum value.
|
|
3568
|
+
*/
|
|
3563
3569
|
max?: number;
|
|
3570
|
+
/**
|
|
3571
|
+
* The minimum value.
|
|
3572
|
+
*/
|
|
3564
3573
|
min?: number;
|
|
3565
3574
|
}
|
|
3575
|
+
/**
|
|
3576
|
+
* ``AcceleratorTotalMemoryMiBRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum total memory size for the accelerators for an instance type, in MiB.
|
|
3577
|
+
*/
|
|
3566
3578
|
interface AutoScalingGroupAcceleratorTotalMemoryMiBRequest {
|
|
3579
|
+
/**
|
|
3580
|
+
* The memory maximum in MiB.
|
|
3581
|
+
*/
|
|
3567
3582
|
max?: number;
|
|
3583
|
+
/**
|
|
3584
|
+
* The memory minimum in MiB.
|
|
3585
|
+
*/
|
|
3568
3586
|
min?: number;
|
|
3569
3587
|
}
|
|
3588
|
+
/**
|
|
3589
|
+
* ``BaselineEbsBandwidthMbpsRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum baseline bandwidth performance for an instance type, in Mbps.
|
|
3590
|
+
*/
|
|
3570
3591
|
interface AutoScalingGroupBaselineEbsBandwidthMbpsRequest {
|
|
3592
|
+
/**
|
|
3593
|
+
* The maximum value in Mbps.
|
|
3594
|
+
*/
|
|
3571
3595
|
max?: number;
|
|
3596
|
+
/**
|
|
3597
|
+
* The minimum value in Mbps.
|
|
3598
|
+
*/
|
|
3572
3599
|
min?: number;
|
|
3573
3600
|
}
|
|
3601
|
+
/**
|
|
3602
|
+
* ``InstanceMaintenancePolicy`` is a property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource.
|
|
3603
|
+
* For more information, see [Instance maintenance policies](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html) in the *Amazon EC2 Auto Scaling User Guide*.
|
|
3604
|
+
*/
|
|
3574
3605
|
interface AutoScalingGroupInstanceMaintenancePolicy {
|
|
3606
|
+
/**
|
|
3607
|
+
* Specifies the upper threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when replacing instances. Value range is 100 to 200. To clear a previously set value, specify a value of ``-1``.
|
|
3608
|
+
* Both ``MinHealthyPercentage`` and ``MaxHealthyPercentage`` must be specified, and the difference between them cannot be greater than 100. A large range increases the number of instances that can be replaced at the same time.
|
|
3609
|
+
*/
|
|
3575
3610
|
maxHealthyPercentage?: number;
|
|
3611
|
+
/**
|
|
3612
|
+
* Specifies the lower threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the minimum percentage of the group to keep in service, healthy, and ready to use to support your workload when replacing instances. Value range is 0 to 100. To clear a previously set value, specify a value of ``-1``.
|
|
3613
|
+
*/
|
|
3576
3614
|
minHealthyPercentage?: number;
|
|
3577
3615
|
}
|
|
3616
|
+
/**
|
|
3617
|
+
* The attributes for the instance types for a mixed instances policy. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance types.
|
|
3618
|
+
* When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.
|
|
3619
|
+
* To limit the list of instance types from which Amazon EC2 Auto Scaling can identify matching instance types, you can use one of the following parameters, but not both in the same request:
|
|
3620
|
+
* + ``AllowedInstanceTypes`` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.
|
|
3621
|
+
* + ``ExcludedInstanceTypes`` - The instance types to exclude from the list, even if they match your specified attributes.
|
|
3622
|
+
*
|
|
3623
|
+
* You must specify ``VCpuCount`` and ``MemoryMiB``. All other attributes are optional. Any unspecified optional attribute is set to its default.
|
|
3624
|
+
* For an example template, see [Auto scaling template snippets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html).
|
|
3625
|
+
* For more information, see [Creating an Auto Scaling group using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html) in the *Amazon EC2 Auto Scaling User Guide*. For help determining which instance types match your attributes before you apply them to your Auto Scaling group, see [Preview instance types with specified attributes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-get-instance-types-from-instance-requirements) in the *Amazon EC2 User Guide for Linux Instances*.
|
|
3626
|
+
* ``InstanceRequirements`` is a property of the ``LaunchTemplateOverrides`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) property type.
|
|
3627
|
+
*/
|
|
3578
3628
|
interface AutoScalingGroupInstanceRequirements {
|
|
3629
|
+
/**
|
|
3630
|
+
* The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) for an instance type.
|
|
3631
|
+
* To exclude accelerator-enabled instance types, set ``Max`` to ``0``.
|
|
3632
|
+
* Default: No minimum or maximum limits
|
|
3633
|
+
*/
|
|
3579
3634
|
acceleratorCount?: outputs.autoscaling.AutoScalingGroupAcceleratorCountRequest;
|
|
3635
|
+
/**
|
|
3636
|
+
* Indicates whether instance types must have accelerators by specific manufacturers.
|
|
3637
|
+
* + For instance types with NVIDIA devices, specify ``nvidia``.
|
|
3638
|
+
* + For instance types with AMD devices, specify ``amd``.
|
|
3639
|
+
* + For instance types with AWS devices, specify ``amazon-web-services``.
|
|
3640
|
+
* + For instance types with Xilinx devices, specify ``xilinx``.
|
|
3641
|
+
*
|
|
3642
|
+
* Default: Any manufacturer
|
|
3643
|
+
*/
|
|
3580
3644
|
acceleratorManufacturers?: string[];
|
|
3645
|
+
/**
|
|
3646
|
+
* Lists the accelerators that must be on an instance type.
|
|
3647
|
+
* + For instance types with NVIDIA A100 GPUs, specify ``a100``.
|
|
3648
|
+
* + For instance types with NVIDIA V100 GPUs, specify ``v100``.
|
|
3649
|
+
* + For instance types with NVIDIA K80 GPUs, specify ``k80``.
|
|
3650
|
+
* + For instance types with NVIDIA T4 GPUs, specify ``t4``.
|
|
3651
|
+
* + For instance types with NVIDIA M60 GPUs, specify ``m60``.
|
|
3652
|
+
* + For instance types with AMD Radeon Pro V520 GPUs, specify ``radeon-pro-v520``.
|
|
3653
|
+
* + For instance types with Xilinx VU9P FPGAs, specify ``vu9p``.
|
|
3654
|
+
*
|
|
3655
|
+
* Default: Any accelerator
|
|
3656
|
+
*/
|
|
3581
3657
|
acceleratorNames?: string[];
|
|
3658
|
+
/**
|
|
3659
|
+
* The minimum and maximum total memory size for the accelerators on an instance type, in MiB.
|
|
3660
|
+
* Default: No minimum or maximum limits
|
|
3661
|
+
*/
|
|
3582
3662
|
acceleratorTotalMemoryMiB?: outputs.autoscaling.AutoScalingGroupAcceleratorTotalMemoryMiBRequest;
|
|
3663
|
+
/**
|
|
3664
|
+
* Lists the accelerator types that must be on an instance type.
|
|
3665
|
+
* + For instance types with GPU accelerators, specify ``gpu``.
|
|
3666
|
+
* + For instance types with FPGA accelerators, specify ``fpga``.
|
|
3667
|
+
* + For instance types with inference accelerators, specify ``inference``.
|
|
3668
|
+
*
|
|
3669
|
+
* Default: Any accelerator type
|
|
3670
|
+
*/
|
|
3583
3671
|
acceleratorTypes?: string[];
|
|
3672
|
+
/**
|
|
3673
|
+
* The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes.
|
|
3674
|
+
* You can use strings with one or more wild cards, represented by an asterisk (``*``), to allow an instance type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``.
|
|
3675
|
+
* For example, if you specify ``c5*``, Amazon EC2 Auto Scaling will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 Auto Scaling will allow all the M5a instance types, but not the M5n instance types.
|
|
3676
|
+
* If you specify ``AllowedInstanceTypes``, you can't specify ``ExcludedInstanceTypes``.
|
|
3677
|
+
* Default: All instance types
|
|
3678
|
+
*/
|
|
3584
3679
|
allowedInstanceTypes?: string[];
|
|
3680
|
+
/**
|
|
3681
|
+
* Indicates whether bare metal instance types are included, excluded, or required.
|
|
3682
|
+
* Default: ``excluded``
|
|
3683
|
+
*/
|
|
3585
3684
|
bareMetal?: string;
|
|
3685
|
+
/**
|
|
3686
|
+
* The minimum and maximum baseline bandwidth performance for an instance type, in Mbps. For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide for Linux Instances*.
|
|
3687
|
+
* Default: No minimum or maximum limits
|
|
3688
|
+
*/
|
|
3586
3689
|
baselineEbsBandwidthMbps?: outputs.autoscaling.AutoScalingGroupBaselineEbsBandwidthMbpsRequest;
|
|
3690
|
+
/**
|
|
3691
|
+
* Indicates whether burstable performance instance types are included, excluded, or required. For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) in the *Amazon EC2 User Guide for Linux Instances*.
|
|
3692
|
+
* Default: ``excluded``
|
|
3693
|
+
*/
|
|
3587
3694
|
burstablePerformance?: string;
|
|
3695
|
+
/**
|
|
3696
|
+
* Lists which specific CPU manufacturers to include.
|
|
3697
|
+
* + For instance types with Intel CPUs, specify ``intel``.
|
|
3698
|
+
* + For instance types with AMD CPUs, specify ``amd``.
|
|
3699
|
+
* + For instance types with AWS CPUs, specify ``amazon-web-services``.
|
|
3700
|
+
*
|
|
3701
|
+
* Don't confuse the CPU hardware manufacturer with the CPU hardware architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.
|
|
3702
|
+
* Default: Any manufacturer
|
|
3703
|
+
*/
|
|
3588
3704
|
cpuManufacturers?: string[];
|
|
3705
|
+
/**
|
|
3706
|
+
* The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (``*``), to exclude an instance family, type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``.
|
|
3707
|
+
* For example, if you specify ``c5*``, you are excluding the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n instance types.
|
|
3708
|
+
* If you specify ``ExcludedInstanceTypes``, you can't specify ``AllowedInstanceTypes``.
|
|
3709
|
+
* Default: No excluded instance types
|
|
3710
|
+
*/
|
|
3589
3711
|
excludedInstanceTypes?: string[];
|
|
3712
|
+
/**
|
|
3713
|
+
* Indicates whether current or previous generation instance types are included.
|
|
3714
|
+
* + For current generation instance types, specify ``current``. The current generation includes EC2 instance types currently recommended for use. This typically includes the latest two to three generations in each instance family. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide for Linux Instances*.
|
|
3715
|
+
* + For previous generation instance types, specify ``previous``.
|
|
3716
|
+
*
|
|
3717
|
+
* Default: Any current or previous generation
|
|
3718
|
+
*/
|
|
3590
3719
|
instanceGenerations?: string[];
|
|
3720
|
+
/**
|
|
3721
|
+
* Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, see [Amazon EC2 instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in the *Amazon EC2 User Guide for Linux Instances*.
|
|
3722
|
+
* Default: ``included``
|
|
3723
|
+
*/
|
|
3591
3724
|
localStorage?: string;
|
|
3725
|
+
/**
|
|
3726
|
+
* Indicates the type of local storage that is required.
|
|
3727
|
+
* + For instance types with hard disk drive (HDD) storage, specify ``hdd``.
|
|
3728
|
+
* + For instance types with solid state drive (SSD) storage, specify ``ssd``.
|
|
3729
|
+
*
|
|
3730
|
+
* Default: Any local storage type
|
|
3731
|
+
*/
|
|
3592
3732
|
localStorageTypes?: string[];
|
|
3733
|
+
/**
|
|
3734
|
+
* [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.
|
|
3735
|
+
* The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.
|
|
3736
|
+
* To indicate no price protection threshold, specify a high value, such as ``999999``.
|
|
3737
|
+
* If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price.
|
|
3738
|
+
* Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, then ``SpotMaxPricePercentageOverLowestPrice`` is used and the value for that parameter defaults to ``100``.
|
|
3739
|
+
*/
|
|
3593
3740
|
maxSpotPriceAsPercentageOfOptimalOnDemandPrice?: number;
|
|
3741
|
+
/**
|
|
3742
|
+
* The minimum and maximum amount of memory per vCPU for an instance type, in GiB.
|
|
3743
|
+
* Default: No minimum or maximum limits
|
|
3744
|
+
*/
|
|
3594
3745
|
memoryGiBPerVCpu?: outputs.autoscaling.AutoScalingGroupMemoryGiBPerVCpuRequest;
|
|
3746
|
+
/**
|
|
3747
|
+
* The minimum and maximum instance memory size for an instance type, in MiB.
|
|
3748
|
+
*/
|
|
3595
3749
|
memoryMiB: outputs.autoscaling.AutoScalingGroupMemoryMiBRequest;
|
|
3750
|
+
/**
|
|
3751
|
+
* The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).
|
|
3752
|
+
* Default: No minimum or maximum limits
|
|
3753
|
+
*/
|
|
3596
3754
|
networkBandwidthGbps?: outputs.autoscaling.AutoScalingGroupNetworkBandwidthGbpsRequest;
|
|
3755
|
+
/**
|
|
3756
|
+
* The minimum and maximum number of network interfaces for an instance type.
|
|
3757
|
+
* Default: No minimum or maximum limits
|
|
3758
|
+
*/
|
|
3597
3759
|
networkInterfaceCount?: outputs.autoscaling.AutoScalingGroupNetworkInterfaceCountRequest;
|
|
3760
|
+
/**
|
|
3761
|
+
* [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.
|
|
3762
|
+
* The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.
|
|
3763
|
+
* To turn off price protection, specify a high value, such as ``999999``.
|
|
3764
|
+
* If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per instance price.
|
|
3765
|
+
* Default: ``20``
|
|
3766
|
+
*/
|
|
3598
3767
|
onDemandMaxPricePercentageOverLowestPrice?: number;
|
|
3768
|
+
/**
|
|
3769
|
+
* Indicates whether instance types must provide On-Demand Instance hibernation support.
|
|
3770
|
+
* Default: ``false``
|
|
3771
|
+
*/
|
|
3599
3772
|
requireHibernateSupport?: boolean;
|
|
3773
|
+
/**
|
|
3774
|
+
* [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.
|
|
3775
|
+
* The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.
|
|
3776
|
+
* To turn off price protection, specify a high value, such as ``999999``.
|
|
3777
|
+
* If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price.
|
|
3778
|
+
* Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified.
|
|
3779
|
+
* Default: ``100``
|
|
3780
|
+
*/
|
|
3600
3781
|
spotMaxPricePercentageOverLowestPrice?: number;
|
|
3782
|
+
/**
|
|
3783
|
+
* The minimum and maximum total local storage size for an instance type, in GB.
|
|
3784
|
+
* Default: No minimum or maximum limits
|
|
3785
|
+
*/
|
|
3601
3786
|
totalLocalStorageGb?: outputs.autoscaling.AutoScalingGroupTotalLocalStorageGbRequest;
|
|
3787
|
+
/**
|
|
3788
|
+
* The minimum and maximum number of vCPUs for an instance type.
|
|
3789
|
+
*/
|
|
3602
3790
|
vCpuCount: outputs.autoscaling.AutoScalingGroupVCpuCountRequest;
|
|
3603
3791
|
}
|
|
3792
|
+
/**
|
|
3793
|
+
* Use this structure to specify the distribution of On-Demand Instances and Spot Instances and the allocation strategies used to fulfill On-Demand and Spot capacities for a mixed instances policy.
|
|
3794
|
+
* For more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide*.
|
|
3795
|
+
* ``InstancesDistribution`` is a property of the [AWS::AutoScaling::AutoScalingGroup MixedInstancesPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-mixedinstancespolicy.html) property type.
|
|
3796
|
+
*/
|
|
3604
3797
|
interface AutoScalingGroupInstancesDistribution {
|
|
3798
|
+
/**
|
|
3799
|
+
* The allocation strategy to apply to your On-Demand Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify.
|
|
3800
|
+
* The following lists the valid values:
|
|
3801
|
+
* + lowest-price Uses price to determine which instance types are the highest priority, launching the lowest priced instance types within an Availability Zone first. This is the default value for Auto Scaling groups that specify InstanceRequirements. + prioritized You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling launches your highest priority instance types first. If all your On-Demand capacity cannot be fulfilled using your highest priority instance type, then Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance type, and so on. This is the default value for Auto Scaling groups that don't specify InstanceRequirements and cannot be used for groups that do.
|
|
3802
|
+
*/
|
|
3605
3803
|
onDemandAllocationStrategy?: string;
|
|
3804
|
+
/**
|
|
3805
|
+
* The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is launched first as your group scales.
|
|
3806
|
+
* This number has the same unit of measurement as the group's desired capacity. If you change the default unit of measurement (number of instances) by specifying weighted capacity values in your launch template overrides list, or by changing the default desired capacity type setting of the group, you must specify this number using the same unit of measurement.
|
|
3807
|
+
* Default: 0
|
|
3808
|
+
* An update to this setting means a gradual replacement of instances to adjust the current On-Demand Instance levels. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones.
|
|
3809
|
+
*/
|
|
3606
3810
|
onDemandBaseCapacity?: number;
|
|
3811
|
+
/**
|
|
3812
|
+
* Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond ``OnDemandBaseCapacity``. Expressed as a number (for example, 20 specifies 20% On-Demand Instances, 80% Spot Instances). If set to 100, only On-Demand Instances are used.
|
|
3813
|
+
* Default: 100
|
|
3814
|
+
* An update to this setting means a gradual replacement of instances to adjust the current On-Demand and Spot Instance levels for your additional capacity higher than the base capacity. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones.
|
|
3815
|
+
*/
|
|
3607
3816
|
onDemandPercentageAboveBaseCapacity?: number;
|
|
3817
|
+
/**
|
|
3818
|
+
* The allocation strategy to apply to your Spot Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify.
|
|
3819
|
+
* The following lists the valid values:
|
|
3820
|
+
* + capacity-optimized Requests Spot Instances using pools that are optimally chosen based on the available Spot capacity. This strategy has the lowest risk of interruption. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized. + capacity-optimized-prioritized You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling honors the instance type priorities on a best effort basis but optimizes for capacity first. Note that if the On-Demand allocation strategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity. This is not a valid value for Auto Scaling groups that specify InstanceRequirements. + lowest-price Requests Spot Instances using the lowest priced pools within an Availability Zone, across the number of Spot pools that you specify for the SpotInstancePools property. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. This is the default value, but it might lead to high interruption rates because this strategy only considers instance price and not available capacity. + price-capacity-optimized (recommended) The price and capacity optimized allocation strategy looks at both price and capacity to select the Spot Instance pools that are the least likely to be interrupted and have the lowest possible price.
|
|
3821
|
+
*/
|
|
3608
3822
|
spotAllocationStrategy?: string;
|
|
3823
|
+
/**
|
|
3824
|
+
* The number of Spot Instance pools across which to allocate your Spot Instances. The Spot pools are determined from the different instance types in the overrides. Valid only when the ``SpotAllocationStrategy`` is ``lowest-price``. Value must be in the range of 1–20.
|
|
3825
|
+
* Default: 2
|
|
3826
|
+
*/
|
|
3609
3827
|
spotInstancePools?: number;
|
|
3828
|
+
/**
|
|
3829
|
+
* The maximum price per unit hour that you are willing to pay for a Spot Instance. If your maximum price is lower than the Spot price for the instance types that you selected, your Spot Instances are not launched. We do not recommend specifying a maximum price because it can lead to increased interruptions. When Spot Instances launch, you pay the current Spot price. To remove a maximum price that you previously set, include the property but specify an empty string ("") for the value.
|
|
3830
|
+
* If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify one.
|
|
3831
|
+
* Valid Range: Minimum value of 0.001
|
|
3832
|
+
*/
|
|
3610
3833
|
spotMaxPrice?: string;
|
|
3611
3834
|
}
|
|
3835
|
+
/**
|
|
3836
|
+
* Use this structure to specify the launch templates and instance types (overrides) for a mixed instances policy.
|
|
3837
|
+
* ``LaunchTemplate`` is a property of the [AWS::AutoScaling::AutoScalingGroup MixedInstancesPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-mixedinstancespolicy.html) property type.
|
|
3838
|
+
*/
|
|
3612
3839
|
interface AutoScalingGroupLaunchTemplate {
|
|
3840
|
+
/**
|
|
3841
|
+
* The launch template.
|
|
3842
|
+
*/
|
|
3613
3843
|
launchTemplateSpecification: outputs.autoscaling.AutoScalingGroupLaunchTemplateSpecification;
|
|
3844
|
+
/**
|
|
3845
|
+
* Any properties that you specify override the same properties in the launch template.
|
|
3846
|
+
*/
|
|
3614
3847
|
overrides?: outputs.autoscaling.AutoScalingGroupLaunchTemplateOverrides[];
|
|
3615
3848
|
}
|
|
3849
|
+
/**
|
|
3850
|
+
* Use this structure to let Amazon EC2 Auto Scaling do the following when the Auto Scaling group has a mixed instances policy:
|
|
3851
|
+
* + Override the instance type that is specified in the launch template.
|
|
3852
|
+
* + Use multiple instance types.
|
|
3853
|
+
*
|
|
3854
|
+
* Specify the instance types that you want, or define your instance requirements instead and let Amazon EC2 Auto Scaling provision the available instance types that meet your requirements. This can provide Amazon EC2 Auto Scaling with a larger selection of instance types to choose from when fulfilling Spot and On-Demand capacities. You can view which instance types are matched before you apply the instance requirements to your Auto Scaling group.
|
|
3855
|
+
* After you define your instance requirements, you don't have to keep updating these settings to get new EC2 instance types automatically. Amazon EC2 Auto Scaling uses the instance requirements of the Auto Scaling group to determine whether a new EC2 instance type can be used.
|
|
3856
|
+
* ``LaunchTemplateOverrides`` is a property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) property type.
|
|
3857
|
+
*/
|
|
3616
3858
|
interface AutoScalingGroupLaunchTemplateOverrides {
|
|
3859
|
+
/**
|
|
3860
|
+
* The instance requirements. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance types.
|
|
3861
|
+
* You can specify up to four separate sets of instance requirements per Auto Scaling group. This is useful for provisioning instances from different Amazon Machine Images (AMIs) in the same Auto Scaling group. To do this, create the AMIs and create a new launch template for each AMI. Then, create a compatible set of instance requirements for each launch template.
|
|
3862
|
+
* If you specify ``InstanceRequirements``, you can't specify ``InstanceType``.
|
|
3863
|
+
*/
|
|
3617
3864
|
instanceRequirements?: outputs.autoscaling.AutoScalingGroupInstanceRequirements;
|
|
3865
|
+
/**
|
|
3866
|
+
* The instance type, such as ``m3.xlarge``. You must specify an instance type that is supported in your requested Region and Availability Zones. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon Elastic Compute Cloud User Guide*.
|
|
3867
|
+
* You can specify up to 40 instance types per Auto Scaling group.
|
|
3868
|
+
*/
|
|
3618
3869
|
instanceType?: string;
|
|
3870
|
+
/**
|
|
3871
|
+
* Provides a launch template for the specified instance type or set of instance requirements. For example, some instance types might require a launch template with a different AMI. If not provided, Amazon EC2 Auto Scaling uses the launch template that's specified in the ``LaunchTemplate`` definition. For more information, see [Specifying a different launch template for an instance type](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-launch-template-overrides.html) in the *Amazon EC2 Auto Scaling User Guide*.
|
|
3872
|
+
* You can specify up to 20 launch templates per Auto Scaling group. The launch templates specified in the overrides and in the ``LaunchTemplate`` definition count towards this limit.
|
|
3873
|
+
*/
|
|
3619
3874
|
launchTemplateSpecification?: outputs.autoscaling.AutoScalingGroupLaunchTemplateSpecification;
|
|
3875
|
+
/**
|
|
3876
|
+
* If you provide a list of instance types to use, you can specify the number of capacity units provided by each instance type in terms of virtual CPUs, memory, storage, throughput, or other relative performance characteristic. When a Spot or On-Demand Instance is launched, the capacity units count toward the desired capacity. Amazon EC2 Auto Scaling launches instances until the desired capacity is totally fulfilled, even if this results in an overage. For example, if there are two units remaining to fulfill capacity, and Amazon EC2 Auto Scaling can only launch an instance with a ``WeightedCapacity`` of five units, the instance is launched, and the desired capacity is exceeded by three units. For more information, see [Configure instance weighting for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-instance-weighting.html) in the *Amazon EC2 Auto Scaling User Guide*. Value must be in the range of 1-999.
|
|
3877
|
+
* If you specify a value for ``WeightedCapacity`` for one instance type, you must specify a value for ``WeightedCapacity`` for all of them.
|
|
3878
|
+
* Every Auto Scaling group has three size parameters (``DesiredCapacity``, ``MaxSize``, and ``MinSize``). Usually, you set these sizes based on a specific number of instances. However, if you configure a mixed instances policy that defines weights for the instance types, you must specify these sizes with the same units that you use for weighting instances.
|
|
3879
|
+
*/
|
|
3620
3880
|
weightedCapacity?: string;
|
|
3621
3881
|
}
|
|
3882
|
+
/**
|
|
3883
|
+
* Specifies a launch template to use when provisioning EC2 instances for an Auto Scaling group.
|
|
3884
|
+
* You must specify the following:
|
|
3885
|
+
* + The ID or the name of the launch template, but not both.
|
|
3886
|
+
* + The version of the launch template.
|
|
3887
|
+
*
|
|
3888
|
+
* ``LaunchTemplateSpecification`` is property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. It is also a property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) and [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property types.
|
|
3889
|
+
* For information about creating a launch template, see [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) and [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide*.
|
|
3890
|
+
* For examples of launch templates, see [Auto scaling template snippets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html) and the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#aws-resource-ec2-launchtemplate--examples) section in the ``AWS::EC2::LaunchTemplate`` resource.
|
|
3891
|
+
*/
|
|
3622
3892
|
interface AutoScalingGroupLaunchTemplateSpecification {
|
|
3893
|
+
/**
|
|
3894
|
+
* The ID of the launch template.
|
|
3895
|
+
* You must specify the ``LaunchTemplateID`` or the ``LaunchTemplateName``, but not both.
|
|
3896
|
+
*/
|
|
3623
3897
|
launchTemplateId?: string;
|
|
3898
|
+
/**
|
|
3899
|
+
* The name of the launch template.
|
|
3900
|
+
* You must specify the ``LaunchTemplateName`` or the ``LaunchTemplateID``, but not both.
|
|
3901
|
+
*/
|
|
3624
3902
|
launchTemplateName?: string;
|
|
3903
|
+
/**
|
|
3904
|
+
* The version number of the launch template.
|
|
3905
|
+
* Specifying ``$Latest`` or ``$Default`` for the template version number is not supported. However, you can specify ``LatestVersionNumber`` or ``DefaultVersionNumber`` using the ``Fn::GetAtt`` intrinsic function. For more information, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html).
|
|
3906
|
+
* For an example of using the ``Fn::GetAtt`` function, see the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#aws-resource-autoscaling-autoscalinggroup--examples) section of the ``AWS::AutoScaling::AutoScalingGroup`` resource.
|
|
3907
|
+
*/
|
|
3625
3908
|
version: string;
|
|
3626
3909
|
}
|
|
3910
|
+
/**
|
|
3911
|
+
* ``LifecycleHookSpecification`` specifies a lifecycle hook for the ``LifecycleHookSpecificationList`` property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. A lifecycle hook specifies actions to perform when Amazon EC2 Auto Scaling launches or terminates instances.
|
|
3912
|
+
* For more information, see [Amazon EC2 Auto Scaling lifecycle hooks](https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html) in the *Amazon EC2 Auto Scaling User Guide*. You can find a sample template snippet in the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-lifecyclehook.html#aws-resource-as-lifecyclehook--examples) section of the ``AWS::AutoScaling::LifecycleHook`` resource.
|
|
3913
|
+
*/
|
|
3627
3914
|
interface AutoScalingGroupLifecycleHookSpecification {
|
|
3915
|
+
/**
|
|
3916
|
+
* The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The default value is ``ABANDON``.
|
|
3917
|
+
* Valid values: ``CONTINUE`` | ``ABANDON``
|
|
3918
|
+
*/
|
|
3628
3919
|
defaultResult?: string;
|
|
3920
|
+
/**
|
|
3921
|
+
* The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from ``30`` to ``7200`` seconds. The default value is ``3600`` seconds (1 hour).
|
|
3922
|
+
*/
|
|
3629
3923
|
heartbeatTimeout?: number;
|
|
3924
|
+
/**
|
|
3925
|
+
* The name of the lifecycle hook.
|
|
3926
|
+
*/
|
|
3630
3927
|
lifecycleHookName: string;
|
|
3928
|
+
/**
|
|
3929
|
+
* The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.
|
|
3930
|
+
* + To create a lifecycle hook for scale-out events, specify ``autoscaling:EC2_INSTANCE_LAUNCHING``.
|
|
3931
|
+
* + To create a lifecycle hook for scale-in events, specify ``autoscaling:EC2_INSTANCE_TERMINATING``.
|
|
3932
|
+
*/
|
|
3631
3933
|
lifecycleTransition: string;
|
|
3934
|
+
/**
|
|
3935
|
+
* Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
|
|
3936
|
+
*/
|
|
3632
3937
|
notificationMetadata?: string;
|
|
3938
|
+
/**
|
|
3939
|
+
* The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook. You can specify an Amazon SNS topic or an Amazon SQS queue.
|
|
3940
|
+
*/
|
|
3633
3941
|
notificationTargetArn?: string;
|
|
3942
|
+
/**
|
|
3943
|
+
* The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. For information about creating this role, see [Configure a notification target for a lifecycle hook](https://docs.aws.amazon.com/autoscaling/ec2/userguide/prepare-for-lifecycle-notifications.html#lifecycle-hook-notification-target) in the *Amazon EC2 Auto Scaling User Guide*.
|
|
3944
|
+
* Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue.
|
|
3945
|
+
*/
|
|
3634
3946
|
roleArn?: string;
|
|
3635
3947
|
}
|
|
3948
|
+
/**
|
|
3949
|
+
* ``MemoryGiBPerVCpuRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum amount of memory per vCPU for an instance type, in GiB.
|
|
3950
|
+
*/
|
|
3636
3951
|
interface AutoScalingGroupMemoryGiBPerVCpuRequest {
|
|
3952
|
+
/**
|
|
3953
|
+
* The memory maximum in GiB.
|
|
3954
|
+
*/
|
|
3637
3955
|
max?: number;
|
|
3956
|
+
/**
|
|
3957
|
+
* The memory minimum in GiB.
|
|
3958
|
+
*/
|
|
3638
3959
|
min?: number;
|
|
3639
3960
|
}
|
|
3961
|
+
/**
|
|
3962
|
+
* ``MemoryMiBRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum instance memory size for an instance type, in MiB.
|
|
3963
|
+
*/
|
|
3640
3964
|
interface AutoScalingGroupMemoryMiBRequest {
|
|
3965
|
+
/**
|
|
3966
|
+
* The memory maximum in MiB.
|
|
3967
|
+
*/
|
|
3641
3968
|
max?: number;
|
|
3969
|
+
/**
|
|
3970
|
+
* The memory minimum in MiB.
|
|
3971
|
+
*/
|
|
3642
3972
|
min?: number;
|
|
3643
3973
|
}
|
|
3974
|
+
/**
|
|
3975
|
+
* ``MetricsCollection`` is a property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource that describes the group metrics that an Amazon EC2 Auto Scaling group sends to Amazon CloudWatch. These metrics describe the group rather than any of its instances.
|
|
3976
|
+
* For more information, see [Monitor CloudWatch metrics for your Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-monitoring.html) in the *Amazon EC2 Auto Scaling User Guide*. You can find a sample template snippet in the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#aws-resource-autoscaling-autoscalinggroup--examples) section of the ``AWS::AutoScaling::AutoScalingGroup`` resource.
|
|
3977
|
+
*/
|
|
3644
3978
|
interface AutoScalingGroupMetricsCollection {
|
|
3979
|
+
/**
|
|
3980
|
+
* The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is ``1Minute``.
|
|
3981
|
+
*/
|
|
3645
3982
|
granularity: string;
|
|
3983
|
+
/**
|
|
3984
|
+
* Identifies the metrics to enable.
|
|
3985
|
+
* You can specify one or more of the following metrics:
|
|
3986
|
+
* + ``GroupMinSize``
|
|
3987
|
+
* + ``GroupMaxSize``
|
|
3988
|
+
* + ``GroupDesiredCapacity``
|
|
3989
|
+
* + ``GroupInServiceInstances``
|
|
3990
|
+
* + ``GroupPendingInstances``
|
|
3991
|
+
* + ``GroupStandbyInstances``
|
|
3992
|
+
* + ``GroupTerminatingInstances``
|
|
3993
|
+
* + ``GroupTotalInstances``
|
|
3994
|
+
* + ``GroupInServiceCapacity``
|
|
3995
|
+
* + ``GroupPendingCapacity``
|
|
3996
|
+
* + ``GroupStandbyCapacity``
|
|
3997
|
+
* + ``GroupTerminatingCapacity``
|
|
3998
|
+
* + ``GroupTotalCapacity``
|
|
3999
|
+
* + ``WarmPoolDesiredCapacity``
|
|
4000
|
+
* + ``WarmPoolWarmedCapacity``
|
|
4001
|
+
* + ``WarmPoolPendingCapacity``
|
|
4002
|
+
* + ``WarmPoolTerminatingCapacity``
|
|
4003
|
+
* + ``WarmPoolTotalCapacity``
|
|
4004
|
+
* + ``GroupAndWarmPoolDesiredCapacity``
|
|
4005
|
+
* + ``GroupAndWarmPoolTotalCapacity``
|
|
4006
|
+
*
|
|
4007
|
+
* If you specify ``Granularity`` and don't specify any metrics, all metrics are enabled.
|
|
4008
|
+
* For more information, see [Auto Scaling group metrics](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-cloudwatch-monitoring.html#as-group-metrics) in the *Amazon EC2 Auto Scaling User Guide*.
|
|
4009
|
+
*/
|
|
3646
4010
|
metrics?: string[];
|
|
3647
4011
|
}
|
|
4012
|
+
/**
|
|
4013
|
+
* Use this structure to launch multiple instance types and On-Demand Instances and Spot Instances within a single Auto Scaling group.
|
|
4014
|
+
* A mixed instances policy contains information that Amazon EC2 Auto Scaling can use to launch instances and help optimize your costs. For more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide*.
|
|
4015
|
+
* You can create a mixed instances policy for new and existing Auto Scaling groups. You must use a launch template to configure the policy. You cannot use a launch configuration.
|
|
4016
|
+
* There are key differences between Spot Instances and On-Demand Instances:
|
|
4017
|
+
* + The price for Spot Instances varies based on demand
|
|
4018
|
+
* + Amazon EC2 can terminate an individual Spot Instance as the availability of, or price for, Spot Instances changes
|
|
4019
|
+
*
|
|
4020
|
+
* When a Spot Instance is terminated, Amazon EC2 Auto Scaling group attempts to launch a replacement instance to maintain the desired capacity for the group.
|
|
4021
|
+
* ``MixedInstancesPolicy`` is a property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource.
|
|
4022
|
+
*/
|
|
3648
4023
|
interface AutoScalingGroupMixedInstancesPolicy {
|
|
4024
|
+
/**
|
|
4025
|
+
* The instances distribution.
|
|
4026
|
+
*/
|
|
3649
4027
|
instancesDistribution?: outputs.autoscaling.AutoScalingGroupInstancesDistribution;
|
|
4028
|
+
/**
|
|
4029
|
+
* One or more launch templates and the instance types (overrides) that are used to launch EC2 instances to fulfill On-Demand and Spot capacities.
|
|
4030
|
+
*/
|
|
3650
4031
|
launchTemplate: outputs.autoscaling.AutoScalingGroupLaunchTemplate;
|
|
3651
4032
|
}
|
|
4033
|
+
/**
|
|
4034
|
+
* ``NetworkBandwidthGbpsRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum network bandwidth for an instance type, in Gbps.
|
|
4035
|
+
* Setting the minimum bandwidth does not guarantee that your instance will achieve the minimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum bandwidth, but the actual bandwidth of your instance might go below the specified minimum at times. For more information, see [Available instance bandwidth](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth) in the *Amazon EC2 User Guide for Linux Instances*.
|
|
4036
|
+
*/
|
|
3652
4037
|
interface AutoScalingGroupNetworkBandwidthGbpsRequest {
|
|
4038
|
+
/**
|
|
4039
|
+
* The maximum amount of network bandwidth, in gigabits per second (Gbps).
|
|
4040
|
+
*/
|
|
3653
4041
|
max?: number;
|
|
4042
|
+
/**
|
|
4043
|
+
* The minimum amount of network bandwidth, in gigabits per second (Gbps).
|
|
4044
|
+
*/
|
|
3654
4045
|
min?: number;
|
|
3655
4046
|
}
|
|
4047
|
+
/**
|
|
4048
|
+
* ``NetworkInterfaceCountRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum number of network interfaces for an instance type.
|
|
4049
|
+
*/
|
|
3656
4050
|
interface AutoScalingGroupNetworkInterfaceCountRequest {
|
|
4051
|
+
/**
|
|
4052
|
+
* The maximum number of network interfaces.
|
|
4053
|
+
*/
|
|
3657
4054
|
max?: number;
|
|
4055
|
+
/**
|
|
4056
|
+
* The minimum number of network interfaces.
|
|
4057
|
+
*/
|
|
3658
4058
|
min?: number;
|
|
3659
4059
|
}
|
|
4060
|
+
/**
|
|
4061
|
+
* A structure that specifies an Amazon SNS notification configuration for the ``NotificationConfigurations`` property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource.
|
|
4062
|
+
* For an example template snippet, see [Auto scaling template snippets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html).
|
|
4063
|
+
* For more information, see [Get Amazon SNS notifications when your Auto Scaling group scales](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html) in the *Amazon EC2 Auto Scaling User Guide*.
|
|
4064
|
+
*/
|
|
3660
4065
|
interface AutoScalingGroupNotificationConfiguration {
|
|
4066
|
+
/**
|
|
4067
|
+
* A list of event types that send a notification. Event types can include any of the following types.
|
|
4068
|
+
* *Allowed values*:
|
|
4069
|
+
* + ``autoscaling:EC2_INSTANCE_LAUNCH``
|
|
4070
|
+
* + ``autoscaling:EC2_INSTANCE_LAUNCH_ERROR``
|
|
4071
|
+
* + ``autoscaling:EC2_INSTANCE_TERMINATE``
|
|
4072
|
+
* + ``autoscaling:EC2_INSTANCE_TERMINATE_ERROR``
|
|
4073
|
+
* + ``autoscaling:TEST_NOTIFICATION``
|
|
4074
|
+
*/
|
|
3661
4075
|
notificationTypes?: string[];
|
|
4076
|
+
/**
|
|
4077
|
+
* The Amazon Resource Name (ARN) of the Amazon SNS topic.
|
|
4078
|
+
*/
|
|
3662
4079
|
topicArn: string[];
|
|
3663
4080
|
}
|
|
4081
|
+
/**
|
|
4082
|
+
* A structure that specifies a tag for the ``Tags`` property of [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource.
|
|
4083
|
+
* For more information, see [Tag Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html) in the *Amazon EC2 Auto Scaling User Guide*. You can find a sample template snippet in the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#aws-resource-autoscaling-autoscalinggroup--examples) section of the ``AWS::AutoScaling::AutoScalingGroup`` resource.
|
|
4084
|
+
* CloudFormation adds the following tags to all Auto Scaling groups and associated instances:
|
|
4085
|
+
* + aws:cloudformation:stack-name
|
|
4086
|
+
* + aws:cloudformation:stack-id
|
|
4087
|
+
* + aws:cloudformation:logical-id
|
|
4088
|
+
*/
|
|
3664
4089
|
interface AutoScalingGroupTagProperty {
|
|
4090
|
+
/**
|
|
4091
|
+
* The tag key.
|
|
4092
|
+
*/
|
|
3665
4093
|
key: string;
|
|
4094
|
+
/**
|
|
4095
|
+
* Set to ``true`` if you want CloudFormation to copy the tag to EC2 instances that are launched as part of the Auto Scaling group. Set to ``false`` if you want the tag attached only to the Auto Scaling group and not copied to any instances launched as part of the Auto Scaling group.
|
|
4096
|
+
*/
|
|
3666
4097
|
propagateAtLaunch: boolean;
|
|
4098
|
+
/**
|
|
4099
|
+
* The tag value.
|
|
4100
|
+
*/
|
|
3667
4101
|
value: string;
|
|
3668
4102
|
}
|
|
4103
|
+
/**
|
|
4104
|
+
* ``TotalLocalStorageGBRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum total local storage size for an instance type, in GB.
|
|
4105
|
+
*/
|
|
3669
4106
|
interface AutoScalingGroupTotalLocalStorageGbRequest {
|
|
4107
|
+
/**
|
|
4108
|
+
* The storage maximum in GB.
|
|
4109
|
+
*/
|
|
3670
4110
|
max?: number;
|
|
4111
|
+
/**
|
|
4112
|
+
* The storage minimum in GB.
|
|
4113
|
+
*/
|
|
3671
4114
|
min?: number;
|
|
3672
4115
|
}
|
|
4116
|
+
/**
|
|
4117
|
+
* ``VCpuCountRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum number of vCPUs for an instance type.
|
|
4118
|
+
*/
|
|
3673
4119
|
interface AutoScalingGroupVCpuCountRequest {
|
|
4120
|
+
/**
|
|
4121
|
+
* The maximum number of vCPUs.
|
|
4122
|
+
*/
|
|
3674
4123
|
max?: number;
|
|
4124
|
+
/**
|
|
4125
|
+
* The minimum number of vCPUs.
|
|
4126
|
+
*/
|
|
3675
4127
|
min?: number;
|
|
3676
4128
|
}
|
|
3677
4129
|
/**
|
|
@@ -8342,6 +8794,50 @@ export declare namespace datasync {
|
|
|
8342
8794
|
*/
|
|
8343
8795
|
value?: string;
|
|
8344
8796
|
}
|
|
8797
|
+
/**
|
|
8798
|
+
* Configures a manifest, which is a list of files or objects that you want DataSync to transfer.
|
|
8799
|
+
*/
|
|
8800
|
+
interface TaskManifestConfig {
|
|
8801
|
+
/**
|
|
8802
|
+
* Specifies what DataSync uses the manifest for.
|
|
8803
|
+
*/
|
|
8804
|
+
action?: enums.datasync.TaskManifestConfigAction;
|
|
8805
|
+
/**
|
|
8806
|
+
* Specifies the file format of your manifest.
|
|
8807
|
+
*/
|
|
8808
|
+
format?: enums.datasync.TaskManifestConfigFormat;
|
|
8809
|
+
/**
|
|
8810
|
+
* Specifies the manifest that you want DataSync to use and where it's hosted.
|
|
8811
|
+
*/
|
|
8812
|
+
source: outputs.datasync.TaskManifestConfigSourceProperties;
|
|
8813
|
+
}
|
|
8814
|
+
/**
|
|
8815
|
+
* Specifies the manifest that you want DataSync to use and where it's hosted.
|
|
8816
|
+
*/
|
|
8817
|
+
interface TaskManifestConfigSourceProperties {
|
|
8818
|
+
s3?: outputs.datasync.TaskManifestConfigSourceS3;
|
|
8819
|
+
}
|
|
8820
|
+
/**
|
|
8821
|
+
* Specifies the S3 bucket where you're hosting the manifest that you want AWS DataSync to use.
|
|
8822
|
+
*/
|
|
8823
|
+
interface TaskManifestConfigSourceS3 {
|
|
8824
|
+
/**
|
|
8825
|
+
* Specifies the AWS Identity and Access Management (IAM) role that allows DataSync to access your manifest.
|
|
8826
|
+
*/
|
|
8827
|
+
bucketAccessRoleArn?: string;
|
|
8828
|
+
/**
|
|
8829
|
+
* Specifies the Amazon S3 object key of your manifest.
|
|
8830
|
+
*/
|
|
8831
|
+
manifestObjectPath?: string;
|
|
8832
|
+
/**
|
|
8833
|
+
* Specifies the object version ID of the manifest that you want DataSync to use.
|
|
8834
|
+
*/
|
|
8835
|
+
manifestObjectVersionId?: string;
|
|
8836
|
+
/**
|
|
8837
|
+
* Specifies the Amazon Resource Name (ARN) of the S3 bucket where you're hosting your manifest.
|
|
8838
|
+
*/
|
|
8839
|
+
s3BucketArn?: string;
|
|
8840
|
+
}
|
|
8345
8841
|
/**
|
|
8346
8842
|
* Represents the options that are available to control the behavior of a StartTaskExecution operation.
|
|
8347
8843
|
*/
|
|
@@ -8436,15 +8932,12 @@ export declare namespace datasync {
|
|
|
8436
8932
|
* Specifies where DataSync uploads your task report.
|
|
8437
8933
|
*/
|
|
8438
8934
|
interface TaskReportConfigDestinationProperties {
|
|
8439
|
-
|
|
8440
|
-
* Specifies the Amazon S3 bucket where DataSync uploads your task report.
|
|
8441
|
-
*/
|
|
8442
|
-
s3?: outputs.datasync.TaskReportConfigDestinationPropertiesS3Properties;
|
|
8935
|
+
s3?: outputs.datasync.TaskReportConfigDestinationS3;
|
|
8443
8936
|
}
|
|
8444
8937
|
/**
|
|
8445
8938
|
* Specifies the Amazon S3 bucket where DataSync uploads your task report.
|
|
8446
8939
|
*/
|
|
8447
|
-
interface
|
|
8940
|
+
interface TaskReportConfigDestinationS3 {
|
|
8448
8941
|
/**
|
|
8449
8942
|
* Specifies the Amazon Resource Name (ARN) of the IAM policy that allows Datasync to upload a task report to your S3 bucket.
|
|
8450
8943
|
*/
|
|
@@ -13884,100 +14377,375 @@ export declare namespace elasticloadbalancingv2 {
|
|
|
13884
14377
|
*/
|
|
13885
14378
|
statusCode: string;
|
|
13886
14379
|
}
|
|
14380
|
+
/**
|
|
14381
|
+
* Specifies an action for a listener rule.
|
|
14382
|
+
*/
|
|
13887
14383
|
interface ListenerRuleAction {
|
|
14384
|
+
/**
|
|
14385
|
+
* [HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when ``Type`` is ``authenticate-cognito``.
|
|
14386
|
+
*/
|
|
13888
14387
|
authenticateCognitoConfig?: outputs.elasticloadbalancingv2.ListenerRuleAuthenticateCognitoConfig;
|
|
14388
|
+
/**
|
|
14389
|
+
* [HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when ``Type`` is ``authenticate-oidc``.
|
|
14390
|
+
*/
|
|
13889
14391
|
authenticateOidcConfig?: outputs.elasticloadbalancingv2.ListenerRuleAuthenticateOidcConfig;
|
|
14392
|
+
/**
|
|
14393
|
+
* [Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when ``Type`` is ``fixed-response``.
|
|
14394
|
+
*/
|
|
13890
14395
|
fixedResponseConfig?: outputs.elasticloadbalancingv2.ListenerRuleFixedResponseConfig;
|
|
14396
|
+
/**
|
|
14397
|
+
* Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when ``Type`` is ``forward``. If you specify both ``ForwardConfig`` and ``TargetGroupArn``, you can specify only one target group using ``ForwardConfig`` and it must be the same target group specified in ``TargetGroupArn``.
|
|
14398
|
+
*/
|
|
13891
14399
|
forwardConfig?: outputs.elasticloadbalancingv2.ListenerRuleForwardConfig;
|
|
14400
|
+
/**
|
|
14401
|
+
* The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first.
|
|
14402
|
+
*/
|
|
13892
14403
|
order?: number;
|
|
14404
|
+
/**
|
|
14405
|
+
* [Application Load Balancer] Information for creating a redirect action. Specify only when ``Type`` is ``redirect``.
|
|
14406
|
+
*/
|
|
13893
14407
|
redirectConfig?: outputs.elasticloadbalancingv2.ListenerRuleRedirectConfig;
|
|
14408
|
+
/**
|
|
14409
|
+
* The Amazon Resource Name (ARN) of the target group. Specify only when ``Type`` is ``forward`` and you want to route to a single target group. To route to one or more target groups, use ``ForwardConfig`` instead.
|
|
14410
|
+
*/
|
|
13894
14411
|
targetGroupArn?: string;
|
|
14412
|
+
/**
|
|
14413
|
+
* The type of action.
|
|
14414
|
+
*/
|
|
13895
14415
|
type: string;
|
|
13896
14416
|
}
|
|
14417
|
+
/**
|
|
14418
|
+
* Specifies information required when integrating with Amazon Cognito to authenticate users.
|
|
14419
|
+
*/
|
|
13897
14420
|
interface ListenerRuleAuthenticateCognitoConfig {
|
|
14421
|
+
/**
|
|
14422
|
+
* The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
|
|
14423
|
+
*/
|
|
13898
14424
|
authenticationRequestExtraParams?: {
|
|
13899
14425
|
[key: string]: string;
|
|
13900
14426
|
};
|
|
14427
|
+
/**
|
|
14428
|
+
* The behavior if the user is not authenticated. The following are possible values:
|
|
14429
|
+
* + deny```` - Return an HTTP 401 Unauthorized error.
|
|
14430
|
+
* + allow```` - Allow the request to be forwarded to the target.
|
|
14431
|
+
* + authenticate```` - Redirect the request to the IdP authorization endpoint. This is the default value.
|
|
14432
|
+
*/
|
|
13901
14433
|
onUnauthenticatedRequest?: string;
|
|
14434
|
+
/**
|
|
14435
|
+
* The set of user claims to be requested from the IdP. The default is ``openid``.
|
|
14436
|
+
* To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
|
|
14437
|
+
*/
|
|
13902
14438
|
scope?: string;
|
|
14439
|
+
/**
|
|
14440
|
+
* The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
|
|
14441
|
+
*/
|
|
13903
14442
|
sessionCookieName?: string;
|
|
14443
|
+
/**
|
|
14444
|
+
* The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
|
|
14445
|
+
*/
|
|
13904
14446
|
sessionTimeout?: number;
|
|
14447
|
+
/**
|
|
14448
|
+
* The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
|
|
14449
|
+
*/
|
|
13905
14450
|
userPoolArn: string;
|
|
14451
|
+
/**
|
|
14452
|
+
* The ID of the Amazon Cognito user pool client.
|
|
14453
|
+
*/
|
|
13906
14454
|
userPoolClientId: string;
|
|
14455
|
+
/**
|
|
14456
|
+
* The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.
|
|
14457
|
+
*/
|
|
13907
14458
|
userPoolDomain: string;
|
|
13908
14459
|
}
|
|
14460
|
+
/**
|
|
14461
|
+
* Specifies information required using an identity provide (IdP) that is compliant with OpenID Connect (OIDC) to authenticate users.
|
|
14462
|
+
*/
|
|
13909
14463
|
interface ListenerRuleAuthenticateOidcConfig {
|
|
14464
|
+
/**
|
|
14465
|
+
* The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
|
|
14466
|
+
*/
|
|
13910
14467
|
authenticationRequestExtraParams?: {
|
|
13911
14468
|
[key: string]: string;
|
|
13912
14469
|
};
|
|
14470
|
+
/**
|
|
14471
|
+
* The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
|
|
14472
|
+
*/
|
|
13913
14473
|
authorizationEndpoint: string;
|
|
14474
|
+
/**
|
|
14475
|
+
* The OAuth 2.0 client identifier.
|
|
14476
|
+
*/
|
|
13914
14477
|
clientId: string;
|
|
14478
|
+
/**
|
|
14479
|
+
* The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set ``UseExistingClientSecret`` to true.
|
|
14480
|
+
*/
|
|
13915
14481
|
clientSecret?: string;
|
|
14482
|
+
/**
|
|
14483
|
+
* The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
|
|
14484
|
+
*/
|
|
13916
14485
|
issuer: string;
|
|
14486
|
+
/**
|
|
14487
|
+
* The behavior if the user is not authenticated. The following are possible values:
|
|
14488
|
+
* + deny```` - Return an HTTP 401 Unauthorized error.
|
|
14489
|
+
* + allow```` - Allow the request to be forwarded to the target.
|
|
14490
|
+
* + authenticate```` - Redirect the request to the IdP authorization endpoint. This is the default value.
|
|
14491
|
+
*/
|
|
13917
14492
|
onUnauthenticatedRequest?: string;
|
|
14493
|
+
/**
|
|
14494
|
+
* The set of user claims to be requested from the IdP. The default is ``openid``.
|
|
14495
|
+
* To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
|
|
14496
|
+
*/
|
|
13918
14497
|
scope?: string;
|
|
14498
|
+
/**
|
|
14499
|
+
* The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
|
|
14500
|
+
*/
|
|
13919
14501
|
sessionCookieName?: string;
|
|
14502
|
+
/**
|
|
14503
|
+
* The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
|
|
14504
|
+
*/
|
|
13920
14505
|
sessionTimeout?: number;
|
|
14506
|
+
/**
|
|
14507
|
+
* The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
|
|
14508
|
+
*/
|
|
13921
14509
|
tokenEndpoint: string;
|
|
14510
|
+
/**
|
|
14511
|
+
* Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false.
|
|
14512
|
+
*/
|
|
13922
14513
|
useExistingClientSecret?: boolean;
|
|
14514
|
+
/**
|
|
14515
|
+
* The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
|
|
14516
|
+
*/
|
|
13923
14517
|
userInfoEndpoint: string;
|
|
13924
14518
|
}
|
|
14519
|
+
/**
|
|
14520
|
+
* Specifies information required when returning a custom HTTP response.
|
|
14521
|
+
*/
|
|
13925
14522
|
interface ListenerRuleFixedResponseConfig {
|
|
14523
|
+
/**
|
|
14524
|
+
* The content type.
|
|
14525
|
+
* Valid Values: text/plain | text/css | text/html | application/javascript | application/json
|
|
14526
|
+
*/
|
|
13926
14527
|
contentType?: string;
|
|
14528
|
+
/**
|
|
14529
|
+
* The message.
|
|
14530
|
+
*/
|
|
13927
14531
|
messageBody?: string;
|
|
14532
|
+
/**
|
|
14533
|
+
* The HTTP response code (2XX, 4XX, or 5XX).
|
|
14534
|
+
*/
|
|
13928
14535
|
statusCode: string;
|
|
13929
14536
|
}
|
|
14537
|
+
/**
|
|
14538
|
+
* Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when ``Type`` is ``forward``. If you specify both ``ForwardConfig`` and ``TargetGroupArn``, you can specify only one target group using ``ForwardConfig`` and it must be the same target group specified in ``TargetGroupArn``.
|
|
14539
|
+
*/
|
|
13930
14540
|
interface ListenerRuleForwardConfig {
|
|
14541
|
+
/**
|
|
14542
|
+
* Information about the target group stickiness for a rule.
|
|
14543
|
+
*/
|
|
13931
14544
|
targetGroupStickinessConfig?: outputs.elasticloadbalancingv2.ListenerRuleTargetGroupStickinessConfig;
|
|
14545
|
+
/**
|
|
14546
|
+
* Information about how traffic will be distributed between multiple target groups in a forward rule.
|
|
14547
|
+
*/
|
|
13932
14548
|
targetGroups?: outputs.elasticloadbalancingv2.ListenerRuleTargetGroupTuple[];
|
|
13933
14549
|
}
|
|
14550
|
+
/**
|
|
14551
|
+
* Information about a host header condition.
|
|
14552
|
+
*/
|
|
13934
14553
|
interface ListenerRuleHostHeaderConfig {
|
|
14554
|
+
/**
|
|
14555
|
+
* The host names. The maximum size of each name is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).
|
|
14556
|
+
* If you specify multiple strings, the condition is satisfied if one of the strings matches the host name.
|
|
14557
|
+
*/
|
|
13935
14558
|
values?: string[];
|
|
13936
14559
|
}
|
|
14560
|
+
/**
|
|
14561
|
+
* Information about an HTTP header condition.
|
|
14562
|
+
* There is a set of standard HTTP header fields. You can also define custom HTTP header fields.
|
|
14563
|
+
*/
|
|
13937
14564
|
interface ListenerRuleHttpHeaderConfig {
|
|
14565
|
+
/**
|
|
14566
|
+
* The name of the HTTP header field. The maximum size is 40 characters. The header name is case insensitive. The allowed characters are specified by RFC 7230. Wildcards are not supported.
|
|
14567
|
+
*/
|
|
13938
14568
|
httpHeaderName?: string;
|
|
14569
|
+
/**
|
|
14570
|
+
* The strings to compare against the value of the HTTP header. The maximum size of each string is 128 characters. The comparison strings are case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).
|
|
14571
|
+
* If the same header appears multiple times in the request, we search them in order until a match is found.
|
|
14572
|
+
* If you specify multiple strings, the condition is satisfied if one of the strings matches the value of the HTTP header. To require that all of the strings are a match, create one condition per string.
|
|
14573
|
+
*/
|
|
13939
14574
|
values?: string[];
|
|
13940
14575
|
}
|
|
14576
|
+
/**
|
|
14577
|
+
* Information about an HTTP method condition.
|
|
14578
|
+
* HTTP defines a set of request methods, also referred to as HTTP verbs. For more information, see the [HTTP Method Registry](https://docs.aws.amazon.com/https://www.iana.org/assignments/http-methods/http-methods.xhtml). You can also define custom HTTP methods.
|
|
14579
|
+
*/
|
|
13941
14580
|
interface ListenerRuleHttpRequestMethodConfig {
|
|
14581
|
+
/**
|
|
14582
|
+
* The name of the request method. The maximum size is 40 characters. The allowed characters are A-Z, hyphen (-), and underscore (_). The comparison is case sensitive. Wildcards are not supported; therefore, the method name must be an exact match.
|
|
14583
|
+
* If you specify multiple strings, the condition is satisfied if one of the strings matches the HTTP request method. We recommend that you route GET and HEAD requests in the same way, because the response to a HEAD request may be cached.
|
|
14584
|
+
*/
|
|
13942
14585
|
values?: string[];
|
|
13943
14586
|
}
|
|
14587
|
+
/**
|
|
14588
|
+
* Information about a path pattern condition.
|
|
14589
|
+
*/
|
|
13944
14590
|
interface ListenerRulePathPatternConfig {
|
|
14591
|
+
/**
|
|
14592
|
+
* The path patterns to compare against the request URL. The maximum size of each string is 128 characters. The comparison is case sensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).
|
|
14593
|
+
* If you specify multiple strings, the condition is satisfied if one of them matches the request URL. The path pattern is compared only to the path of the URL, not to its query string.
|
|
14594
|
+
*/
|
|
13945
14595
|
values?: string[];
|
|
13946
14596
|
}
|
|
14597
|
+
/**
|
|
14598
|
+
* Information about a query string condition.
|
|
14599
|
+
* The query string component of a URI starts after the first '?' character and is terminated by either a '#' character or the end of the URI. A typical query string contains key/value pairs separated by '&' characters. The allowed characters are specified by RFC 3986. Any character can be percentage encoded.
|
|
14600
|
+
*/
|
|
13947
14601
|
interface ListenerRuleQueryStringConfig {
|
|
14602
|
+
/**
|
|
14603
|
+
* The key/value pairs or values to find in the query string. The maximum size of each string is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character). To search for a literal '*' or '?' character in a query string, you must escape these characters in ``Values`` using a '\' character.
|
|
14604
|
+
* If you specify multiple key/value pairs or values, the condition is satisfied if one of them is found in the query string.
|
|
14605
|
+
*/
|
|
13948
14606
|
values?: outputs.elasticloadbalancingv2.ListenerRuleQueryStringKeyValue[];
|
|
13949
14607
|
}
|
|
14608
|
+
/**
|
|
14609
|
+
* Information about a key/value pair.
|
|
14610
|
+
*/
|
|
13950
14611
|
interface ListenerRuleQueryStringKeyValue {
|
|
14612
|
+
/**
|
|
14613
|
+
* The key. You can omit the key.
|
|
14614
|
+
*/
|
|
13951
14615
|
key?: string;
|
|
14616
|
+
/**
|
|
14617
|
+
* The value.
|
|
14618
|
+
*/
|
|
13952
14619
|
value?: string;
|
|
13953
14620
|
}
|
|
14621
|
+
/**
|
|
14622
|
+
* Information about a redirect action.
|
|
14623
|
+
* A URI consists of the following components: protocol://hostname:port/path?query. You must modify at least one of the following components to avoid a redirect loop: protocol, hostname, port, or path. Any components that you do not modify retain their original values.
|
|
14624
|
+
* You can reuse URI components using the following reserved keywords:
|
|
14625
|
+
* + #{protocol}
|
|
14626
|
+
* + #{host}
|
|
14627
|
+
* + #{port}
|
|
14628
|
+
* + #{path} (the leading "/" is removed)
|
|
14629
|
+
* + #{query}
|
|
14630
|
+
*
|
|
14631
|
+
* For example, you can change the path to "/new/#{path}", the hostname to "example.#{host}", or the query to "#{query}&value=xyz".
|
|
14632
|
+
*/
|
|
13954
14633
|
interface ListenerRuleRedirectConfig {
|
|
14634
|
+
/**
|
|
14635
|
+
* The hostname. This component is not percent-encoded. The hostname can contain #{host}.
|
|
14636
|
+
*/
|
|
13955
14637
|
host?: string;
|
|
14638
|
+
/**
|
|
14639
|
+
* The absolute path, starting with the leading "/". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}.
|
|
14640
|
+
*/
|
|
13956
14641
|
path?: string;
|
|
14642
|
+
/**
|
|
14643
|
+
* The port. You can specify a value from 1 to 65535 or #{port}.
|
|
14644
|
+
*/
|
|
13957
14645
|
port?: string;
|
|
14646
|
+
/**
|
|
14647
|
+
* The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP.
|
|
14648
|
+
*/
|
|
13958
14649
|
protocol?: string;
|
|
14650
|
+
/**
|
|
14651
|
+
* The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading "?", as it is automatically added. You can specify any of the reserved keywords.
|
|
14652
|
+
*/
|
|
13959
14653
|
query?: string;
|
|
14654
|
+
/**
|
|
14655
|
+
* The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302).
|
|
14656
|
+
*/
|
|
13960
14657
|
statusCode: string;
|
|
13961
14658
|
}
|
|
14659
|
+
/**
|
|
14660
|
+
* Specifies a condition for a listener rule.
|
|
14661
|
+
*/
|
|
13962
14662
|
interface ListenerRuleRuleCondition {
|
|
14663
|
+
/**
|
|
14664
|
+
* The field in the HTTP request. The following are the possible values:
|
|
14665
|
+
* + ``http-header``
|
|
14666
|
+
* + ``http-request-method``
|
|
14667
|
+
* + ``host-header``
|
|
14668
|
+
* + ``path-pattern``
|
|
14669
|
+
* + ``query-string``
|
|
14670
|
+
* + ``source-ip``
|
|
14671
|
+
*/
|
|
13963
14672
|
field?: string;
|
|
14673
|
+
/**
|
|
14674
|
+
* Information for a host header condition. Specify only when ``Field`` is ``host-header``.
|
|
14675
|
+
*/
|
|
13964
14676
|
hostHeaderConfig?: outputs.elasticloadbalancingv2.ListenerRuleHostHeaderConfig;
|
|
14677
|
+
/**
|
|
14678
|
+
* Information for an HTTP header condition. Specify only when ``Field`` is ``http-header``.
|
|
14679
|
+
*/
|
|
13965
14680
|
httpHeaderConfig?: outputs.elasticloadbalancingv2.ListenerRuleHttpHeaderConfig;
|
|
14681
|
+
/**
|
|
14682
|
+
* Information for an HTTP method condition. Specify only when ``Field`` is ``http-request-method``.
|
|
14683
|
+
*/
|
|
13966
14684
|
httpRequestMethodConfig?: outputs.elasticloadbalancingv2.ListenerRuleHttpRequestMethodConfig;
|
|
14685
|
+
/**
|
|
14686
|
+
* Information for a path pattern condition. Specify only when ``Field`` is ``path-pattern``.
|
|
14687
|
+
*/
|
|
13967
14688
|
pathPatternConfig?: outputs.elasticloadbalancingv2.ListenerRulePathPatternConfig;
|
|
14689
|
+
/**
|
|
14690
|
+
* Information for a query string condition. Specify only when ``Field`` is ``query-string``.
|
|
14691
|
+
*/
|
|
13968
14692
|
queryStringConfig?: outputs.elasticloadbalancingv2.ListenerRuleQueryStringConfig;
|
|
14693
|
+
/**
|
|
14694
|
+
* Information for a source IP condition. Specify only when ``Field`` is ``source-ip``.
|
|
14695
|
+
*/
|
|
13969
14696
|
sourceIpConfig?: outputs.elasticloadbalancingv2.ListenerRuleSourceIpConfig;
|
|
14697
|
+
/**
|
|
14698
|
+
* The condition value. Specify only when ``Field`` is ``host-header`` or ``path-pattern``. Alternatively, to specify multiple host names or multiple path patterns, use ``HostHeaderConfig`` or ``PathPatternConfig``.
|
|
14699
|
+
* If ``Field`` is ``host-header`` and you're not using ``HostHeaderConfig``, you can specify a single host name (for example, my.example.com). A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters.
|
|
14700
|
+
* + A-Z, a-z, 0-9
|
|
14701
|
+
* + - .
|
|
14702
|
+
* + * (matches 0 or more characters)
|
|
14703
|
+
* + ? (matches exactly 1 character)
|
|
14704
|
+
*
|
|
14705
|
+
* If ``Field`` is ``path-pattern`` and you're not using ``PathPatternConfig``, you can specify a single path pattern (for example, /img/*). A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.
|
|
14706
|
+
* + A-Z, a-z, 0-9
|
|
14707
|
+
* + _ - . $ / ~ " ' @ : +
|
|
14708
|
+
* + & (using &)
|
|
14709
|
+
* + * (matches 0 or more characters)
|
|
14710
|
+
* + ? (matches exactly 1 character)
|
|
14711
|
+
*/
|
|
13970
14712
|
values?: string[];
|
|
13971
14713
|
}
|
|
14714
|
+
/**
|
|
14715
|
+
* Information about a source IP condition.
|
|
14716
|
+
* You can use this condition to route based on the IP address of the source that connects to the load balancer. If a client is behind a proxy, this is the IP address of the proxy not the IP address of the client.
|
|
14717
|
+
*/
|
|
13972
14718
|
interface ListenerRuleSourceIpConfig {
|
|
14719
|
+
/**
|
|
14720
|
+
* The source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses. Wildcards are not supported.
|
|
14721
|
+
* If you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks. This condition is not satisfied by the addresses in the X-Forwarded-For header.
|
|
14722
|
+
*/
|
|
13973
14723
|
values?: string[];
|
|
13974
14724
|
}
|
|
14725
|
+
/**
|
|
14726
|
+
* Information about the target group stickiness for a rule.
|
|
14727
|
+
*/
|
|
13975
14728
|
interface ListenerRuleTargetGroupStickinessConfig {
|
|
14729
|
+
/**
|
|
14730
|
+
* The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days).
|
|
14731
|
+
*/
|
|
13976
14732
|
durationSeconds?: number;
|
|
14733
|
+
/**
|
|
14734
|
+
* Indicates whether target group stickiness is enabled.
|
|
14735
|
+
*/
|
|
13977
14736
|
enabled?: boolean;
|
|
13978
14737
|
}
|
|
14738
|
+
/**
|
|
14739
|
+
* Information about how traffic will be distributed between multiple target groups in a forward rule.
|
|
14740
|
+
*/
|
|
13979
14741
|
interface ListenerRuleTargetGroupTuple {
|
|
14742
|
+
/**
|
|
14743
|
+
* The Amazon Resource Name (ARN) of the target group.
|
|
14744
|
+
*/
|
|
13980
14745
|
targetGroupArn?: string;
|
|
14746
|
+
/**
|
|
14747
|
+
* The weight. The range is 0 to 999.
|
|
14748
|
+
*/
|
|
13981
14749
|
weight?: number;
|
|
13982
14750
|
}
|
|
13983
14751
|
/**
|