DATASOURCE::ECS::DeploymentSets is used to query one or more deployment sets.
Syntax
{
"Type": "DATASOURCE::ECS::DeploymentSets",
"Properties": {
"DeploymentSetIds": List,
"Strategy": String,
"DeploymentSetName": String,
"Domain": 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:
For more information about deployment strategies, see Deployment strategies. |
DeploymentSetName | String | No | Yes | The name of the deployment set. | The name must be 2 to 128 characters in length, and can contain letters, digits, colons
(:), underscores (_), and hyphens (-). The name must start with a letter but cannot
start with http:// or https:// .
|
Domain | String | No | Yes | The deployment domain. | None. |
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 the DeploymentStrategy property is the same as the value of the Strategy property. |
DeploymentSetDescription | String | The description of the deployment set. | None. |
Domain | String | The deployment domain. | None. |
GroupCount | Number | The number of deployment set groups in the deployment set. | This property is returned if the Strategy property 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. | Separate multiple instance IDs with commas (,).
Example: |
Capacities | List | Details of the capacity of the deployment set in an array. | This property is returned only if the deployment set contains Elastic Compute Service (ECS) instances. The value contains the capacity of the deployment set in a specific zone. |
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"
]
}
}
}
}