Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . opsworks ]

describe-elastic-load-balancers

Description

Describes a stack's Elastic Load Balancing instances.

Note

This call accepts only one resource-identifying parameter.

Required Permissions : To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-elastic-load-balancers
[--stack-id <value>]
[--layer-ids <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--stack-id (string)

A stack ID. The action describes the stack's Elastic Load Balancing instances.

--layer-ids (list)

A list of layer IDs. The action describes the Elastic Load Balancing instances for the specified layers.

(string)

Syntax:

"string" "string" ...

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To describe a stack's elastic load balancers

The following describe-elastic-load-balancers command describes a specified stack's load balancers.

aws opsworks --region us-west-2 describe-elastic-load-balancers --stack-id 6f4660e5-37a6-4e42-bfa0-1358ebd9c182

Output: This particular stack has one load balancer.

{
  "ElasticLoadBalancers": [
      {
          "SubnetIds": [
              "subnet-60e4ea04",
              "subnet-66e1c110"
          ],
          "Ec2InstanceIds": [],
          "ElasticLoadBalancerName": "my-balancer",
          "Region": "us-west-2",
          "LayerId": "344973cb-bf2b-4cd0-8d93-51cd819bab04",
          "AvailabilityZones": [
              "us-west-2a",
              "us-west-2b"
          ],
          "VpcId": "vpc-b319f9d4",
          "StackId": "6f4660e5-37a6-4e42-bfa0-1358ebd9c182",
          "DnsName": "my-balancer-2094040179.us-west-2.elb.amazonaws.com"
      }
  ]
}

More Information

For more information, see Apps in the AWS OpsWorks User Guide.

Output

ElasticLoadBalancers -> (list)

A list of ElasticLoadBalancer objects that describe the specified Elastic Load Balancing instances.

(structure)

Describes an Elastic Load Balancing instance.

ElasticLoadBalancerName -> (string)

The Elastic Load Balancing instance's name.

Region -> (string)

The instance's AWS region.

DnsName -> (string)

The instance's public DNS name.

StackId -> (string)

The ID of the stack that the instance is associated with.

LayerId -> (string)

The ID of the layer that the instance is attached to.

VpcId -> (string)

The VPC ID.

AvailabilityZones -> (list)

A list of Availability Zones.

(string)

SubnetIds -> (list)

A list of subnet IDs, if the stack is running in a VPC.

(string)

Ec2InstanceIds -> (list)

A list of the EC2 instances that the Elastic Load Balancing instance is managing traffic for.

(string)