DATASOURCE::ESS::ScalingConfigurations - Resource Orchestration Service

DATASOURCE::ESS::ScalingConfigurations is used to query the details of scaling configurations.

Syntax

{
  "Type": "DATASOURCE::ESS::ScalingConfigurations",
  "Properties": {
    "ScalingGroupId": String,
    "ScalingConfigurationIds": List,
    "ScalingConfigurationNames": List
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
ScalingGroupId	String	No	Yes	The ID of the scaling group.	None.
ScalingConfigurationIds	List	No	Yes	The IDs of the scaling configurations.	You can differentiate between active and inactive scaling configurations based on the value of the LifecycleState property. Note You can query up to 10 scaling configuration IDs in a request.
ScalingConfigurationNames	List	No	Yes	The names of the scaling configurations.	The names of inactive scaling configurations are not returned, and no errors are reported. Note You can query up to 10 scaling configuration names in a request.

Return values (Fn::GetAtt)

ScalingConfigurationIds: the IDs of the scaling configurations.
ScalingConfigurations: details of the scaling configurations.

Property	Type	Description	Constraint
ScalingConfigurationIds	List	The IDs of the scaling configurations.	None.
ScalingConfigurations	List	Details of the scaling configurations.	None.
ScalingConfigurationName	String	The name of the scaling configuration.	None.
LoadBalancerWeight	Number	The weight of the Elastic Compute Service (ECS) instance that is used as a backend server.	Valid values: 1 to 100.
IoOptimized	String	Indicates whether the instance is an I/O optimized instance.	Valid values: none: The instance is not an I/O optimized instance. optimized: The instance is an I/O optimized instance.
ResourceGroupId	String	The ID of the resource group to which the ECS instance belongs.	None.
DataDisks	List	Details of the data disks.	Example: `{ "Size": 200, "Category": "cloud", "SnapshotId": "s-280s7****", "Device": "/dev/xvdb" }`.
SystemDiskSize	Number	The size of the system disk.	None.
ScalingGroupId	String	The ID of the scaling group to which the scaling configurations belong.	None.
SecurityGroupId	String	The ID of the security group to which the ECS instance belongs.	ECS instances in the same security group can access each other.
LifecycleState	String	The state of the scaling configuration in the scaling group.	Valid values: Active: The scaling configuration is active in the scaling group. Auto Scaling uses active scaling configurations to automatically create ECS instances. Inactive: The scaling configuration is inactive in the scaling group.
SecurityGroupIds	List	The IDs of the security groups to which the ECS instances belong.	ECS instances in the same security group can access each other. Example: `["sg-bp18kz60mefs**", "sg-shankjdauw1**"]`.
SystemDiskCategory	String	The category of the system disk.	Valid values: cloud: basic disk cloud_efficiency: ultra disk cloud_ssd: standard SSD ephemeral_ssd: local SSD cloud_essd: enhanced SSD (ESSD)
InternetChargeType	String	The metering method for network usage.	Valid values: PayByBandwidth: pay-by-bandwidth. You are charged based on the bandwidth that is specified by the InternetMaxBandwidthOut property. PayByTraffic: pay-by-data-transfer. You are charged for the actual traffic that you use. The InternetMaxBandwidthOut property specifies only the maximum outbound public bandwidth.
InstanceName	String	The name of the ECS instance.	None.
InternetMaxBandwidthOut	Number	The maximum outbound public bandwidth.	Unit: Mbit/s. Valid values: Valid values if the InternetChargeType property is set to PayByBandwidth: 0 to 100. If you leave the InternetMaxBandwidthOut property empty, the default outbound public bandwidth is 0 Mbit/s. Valid values if the InternetChargeType property is set to PayByTraffic: 0 to 100. If you leave the InternetMaxBandwidthOut property empty, an error is reported.
InternetMaxBandwidthIn	Number	The maximum inbound public bandwidth.	Unit: Mbit/s. Valid values: 1 to 200.
SystemDiskCategories	List	The categories of the system disks.	The priorities of values decrease based on a configured order. The first value has the highest priority. Valid values: cloud: basic disk cloud_efficiency: ultra disk cloud_ssd: standard SSD cloud_essd: ESSD Note If Auto Scaling cannot create system disks of the disk category that has the highest priority, Auto Scaling automatically creates disks of the disk category that has the next highest priority.
CreationTime	String	The time when the scaling configuration was created.	None.
ImageId	String	The ID of the image.	Auto Scaling uses the image to automatically creates instances.
SystemDiskEncrypted	Boolean	Indicates whether the system disk is encrypted.	Default value: false. Valid values: true false
InstanceGeneration	String	The generation of the ECS instance.	None.
InstanceTypes	List	The ECS instance types.	Example: `[ "ecs.g6.large", "ecs.g5.large"]`.
InstanceType	String	The ECS instance type.	None.
ScalingConfigurationId	String	The ID of the scaling configuration.	None.

Examples

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ScalingGroupId": {
      "Type": "String",
      "Description": "The ID of the scaling group. You can use the ID to query all scaling configurations in the scaling group."
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ESS::ScalingConfigurations",
      "Properties": {
        "ScalingGroupId": {
          "Ref": "ScalingGroupId"
        }
      }
    }
  },
  "Outputs": {
    "ScalingConfigurationIds": {
      "Description": "The list of scaling configuration IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ScalingConfigurationIds"
        ]
      }
    },
    "ScalingConfigurations": {
      "Description": "The list of scaling configurations.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ScalingConfigurations"
        ]
      }
    }
  }
}

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ScalingGroupId:
    Type: String
    Description: The ID of the scaling group. You can use the ID to query all scaling configurations in the scaling group.
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::ESS::ScalingConfigurations
    Properties:
      ScalingGroupId:
        Ref: ScalingGroupId
Outputs:
  ScalingConfigurationIds:
    Description: The list of scaling configuration IDs.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ScalingConfigurationIds
  ScalingConfigurations:
    Description: The list of scaling configurations.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ScalingConfigurations