elbv2

Documentation

Overview

Package elbv2 is a client for Elastic Load Balancing (v2).

Index

• type Client
• type CreateListenerParameters
  • func (input *CreateListenerParameters) SetCertificateARNs(arns []string)
• type CreateLoadBalancerParameters
• type CreateTargetGroupParameters
• type Listener
  • func (l Listener) String() string
• type Listeners
  • func (l Listeners) String() string
• type LoadBalancer
• type LoadBalancers
• type Rule
  • func (r Rule) String() string
• type SDKClient
  • func New(sess *session.Session) SDKClient
  • func (elbv2 SDKClient) AddRule(lbARN, targetGroupARN string, rule Rule)
  • func (elbv2 SDKClient) AddRuleToListener(listenerARN, targetGroupARN string, rule Rule)
  • func (elbv2 SDKClient) CreateListener(p CreateListenerParameters) (string, error)
  • func (elbv2 SDKClient) CreateLoadBalancer(p CreateLoadBalancerParameters) (string, error)
  • func (elbv2 SDKClient) CreateTargetGroup(i CreateTargetGroupParameters) (string, error)
  • func (elbv2 SDKClient) DeleteLoadBalancer(lbName string)
  • func (elbv2 SDKClient) DeleteRule(ruleARN string)
  • func (elbv2 SDKClient) DeleteTargetGroup(targetGroupName string)
  • func (elbv2 SDKClient) DeleteTargetGroupByArn(targetGroupARN string)
  • func (elbv2 SDKClient) DescribeListeners(lbARN string) (Listeners, error)
  • func (elbv2 SDKClient) DescribeLoadBalancer(lbName string) LoadBalancer
  • func (elbv2 SDKClient) DescribeLoadBalancerByARN(lbARN string) LoadBalancer
  • func (elbv2 SDKClient) DescribeLoadBalancers() (LoadBalancers, error)
  • func (elbv2 SDKClient) DescribeLoadBalancersByARN(lbARNs []string) (LoadBalancers, error)
  • func (elbv2 SDKClient) DescribeLoadBalancersByName(lbNames []string) (LoadBalancers, error)
  • func (elbv2 SDKClient) DescribeRules(listenerARN string) []Rule
  • func (elbv2 SDKClient) DescribeTargetGroups(targetGroupARNs []string) []TargetGroup
  • func (elbv2 SDKClient) GetHighestPriorityFromListener(listenerARN string) int64
  • func (elbv2 SDKClient) GetListeners(lbARN string) []Listener
  • func (elbv2 SDKClient) GetTargetGroupArn(targetGroupName string) string
  • func (elbv2 SDKClient) GetTargetGroupLoadBalancerArn(targetGroupARN string) string
  • func (elbv2 SDKClient) ModifyListenerDefaultAction(listenerARN, targetGroupARN string)
  • func (elbv2 SDKClient) ModifyLoadBalancerDefaultAction(lbARN, targetGroupARN string)
• type TargetGroup

Types

type Client

type Client interface {
	CreateListener(CreateListenerParameters) (string, error)
	DescribeListeners(string) (Listeners, error)

	DescribeLoadBalancers() (LoadBalancers, error)
	DescribeLoadBalancersByName([]string) (LoadBalancers, error)
	CreateLoadBalancer(CreateLoadBalancerParameters) (string, error)

	CreateTargetGroup(CreateTargetGroupParameters) (string, error)
}

Client represents a method for accessing Elastic Load Balancing (v2).

type CreateListenerParameters

type CreateListenerParameters struct {
	CertificateARNs       []string
	DefaultTargetGroupARN string
	LoadBalancerARN       string
	Port                  int64
	Protocol              string
}

CreateListenerParameters are the parameters required to create a new listener.

func (*CreateListenerParameters) SetCertificateARNs

func (input *CreateListenerParameters) SetCertificateARNs(arns []string)

SetCertificateARNs sets the certificate ARNs with the given ARNs.

type CreateLoadBalancerParameters

type CreateLoadBalancerParameters struct {
	Name             string
	SecurityGroupIDs []string
	SubnetIDs        []string
	Type             string
}

CreateLoadBalancerParameters are the parameters required to create a new load balancer.

type CreateTargetGroupParameters

type CreateTargetGroupParameters struct {
	Name     string
	Port     int64
	Protocol string
	VPCID    string
}

type Listener

type Listener struct {
	ARN             string
	CertificateARNs []string
	Port            int64
	Protocol        string
	Rules           []Rule
}

Listener accepts incoming traffic on a load balancer based upon the provided routing rules.

func (Listener) String

func (l Listener) String() string

String returns a friendly representation of the listener.

type Listeners

type Listeners []Listener

Listeners is a collection of listeners.

func (Listeners) String

func (l Listeners) String() string

Listeners returns a comma-separated friendly representation of the listeners.

type LoadBalancer

type LoadBalancer struct {
	ARN              string
	DNSName          string
	HostedZoneID     string
	Listeners        Listeners
	Name             string
	SecurityGroupIDs []string
	Status           string
	SubnetIDs        []string
	Type             string
	VPCID            string
}

LoadBalancer represents an Elastic Load Balancing (v2) load balancer.

type LoadBalancers

type LoadBalancers []LoadBalancer

LoadBalancers is a collection of Elastic Load Balancing (v2) load balancers.

type Rule

type Rule struct {
	ARN            string
	IsDefault      bool
	Priority       int
	TargetGroupARN string
	Type           string
	Value          string
}

Rule defines a routing rule defining how traffic should be routed to a listener.

func (Rule) String

func (r Rule) String() string

String returns a friendly representation of a rule.

type SDKClient

type SDKClient struct {
	// contains filtered or unexported fields
}

SDKClient implements access to Elastic Load Balancing (v2) via the AWS SDK.

func New

func New(sess *session.Session) SDKClient

New returns an SDKClient configured with the given session.

func (SDKClient) AddRule

func (elbv2 SDKClient) AddRule(lbARN, targetGroupARN string, rule Rule)

func (SDKClient) AddRuleToListener

func (elbv2 SDKClient) AddRuleToListener(listenerARN, targetGroupARN string, rule Rule)

func (SDKClient) CreateListener

func (elbv2 SDKClient) CreateListener(p CreateListenerParameters) (string, error)

CreateListener creates a new listener and returns the listener ARN if successfully created.

func (SDKClient) CreateLoadBalancer

func (elbv2 SDKClient) CreateLoadBalancer(p CreateLoadBalancerParameters) (string, error)

CreateLoadBalancer creates a new load balancer. It returns the ARN of the load balancer if it is successfully created.

func (SDKClient) CreateTargetGroup

func (elbv2 SDKClient) CreateTargetGroup(i CreateTargetGroupParameters) (string, error)

func (SDKClient) DeleteLoadBalancer

func (elbv2 SDKClient) DeleteLoadBalancer(lbName string)

func (SDKClient) DeleteRule

func (elbv2 SDKClient) DeleteRule(ruleARN string)

func (SDKClient) DeleteTargetGroup

func (elbv2 SDKClient) DeleteTargetGroup(targetGroupName string)

func (SDKClient) DeleteTargetGroupByArn

func (elbv2 SDKClient) DeleteTargetGroupByArn(targetGroupARN string)

func (SDKClient) DescribeListeners

func (elbv2 SDKClient) DescribeListeners(lbARN string) (Listeners, error)

DescribeListeners returns all of the listeners for a given load balancer ARN.

func (SDKClient) DescribeLoadBalancer

func (elbv2 SDKClient) DescribeLoadBalancer(lbName string) LoadBalancer

func (SDKClient) DescribeLoadBalancerByARN

func (elbv2 SDKClient) DescribeLoadBalancerByARN(lbARN string) LoadBalancer

func (SDKClient) DescribeLoadBalancers

func (elbv2 SDKClient) DescribeLoadBalancers() (LoadBalancers, error)

DescribeLoadBalancers returns all load balancers.

func (SDKClient) DescribeLoadBalancersByARN

func (elbv2 SDKClient) DescribeLoadBalancersByARN(lbARNs []string) (LoadBalancers, error)

DescribeLoadBalancersByARN returns load balancers that match the given load balancer ARNs.

func (SDKClient) DescribeLoadBalancersByName

func (elbv2 SDKClient) DescribeLoadBalancersByName(lbNames []string) (LoadBalancers, error)

DescribeLoadBalancersByName returns load balancers that match the given load balancer names.

func (SDKClient) DescribeRules

func (elbv2 SDKClient) DescribeRules(listenerARN string) []Rule

func (SDKClient) DescribeTargetGroups

func (elbv2 SDKClient) DescribeTargetGroups(targetGroupARNs []string) []TargetGroup

func (SDKClient) GetHighestPriorityFromListener

func (elbv2 SDKClient) GetHighestPriorityFromListener(listenerARN string) int64

func (SDKClient) GetListeners

func (elbv2 SDKClient) GetListeners(lbARN string) []Listener

func (SDKClient) GetTargetGroupArn

func (elbv2 SDKClient) GetTargetGroupArn(targetGroupName string) string

func (SDKClient) GetTargetGroupLoadBalancerArn

func (elbv2 SDKClient) GetTargetGroupLoadBalancerArn(targetGroupARN string) string

func (SDKClient) ModifyListenerDefaultAction

func (elbv2 SDKClient) ModifyListenerDefaultAction(listenerARN, targetGroupARN string)

func (SDKClient) ModifyLoadBalancerDefaultAction

func (elbv2 SDKClient) ModifyLoadBalancerDefaultAction(lbARN, targetGroupARN string)

type TargetGroup

type TargetGroup struct {
	Name            string
	Arn             string
	LoadBalancerARN string
}