Ec2 Auto Scaling Start Instance Refresh Type Structure
StartInstanceRefreshType schema from Auto Scaling
Type: objectProperties: 4Required: 1
Amazon Web ServicesAuto-ScalingComputeEC2High AvailabilityScaling
StartInstanceRefreshType is a JSON Structure definition published by Amazon EC2 Auto Scaling, describing 4 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-ec2-auto-scaling/refs/heads/main/json-structure/ec2-auto-scaling-start-instance-refresh-type-structure.json",
"name": "StartInstanceRefreshType",
"description": "StartInstanceRefreshType schema from Auto Scaling",
"type": "object",
"properties": {
"AutoScalingGroupName": {
"allOf": [
{
"$ref": "#/components/schemas/XmlStringMaxLen255"
},
{
"description": "The name of the Auto Scaling group."
}
]
},
"Strategy": {
"allOf": [
{
"$ref": "#/components/schemas/RefreshStrategy"
},
{
"description": "The strategy to use for the instance refresh. The only valid value is <code>Rolling</code>."
}
]
},
"DesiredConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/DesiredConfiguration"
},
{
"description": "<p>The desired configuration. For example, the desired configuration can specify a new launch template or a new version of the current launch template.</p> <p>Once the instance refresh succeeds, Amazon EC2 Auto Scaling updates the settings of the Auto Scaling group to reflect the new desired configuration. </p> <note> <p>When you specify a new launch template or a new version of the current launch template for your desired configuration, consider enabling the <code>SkipMatching</code> property in preferences. If it's enabled, Amazon EC2 Auto Scaling skips replacing instances that already use the specified launch template and instance types. This can help you reduce the number of replacements that are required to apply updates. </p> </note>"
}
]
},
"Preferences": {
"allOf": [
{
"$ref": "#/components/schemas/RefreshPreferences"
},
{
"description": "<p>Sets your preferences for the instance refresh so that it performs as expected when you start it. Includes the instance warmup time, the minimum healthy percentage, and the behaviors that you want Amazon EC2 Auto Scaling to use if instances that are in <code>Standby</code> state or protected from scale in are found. You can also choose to enable additional features, such as the following:</p> <ul> <li> <p>Auto rollback</p> </li> <li> <p>Checkpoints</p> </li> <li> <p>Skip matching</p> </li> </ul>"
}
]
}
},
"required": [
"AutoScalingGroupName"
]
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.