Use DATASOURCE::ECS::DeploymentSets in a call to query details of one or more deployment sets - Resource Orchestration Service

DATASOURCE::ECS::DeploymentSets is used to query the information about deployment sets.

Syntax

{
  "Type": "DATASOURCE::ECS::DeploymentSets",
  "Properties": {
    "DeploymentSetIds": List,
    "Strategy": String,
    "DeploymentSetName": String,
    "Domain": String,
    "RefreshOptions": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
DeploymentSetIds	List	No	Yes	The IDs of the deployment sets.	You can specify up to 100 deployment set IDs.
Strategy	String	No	Yes	The deployment strategy.	Valid values: Availability: high availability strategy AvailabilityGroup: high availability group strategy For more information, see Deployment set.
DeploymentSetName	String	No	Yes	The name of the deployment set.	The name must be 2 to 128 characters in length. It must start with a letter and cannot start with `http://` or `https://`. It can contain letters, digits, colons (:), underscores (_), and hyphens (-).
Domain	String	No	Yes	The deployment domain.	None.
RefreshOptions	String	No	Yes	The refresh policy for data source resources when the stack is updated.	Valid values: Never (default): does not refresh data source resources when the stack is updated. Always: refreshes data source resources when the stack is updated.

Return values (Fn::GetAtt)

DeploymentSetIds: the IDs of the deployment sets.
DeploymentSets: details of the deployment sets.

Property	Type	Description	Constraint
DeploymentSetIds	List	The IDs of the deployment sets.	None.
DeploymentSets	List	Details of the deployment sets.	None.
Strategy	String	The deployment strategy.	None.
DeploymentSetId	String	The ID of the deployment set.	None.
DeploymentStrategy	String	The deployment strategy.	The value of DeploymentStrategy is the same as the value of Strategy.
DeploymentSetDescription	String	The description of the deployment set.	None.
Domain	String	The deployment domain.	None.
GroupCount	Number	The number of groups in the deployment set.	This property is returned if Strategy is set to AvailabilityGroup.
Granularity	String	The deployment granularity.	None.
DeploymentSetName	String	The name of the deployment set.	None.
InstanceAmount	Number	The number of instances in the deployment set.	None.
InstanceIds	List	The IDs of the instances in the deployment set.	Multiple instance IDs are separated by commas (,). Example: `["i-bp67acfmxazb4ph**","i-bp67acfmxazb4pi","i-bp67acfmxazb4pj**"]`.
Capacities	List	An array that consists of the capacities of the deployment set.	This property is returned only if the deployment set contains Elastic Compute Service (ECS) instances. The value contains information about the capacities of the deployment set in different zones.

Examples

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DeploymentSetIds": {
      "Type": "CommaDelimitedList",
      "Description": "the IDs of the deployment sets. The value can be a JSON array that consists of up to 100 deployment set IDs in the format of [\"ds-xxxxxxxxx\", \"ds-yyyyyyyyy\", … \"ds-zzzzzzzzz\"]. Separate multiple deployment set IDs with commas (,).",
      "MaxLength": 100,
      "Default": [ "ds-bp1j51y75npa2odp****"]
    }
  },
  "Resources": {
    "DeploymentSets": {
      "Type": "DATASOURCE::ECS::DeploymentSets",
      "Properties": {
        "DeploymentSetIds": {
          "Ref": "DeploymentSetIds"
        }
      }
    }
  },
  "Outputs": {
    "DeploymentSets": {
      "Value": {
        "Fn::GetAtt": [
          "DeploymentSets",
          "DeploymentSets"
        ]
      }
    },
    "DeploymentSetIds": {
      "Value": {
        "Fn::GetAtt": [
          "DeploymentSets",
          "DeploymentSetIds"
        ]
      }
    }
  }
}