attach_instances_to_load_balancer

Lightsail.Client.attach_instances_to_load_balancer(**kwargs)

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 Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.attach_instances_to_load_balancer(
    loadBalancerName='string',
    instanceNames=[
        'string',
    ]
)

Parameters

• loadBalancerName (string) --

  [REQUIRED]

  The name of the load balancer.

• instanceNames (list) --

  [REQUIRED]

  An array of strings representing the instance name(s) you want to attach to your load balancer.

  An instance must be running before 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) --

Return type

dict

Returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate'|'Bucket',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'eu-north-1'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'SetIpAddressType'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage'|'CreateBucket'|'DeleteBucket'|'CreateBucketAccessKey'|'DeleteBucketAccessKey'|'UpdateBucketBundle'|'UpdateBucket'|'SetResourceAccessForBucket'|'UpdateInstanceMetadataOptions'|'StartGUISession'|'StopGUISession',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • 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.

    • (dict) --

      Describes the API operation.

      • id (string) --

        The ID of the operation.

      • resourceName (string) --

        The resource name.

      • resourceType (string) --

        The resource type.

      • createdAt (datetime) --

        The timestamp when the operation was initialized (e.g., 1479816991.349 ).

      • location (dict) --

        The Amazon Web Services Region and Availability Zone.

        • availabilityZone (string) --

          The Availability Zone. Follows the format us-east-2a (case-sensitive).

        • regionName (string) --

          The Amazon Web Services 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 (datetime) --

        The timestamp when the status was changed (e.g., 1479816991.349 ).

      • errorCode (string) --

        The error code.

      • errorDetails (string) --

        The error details.

Exceptions

• Lightsail.Client.exceptions.ServiceException
• Lightsail.Client.exceptions.InvalidInputException
• Lightsail.Client.exceptions.NotFoundException
• Lightsail.Client.exceptions.OperationFailureException
• Lightsail.Client.exceptions.AccessDeniedException
• Lightsail.Client.exceptions.AccountSetupInProgressException
• Lightsail.Client.exceptions.UnauthenticatedException