doc.go 3.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
  2. // Package elbv2 provides the client and types for making API
  3. // requests to Elastic Load Balancing.
  4. //
  5. // A load balancer distributes incoming traffic across targets, such as your
  6. // EC2 instances. This enables you to increase the availability of your application.
  7. // The load balancer also monitors the health of its registered targets and
  8. // ensures that it routes traffic only to healthy targets. You configure your
  9. // load balancer to accept incoming traffic by specifying one or more listeners,
  10. // which are configured with a protocol and port number for connections from
  11. // clients to the load balancer. You configure a target group with a protocol
  12. // and port number for connections from the load balancer to the targets, and
  13. // with health check settings to be used when checking the health status of
  14. // the targets.
  15. //
  16. // Elastic Load Balancing supports the following types of load balancers: Application
  17. // Load Balancers, Network Load Balancers, and Classic Load Balancers.
  18. //
  19. // An Application Load Balancer makes routing and load balancing decisions at
  20. // the application layer (HTTP/HTTPS). A Network Load Balancer makes routing
  21. // and load balancing decisions at the transport layer (TCP/TLS). Both Application
  22. // Load Balancers and Network Load Balancers can route requests to one or more
  23. // ports on each EC2 instance or container instance in your virtual private
  24. // cloud (VPC).
  25. //
  26. // A Classic Load Balancer makes routing and load balancing decisions either
  27. // at the transport layer (TCP/SSL) or the application layer (HTTP/HTTPS), and
  28. // supports either EC2-Classic or a VPC. For more information, see the Elastic
  29. // Load Balancing User Guide (http://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/).
  30. //
  31. // This reference covers the 2015-12-01 API, which supports Application Load
  32. // Balancers and Network Load Balancers. The 2012-06-01 API supports Classic
  33. // Load Balancers.
  34. //
  35. // To get started, complete the following tasks:
  36. //
  37. // Create a load balancer using CreateLoadBalancer.
  38. //
  39. // Create a target group using CreateTargetGroup.
  40. //
  41. // Register targets for the target group using RegisterTargets.
  42. //
  43. // Create one or more listeners for your load balancer using CreateListener.
  44. //
  45. // To delete a load balancer and its related resources, complete the following
  46. // tasks:
  47. //
  48. // Delete the load balancer using DeleteLoadBalancer.
  49. //
  50. // Delete the target group using DeleteTargetGroup.
  51. //
  52. // All Elastic Load Balancing operations are idempotent, which means that they
  53. // complete at most one time. If you repeat an operation, it succeeds.
  54. //
  55. // See https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01 for more information on this service.
  56. //
  57. // See elbv2 package documentation for more information.
  58. // https://docs.aws.amazon.com/sdk-for-go/api/service/elbv2/
  59. //
  60. // Using the Client
  61. //
  62. // To contact Elastic Load Balancing with the SDK use the New function to create
  63. // a new service client. With that client you can make API requests to the service.
  64. // These clients are safe to use concurrently.
  65. //
  66. // See the SDK's documentation for more information on how to use the SDK.
  67. // https://docs.aws.amazon.com/sdk-for-go/api/
  68. //
  69. // See aws.Config documentation for more information on configuring SDK clients.
  70. // https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
  71. //
  72. // See the Elastic Load Balancing client ELBV2 for more
  73. // information on creating client for this service.
  74. // https://docs.aws.amazon.com/sdk-for-go/api/service/elbv2/#New
  75. package elbv2