attach-instances-to-load-balancer¶
Description¶
Attaches one or more Lightsail instances to a load balancer.
After some time, the instances are attached to the load balancer and the health check status is available.
The attach instances to load balancer operation supports tag-based access control via resource tags applied to the resource identified by load balancer name . For more information, see the Lightsail Dev Guide .
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
attach-instances-to-load-balancer
--load-balancer-name <value>
--instance-names <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]
Options¶
--load-balancer-name (string)
The name of the load balancer.
--instance-names (list)
An array of strings representing the instance name(s) you want to attach to your load balancer.
An instance must be
runningbefore you can attach it to your load balancer.There are no additional limits on the number of instances you can attach to your load balancer, aside from the limit of Lightsail instances you can create in your account (20).
(string)
Syntax:
"string" "string" ...
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
See ‘aws help’ for descriptions of global parameters.
Examples¶
To attach instances to a load balancer
The following attach-instances-to-load-balancer example attaches instances MEAN-1, MEAN-2, and MEAN-3 to the load balancer LoadBalancer-1.
aws lightsail attach-instances-to-load-balancer \
--instance-names {"MEAN-1","MEAN-2","MEAN-3"} \
--load-balancer-name LoadBalancer-1
Output:
{
"operations": [
{
"id": "8055d19d-abb2-40b9-b527-1EXAMPLE3c7b",
"resourceName": "LoadBalancer-1",
"resourceType": "LoadBalancer",
"createdAt": 1571071699.892,
"location": {
"availabilityZone": "all",
"regionName": "us-west-2"
},
"isTerminal": false,
"operationDetails": "MEAN-2",
"operationType": "AttachInstancesToLoadBalancer",
"status": "Started",
"statusChangedAt": 1571071699.892
},
{
"id": "c35048eb-8538-456a-a118-0EXAMPLEfb73",
"resourceName": "MEAN-2",
"resourceType": "Instance",
"createdAt": 1571071699.887,
"location": {
"availabilityZone": "all",
"regionName": "us-west-2"
},
"isTerminal": false,
"operationDetails": "LoadBalancer-1",
"operationType": "AttachInstancesToLoadBalancer",
"status": "Started",
"statusChangedAt": 1571071699.887
},
{
"id": "910d09e0-adc5-4372-bc2e-0EXAMPLEd891",
"resourceName": "LoadBalancer-1",
"resourceType": "LoadBalancer",
"createdAt": 1571071699.882,
"location": {
"availabilityZone": "all",
"regionName": "us-west-2"
},
"isTerminal": false,
"operationDetails": "MEAN-3",
"operationType": "AttachInstancesToLoadBalancer",
"status": "Started",
"statusChangedAt": 1571071699.882
},
{
"id": "178b18ac-43e8-478c-9bed-1EXAMPLE4755",
"resourceName": "MEAN-3",
"resourceType": "Instance",
"createdAt": 1571071699.901,
"location": {
"availabilityZone": "all",
"regionName": "us-west-2"
},
"isTerminal": false,
"operationDetails": "LoadBalancer-1",
"operationType": "AttachInstancesToLoadBalancer",
"status": "Started",
"statusChangedAt": 1571071699.901
},
{
"id": "fb62536d-2a98-4190-a6fc-4EXAMPLE7470",
"resourceName": "LoadBalancer-1",
"resourceType": "LoadBalancer",
"createdAt": 1571071699.885,
"location": {
"availabilityZone": "all",
"regionName": "us-west-2"
},
"isTerminal": false,
"operationDetails": "MEAN-1",
"operationType": "AttachInstancesToLoadBalancer",
"status": "Started",
"statusChangedAt": 1571071699.885
},
{
"id": "787dac0d-f98d-46c3-8571-3EXAMPLE5a85",
"resourceName": "MEAN-1",
"resourceType": "Instance",
"createdAt": 1571071699.901,
"location": {
"availabilityZone": "all",
"regionName": "us-west-2"
},
"isTerminal": false,
"operationDetails": "LoadBalancer-1",
"operationType": "AttachInstancesToLoadBalancer",
"status": "Started",
"statusChangedAt": 1571071699.901
}
]
}
Output¶
operations -> (list)
An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
(structure)
Describes the API operation.
id -> (string)
The ID of the operation.
resourceName -> (string)
The resource name.
resourceType -> (string)
The resource type.
createdAt -> (timestamp)
The timestamp when the operation was initialized (e.g.,
1479816991.349).location -> (structure)
The AWS Region and Availability Zone.
availabilityZone -> (string)
The Availability Zone. Follows the format
us-east-2a(case-sensitive).regionName -> (string)
The AWS Region name.
isTerminal -> (boolean)
A Boolean value indicating whether the operation is terminal.
operationDetails -> (string)
Details about the operation (e.g.,
Debian-1GB-Ohio-1).operationType -> (string)
The type of operation.
status -> (string)
The status of the operation.
statusChangedAt -> (timestamp)
The timestamp when the status was changed (e.g.,
1479816991.349).errorCode -> (string)
The error code.
errorDetails -> (string)
The error details.