@alicloud/ess20220222 1.8.16 → 1.8.18

package/src/models/CreateScalingGroupRequest.ts

@@ -1,16 +1,640 @@
 // This file is auto-generated, don't edit it
 import * as $dara from '@darabonba/typescript';
-import { CreateScalingGroupRequestAlbServerGroups } from "./CreateScalingGroupRequestAlbServerGroups";
-import { CreateScalingGroupRequestCapacityOptions } from "./CreateScalingGroupRequestCapacityOptions";
-import { CreateScalingGroupRequestDBInstances } from "./CreateScalingGroupRequestDbinstances";
-import { CreateScalingGroupRequestLaunchTemplateOverrides } from "./CreateScalingGroupRequestLaunchTemplateOverrides";
-import { CreateScalingGroupRequestLifecycleHooks } from "./CreateScalingGroupRequestLifecycleHooks";
-import { CreateScalingGroupRequestLoadBalancerConfigs } from "./CreateScalingGroupRequestLoadBalancerConfigs";
-import { CreateScalingGroupRequestServerGroups } from "./CreateScalingGroupRequestServerGroups";
-import { CreateScalingGroupRequestTags } from "./CreateScalingGroupRequestTags";
-import { CreateScalingGroupRequestVServerGroups } from "./CreateScalingGroupRequestVserverGroups";
 
 
+export class CreateScalingGroupRequestAlbServerGroups extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the ALB server group.
+   * 
+   * You can attach only a limited number of ALB server groups to a scaling group. To view the predefined quota limit or manually request a quota increase, go to [Quota Center](https://quotas.console.aliyun.com/products/ess/quotas).
+   * 
+   * @example
+   * sgp-ddwb0y0g6y9bjm****
+   */
+  albServerGroupId?: string;
+  /**
+   * @remarks
+   * The port number used by each ECS instance as a backend server in the ALB server group. Valid values: 1 to 65535.
+   * 
+   * @example
+   * 22
+   */
+  port?: number;
+  /**
+   * @remarks
+   * The weight of an ECS instance as a backend server in the ALB server group. If you increase the weight for an ECS instance, the number of requests that are forwarded to the ECS instance also increases. If you set the weight for an ECS instance to 0, no requests are forwarded to the ECS instance. Valid values: 0 to 100.
+   * 
+   * @example
+   * 100
+   */
+  weight?: number;
+  static names(): { [key: string]: string } {
+    return {
+      albServerGroupId: 'AlbServerGroupId',
+      port: 'Port',
+      weight: 'Weight',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      albServerGroupId: 'string',
+      port: 'number',
+      weight: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class CreateScalingGroupRequestCapacityOptions extends $dara.Model {
+  /**
+   * @remarks
+   * Specifies whether to automatically create pay-as-you-go ECS instances to reach the required number of ECS instances when preemptible ECS instances cannot be created due to high prices or insufficient inventory of resources. This parameter takes effect when you set `MultiAZPolicy` to `COST_OPTIMIZED`. Valid values:
+   * 
+   * *   true
+   * *   false
+   * 
+   * Default value: true.
+   * 
+   * @example
+   * true
+   */
+  compensateWithOnDemand?: boolean;
+  /**
+   * @remarks
+   * The minimum number of pay-as-you-go instances required in the scaling group. When the number of pay-as-you-go instances drops below the value of this parameter, Auto Scaling preferentially creates pay-as-you-go instances. Valid values: 0 to 1000.
+   * 
+   * If you set `MultiAZPolicy` to `COMPOSABLE`, the default value is 0.
+   * 
+   * @example
+   * 30
+   */
+  onDemandBaseCapacity?: number;
+  /**
+   * @remarks
+   * The percentage of pay-as-you-go instances in the excess instances when the minimum number of pay-as-you-go instances is reached. `OnDemandBaseCapacity` specifies the minimum number of pay-as-you-go instances that must be contained in the scaling group. Valid values: 0 to 100.
+   * 
+   * If you set `MultiAZPolicy` to `COMPOSABLE`, the default value is 100.
+   * 
+   * @example
+   * 20
+   */
+  onDemandPercentageAboveBaseCapacity?: number;
+  /**
+   * @remarks
+   * The cost comparison method. Valid values:
+   * 
+   * *   PricePerUnit: Prices are compared based on the price per instance capacity.
+   * 
+   *     Capacity is determined by the weights assigned to instance types in the scaling group. If no weight is specified, a default weight of 1 is used, meaning each instance is assigned a capacity of 1.
+   * 
+   * *   PricePerVCpu: Prices are compared based on the price per vCPU.
+   * 
+   * Default value: PricePerUnit.
+   * 
+   * @example
+   * PricePerUnit
+   */
+  priceComparisonMode?: string;
+  /**
+   * @remarks
+   * Specifies whether to replace pay-as-you-go instances with preemptible instances. If you specify `CompensateWithOnDemand`, it may result in a higher percentage of pay-as-you-go instances compared to the value of `OnDemandPercentageAboveBaseCapacity`. In this scenario, Auto Scaling will try to deploy preemptible instances to replace the surplus pay-as-you-go instances. When `CompensateWithOnDemand` is specified, Auto Scaling creates pay-as-you-go instances if there are not enough preemptible instance types. To avoid keeping these pay-as-you-go ECS instances for long periods, Auto Scaling tries to replace them with preemptible instances as soon as enough of preemptible instance types become available. Valid values:
+   * 
+   * *   true
+   * *   false
+   * 
+   * Default value: false.
+   * 
+   * @example
+   * false
+   */
+  spotAutoReplaceOnDemand?: boolean;
+  static names(): { [key: string]: string } {
+    return {
+      compensateWithOnDemand: 'CompensateWithOnDemand',
+      onDemandBaseCapacity: 'OnDemandBaseCapacity',
+      onDemandPercentageAboveBaseCapacity: 'OnDemandPercentageAboveBaseCapacity',
+      priceComparisonMode: 'PriceComparisonMode',
+      spotAutoReplaceOnDemand: 'SpotAutoReplaceOnDemand',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      compensateWithOnDemand: 'boolean',
+      onDemandBaseCapacity: 'number',
+      onDemandPercentageAboveBaseCapacity: 'number',
+      priceComparisonMode: 'string',
+      spotAutoReplaceOnDemand: 'boolean',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class CreateScalingGroupRequestDBInstances extends $dara.Model {
+  /**
+   * @remarks
+   * The mode in which you want to attach the database to the scaling group. Valid values:
+   * 
+   * *   SecurityIp: the mode in which Auto Scaling automatically adds the private IP addresses of ECS instances to the IP address whitelist of the database during scale-out events. You can set the value to SecurityIp only if you set Type to RDS.
+   * *   SecurityGroup: the mode in which Auto Scaling adds the security group of the applied scaling configuration to the security group whitelist of the database. This setting allows ECS instances created from the scaling configuration to access the database.
+   * 
+   * @example
+   * SecurityIp
+   */
+  attachMode?: string;
+  /**
+   * @remarks
+   * The database ID.
+   * 
+   * @example
+   * rm-m5eqju85s45mu0***
+   */
+  DBInstanceId?: string;
+  /**
+   * @remarks
+   * The database type. Valid values:
+   * 
+   * *   RDS
+   * *   Redis
+   * *   MongoDB
+   * 
+   * Default value: RDS.
+   * 
+   * @example
+   * RDS
+   */
+  type?: string;
+  static names(): { [key: string]: string } {
+    return {
+      attachMode: 'AttachMode',
+      DBInstanceId: 'DBInstanceId',
+      type: 'Type',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      attachMode: 'string',
+      DBInstanceId: 'string',
+      type: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class CreateScalingGroupRequestLaunchTemplateOverrides extends $dara.Model {
+  /**
+   * @remarks
+   * The instance type that you want to use to override the instance type that is specified in the launch template.
+   * 
+   * If you want to scale instances based on the weighted capacities of the instances, you must specify both the InstanceType and WeightedCapacity parameters.
+   * 
+   * > This parameter is available only if you specify the LaunchTemplateId parameter.
+   * 
+   * You can use the InstanceType parameter to specify only instance types that are available for purchase.
+   * 
+   * @example
+   * ecs.c5.xlarge
+   */
+  instanceType?: string;
+  /**
+   * @remarks
+   * The maximum bid price of the instance type that is specified by the `InstanceType` parameter. You can specify 1 to 10 instance types by using the Extended Configurations feature of the launch template.
+   * 
+   * > This parameter is available only if you specify the `LaunchTemplateId` parameter.
+   * 
+   * @example
+   * 0.025
+   */
+  spotPriceLimit?: number;
+  /**
+   * @remarks
+   * The weight of the instance type. The weight specifies the capacity of an instance of the specified instance type in the scaling group. If you want to scale instances based on the weighted capacities of the instances, you must specify the WeightedCapacity parameter after you specify the InstanceType parameter.
+   * 
+   * A higher weight specifies that a smaller number of instances of the specified instance type are required to meet the expected capacity requirement.
+   * 
+   * Performance metrics, such as the number of vCPUs and the memory size of each instance type, may vary. You can specify different weights for different instance types based on your business requirements.
+   * 
+   * Example:
+   * 
+   * *   Current capacity: 0
+   * *   Expected capacity: 6
+   * *   Capacity of ecs.c5.xlarge: 4
+   * 
+   * To meet the expected capacity requirement, Auto Scaling must create and add two ecs.c5.xlarge instances.
+   * 
+   * > The capacity of the scaling group cannot exceed the sum of the maximum number of instances that is specified by the MaxSize parameter and the maximum weight of the instance types.
+   * 
+   * Valid values of the WeightedCapacity parameter: 1 to 500.
+   * 
+   * @example
+   * 4
+   */
+  weightedCapacity?: number;
+  static names(): { [key: string]: string } {
+    return {
+      instanceType: 'InstanceType',
+      spotPriceLimit: 'SpotPriceLimit',
+      weightedCapacity: 'WeightedCapacity',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      instanceType: 'string',
+      spotPriceLimit: 'number',
+      weightedCapacity: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class CreateScalingGroupRequestLifecycleHooks extends $dara.Model {
+  /**
+   * @remarks
+   * The action that Auto Scaling performs when the lifecycle hook times out. Valid values:
+   * 
+   * *   CONTINUE: Auto Scaling continues to respond to the scaling request.
+   * *   ABANDON: Auto Scaling releases ECS instances that are created during scale-out events, or removes ECS instances from the scaling group during scale-in events.
+   * 
+   * If multiple lifecycle hooks in the scaling group are triggered during scale-in events, and you set DefaultResult to ABANDON for one of the lifecycle hooks, Auto Scaling immediately performs the action after the lifecycle hook whose DefaultResult is set to ABANDON times out. In this case, other lifecycle hooks time out ahead of schedule. In other cases, Auto Scaling performs the action only after all lifecycle hooks time out. The action that Auto Scaling performs is determined by the value of DefaultResult that you specify for the lifecycle hook that most recently times out.
+   * 
+   * Default value: CONTINUE.
+   * 
+   * @example
+   * CONTINUE
+   */
+  defaultResult?: string;
+  /**
+   * @remarks
+   * The period of time before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the action that is specified by DefaultResult. Valid values: 30 to 21600. Unit: seconds.
+   * 
+   * After you create a lifecycle hook, you can call the RecordLifecycleActionHeartbeat operation to extend the timeout period of the lifecycle hook. You can also call the CompleteLifecycleAction operation to end the timeout period of the lifecycle hook ahead of schedule.
+   * 
+   * Default value: 600.
+   * 
+   * @example
+   * 600
+   */
+  heartbeatTimeout?: number;
+  /**
+   * @remarks
+   * The name of the lifecycle hook. After you specify this parameter, you cannot change the name of the lifecycle hook. If you do not specify this parameter, the name of the lifecycle hook is the same as the ID of the lifecycle hook.
+   * 
+   * @example
+   * lifecyclehook****
+   */
+  lifecycleHookName?: string;
+  /**
+   * @remarks
+   * The type of the scaling activity to which you want to apply the lifecycle hook. Valid values:
+   * 
+   * *   SCALE_OUT
+   * *   SCALE_IN
+   * 
+   * >  If you specify lifecycle hooks for the scaling group, you must specify LifecycleTransition. Other parameters are optional.
+   * 
+   * @example
+   * SCALE_OUT
+   */
+  lifecycleTransition?: string;
+  /**
+   * @remarks
+   * The Alibaba Cloud Resource Name (ARN) of the notification recipient party. You can specify a Simple Message Queue (SMQ, formerly MNS) topic or queue as the recipient party. The value is in the acs:ess:{region}:{account-id}:{resource-relative-id} format.
+   * 
+   * *   region: the region ID of the scaling group
+   * *   account-id: the ID of your Alibaba Cloud account.
+   * 
+   * Examples:
+   * 
+   * *   SMQ queue: acs:ess:{region}:{account-id}:queue/{queuename}
+   * *   SMQ topic: acs:ess:{region}:{account-id}:topic/{topicname}
+   * 
+   * @example
+   * acs:ess:cn-hangzhou:1111111111:queue/queue2
+   */
+  notificationArn?: string;
+  /**
+   * @remarks
+   * The fixed string that you want to include in notifications. When a lifecycle hook takes effect, Auto Scaling sends a notification. The fixed string can contain up to 4,096 characters in length. When Auto Scaling sends a notification to the recipient party, it includes predefined notification metadata into the notification. This helps in managing and labeling notifications of different categories. NotificationMetadata takes effect only if you specify NotificationArn.
+   * 
+   * @example
+   * Test
+   */
+  notificationMetadata?: string;
+  static names(): { [key: string]: string } {
+    return {
+      defaultResult: 'DefaultResult',
+      heartbeatTimeout: 'HeartbeatTimeout',
+      lifecycleHookName: 'LifecycleHookName',
+      lifecycleTransition: 'LifecycleTransition',
+      notificationArn: 'NotificationArn',
+      notificationMetadata: 'NotificationMetadata',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      defaultResult: 'string',
+      heartbeatTimeout: 'number',
+      lifecycleHookName: 'string',
+      lifecycleTransition: 'string',
+      notificationArn: 'string',
+      notificationMetadata: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class CreateScalingGroupRequestLoadBalancerConfigs extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the CLB instance.
+   * 
+   * @example
+   * lb-2zen1olhfg9yw3f4qgte4
+   */
+  loadBalancerId?: string;
+  /**
+   * @remarks
+   * The weight of each ECS instance as a backend server in the CLB backend server group. If you increase the weight for an ECS instance, the number of requests that are forwarded to the ECS instance also increases. If you set the weight for an ECS instance to 0, no requests are forwarded to the ECS instance. Valid values: 0 to 100.
+   * 
+   * @example
+   * 10
+   */
+  weight?: number;
+  static names(): { [key: string]: string } {
+    return {
+      loadBalancerId: 'LoadBalancerId',
+      weight: 'Weight',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      loadBalancerId: 'string',
+      weight: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class CreateScalingGroupRequestServerGroups extends $dara.Model {
+  /**
+   * @remarks
+   * The port number used by each ECS instance as backend server in the vServer group. Valid values: 1 to 65535.
+   * 
+   * @example
+   * 22
+   */
+  port?: number;
+  /**
+   * @remarks
+   * The ID of the server group.
+   * 
+   * @example
+   * sgp-5yc3bd9lfyh*****
+   */
+  serverGroupId?: string;
+  /**
+   * @remarks
+   * The type of the server group. Valid values:
+   * 
+   * *   ALB
+   * *   NLB
+   * 
+   * @example
+   * ALB
+   */
+  type?: string;
+  /**
+   * @remarks
+   * The weight of each ECS instance as a backend server in the server group. Valid values: 0 to 100.
+   * 
+   * If you increase the weight for an ECS instance, the number of requests that are forwarded to the ECS instance also increases. If you set the weight for an ECS instance to 0, no requests are forwarded to the ECS instance.
+   * 
+   * @example
+   * 100
+   */
+  weight?: number;
+  static names(): { [key: string]: string } {
+    return {
+      port: 'Port',
+      serverGroupId: 'ServerGroupId',
+      type: 'Type',
+      weight: 'Weight',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      port: 'number',
+      serverGroupId: 'string',
+      type: 'string',
+      weight: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class CreateScalingGroupRequestTags extends $dara.Model {
+  /**
+   * @remarks
+   * The tag key that you want to add to the scaling group.
+   * 
+   * @example
+   * Department
+   */
+  key?: string;
+  /**
+   * @remarks
+   * Specifies whether to propagate the tag that you want to add to the scaling group. Valid values:
+   * 
+   * *   true: propagates the tag to only instances that are newly created.
+   * *   false: does not propagate the tag to any instances.
+   * 
+   * Default value: false.
+   * 
+   * @example
+   * false
+   */
+  propagate?: boolean;
+  /**
+   * @remarks
+   * The tag value that you want to add to the scaling group.
+   * 
+   * @example
+   * Finance
+   */
+  value?: string;
+  static names(): { [key: string]: string } {
+    return {
+      key: 'Key',
+      propagate: 'Propagate',
+      value: 'Value',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      key: 'string',
+      propagate: 'boolean',
+      value: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class CreateScalingGroupRequestVServerGroupsVServerGroupAttributes extends $dara.Model {
+  /**
+   * @remarks
+   * The port number used by each ECS instance as a backend server in the vServer group. Valid values: 1 to 65535.
+   * 
+   * @example
+   * 22
+   */
+  port?: number;
+  /**
+   * @remarks
+   * The ID of the vServer group.
+   * 
+   * @example
+   * rsp-bp1443g77****
+   */
+  VServerGroupId?: string;
+  /**
+   * @remarks
+   * The weight of each ECS instance as a backend server in the vServer group. If you increase the weight for an ECS instance, the number of requests that are forwarded to the ECS instance also increases. If you set the weight for an ECS instance to 0, no requests are forwarded to the ECS instance. Valid values: 0 to 100.
+   * 
+   * Default value: 50.
+   * 
+   * @example
+   * 100
+   */
+  weight?: number;
+  static names(): { [key: string]: string } {
+    return {
+      port: 'Port',
+      VServerGroupId: 'VServerGroupId',
+      weight: 'Weight',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      port: 'number',
+      VServerGroupId: 'string',
+      weight: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class CreateScalingGroupRequestVServerGroups extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the CLB instance to which the backend vServer group belongs.
+   * 
+   * @example
+   * lb-bp1u7etiogg38yvwz****
+   */
+  loadBalancerId?: string;
+  /**
+   * @remarks
+   * The attributes of the backend vServer group.
+   */
+  VServerGroupAttributes?: CreateScalingGroupRequestVServerGroupsVServerGroupAttributes[];
+  static names(): { [key: string]: string } {
+    return {
+      loadBalancerId: 'LoadBalancerId',
+      VServerGroupAttributes: 'VServerGroupAttributes',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      loadBalancerId: 'string',
+      VServerGroupAttributes: { 'type': 'array', 'itemType': CreateScalingGroupRequestVServerGroupsVServerGroupAttributes },
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.VServerGroupAttributes)) {
+      $dara.Model.validateArray(this.VServerGroupAttributes);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
 export class CreateScalingGroupRequest extends $dara.Model {
   /**
    * @remarks