@pulumi/spotinst 3.83.0 → 3.83.1

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/types/output.d.ts CHANGED
@@ -63,6 +63,9 @@ export interface HealthCheckCheck {
63
63
  * The destination for the request.
64
64
  */
65
65
  endpoint?: string;
66
+ /**
67
+ * The number of consecutive successful health checks that must occur before declaring an instance healthy.
68
+ */
66
69
  healthy: number;
67
70
  /**
68
71
  * The amount of time (in seconds) between each health check (minimum: 10).
@@ -81,6 +84,9 @@ export interface HealthCheckCheck {
81
84
  * the amount of time (in seconds) to wait when receiving a response from the health check.
82
85
  */
83
86
  timeout?: number;
87
+ /**
88
+ * The number of consecutive failed health checks that must occur before declaring an instance unhealthy.
89
+ */
84
90
  unhealthy: number;
85
91
  }
86
92
  export interface OceanRightSizingRuleAttachWorkload {
@@ -547,11 +553,20 @@ export declare namespace aws {
547
553
  weight: number;
548
554
  }
549
555
  interface ElastigroupIntegrationBeanstalk {
556
+ /**
557
+ * Preferences when performing a roll
558
+ */
550
559
  deploymentPreferences?: outputs.aws.ElastigroupIntegrationBeanstalkDeploymentPreferences;
551
560
  environmentId?: string;
561
+ /**
562
+ * Managed Actions parameters
563
+ */
552
564
  managedActions?: outputs.aws.ElastigroupIntegrationBeanstalkManagedActions;
553
565
  }
554
566
  interface ElastigroupIntegrationBeanstalkDeploymentPreferences {
567
+ /**
568
+ * Should roll perform automatically
569
+ */
555
570
  automaticRoll?: boolean;
556
571
  batchSizePercentage?: number;
557
572
  gracePeriod?: number;
@@ -562,20 +577,48 @@ export declare namespace aws {
562
577
  shouldDrainInstances?: boolean;
563
578
  }
564
579
  interface ElastigroupIntegrationBeanstalkManagedActions {
580
+ /**
581
+ * Platform Update parameters
582
+ */
565
583
  platformUpdate?: outputs.aws.ElastigroupIntegrationBeanstalkManagedActionsPlatformUpdate;
566
584
  }
567
585
  interface ElastigroupIntegrationBeanstalkManagedActionsPlatformUpdate {
568
586
  performAt?: string;
587
+ /**
588
+ * Time Window for when action occurs ex. Mon:23:50-Tue:00:20
589
+ */
569
590
  timeWindow?: string;
591
+ /**
592
+ * Level to update
593
+ *
594
+ * Usage:
595
+ */
570
596
  updateLevel?: string;
571
597
  }
572
598
  interface ElastigroupIntegrationCodedeploy {
599
+ /**
600
+ * Cleanup automatically after a failed deploy.
601
+ */
573
602
  cleanupOnFailure: boolean;
603
+ /**
604
+ * Specify the deployment groups details.
605
+ */
574
606
  deploymentGroups: outputs.aws.ElastigroupIntegrationCodedeployDeploymentGroup[];
607
+ /**
608
+ * Terminate the instance automatically after a failed deploy.
609
+ */
575
610
  terminateInstanceOnFailure: boolean;
576
611
  }
577
612
  interface ElastigroupIntegrationCodedeployDeploymentGroup {
613
+ /**
614
+ * The application name.
615
+ */
578
616
  applicationName: string;
617
+ /**
618
+ * The deployment group name.
619
+ *
620
+ * Usage:
621
+ */
579
622
  deploymentGroupName: string;
580
623
  }
581
624
  interface ElastigroupIntegrationDockerSwarm {
@@ -596,14 +639,26 @@ export declare namespace aws {
596
639
  numOfUnits?: number;
597
640
  }
598
641
  interface ElastigroupIntegrationEcs {
642
+ /**
643
+ * A key/value mapping of tags to assign to the resource.
644
+ */
599
645
  autoscaleAttributes?: outputs.aws.ElastigroupIntegrationEcsAutoscaleAttribute[];
600
646
  autoscaleCooldown?: number;
601
647
  autoscaleDown?: outputs.aws.ElastigroupIntegrationEcsAutoscaleDown;
602
648
  autoscaleHeadroom?: outputs.aws.ElastigroupIntegrationEcsAutoscaleHeadroom;
603
649
  autoscaleIsAutoConfig?: boolean;
604
650
  autoscaleIsEnabled?: boolean;
651
+ /**
652
+ * Determines whether to scale down non-service tasks.
653
+ */
605
654
  autoscaleScaleDownNonServiceTasks?: boolean;
655
+ /**
656
+ * Batch configuration object:
657
+ */
606
658
  batch?: outputs.aws.ElastigroupIntegrationEcsBatch;
659
+ /**
660
+ * The name of the EC2 Container Service cluster.
661
+ */
607
662
  clusterName: string;
608
663
  }
609
664
  interface ElastigroupIntegrationEcsAutoscaleAttribute {
@@ -620,9 +675,17 @@ export declare namespace aws {
620
675
  numOfUnits?: number;
621
676
  }
622
677
  interface ElastigroupIntegrationEcsBatch {
678
+ /**
679
+ * Array of strings.
680
+ *
681
+ * Usage:
682
+ */
623
683
  jobQueueNames: string[];
624
684
  }
625
685
  interface ElastigroupIntegrationGitlab {
686
+ /**
687
+ * Settings for Gitlab runner.
688
+ */
626
689
  runner?: outputs.aws.ElastigroupIntegrationGitlabRunner;
627
690
  }
628
691
  interface ElastigroupIntegrationGitlabRunner {
@@ -635,9 +698,20 @@ export declare namespace aws {
635
698
  autoscaleHeadroom?: outputs.aws.ElastigroupIntegrationKubernetesAutoscaleHeadroom;
636
699
  autoscaleIsAutoConfig?: boolean;
637
700
  autoscaleIsEnabled?: boolean;
701
+ /**
702
+ * A key/value mapping of tags to assign to the resource.
703
+ *
704
+ * Usage:
705
+ */
638
706
  autoscaleLabels?: outputs.aws.ElastigroupIntegrationKubernetesAutoscaleLabel[];
639
707
  clusterIdentifier?: string;
708
+ /**
709
+ * Valid values: `"saas"`, `"pod"`.
710
+ */
640
711
  integrationMode?: string;
712
+ /**
713
+ * Kubernetes Token
714
+ */
641
715
  token?: string;
642
716
  }
643
717
  interface ElastigroupIntegrationKubernetesAutoscaleDown {
@@ -657,7 +731,15 @@ export declare namespace aws {
657
731
  apiServer: string;
658
732
  }
659
733
  interface ElastigroupIntegrationNomad {
734
+ /**
735
+ * Nomad ACL Token
736
+ */
660
737
  aclToken?: string;
738
+ /**
739
+ * A key/value mapping of tags to assign to the resource.
740
+ *
741
+ * Usage:
742
+ */
661
743
  autoscaleConstraints?: outputs.aws.ElastigroupIntegrationNomadAutoscaleConstraint[];
662
744
  autoscaleCooldown?: number;
663
745
  autoscaleDown?: outputs.aws.ElastigroupIntegrationNomadAutoscaleDown;
@@ -679,18 +761,43 @@ export declare namespace aws {
679
761
  numOfUnits?: number;
680
762
  }
681
763
  interface ElastigroupIntegrationRancher {
764
+ /**
765
+ * The access key of the Rancher API.
766
+ */
682
767
  accessKey: string;
683
768
  masterHost: string;
769
+ /**
770
+ * The secret key of the Rancher API.
771
+ */
684
772
  secretKey: string;
773
+ /**
774
+ * The Rancher version. Must be `"1"` or `"2"`. If this field is omitted, it’s assumed that the Rancher cluster is version 1. Note that Kubernetes is required when using Rancher version 2^.
775
+ * Usage:
776
+ */
685
777
  version?: string;
686
778
  }
687
779
  interface ElastigroupIntegrationRoute53 {
780
+ /**
781
+ * Collection of one or more domains to register.
782
+ */
688
783
  domains: outputs.aws.ElastigroupIntegrationRoute53Domain[];
689
784
  }
690
785
  interface ElastigroupIntegrationRoute53Domain {
786
+ /**
787
+ * The id associated with a hosted zone.
788
+ */
691
789
  hostedZoneId: string;
790
+ /**
791
+ * The type of the record set. Valid values: `"a"`, `"cname"`.
792
+ */
692
793
  recordSetType?: string;
794
+ /**
795
+ * Collection of records containing authoritative DNS information for the specified domain name.
796
+ */
693
797
  recordSets: outputs.aws.ElastigroupIntegrationRoute53DomainRecordSet[];
798
+ /**
799
+ * The Spotinst account ID that is linked to the AWS account that holds the Route 53 Hosted Zone ID. The default is the user Spotinst account provided as a URL parameter.
800
+ */
694
801
  spotinstAcctId?: string;
695
802
  }
696
803
  interface ElastigroupIntegrationRoute53DomainRecordSet {
@@ -698,7 +805,15 @@ export declare namespace aws {
698
805
  * The group name.
699
806
  */
700
807
  name: string;
808
+ /**
809
+ * Designates whether the DNS address should be exposed to connections outside the VPC.
810
+ *
811
+ * Usage:
812
+ */
701
813
  usePublicDns?: boolean;
814
+ /**
815
+ * Designates whether the IP address should be exposed to connections outside the VPC.
816
+ */
702
817
  usePublicIp?: boolean;
703
818
  }
704
819
  interface ElastigroupItf {
@@ -784,10 +899,19 @@ export declare namespace aws {
784
899
  instanceMetadataTags?: string;
785
900
  }
786
901
  interface ElastigroupMultipleMetrics {
902
+ /**
903
+ * Array of objects (Expression config)
904
+ */
787
905
  expressions?: outputs.aws.ElastigroupMultipleMetricsExpression[];
906
+ /**
907
+ * Array of objects (Metric config)
908
+ */
788
909
  metrics?: outputs.aws.ElastigroupMultipleMetricsMetric[];
789
910
  }
790
911
  interface ElastigroupMultipleMetricsExpression {
912
+ /**
913
+ * An expression consisting of the metric names listed in the 'metrics' array.
914
+ */
791
915
  expression: string;
792
916
  /**
793
917
  * The group name.
@@ -796,6 +920,9 @@ export declare namespace aws {
796
920
  }
797
921
  interface ElastigroupMultipleMetricsMetric {
798
922
  dimensions?: outputs.aws.ElastigroupMultipleMetricsMetricDimension[];
923
+ /**
924
+ * Percentile statistic. Valid values: `"p0.1"` - `"p100"`.
925
+ */
799
926
  extendedStatistic?: string;
800
927
  metricName: string;
801
928
  /**
@@ -1462,11 +1589,17 @@ export declare namespace aws {
1462
1589
  value?: string;
1463
1590
  }
1464
1591
  interface MrScalarApplication {
1592
+ /**
1593
+ * Arguments for EMR to pass to the application.
1594
+ */
1465
1595
  args?: string[];
1466
1596
  /**
1467
1597
  * The MrScaler name.
1468
1598
  */
1469
1599
  name: string;
1600
+ /**
1601
+ * T he version of the application.
1602
+ */
1470
1603
  version?: string;
1471
1604
  }
1472
1605
  interface MrScalarBootstrapActionsFile {
@@ -1484,51 +1617,117 @@ export declare namespace aws {
1484
1617
  volumesPerInstance?: number;
1485
1618
  }
1486
1619
  interface MrScalarCoreScalingDownPolicy {
1620
+ /**
1621
+ * The type of action to perform. Allowed values are : 'adjustment', 'setMinTarget', 'setMaxTarget', 'updateCapacity', 'percentageAdjustment'
1622
+ */
1487
1623
  actionType?: string;
1624
+ /**
1625
+ * The number of instances to add/remove to/from the target capacity when scale is needed.
1626
+ */
1488
1627
  adjustment?: string;
1628
+ /**
1629
+ * The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start.
1630
+ */
1489
1631
  cooldown: number;
1632
+ /**
1633
+ * A mapping of dimensions describing qualities of the metric.
1634
+ */
1490
1635
  dimensions?: {
1491
1636
  [key: string]: any;
1492
1637
  };
1493
1638
  evaluationPeriods: number;
1639
+ /**
1640
+ * Max target capacity for scale down.
1641
+ */
1494
1642
  maxTargetCapacity?: string;
1643
+ /**
1644
+ * The maximum to set when scale is needed.
1645
+ */
1495
1646
  maximum?: string;
1496
1647
  metricName: string;
1648
+ /**
1649
+ * Min target capacity for scale up.
1650
+ */
1497
1651
  minTargetCapacity?: string;
1652
+ /**
1653
+ * The minimum to set when scale is needed.
1654
+ */
1498
1655
  minimum?: string;
1499
1656
  namespace: string;
1500
1657
  operator: string;
1501
1658
  period: number;
1659
+ /**
1660
+ * The name of the policy.
1661
+ */
1502
1662
  policyName: string;
1503
1663
  statistic: string;
1664
+ /**
1665
+ * The number of instances to set when scale is needed.
1666
+ */
1504
1667
  target?: string;
1505
1668
  threshold: number;
1506
1669
  unit: string;
1507
1670
  }
1508
1671
  interface MrScalarCoreScalingUpPolicy {
1672
+ /**
1673
+ * The type of action to perform. Allowed values are : 'adjustment', 'setMinTarget', 'setMaxTarget', 'updateCapacity', 'percentageAdjustment'
1674
+ */
1509
1675
  actionType?: string;
1676
+ /**
1677
+ * The number of instances to add/remove to/from the target capacity when scale is needed.
1678
+ */
1510
1679
  adjustment?: string;
1680
+ /**
1681
+ * The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start.
1682
+ */
1511
1683
  cooldown: number;
1684
+ /**
1685
+ * A mapping of dimensions describing qualities of the metric.
1686
+ */
1512
1687
  dimensions?: {
1513
1688
  [key: string]: any;
1514
1689
  };
1515
1690
  evaluationPeriods: number;
1691
+ /**
1692
+ * Max target capacity for scale down.
1693
+ */
1516
1694
  maxTargetCapacity?: string;
1695
+ /**
1696
+ * The maximum to set when scale is needed.
1697
+ */
1517
1698
  maximum?: string;
1518
1699
  metricName: string;
1700
+ /**
1701
+ * Min target capacity for scale up.
1702
+ */
1519
1703
  minTargetCapacity?: string;
1704
+ /**
1705
+ * The minimum to set when scale is needed.
1706
+ */
1520
1707
  minimum?: string;
1521
1708
  namespace: string;
1522
1709
  operator: string;
1523
1710
  period: number;
1711
+ /**
1712
+ * The name of the policy.
1713
+ */
1524
1714
  policyName: string;
1525
1715
  statistic: string;
1716
+ /**
1717
+ * The number of instances to set when scale is needed.
1718
+ */
1526
1719
  target?: string;
1527
1720
  threshold: number;
1528
1721
  unit: string;
1529
1722
  }
1530
1723
  interface MrScalarInstanceWeight {
1724
+ /**
1725
+ * The type of the instance.
1726
+ */
1531
1727
  instanceType: string;
1728
+ /**
1729
+ * The weight given to the associated instance type.
1730
+ */
1532
1731
  weightedCapacity: number;
1533
1732
  }
1534
1733
  interface MrScalarMasterEbsBlockDevice {
@@ -1538,16 +1737,43 @@ export declare namespace aws {
1538
1737
  volumesPerInstance?: number;
1539
1738
  }
1540
1739
  interface MrScalarProvisioningTimeout {
1740
+ /**
1741
+ * The amount of time (minutes) after which the cluster is automatically terminated if it's still in provisioning status. Minimum: '15'.
1742
+ */
1541
1743
  timeout: number;
1744
+ /**
1745
+ * The action to take if the timeout is exceeded. Valid values: `terminate`, `terminateAndRetry`.
1746
+ */
1542
1747
  timeoutAction: string;
1543
1748
  }
1544
1749
  interface MrScalarScheduledTask {
1750
+ /**
1751
+ * A cron expression representing the schedule for the task.
1752
+ */
1545
1753
  cron: string;
1754
+ /**
1755
+ * New desired capacity for the elastigroup.
1756
+ */
1546
1757
  desiredCapacity?: string;
1758
+ /**
1759
+ * Select the EMR instance groups to execute the scheduled task on. Valid values: `task`.
1760
+ */
1547
1761
  instanceGroupType: string;
1762
+ /**
1763
+ * Enable/Disable the specified scheduling task.
1764
+ */
1548
1765
  isEnabled?: boolean;
1766
+ /**
1767
+ * New max capacity for the elastigroup.
1768
+ */
1549
1769
  maxCapacity?: string;
1770
+ /**
1771
+ * New min capacity for the elastigroup.
1772
+ */
1550
1773
  minCapacity?: string;
1774
+ /**
1775
+ * The type of task to be scheduled. Valid values: `setCapacity`.
1776
+ */
1551
1777
  taskType: string;
1552
1778
  }
1553
1779
  interface MrScalarStepsFile {
@@ -1556,6 +1782,11 @@ export declare namespace aws {
1556
1782
  }
1557
1783
  interface MrScalarTag {
1558
1784
  key: string;
1785
+ /**
1786
+ * Tag value.
1787
+ *
1788
+ * <a id="Optional Compute Parameters"></a>
1789
+ */
1559
1790
  value: string;
1560
1791
  }
1561
1792
  interface MrScalarTaskEbsBlockDevice {
@@ -1565,45 +1796,105 @@ export declare namespace aws {
1565
1796
  volumesPerInstance?: number;
1566
1797
  }
1567
1798
  interface MrScalarTaskScalingDownPolicy {
1799
+ /**
1800
+ * The type of action to perform. Allowed values are : 'adjustment', 'setMinTarget', 'setMaxTarget', 'updateCapacity', 'percentageAdjustment'
1801
+ */
1568
1802
  actionType?: string;
1803
+ /**
1804
+ * The number of instances to add/remove to/from the target capacity when scale is needed.
1805
+ */
1569
1806
  adjustment?: string;
1807
+ /**
1808
+ * The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start.
1809
+ */
1570
1810
  cooldown: number;
1811
+ /**
1812
+ * A mapping of dimensions describing qualities of the metric.
1813
+ */
1571
1814
  dimensions?: {
1572
1815
  [key: string]: any;
1573
1816
  };
1574
1817
  evaluationPeriods: number;
1818
+ /**
1819
+ * Max target capacity for scale down.
1820
+ */
1575
1821
  maxTargetCapacity?: string;
1822
+ /**
1823
+ * The maximum to set when scale is needed.
1824
+ */
1576
1825
  maximum?: string;
1577
1826
  metricName: string;
1827
+ /**
1828
+ * Min target capacity for scale up.
1829
+ */
1578
1830
  minTargetCapacity?: string;
1831
+ /**
1832
+ * The minimum to set when scale is needed.
1833
+ */
1579
1834
  minimum?: string;
1580
1835
  namespace: string;
1581
1836
  operator: string;
1582
1837
  period: number;
1838
+ /**
1839
+ * The name of the policy.
1840
+ */
1583
1841
  policyName: string;
1584
1842
  statistic: string;
1843
+ /**
1844
+ * The number of instances to set when scale is needed.
1845
+ */
1585
1846
  target?: string;
1586
1847
  threshold: number;
1587
1848
  unit: string;
1588
1849
  }
1589
1850
  interface MrScalarTaskScalingUpPolicy {
1851
+ /**
1852
+ * The type of action to perform. Allowed values are : 'adjustment', 'setMinTarget', 'setMaxTarget', 'updateCapacity', 'percentageAdjustment'
1853
+ */
1590
1854
  actionType?: string;
1855
+ /**
1856
+ * The number of instances to add/remove to/from the target capacity when scale is needed.
1857
+ */
1591
1858
  adjustment?: string;
1859
+ /**
1860
+ * The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start.
1861
+ */
1592
1862
  cooldown: number;
1863
+ /**
1864
+ * A mapping of dimensions describing qualities of the metric.
1865
+ */
1593
1866
  dimensions?: {
1594
1867
  [key: string]: any;
1595
1868
  };
1596
1869
  evaluationPeriods: number;
1870
+ /**
1871
+ * Max target capacity for scale down.
1872
+ */
1597
1873
  maxTargetCapacity?: string;
1874
+ /**
1875
+ * The maximum to set when scale is needed.
1876
+ */
1598
1877
  maximum?: string;
1599
1878
  metricName: string;
1879
+ /**
1880
+ * Min target capacity for scale up.
1881
+ */
1600
1882
  minTargetCapacity?: string;
1883
+ /**
1884
+ * The minimum to set when scale is needed.
1885
+ */
1601
1886
  minimum?: string;
1602
1887
  namespace: string;
1603
1888
  operator: string;
1604
1889
  period: number;
1890
+ /**
1891
+ * The name of the policy.
1892
+ */
1605
1893
  policyName: string;
1606
1894
  statistic: string;
1895
+ /**
1896
+ * The number of instances to set when scale is needed.
1897
+ */
1607
1898
  target?: string;
1608
1899
  threshold: number;
1609
1900
  unit: string;
@@ -1834,24 +2125,75 @@ export declare namespace aws {
1834
2125
  type: string;
1835
2126
  }
1836
2127
  interface OceanFilters {
2128
+ /**
2129
+ * The filtered instance types will support at least one of the architectures from this list.
2130
+ */
1837
2131
  architectures?: string[];
2132
+ /**
2133
+ * The filtered instance types will belong to one of the categories types from this list.
2134
+ */
1838
2135
  categories?: string[];
2136
+ /**
2137
+ * The filtered instance types will have one of the disk type from this list.
2138
+ */
1839
2139
  diskTypes?: string[];
2140
+ /**
2141
+ * Types belonging to a family from the ExcludeFamilies will not be available for scaling (asterisk wildcard is also supported). For example, C* will exclude instance types from these families: c5, c4, c4a, etc.
2142
+ */
1840
2143
  excludeFamilies?: string[];
2144
+ /**
2145
+ * In case excludeMetal is set to true, metal types will not be available for scaling.
2146
+ */
1841
2147
  excludeMetal?: boolean;
2148
+ /**
2149
+ * The filtered instance types will have a hypervisor type from this list.
2150
+ */
1842
2151
  hypervisors?: string[];
2152
+ /**
2153
+ * Types belonging to a family from the IncludeFamilies will be available for scaling (asterisk wildcard is also supported). For example, C* will include instance types from these families: c5, c4, c4a, etc.
2154
+ */
1843
2155
  includeFamilies?: string[];
2156
+ /**
2157
+ * Ena is supported or not.
2158
+ */
1844
2159
  isEnaSupported?: string;
2160
+ /**
2161
+ * Maximum total number of GPUs.
2162
+ */
1845
2163
  maxGpu?: number;
1846
2164
  maxMemoryGib?: number;
2165
+ /**
2166
+ * Maximum Bandwidth in Gib/s of network performance.
2167
+ */
1847
2168
  maxNetworkPerformance?: number;
1848
2169
  maxVcpu?: number;
2170
+ /**
2171
+ * Minimum number of network interfaces (ENIs).
2172
+ */
1849
2173
  minEnis?: number;
2174
+ /**
2175
+ * Minimum total number of GPUs.
2176
+ */
1850
2177
  minGpu?: number;
2178
+ /**
2179
+ * Minimum amount of Memory (GiB).
2180
+ */
1851
2181
  minMemoryGib?: number;
2182
+ /**
2183
+ * Minimum Bandwidth in Gib/s of network performance.
2184
+ */
1852
2185
  minNetworkPerformance?: number;
2186
+ /**
2187
+ * Minimum number of vcpus available.
2188
+ */
1853
2189
  minVcpu?: number;
2190
+ /**
2191
+ * The filtered instance types will have a root device types from this list.
2192
+ */
1854
2193
  rootDeviceTypes?: string[];
2194
+ /**
2195
+ * The filtered instance types will support at least one of the virtualization types from this list.
2196
+ */
1855
2197
  virtualizationTypes?: string[];
1856
2198
  }
1857
2199
  interface OceanInstanceMetadataOptions {
@@ -1903,6 +2245,9 @@ export declare namespace aws {
1903
2245
  * Object. Set Elastic Block Store properties .
1904
2246
  */
1905
2247
  ebs?: outputs.aws.OceanLaunchSpecBlockDeviceMappingEbs;
2248
+ /**
2249
+ * String. Suppresses the specified device included in the block device mapping of the AMI.
2250
+ */
1906
2251
  noDevice?: string;
1907
2252
  virtualName?: string;
1908
2253
  }
@@ -2543,11 +2888,17 @@ export declare namespace azure {
2543
2888
  tasks?: outputs.azure.OceanNpSchedulingTask[];
2544
2889
  }
2545
2890
  interface OceanNpSchedulingShutdownHours {
2891
+ /**
2892
+ * Enable automatic headroom. When set to True, Ocean configures and optimizes headroom automatically.
2893
+ */
2546
2894
  isEnabled?: boolean;
2547
2895
  timeWindows?: string[];
2548
2896
  }
2549
2897
  interface OceanNpSchedulingTask {
2550
2898
  cronExpression: string;
2899
+ /**
2900
+ * Enable automatic headroom. When set to True, Ocean configures and optimizes headroom automatically.
2901
+ */
2551
2902
  isEnabled: boolean;
2552
2903
  parameters?: outputs.azure.OceanNpSchedulingTaskParameters;
2553
2904
  taskType: string;
@@ -2556,11 +2907,29 @@ export declare namespace azure {
2556
2907
  parametersClusterRoll?: outputs.azure.OceanNpSchedulingTaskParametersParametersClusterRoll;
2557
2908
  }
2558
2909
  interface OceanNpSchedulingTaskParametersParametersClusterRoll {
2910
+ /**
2911
+ * Indicates the threshold of minimum healthy nodes in single batch. If the amount of healthy nodes in single batch is under the threshold, the roll will fail. If exists, the parameter value will be in range of 1-100. In case of null as value, the default value in the backend will be 50%. Value of param should represent the number in percentage (%) of the batch.
2912
+ */
2559
2913
  batchMinHealthyPercentage?: number;
2914
+ /**
2915
+ * Value as a percent to set the size of a batch in a roll. Valid values are 0-100. In case of null as value, the default value in the backend will be 20%.
2916
+ */
2560
2917
  batchSizePercentage?: number;
2918
+ /**
2919
+ * Add a comment description for the roll. The comment is limited to 256 chars and optional.
2920
+ */
2561
2921
  comment?: string;
2922
+ /**
2923
+ * During the roll, if the parameter is set to true we honor PDB during the nodes replacement.
2924
+ */
2562
2925
  respectPdb?: boolean;
2926
+ /**
2927
+ * During the roll, if the parameter is set to true we honor Restrict Scale Down label during the nodes replacement.
2928
+ */
2563
2929
  respectRestrictScaleDown?: boolean;
2930
+ /**
2931
+ * List of virtual node group identifiers to be rolled. Each identifier is a string. vngIds can be null, and cannot be used together with nodeNames and nodePoolNames.
2932
+ */
2564
2933
  vngIds?: string[];
2565
2934
  }
2566
2935
  interface OceanNpTaint {
@@ -2923,24 +3292,75 @@ export declare namespace ecs {
2923
3292
  availabilityVsCost?: string;
2924
3293
  }
2925
3294
  interface OceanFilters {
3295
+ /**
3296
+ * The filtered instance types will support at least one of the architectures from this list.
3297
+ */
2926
3298
  architectures?: string[];
3299
+ /**
3300
+ * The filtered instance types will belong to one of the categories types from this list.
3301
+ */
2927
3302
  categories?: string[];
3303
+ /**
3304
+ * The filtered instance types will have one of the disk type from this list.
3305
+ */
2928
3306
  diskTypes?: string[];
3307
+ /**
3308
+ * Types belonging to a family from the ExcludeFamilies will not be available for scaling (asterisk wildcard is also supported). For example, C* will exclude instance types from these families: c5, c4, c4a, etc.
3309
+ */
2929
3310
  excludeFamilies?: string[];
3311
+ /**
3312
+ * In case excludeMetal is set to true, metal types will not be available for scaling.
3313
+ */
2930
3314
  excludeMetal?: boolean;
3315
+ /**
3316
+ * The filtered instance types will have a hypervisor type from this list.
3317
+ */
2931
3318
  hypervisors?: string[];
3319
+ /**
3320
+ * Types belonging to a family from the IncludeFamilies will be available for scaling (asterisk wildcard is also supported). For example, C* will include instance types from these families: c5, c4, c4a, etc.
3321
+ */
2932
3322
  includeFamilies?: string[];
3323
+ /**
3324
+ * Ena is supported or not.
3325
+ */
2933
3326
  isEnaSupported?: string;
3327
+ /**
3328
+ * Maximum total number of GPUs.
3329
+ */
2934
3330
  maxGpu?: number;
2935
3331
  maxMemoryGib?: number;
3332
+ /**
3333
+ * Maximum Bandwidth in Gib/s of network performance.
3334
+ */
2936
3335
  maxNetworkPerformance?: number;
2937
3336
  maxVcpu?: number;
3337
+ /**
3338
+ * Minimum number of network interfaces (ENIs).
3339
+ */
2938
3340
  minEnis?: number;
3341
+ /**
3342
+ * Minimum total number of GPUs.
3343
+ */
2939
3344
  minGpu?: number;
3345
+ /**
3346
+ * Minimum amount of Memory (GiB).
3347
+ */
2940
3348
  minMemoryGib?: number;
3349
+ /**
3350
+ * Minimum Bandwidth in Gib/s of network performance.
3351
+ */
2941
3352
  minNetworkPerformance?: number;
3353
+ /**
3354
+ * Minimum number of vcpus available.
3355
+ */
2942
3356
  minVcpu?: number;
3357
+ /**
3358
+ * The filtered instance types will have a root device types from this list.
3359
+ */
2943
3360
  rootDeviceTypes?: string[];
3361
+ /**
3362
+ * The filtered instance types will support at least one of the virtualization types from this list.
3363
+ */
2944
3364
  virtualizationTypes?: string[];
2945
3365
  }
2946
3366
  interface OceanInstanceMetadataOptions {
@@ -2986,6 +3406,9 @@ export declare namespace ecs {
2986
3406
  * Object. Set Elastic Block Store properties .
2987
3407
  */
2988
3408
  ebs?: outputs.ecs.OceanLaunchSpecBlockDeviceMappingEbs;
3409
+ /**
3410
+ * String. suppresses the specified device included in the block device mapping of the AMI.
3411
+ */
2989
3412
  noDevice?: string;
2990
3413
  virtualName?: string;
2991
3414
  }
@@ -3096,7 +3519,13 @@ export declare namespace ecs {
3096
3519
  spotPercentage?: number;
3097
3520
  }
3098
3521
  interface OceanLaunchSpecTag {
3522
+ /**
3523
+ * The label key.
3524
+ */
3099
3525
  key: string;
3526
+ /**
3527
+ * The label value.
3528
+ */
3100
3529
  value: string;
3101
3530
  }
3102
3531
  interface OceanLogging {
@@ -3303,7 +3732,15 @@ export declare namespace gcp {
3303
3732
  vcpu: number;
3304
3733
  }
3305
3734
  interface ElastigroupIntegrationDockerSwarm {
3735
+ /**
3736
+ * IP or FQDN of one of your swarm managers.
3737
+ */
3306
3738
  masterHost: string;
3739
+ /**
3740
+ * Network port used by your swarm.
3741
+ *
3742
+ * Usage:
3743
+ */
3307
3744
  masterPort: number;
3308
3745
  }
3309
3746
  interface ElastigroupIntegrationGke {
@@ -3318,6 +3755,9 @@ export declare namespace gcp {
3318
3755
  location?: string;
3319
3756
  }
3320
3757
  interface ElastigroupIntegrationGkeAutoscaleDown {
3758
+ /**
3759
+ * Number of consecutive periods in which the threshold must be met in order to trigger a scaling action.
3760
+ */
3321
3761
  evaluationPeriods?: number;
3322
3762
  }
3323
3763
  interface ElastigroupIntegrationGkeAutoscaleHeadroom {
@@ -3350,8 +3790,14 @@ export declare namespace gcp {
3350
3790
  value: string;
3351
3791
  }
3352
3792
  interface ElastigroupNetworkInterface {
3793
+ /**
3794
+ * Array of configurations.
3795
+ */
3353
3796
  accessConfigs?: outputs.gcp.ElastigroupNetworkInterfaceAccessConfig[];
3354
3797
  aliasIpRanges?: outputs.gcp.ElastigroupNetworkInterfaceAliasIpRange[];
3798
+ /**
3799
+ * Network resource for this group.
3800
+ */
3355
3801
  network: string;
3356
3802
  }
3357
3803
  interface ElastigroupNetworkInterfaceAccessConfig {
@@ -3366,18 +3812,54 @@ export declare namespace gcp {
3366
3812
  subnetworkRangeName: string;
3367
3813
  }
3368
3814
  interface ElastigroupScalingDownPolicy {
3815
+ /**
3816
+ * Type of scaling action to take when the scaling policy is triggered. Valid values: "adjustment", "setMinTarget", "updateCapacity", "percentageAdjustment"
3817
+ */
3369
3818
  actionType?: string;
3819
+ /**
3820
+ * Value to which the action type will be adjusted. Required if using "numeric" or "percentageAdjustment" action types.
3821
+ */
3370
3822
  adjustment?: number;
3823
+ /**
3824
+ * Time (seconds) to wait after a scaling action before resuming monitoring.
3825
+ */
3371
3826
  cooldown: number;
3827
+ /**
3828
+ * A list of dimensions describing qualities of the metric.
3829
+ */
3372
3830
  dimensions?: outputs.gcp.ElastigroupScalingDownPolicyDimension[];
3831
+ /**
3832
+ * Number of consecutive periods in which the threshold must be met in order to trigger a scaling action.
3833
+ */
3373
3834
  evaluationPeriods: number;
3835
+ /**
3836
+ * Metric to monitor. Valid values: "Percentage CPU", "Network In", "Network Out", "Disk Read Bytes", "Disk Write Bytes", "Disk Write Operations/Sec", "Disk Read Operations/Sec".
3837
+ */
3374
3838
  metricName: string;
3375
3839
  namespace: string;
3840
+ /**
3841
+ * The operator used to evaluate the threshold against the current metric value. Valid values: "gt" (greater than), "get" (greater-than or equal), "lt" (less than), "lte" (less than or equal).
3842
+ */
3376
3843
  operator: string;
3844
+ /**
3845
+ * Amount of time (seconds) for which the threshold must be met in order to trigger the scaling action.
3846
+ */
3377
3847
  period: number;
3848
+ /**
3849
+ * Name of scaling policy.
3850
+ */
3378
3851
  policyName: string;
3852
+ /**
3853
+ * Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.
3854
+ */
3379
3855
  source: string;
3856
+ /**
3857
+ * Statistic by which to evaluate the selected metric. Valid values: "AVERAGE", "SAMPLE_COUNT", "SUM", "MINIMUM", "MAXIMUM", "PERCENTILE", "COUNT".
3858
+ */
3380
3859
  statistic: string;
3860
+ /**
3861
+ * The value at which the scaling action is triggered.
3862
+ */
3381
3863
  threshold: number;
3382
3864
  unit: string;
3383
3865
  }
@@ -3426,6 +3908,9 @@ export declare namespace gcp {
3426
3908
  * Name of scaling policy.
3427
3909
  */
3428
3910
  policyName: string;
3911
+ /**
3912
+ * Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.
3913
+ */
3429
3914
  source: string;
3430
3915
  /**
3431
3916
  * Statistic by which to evaluate the selected metric. Valid values: "AVERAGE", "SAMPLE_COUNT", "SUM", "MINIMUM", "MAXIMUM", "PERCENTILE", "COUNT".
@@ -3528,21 +4013,51 @@ export declare namespace gke {
3528
4013
  }
3529
4014
  interface ElastigroupIntegrationGke {
3530
4015
  autoUpdate?: boolean;
4016
+ /**
4017
+ * The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start.
4018
+ */
3531
4019
  autoscaleCooldown?: number;
4020
+ /**
4021
+ * Enabling scale down.
4022
+ */
3532
4023
  autoscaleDown?: outputs.gke.ElastigroupIntegrationGkeAutoscaleDown;
4024
+ /**
4025
+ * Headroom for the cluster.
4026
+ */
3533
4027
  autoscaleHeadroom?: outputs.gke.ElastigroupIntegrationGkeAutoscaleHeadroom;
3534
4028
  autoscaleIsAutoConfig?: boolean;
4029
+ /**
4030
+ * Specifies whether the auto scaling feature is enabled.
4031
+ */
3535
4032
  autoscaleIsEnabled?: boolean;
4033
+ /**
4034
+ * Labels to assign to the resource.
4035
+ */
3536
4036
  autoscaleLabels?: outputs.gke.ElastigroupIntegrationGkeAutoscaleLabel[];
3537
4037
  clusterId?: string;
4038
+ /**
4039
+ * The location of your GKE cluster.
4040
+ */
3538
4041
  location?: string;
3539
4042
  }
3540
4043
  interface ElastigroupIntegrationGkeAutoscaleDown {
4044
+ /**
4045
+ * Amount of cooldown evaluation periods for scale down.
4046
+ */
3541
4047
  evaluationPeriods?: number;
3542
4048
  }
3543
4049
  interface ElastigroupIntegrationGkeAutoscaleHeadroom {
4050
+ /**
4051
+ * Cpu units for compute.
4052
+ */
3544
4053
  cpuPerUnit?: number;
4054
+ /**
4055
+ * RAM units for compute.
4056
+ */
3545
4057
  memoryPerUnit?: number;
4058
+ /**
4059
+ * Amount of units for compute.
4060
+ */
3546
4061
  numOfUnits?: number;
3547
4062
  }
3548
4063
  interface ElastigroupIntegrationGkeAutoscaleLabel {
@@ -3575,6 +4090,9 @@ export declare namespace gke {
3575
4090
  adjustment?: number;
3576
4091
  cooldown: number;
3577
4092
  dimensions?: outputs.gke.ElastigroupScalingDownPolicyDimension[];
4093
+ /**
4094
+ * Amount of cooldown evaluation periods for scale down.
4095
+ */
3578
4096
  evaluationPeriods: number;
3579
4097
  metricName: string;
3580
4098
  namespace: string;
@@ -3595,6 +4113,9 @@ export declare namespace gke {
3595
4113
  adjustment?: number;
3596
4114
  cooldown: number;
3597
4115
  dimensions?: outputs.gke.ElastigroupScalingUpPolicyDimension[];
4116
+ /**
4117
+ * Amount of cooldown evaluation periods for scale down.
4118
+ */
3598
4119
  evaluationPeriods: number;
3599
4120
  metricName: string;
3600
4121
  namespace: string;
@@ -3699,6 +4220,9 @@ export declare namespace gke {
3699
4220
  }
3700
4221
  interface OceanImportBackendServiceNamedPort {
3701
4222
  name: string;
4223
+ /**
4224
+ * A list of ports.
4225
+ */
3702
4226
  ports: string[];
3703
4227
  }
3704
4228
  interface OceanImportScheduledTask {
@@ -4758,6 +5282,9 @@ export declare namespace oceancd {
4758
5282
  profile?: string;
4759
5283
  }
4760
5284
  interface VerificationTemplateMetricProviderPrometheus {
5285
+ /**
5286
+ * A request for information retrieved from Prometheus.
5287
+ */
4761
5288
  prometheusQuery: string;
4762
5289
  }
4763
5290
  interface VerificationTemplateMetricProviderWeb {