elbv2

package
v1.38.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 24, 2021 License: Apache-2.0 Imports: 10 Imported by: 825

Documentation

Overview

Package elbv2 provides the client and types for making API requests to Elastic Load Balancing.

A load balancer distributes incoming traffic across targets, such as your EC2 instances. This enables you to increase the availability of your application. The load balancer also monitors the health of its registered targets and ensures that it routes traffic only to healthy targets. You configure your load balancer to accept incoming traffic by specifying one or more listeners, which are configured with a protocol and port number for connections from clients to the load balancer. You configure a target group with a protocol and port number for connections from the load balancer to the targets, and with health check settings to be used when checking the health status of the targets.

Elastic Load Balancing supports the following types of load balancers: Application Load Balancers, Network Load Balancers, Gateway Load Balancers, and Classic Load Balancers. This reference covers the following load balancer types:

  • Application Load Balancer - Operates at the application layer (layer 7) and supports HTTP and HTTPS.

  • Network Load Balancer - Operates at the transport layer (layer 4) and supports TCP, TLS, and UDP.

  • Gateway Load Balancer - Operates at the network layer (layer 3).

For more information, see the Elastic Load Balancing User Guide (https://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/).

All Elastic Load Balancing operations are idempotent, which means that they complete at most one time. If you repeat an operation, it succeeds.

See https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01 for more information on this service.

See elbv2 package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/elbv2/

Using the Client

To contact Elastic Load Balancing with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Elastic Load Balancing client ELBV2 for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/elbv2/#New

Index

Examples

Constants

View Source
const (
	// ActionTypeEnumForward is a ActionTypeEnum enum value
	ActionTypeEnumForward = "forward"

	// ActionTypeEnumAuthenticateOidc is a ActionTypeEnum enum value
	ActionTypeEnumAuthenticateOidc = "authenticate-oidc"

	// ActionTypeEnumAuthenticateCognito is a ActionTypeEnum enum value
	ActionTypeEnumAuthenticateCognito = "authenticate-cognito"

	// ActionTypeEnumRedirect is a ActionTypeEnum enum value
	ActionTypeEnumRedirect = "redirect"

	// ActionTypeEnumFixedResponse is a ActionTypeEnum enum value
	ActionTypeEnumFixedResponse = "fixed-response"
)
View Source
const (
	// AuthenticateCognitoActionConditionalBehaviorEnumDeny is a AuthenticateCognitoActionConditionalBehaviorEnum enum value
	AuthenticateCognitoActionConditionalBehaviorEnumDeny = "deny"

	// AuthenticateCognitoActionConditionalBehaviorEnumAllow is a AuthenticateCognitoActionConditionalBehaviorEnum enum value
	AuthenticateCognitoActionConditionalBehaviorEnumAllow = "allow"

	// AuthenticateCognitoActionConditionalBehaviorEnumAuthenticate is a AuthenticateCognitoActionConditionalBehaviorEnum enum value
	AuthenticateCognitoActionConditionalBehaviorEnumAuthenticate = "authenticate"
)
View Source
const (
	// AuthenticateOidcActionConditionalBehaviorEnumDeny is a AuthenticateOidcActionConditionalBehaviorEnum enum value
	AuthenticateOidcActionConditionalBehaviorEnumDeny = "deny"

	// AuthenticateOidcActionConditionalBehaviorEnumAllow is a AuthenticateOidcActionConditionalBehaviorEnum enum value
	AuthenticateOidcActionConditionalBehaviorEnumAllow = "allow"

	// AuthenticateOidcActionConditionalBehaviorEnumAuthenticate is a AuthenticateOidcActionConditionalBehaviorEnum enum value
	AuthenticateOidcActionConditionalBehaviorEnumAuthenticate = "authenticate"
)
View Source
const (
	// IpAddressTypeIpv4 is a IpAddressType enum value
	IpAddressTypeIpv4 = "ipv4"

	// IpAddressTypeDualstack is a IpAddressType enum value
	IpAddressTypeDualstack = "dualstack"
)
View Source
const (
	// LoadBalancerSchemeEnumInternetFacing is a LoadBalancerSchemeEnum enum value
	LoadBalancerSchemeEnumInternetFacing = "internet-facing"

	// LoadBalancerSchemeEnumInternal is a LoadBalancerSchemeEnum enum value
	LoadBalancerSchemeEnumInternal = "internal"
)
View Source
const (
	// LoadBalancerStateEnumActive is a LoadBalancerStateEnum enum value
	LoadBalancerStateEnumActive = "active"

	// LoadBalancerStateEnumProvisioning is a LoadBalancerStateEnum enum value
	LoadBalancerStateEnumProvisioning = "provisioning"

	// LoadBalancerStateEnumActiveImpaired is a LoadBalancerStateEnum enum value
	LoadBalancerStateEnumActiveImpaired = "active_impaired"

	// LoadBalancerStateEnumFailed is a LoadBalancerStateEnum enum value
	LoadBalancerStateEnumFailed = "failed"
)
View Source
const (
	// LoadBalancerTypeEnumApplication is a LoadBalancerTypeEnum enum value
	LoadBalancerTypeEnumApplication = "application"

	// LoadBalancerTypeEnumNetwork is a LoadBalancerTypeEnum enum value
	LoadBalancerTypeEnumNetwork = "network"

	// LoadBalancerTypeEnumGateway is a LoadBalancerTypeEnum enum value
	LoadBalancerTypeEnumGateway = "gateway"
)
View Source
const (
	// ProtocolEnumHttp is a ProtocolEnum enum value
	ProtocolEnumHttp = "HTTP"

	// ProtocolEnumHttps is a ProtocolEnum enum value
	ProtocolEnumHttps = "HTTPS"

	// ProtocolEnumTcp is a ProtocolEnum enum value
	ProtocolEnumTcp = "TCP"

	// ProtocolEnumTls is a ProtocolEnum enum value
	ProtocolEnumTls = "TLS"

	// ProtocolEnumUdp is a ProtocolEnum enum value
	ProtocolEnumUdp = "UDP"

	// ProtocolEnumTcpUdp is a ProtocolEnum enum value
	ProtocolEnumTcpUdp = "TCP_UDP"

	// ProtocolEnumGeneve is a ProtocolEnum enum value
	ProtocolEnumGeneve = "GENEVE"
)
View Source
const (
	// RedirectActionStatusCodeEnumHttp301 is a RedirectActionStatusCodeEnum enum value
	RedirectActionStatusCodeEnumHttp301 = "HTTP_301"

	// RedirectActionStatusCodeEnumHttp302 is a RedirectActionStatusCodeEnum enum value
	RedirectActionStatusCodeEnumHttp302 = "HTTP_302"
)
View Source
const (
	// TargetHealthReasonEnumElbRegistrationInProgress is a TargetHealthReasonEnum enum value
	TargetHealthReasonEnumElbRegistrationInProgress = "Elb.RegistrationInProgress"

	// TargetHealthReasonEnumElbInitialHealthChecking is a TargetHealthReasonEnum enum value
	TargetHealthReasonEnumElbInitialHealthChecking = "Elb.InitialHealthChecking"

	// TargetHealthReasonEnumTargetResponseCodeMismatch is a TargetHealthReasonEnum enum value
	TargetHealthReasonEnumTargetResponseCodeMismatch = "Target.ResponseCodeMismatch"

	// TargetHealthReasonEnumTargetTimeout is a TargetHealthReasonEnum enum value
	TargetHealthReasonEnumTargetTimeout = "Target.Timeout"

	// TargetHealthReasonEnumTargetFailedHealthChecks is a TargetHealthReasonEnum enum value
	TargetHealthReasonEnumTargetFailedHealthChecks = "Target.FailedHealthChecks"

	// TargetHealthReasonEnumTargetNotRegistered is a TargetHealthReasonEnum enum value
	TargetHealthReasonEnumTargetNotRegistered = "Target.NotRegistered"

	// TargetHealthReasonEnumTargetNotInUse is a TargetHealthReasonEnum enum value
	TargetHealthReasonEnumTargetNotInUse = "Target.NotInUse"

	// TargetHealthReasonEnumTargetDeregistrationInProgress is a TargetHealthReasonEnum enum value
	TargetHealthReasonEnumTargetDeregistrationInProgress = "Target.DeregistrationInProgress"

	// TargetHealthReasonEnumTargetInvalidState is a TargetHealthReasonEnum enum value
	TargetHealthReasonEnumTargetInvalidState = "Target.InvalidState"

	// TargetHealthReasonEnumTargetIpUnusable is a TargetHealthReasonEnum enum value
	TargetHealthReasonEnumTargetIpUnusable = "Target.IpUnusable"

	// TargetHealthReasonEnumTargetHealthCheckDisabled is a TargetHealthReasonEnum enum value
	TargetHealthReasonEnumTargetHealthCheckDisabled = "Target.HealthCheckDisabled"

	// TargetHealthReasonEnumElbInternalError is a TargetHealthReasonEnum enum value
	TargetHealthReasonEnumElbInternalError = "Elb.InternalError"
)
View Source
const (
	// TargetHealthStateEnumInitial is a TargetHealthStateEnum enum value
	TargetHealthStateEnumInitial = "initial"

	// TargetHealthStateEnumHealthy is a TargetHealthStateEnum enum value
	TargetHealthStateEnumHealthy = "healthy"

	// TargetHealthStateEnumUnhealthy is a TargetHealthStateEnum enum value
	TargetHealthStateEnumUnhealthy = "unhealthy"

	// TargetHealthStateEnumUnused is a TargetHealthStateEnum enum value
	TargetHealthStateEnumUnused = "unused"

	// TargetHealthStateEnumDraining is a TargetHealthStateEnum enum value
	TargetHealthStateEnumDraining = "draining"

	// TargetHealthStateEnumUnavailable is a TargetHealthStateEnum enum value
	TargetHealthStateEnumUnavailable = "unavailable"
)
View Source
const (
	// TargetTypeEnumInstance is a TargetTypeEnum enum value
	TargetTypeEnumInstance = "instance"

	// TargetTypeEnumIp is a TargetTypeEnum enum value
	TargetTypeEnumIp = "ip"

	// TargetTypeEnumLambda is a TargetTypeEnum enum value
	TargetTypeEnumLambda = "lambda"
)
View Source
const (

	// ErrCodeALPNPolicyNotSupportedException for service response error code
	// "ALPNPolicyNotFound".
	//
	// The specified ALPN policy is not supported.
	ErrCodeALPNPolicyNotSupportedException = "ALPNPolicyNotFound"

	// ErrCodeAllocationIdNotFoundException for service response error code
	// "AllocationIdNotFound".
	//
	// The specified allocation ID does not exist.
	ErrCodeAllocationIdNotFoundException = "AllocationIdNotFound"

	// ErrCodeAvailabilityZoneNotSupportedException for service response error code
	// "AvailabilityZoneNotSupported".
	//
	// The specified Availability Zone is not supported.
	ErrCodeAvailabilityZoneNotSupportedException = "AvailabilityZoneNotSupported"

	// ErrCodeCertificateNotFoundException for service response error code
	// "CertificateNotFound".
	//
	// The specified certificate does not exist.
	ErrCodeCertificateNotFoundException = "CertificateNotFound"

	// ErrCodeDuplicateListenerException for service response error code
	// "DuplicateListener".
	//
	// A listener with the specified port already exists.
	ErrCodeDuplicateListenerException = "DuplicateListener"

	// ErrCodeDuplicateLoadBalancerNameException for service response error code
	// "DuplicateLoadBalancerName".
	//
	// A load balancer with the specified name already exists.
	ErrCodeDuplicateLoadBalancerNameException = "DuplicateLoadBalancerName"

	// ErrCodeDuplicateTagKeysException for service response error code
	// "DuplicateTagKeys".
	//
	// A tag key was specified more than once.
	ErrCodeDuplicateTagKeysException = "DuplicateTagKeys"

	// ErrCodeDuplicateTargetGroupNameException for service response error code
	// "DuplicateTargetGroupName".
	//
	// A target group with the specified name already exists.
	ErrCodeDuplicateTargetGroupNameException = "DuplicateTargetGroupName"

	// ErrCodeHealthUnavailableException for service response error code
	// "HealthUnavailable".
	//
	// The health of the specified targets could not be retrieved due to an internal
	// error.
	ErrCodeHealthUnavailableException = "HealthUnavailable"

	// ErrCodeIncompatibleProtocolsException for service response error code
	// "IncompatibleProtocols".
	//
	// The specified configuration is not valid with this protocol.
	ErrCodeIncompatibleProtocolsException = "IncompatibleProtocols"

	// ErrCodeInvalidConfigurationRequestException for service response error code
	// "InvalidConfigurationRequest".
	//
	// The requested configuration is not valid.
	ErrCodeInvalidConfigurationRequestException = "InvalidConfigurationRequest"

	// ErrCodeInvalidLoadBalancerActionException for service response error code
	// "InvalidLoadBalancerAction".
	//
	// The requested action is not valid.
	ErrCodeInvalidLoadBalancerActionException = "InvalidLoadBalancerAction"

	// ErrCodeInvalidSchemeException for service response error code
	// "InvalidScheme".
	//
	// The requested scheme is not valid.
	ErrCodeInvalidSchemeException = "InvalidScheme"

	// ErrCodeInvalidSecurityGroupException for service response error code
	// "InvalidSecurityGroup".
	//
	// The specified security group does not exist.
	ErrCodeInvalidSecurityGroupException = "InvalidSecurityGroup"

	// ErrCodeInvalidSubnetException for service response error code
	// "InvalidSubnet".
	//
	// The specified subnet is out of available addresses.
	ErrCodeInvalidSubnetException = "InvalidSubnet"

	// ErrCodeInvalidTargetException for service response error code
	// "InvalidTarget".
	//
	// The specified target does not exist, is not in the same VPC as the target
	// group, or has an unsupported instance type.
	ErrCodeInvalidTargetException = "InvalidTarget"

	// ErrCodeListenerNotFoundException for service response error code
	// "ListenerNotFound".
	//
	// The specified listener does not exist.
	ErrCodeListenerNotFoundException = "ListenerNotFound"

	// ErrCodeLoadBalancerNotFoundException for service response error code
	// "LoadBalancerNotFound".
	//
	// The specified load balancer does not exist.
	ErrCodeLoadBalancerNotFoundException = "LoadBalancerNotFound"

	// ErrCodeOperationNotPermittedException for service response error code
	// "OperationNotPermitted".
	//
	// This operation is not allowed.
	ErrCodeOperationNotPermittedException = "OperationNotPermitted"

	// ErrCodePriorityInUseException for service response error code
	// "PriorityInUse".
	//
	// The specified priority is in use.
	ErrCodePriorityInUseException = "PriorityInUse"

	// ErrCodeResourceInUseException for service response error code
	// "ResourceInUse".
	//
	// A specified resource is in use.
	ErrCodeResourceInUseException = "ResourceInUse"

	// ErrCodeRuleNotFoundException for service response error code
	// "RuleNotFound".
	//
	// The specified rule does not exist.
	ErrCodeRuleNotFoundException = "RuleNotFound"

	// ErrCodeSSLPolicyNotFoundException for service response error code
	// "SSLPolicyNotFound".
	//
	// The specified SSL policy does not exist.
	ErrCodeSSLPolicyNotFoundException = "SSLPolicyNotFound"

	// ErrCodeSubnetNotFoundException for service response error code
	// "SubnetNotFound".
	//
	// The specified subnet does not exist.
	ErrCodeSubnetNotFoundException = "SubnetNotFound"

	// ErrCodeTargetGroupAssociationLimitException for service response error code
	// "TargetGroupAssociationLimit".
	//
	// You've reached the limit on the number of load balancers per target group.
	ErrCodeTargetGroupAssociationLimitException = "TargetGroupAssociationLimit"

	// ErrCodeTargetGroupNotFoundException for service response error code
	// "TargetGroupNotFound".
	//
	// The specified target group does not exist.
	ErrCodeTargetGroupNotFoundException = "TargetGroupNotFound"

	// ErrCodeTooManyActionsException for service response error code
	// "TooManyActions".
	//
	// You've reached the limit on the number of actions per rule.
	ErrCodeTooManyActionsException = "TooManyActions"

	// ErrCodeTooManyCertificatesException for service response error code
	// "TooManyCertificates".
	//
	// You've reached the limit on the number of certificates per load balancer.
	ErrCodeTooManyCertificatesException = "TooManyCertificates"

	// ErrCodeTooManyListenersException for service response error code
	// "TooManyListeners".
	//
	// You've reached the limit on the number of listeners per load balancer.
	ErrCodeTooManyListenersException = "TooManyListeners"

	// ErrCodeTooManyLoadBalancersException for service response error code
	// "TooManyLoadBalancers".
	//
	// You've reached the limit on the number of load balancers for your AWS account.
	ErrCodeTooManyLoadBalancersException = "TooManyLoadBalancers"

	// ErrCodeTooManyRegistrationsForTargetIdException for service response error code
	// "TooManyRegistrationsForTargetId".
	//
	// You've reached the limit on the number of times a target can be registered
	// with a load balancer.
	ErrCodeTooManyRegistrationsForTargetIdException = "TooManyRegistrationsForTargetId"

	// ErrCodeTooManyRulesException for service response error code
	// "TooManyRules".
	//
	// You've reached the limit on the number of rules per load balancer.
	ErrCodeTooManyRulesException = "TooManyRules"

	// ErrCodeTooManyTagsException for service response error code
	// "TooManyTags".
	//
	// You've reached the limit on the number of tags per load balancer.
	ErrCodeTooManyTagsException = "TooManyTags"

	// ErrCodeTooManyTargetGroupsException for service response error code
	// "TooManyTargetGroups".
	//
	// You've reached the limit on the number of target groups for your AWS account.
	ErrCodeTooManyTargetGroupsException = "TooManyTargetGroups"

	// ErrCodeTooManyTargetsException for service response error code
	// "TooManyTargets".
	//
	// You've reached the limit on the number of targets.
	ErrCodeTooManyTargetsException = "TooManyTargets"

	// ErrCodeTooManyUniqueTargetGroupsPerLoadBalancerException for service response error code
	// "TooManyUniqueTargetGroupsPerLoadBalancer".
	//
	// You've reached the limit on the number of unique target groups per load balancer
	// across all listeners. If a target group is used by multiple actions for a
	// load balancer, it is counted as only one use.
	ErrCodeTooManyUniqueTargetGroupsPerLoadBalancerException = "TooManyUniqueTargetGroupsPerLoadBalancer"

	// ErrCodeUnsupportedProtocolException for service response error code
	// "UnsupportedProtocol".
	//
	// The specified protocol is not supported.
	ErrCodeUnsupportedProtocolException = "UnsupportedProtocol"
)
View Source
const (
	ServiceName = "elasticloadbalancing"      // Name of service.
	EndpointsID = ServiceName                 // ID to lookup a service endpoint with.
	ServiceID   = "Elastic Load Balancing v2" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func ActionTypeEnum_Values added in v1.34.3

func ActionTypeEnum_Values() []string

ActionTypeEnum_Values returns all elements of the ActionTypeEnum enum

func AuthenticateCognitoActionConditionalBehaviorEnum_Values added in v1.34.3

func AuthenticateCognitoActionConditionalBehaviorEnum_Values() []string

AuthenticateCognitoActionConditionalBehaviorEnum_Values returns all elements of the AuthenticateCognitoActionConditionalBehaviorEnum enum

func AuthenticateOidcActionConditionalBehaviorEnum_Values added in v1.34.3

func AuthenticateOidcActionConditionalBehaviorEnum_Values() []string

AuthenticateOidcActionConditionalBehaviorEnum_Values returns all elements of the AuthenticateOidcActionConditionalBehaviorEnum enum

func IpAddressType_Values added in v1.34.3

func IpAddressType_Values() []string

IpAddressType_Values returns all elements of the IpAddressType enum

func LoadBalancerSchemeEnum_Values added in v1.34.3

func LoadBalancerSchemeEnum_Values() []string

LoadBalancerSchemeEnum_Values returns all elements of the LoadBalancerSchemeEnum enum

func LoadBalancerStateEnum_Values added in v1.34.3

func LoadBalancerStateEnum_Values() []string

LoadBalancerStateEnum_Values returns all elements of the LoadBalancerStateEnum enum

func LoadBalancerTypeEnum_Values added in v1.34.3

func LoadBalancerTypeEnum_Values() []string

LoadBalancerTypeEnum_Values returns all elements of the LoadBalancerTypeEnum enum

func ProtocolEnum_Values added in v1.34.3

func ProtocolEnum_Values() []string

ProtocolEnum_Values returns all elements of the ProtocolEnum enum

func RedirectActionStatusCodeEnum_Values added in v1.34.3

func RedirectActionStatusCodeEnum_Values() []string

RedirectActionStatusCodeEnum_Values returns all elements of the RedirectActionStatusCodeEnum enum

func TargetHealthReasonEnum_Values added in v1.34.3

func TargetHealthReasonEnum_Values() []string

TargetHealthReasonEnum_Values returns all elements of the TargetHealthReasonEnum enum

func TargetHealthStateEnum_Values added in v1.34.3

func TargetHealthStateEnum_Values() []string

TargetHealthStateEnum_Values returns all elements of the TargetHealthStateEnum enum

func TargetTypeEnum_Values added in v1.34.3

func TargetTypeEnum_Values() []string

TargetTypeEnum_Values returns all elements of the TargetTypeEnum enum

Types

type Action

type Action struct {

	// [HTTPS listeners] Information for using Amazon Cognito to authenticate users.
	// Specify only when Type is authenticate-cognito.
	AuthenticateCognitoConfig *AuthenticateCognitoActionConfig `type:"structure"`

	// [HTTPS listeners] Information about an identity provider that is compliant
	// with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc.
	AuthenticateOidcConfig *AuthenticateOidcActionConfig `type:"structure"`

	// [Application Load Balancer] Information for creating an action that returns
	// a custom HTTP response. Specify only when Type is fixed-response.
	FixedResponseConfig *FixedResponseActionConfig `type:"structure"`

	// Information for creating an action that distributes requests among one or
	// more target groups. For Network Load Balancers, you can specify a single
	// target group. Specify only when Type is forward. If you specify both ForwardConfig
	// and TargetGroupArn, you can specify only one target group using ForwardConfig
	// and it must be the same target group specified in TargetGroupArn.
	ForwardConfig *ForwardActionConfig `type:"structure"`

	// The order for the action. This value is required for rules with multiple
	// actions. The action with the lowest value for order is performed first.
	Order *int64 `min:"1" type:"integer"`

	// [Application Load Balancer] Information for creating a redirect action. Specify
	// only when Type is redirect.
	RedirectConfig *RedirectActionConfig `type:"structure"`

	// The Amazon Resource Name (ARN) of the target group. Specify only when Type
	// is forward and you want to route to a single target group. To route to one
	// or more target groups, use ForwardConfig instead.
	TargetGroupArn *string `type:"string"`

	// The type of action.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"ActionTypeEnum"`
	// contains filtered or unexported fields
}

Information about an action.

Each rule must include exactly one of the following types of actions: forward, fixed-response, or redirect, and it must be the last action to be performed.

func (Action) GoString

func (s Action) GoString() string

GoString returns the string representation

func (*Action) SetAuthenticateCognitoConfig added in v1.13.58

func (s *Action) SetAuthenticateCognitoConfig(v *AuthenticateCognitoActionConfig) *Action

SetAuthenticateCognitoConfig sets the AuthenticateCognitoConfig field's value.

func (*Action) SetAuthenticateOidcConfig added in v1.13.58

func (s *Action) SetAuthenticateOidcConfig(v *AuthenticateOidcActionConfig) *Action

SetAuthenticateOidcConfig sets the AuthenticateOidcConfig field's value.

func (*Action) SetFixedResponseConfig added in v1.14.33

func (s *Action) SetFixedResponseConfig(v *FixedResponseActionConfig) *Action

SetFixedResponseConfig sets the FixedResponseConfig field's value.

func (*Action) SetForwardConfig added in v1.25.38

func (s *Action) SetForwardConfig(v *ForwardActionConfig) *Action

SetForwardConfig sets the ForwardConfig field's value.

func (*Action) SetOrder added in v1.13.58

func (s *Action) SetOrder(v int64) *Action

SetOrder sets the Order field's value.

func (*Action) SetRedirectConfig added in v1.14.33

func (s *Action) SetRedirectConfig(v *RedirectActionConfig) *Action

SetRedirectConfig sets the RedirectConfig field's value.

func (*Action) SetTargetGroupArn added in v1.5.0

func (s *Action) SetTargetGroupArn(v string) *Action

SetTargetGroupArn sets the TargetGroupArn field's value.

func (*Action) SetType added in v1.5.0

func (s *Action) SetType(v string) *Action

SetType sets the Type field's value.

func (Action) String

func (s Action) String() string

String returns the string representation

func (*Action) Validate

func (s *Action) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AddListenerCertificatesInput added in v1.12.8

type AddListenerCertificatesInput struct {

	// The certificate to add. You can specify one certificate per call. Set CertificateArn
	// to the certificate ARN but do not set IsDefault.
	//
	// Certificates is a required field
	Certificates []*Certificate `type:"list" required:"true"`

	// The Amazon Resource Name (ARN) of the listener.
	//
	// ListenerArn is a required field
	ListenerArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AddListenerCertificatesInput) GoString added in v1.12.8

func (s AddListenerCertificatesInput) GoString() string

GoString returns the string representation

func (*AddListenerCertificatesInput) SetCertificates added in v1.12.8

SetCertificates sets the Certificates field's value.

func (*AddListenerCertificatesInput) SetListenerArn added in v1.12.8

SetListenerArn sets the ListenerArn field's value.

func (AddListenerCertificatesInput) String added in v1.12.8

String returns the string representation

func (*AddListenerCertificatesInput) Validate added in v1.12.8

func (s *AddListenerCertificatesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AddListenerCertificatesOutput added in v1.12.8

type AddListenerCertificatesOutput struct {

	// Information about the certificates in the certificate list.
	Certificates []*Certificate `type:"list"`
	// contains filtered or unexported fields
}

func (AddListenerCertificatesOutput) GoString added in v1.12.8

GoString returns the string representation

func (*AddListenerCertificatesOutput) SetCertificates added in v1.12.8

SetCertificates sets the Certificates field's value.

func (AddListenerCertificatesOutput) String added in v1.12.8

String returns the string representation

type AddTagsInput

type AddTagsInput struct {

	// The Amazon Resource Name (ARN) of the resource.
	//
	// ResourceArns is a required field
	ResourceArns []*string `type:"list" required:"true"`

	// The tags.
	//
	// Tags is a required field
	Tags []*Tag `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (AddTagsInput) GoString

func (s AddTagsInput) GoString() string

GoString returns the string representation

func (*AddTagsInput) SetResourceArns added in v1.5.0

func (s *AddTagsInput) SetResourceArns(v []*string) *AddTagsInput

SetResourceArns sets the ResourceArns field's value.

func (*AddTagsInput) SetTags added in v1.5.0

func (s *AddTagsInput) SetTags(v []*Tag) *AddTagsInput

SetTags sets the Tags field's value.

func (AddTagsInput) String

func (s AddTagsInput) String() string

String returns the string representation

func (*AddTagsInput) Validate

func (s *AddTagsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AddTagsOutput

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

func (AddTagsOutput) GoString

func (s AddTagsOutput) GoString() string

GoString returns the string representation

func (AddTagsOutput) String

func (s AddTagsOutput) String() string

String returns the string representation

type AuthenticateCognitoActionConfig added in v1.13.58

type AuthenticateCognitoActionConfig struct {

	// The query parameters (up to 10) to include in the redirect request to the
	// authorization endpoint.
	AuthenticationRequestExtraParams map[string]*string `type:"map"`

	// The behavior if the user is not authenticated. The following are possible
	// values:
	//
	//    * deny - Return an HTTP 401 Unauthorized error.
	//
	//    * allow - Allow the request to be forwarded to the target.
	//
	//    * authenticate - Redirect the request to the IdP authorization endpoint.
	//    This is the default value.
	OnUnauthenticatedRequest *string `type:"string" enum:"AuthenticateCognitoActionConditionalBehaviorEnum"`

	// The set of user claims to be requested from the IdP. The default is openid.
	//
	// To verify which scope values your IdP supports and how to separate multiple
	// values, see the documentation for your IdP.
	Scope *string `type:"string"`

	// The name of the cookie used to maintain session information. The default
	// is AWSELBAuthSessionCookie.
	SessionCookieName *string `type:"string"`

	// The maximum duration of the authentication session, in seconds. The default
	// is 604800 seconds (7 days).
	SessionTimeout *int64 `type:"long"`

	// The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
	//
	// UserPoolArn is a required field
	UserPoolArn *string `type:"string" required:"true"`

	// The ID of the Amazon Cognito user pool client.
	//
	// UserPoolClientId is a required field
	UserPoolClientId *string `type:"string" required:"true"`

	// The domain prefix or fully-qualified domain name of the Amazon Cognito user
	// pool.
	//
	// UserPoolDomain is a required field
	UserPoolDomain *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request parameters to use when integrating with Amazon Cognito to authenticate users.

func (AuthenticateCognitoActionConfig) GoString added in v1.13.58

GoString returns the string representation

func (*AuthenticateCognitoActionConfig) SetAuthenticationRequestExtraParams added in v1.13.58

func (s *AuthenticateCognitoActionConfig) SetAuthenticationRequestExtraParams(v map[string]*string) *AuthenticateCognitoActionConfig

SetAuthenticationRequestExtraParams sets the AuthenticationRequestExtraParams field's value.

func (*AuthenticateCognitoActionConfig) SetOnUnauthenticatedRequest added in v1.13.58

func (s *AuthenticateCognitoActionConfig) SetOnUnauthenticatedRequest(v string) *AuthenticateCognitoActionConfig

SetOnUnauthenticatedRequest sets the OnUnauthenticatedRequest field's value.

func (*AuthenticateCognitoActionConfig) SetScope added in v1.13.58

SetScope sets the Scope field's value.

func (*AuthenticateCognitoActionConfig) SetSessionCookieName added in v1.13.58

SetSessionCookieName sets the SessionCookieName field's value.

func (*AuthenticateCognitoActionConfig) SetSessionTimeout added in v1.13.58

SetSessionTimeout sets the SessionTimeout field's value.

func (*AuthenticateCognitoActionConfig) SetUserPoolArn added in v1.13.58

SetUserPoolArn sets the UserPoolArn field's value.

func (*AuthenticateCognitoActionConfig) SetUserPoolClientId added in v1.13.58

SetUserPoolClientId sets the UserPoolClientId field's value.

func (*AuthenticateCognitoActionConfig) SetUserPoolDomain added in v1.13.58

SetUserPoolDomain sets the UserPoolDomain field's value.

func (AuthenticateCognitoActionConfig) String added in v1.13.58

String returns the string representation

func (*AuthenticateCognitoActionConfig) Validate added in v1.13.58

func (s *AuthenticateCognitoActionConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AuthenticateOidcActionConfig added in v1.13.58

type AuthenticateOidcActionConfig struct {

	// The query parameters (up to 10) to include in the redirect request to the
	// authorization endpoint.
	AuthenticationRequestExtraParams map[string]*string `type:"map"`

	// The authorization endpoint of the IdP. This must be a full URL, including
	// the HTTPS protocol, the domain, and the path.
	//
	// AuthorizationEndpoint is a required field
	AuthorizationEndpoint *string `type:"string" required:"true"`

	// The OAuth 2.0 client identifier.
	//
	// ClientId is a required field
	ClientId *string `type:"string" required:"true"`

	// The OAuth 2.0 client secret. This parameter is required if you are creating
	// a rule. If you are modifying a rule, you can omit this parameter if you set
	// UseExistingClientSecret to true.
	ClientSecret *string `type:"string"`

	// The OIDC issuer identifier of the IdP. This must be a full URL, including
	// the HTTPS protocol, the domain, and the path.
	//
	// Issuer is a required field
	Issuer *string `type:"string" required:"true"`

	// The behavior if the user is not authenticated. The following are possible
	// values:
	//
	//    * deny - Return an HTTP 401 Unauthorized error.
	//
	//    * allow - Allow the request to be forwarded to the target.
	//
	//    * authenticate - Redirect the request to the IdP authorization endpoint.
	//    This is the default value.
	OnUnauthenticatedRequest *string `type:"string" enum:"AuthenticateOidcActionConditionalBehaviorEnum"`

	// The set of user claims to be requested from the IdP. The default is openid.
	//
	// To verify which scope values your IdP supports and how to separate multiple
	// values, see the documentation for your IdP.
	Scope *string `type:"string"`

	// The name of the cookie used to maintain session information. The default
	// is AWSELBAuthSessionCookie.
	SessionCookieName *string `type:"string"`

	// The maximum duration of the authentication session, in seconds. The default
	// is 604800 seconds (7 days).
	SessionTimeout *int64 `type:"long"`

	// The token endpoint of the IdP. This must be a full URL, including the HTTPS
	// protocol, the domain, and the path.
	//
	// TokenEndpoint is a required field
	TokenEndpoint *string `type:"string" required:"true"`

	// Indicates whether to use the existing client secret when modifying a rule.
	// If you are creating a rule, you can omit this parameter or set it to false.
	UseExistingClientSecret *bool `type:"boolean"`

	// The user info endpoint of the IdP. This must be a full URL, including the
	// HTTPS protocol, the domain, and the path.
	//
	// UserInfoEndpoint is a required field
	UserInfoEndpoint *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request parameters when using an identity provider (IdP) that is compliant with OpenID Connect (OIDC) to authenticate users.

func (AuthenticateOidcActionConfig) GoString added in v1.13.58

func (s AuthenticateOidcActionConfig) GoString() string

GoString returns the string representation

func (*AuthenticateOidcActionConfig) SetAuthenticationRequestExtraParams added in v1.13.58

func (s *AuthenticateOidcActionConfig) SetAuthenticationRequestExtraParams(v map[string]*string) *AuthenticateOidcActionConfig

SetAuthenticationRequestExtraParams sets the AuthenticationRequestExtraParams field's value.

func (*AuthenticateOidcActionConfig) SetAuthorizationEndpoint added in v1.13.58

func (s *AuthenticateOidcActionConfig) SetAuthorizationEndpoint(v string) *AuthenticateOidcActionConfig

SetAuthorizationEndpoint sets the AuthorizationEndpoint field's value.

func (*AuthenticateOidcActionConfig) SetClientId added in v1.13.58

SetClientId sets the ClientId field's value.

func (*AuthenticateOidcActionConfig) SetClientSecret added in v1.13.58

SetClientSecret sets the ClientSecret field's value.

func (*AuthenticateOidcActionConfig) SetIssuer added in v1.13.58

SetIssuer sets the Issuer field's value.

func (*AuthenticateOidcActionConfig) SetOnUnauthenticatedRequest added in v1.13.58

func (s *AuthenticateOidcActionConfig) SetOnUnauthenticatedRequest(v string) *AuthenticateOidcActionConfig

SetOnUnauthenticatedRequest sets the OnUnauthenticatedRequest field's value.

func (*AuthenticateOidcActionConfig) SetScope added in v1.13.58

SetScope sets the Scope field's value.

func (*AuthenticateOidcActionConfig) SetSessionCookieName added in v1.13.58

SetSessionCookieName sets the SessionCookieName field's value.

func (*AuthenticateOidcActionConfig) SetSessionTimeout added in v1.13.58

SetSessionTimeout sets the SessionTimeout field's value.

func (*AuthenticateOidcActionConfig) SetTokenEndpoint added in v1.13.58

SetTokenEndpoint sets the TokenEndpoint field's value.

func (*AuthenticateOidcActionConfig) SetUseExistingClientSecret added in v1.15.87

func (s *AuthenticateOidcActionConfig) SetUseExistingClientSecret(v bool) *AuthenticateOidcActionConfig

SetUseExistingClientSecret sets the UseExistingClientSecret field's value.

func (*AuthenticateOidcActionConfig) SetUserInfoEndpoint added in v1.13.58

SetUserInfoEndpoint sets the UserInfoEndpoint field's value.

func (AuthenticateOidcActionConfig) String added in v1.13.58

String returns the string representation

func (*AuthenticateOidcActionConfig) Validate added in v1.13.58

func (s *AuthenticateOidcActionConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AvailabilityZone

type AvailabilityZone struct {

	// [Network Load Balancers] If you need static IP addresses for your load balancer,
	// you can specify one Elastic IP address per Availability Zone when you create
	// an internal-facing load balancer. For internal load balancers, you can specify
	// a private IP address from the IPv4 range of the subnet.
	LoadBalancerAddresses []*LoadBalancerAddress `type:"list"`

	// [Application Load Balancers on Outposts] The ID of the Outpost.
	OutpostId *string `type:"string"`

	// The ID of the subnet. You can specify one subnet per Availability Zone.
	SubnetId *string `type:"string"`

	// The name of the Availability Zone.
	ZoneName *string `type:"string"`
	// contains filtered or unexported fields
}

Information about an Availability Zone.

func (AvailabilityZone) GoString

func (s AvailabilityZone) GoString() string

GoString returns the string representation

func (*AvailabilityZone) SetLoadBalancerAddresses added in v1.10.40

func (s *AvailabilityZone) SetLoadBalancerAddresses(v []*LoadBalancerAddress) *AvailabilityZone

SetLoadBalancerAddresses sets the LoadBalancerAddresses field's value.

func (*AvailabilityZone) SetOutpostId added in v1.34.19

func (s *AvailabilityZone) SetOutpostId(v string) *AvailabilityZone

SetOutpostId sets the OutpostId field's value.

func (*AvailabilityZone) SetSubnetId added in v1.5.0

func (s *AvailabilityZone) SetSubnetId(v string) *AvailabilityZone

SetSubnetId sets the SubnetId field's value.

func (*AvailabilityZone) SetZoneName added in v1.5.0

func (s *AvailabilityZone) SetZoneName(v string) *AvailabilityZone

SetZoneName sets the ZoneName field's value.

func (AvailabilityZone) String

func (s AvailabilityZone) String() string

String returns the string representation

type Certificate

type Certificate struct {

	// The Amazon Resource Name (ARN) of the certificate.
	CertificateArn *string `type:"string"`

	// Indicates whether the certificate is the default certificate. Do not set
	// this value when specifying a certificate as an input. This value is not included
	// in the output when describing a listener, but is included when describing
	// listener certificates.
	IsDefault *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Information about an SSL server certificate.

func (Certificate) GoString

func (s Certificate) GoString() string

GoString returns the string representation

func (*Certificate) SetCertificateArn added in v1.5.0

func (s *Certificate) SetCertificateArn(v string) *Certificate

SetCertificateArn sets the CertificateArn field's value.

func (*Certificate) SetIsDefault added in v1.12.8

func (s *Certificate) SetIsDefault(v bool) *Certificate

SetIsDefault sets the IsDefault field's value.

func (Certificate) String

func (s Certificate) String() string

String returns the string representation

type Cipher

type Cipher struct {

	// The name of the cipher.
	Name *string `type:"string"`

	// The priority of the cipher.
	Priority *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Information about a cipher used in a policy.

func (Cipher) GoString

func (s Cipher) GoString() string

GoString returns the string representation

func (*Cipher) SetName added in v1.5.0

func (s *Cipher) SetName(v string) *Cipher

SetName sets the Name field's value.

func (*Cipher) SetPriority added in v1.5.0

func (s *Cipher) SetPriority(v int64) *Cipher

SetPriority sets the Priority field's value.

func (Cipher) String

func (s Cipher) String() string

String returns the string representation

type CreateListenerInput

type CreateListenerInput struct {

	// [TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN)
	// policy. You can specify one policy name. The following are the possible values:
	//
	//    * HTTP1Only
	//
	//    * HTTP2Only
	//
	//    * HTTP2Optional
	//
	//    * HTTP2Preferred
	//
	//    * None
	//
	// For more information, see ALPN policies (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#alpn-policies)
	// in the Network Load Balancers Guide.
	AlpnPolicy []*string `type:"list"`

	// [HTTPS and TLS listeners] The default certificate for the listener. You must
	// provide exactly one certificate. Set CertificateArn to the certificate ARN
	// but do not set IsDefault.
	Certificates []*Certificate `type:"list"`

	// The actions for the default rule.
	//
	// DefaultActions is a required field
	DefaultActions []*Action `type:"list" required:"true"`

	// The Amazon Resource Name (ARN) of the load balancer.
	//
	// LoadBalancerArn is a required field
	LoadBalancerArn *string `type:"string" required:"true"`

	// The port on which the load balancer is listening. You cannot specify a port
	// for a Gateway Load Balancer.
	Port *int64 `min:"1" type:"integer"`

	// The protocol for connections from clients to the load balancer. For Application
	// Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load
	// Balancers, the supported protocols are TCP, TLS, UDP, and TCP_UDP. You can’t
	// specify the UDP or TCP_UDP protocol if dual-stack mode is enabled. You cannot
	// specify a protocol for a Gateway Load Balancer.
	Protocol *string `type:"string" enum:"ProtocolEnum"`

	// [HTTPS and TLS listeners] The security policy that defines which protocols
	// and ciphers are supported.
	//
	// For more information, see Security policies (https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies)
	// in the Application Load Balancers Guide and Security policies (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies)
	// in the Network Load Balancers Guide.
	SslPolicy *string `type:"string"`

	// The tags to assign to the listener.
	Tags []*Tag `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (CreateListenerInput) GoString

func (s CreateListenerInput) GoString() string

GoString returns the string representation

func (*CreateListenerInput) SetAlpnPolicy added in v1.31.6

func (s *CreateListenerInput) SetAlpnPolicy(v []*string) *CreateListenerInput

SetAlpnPolicy sets the AlpnPolicy field's value.

func (*CreateListenerInput) SetCertificates added in v1.5.0

func (s *CreateListenerInput) SetCertificates(v []*Certificate) *CreateListenerInput

SetCertificates sets the Certificates field's value.

func (*CreateListenerInput) SetDefaultActions added in v1.5.0

func (s *CreateListenerInput) SetDefaultActions(v []*Action) *CreateListenerInput

SetDefaultActions sets the DefaultActions field's value.

func (*CreateListenerInput) SetLoadBalancerArn added in v1.5.0

func (s *CreateListenerInput) SetLoadBalancerArn(v string) *CreateListenerInput

SetLoadBalancerArn sets the LoadBalancerArn field's value.

func (*CreateListenerInput) SetPort added in v1.5.0

SetPort sets the Port field's value.

func (*CreateListenerInput) SetProtocol added in v1.5.0

func (s *CreateListenerInput) SetProtocol(v string) *CreateListenerInput

SetProtocol sets the Protocol field's value.

func (*CreateListenerInput) SetSslPolicy added in v1.5.0

func (s *CreateListenerInput) SetSslPolicy(v string) *CreateListenerInput

SetSslPolicy sets the SslPolicy field's value.

func (*CreateListenerInput) SetTags added in v1.35.2

func (s *CreateListenerInput) SetTags(v []*Tag) *CreateListenerInput

SetTags sets the Tags field's value.

func (CreateListenerInput) String

func (s CreateListenerInput) String() string

String returns the string representation

func (*CreateListenerInput) Validate

func (s *CreateListenerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateListenerOutput

type CreateListenerOutput struct {

	// Information about the listener.
	Listeners []*Listener `type:"list"`
	// contains filtered or unexported fields
}

func (CreateListenerOutput) GoString

func (s CreateListenerOutput) GoString() string

GoString returns the string representation

func (*CreateListenerOutput) SetListeners added in v1.5.0

func (s *CreateListenerOutput) SetListeners(v []*Listener) *CreateListenerOutput

SetListeners sets the Listeners field's value.

func (CreateListenerOutput) String

func (s CreateListenerOutput) String() string

String returns the string representation

type CreateLoadBalancerInput

type CreateLoadBalancerInput struct {

	// [Application Load Balancers on Outposts] The ID of the customer-owned address
	// pool (CoIP pool).
	CustomerOwnedIpv4Pool *string `type:"string"`

	// The type of IP addresses used by the subnets for your load balancer. The
	// possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and
	// IPv6 addresses). Internal load balancers must use ipv4.
	IpAddressType *string `type:"string" enum:"IpAddressType"`

	// The name of the load balancer.
	//
	// This name must be unique per region per account, can have a maximum of 32
	// characters, must contain only alphanumeric characters or hyphens, must not
	// begin or end with a hyphen, and must not begin with "internal-".
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// The nodes of an Internet-facing load balancer have public IP addresses. The
	// DNS name of an Internet-facing load balancer is publicly resolvable to the
	// public IP addresses of the nodes. Therefore, Internet-facing load balancers
	// can route requests from clients over the internet.
	//
	// The nodes of an internal load balancer have only private IP addresses. The
	// DNS name of an internal load balancer is publicly resolvable to the private
	// IP addresses of the nodes. Therefore, internal load balancers can route requests
	// only from clients with access to the VPC for the load balancer.
	//
	// The default is an Internet-facing load balancer.
	//
	// You cannot specify a scheme for a Gateway Load Balancer.
	Scheme *string `type:"string" enum:"LoadBalancerSchemeEnum"`

	// [Application Load Balancers] The IDs of the security groups for the load
	// balancer.
	SecurityGroups []*string `type:"list"`

	// The IDs of the public subnets. You can specify only one subnet per Availability
	// Zone. You must specify either subnets or subnet mappings.
	//
	// [Application Load Balancers] You must specify subnets from at least two Availability
	// Zones. You cannot specify Elastic IP addresses for your subnets.
	//
	// [Application Load Balancers on Outposts] You must specify one Outpost subnet.
	//
	// [Application Load Balancers on Local Zones] You can specify subnets from
	// one or more Local Zones.
	//
	// [Network Load Balancers] You can specify subnets from one or more Availability
	// Zones. You can specify one Elastic IP address per subnet if you need static
	// IP addresses for your internet-facing load balancer. For internal load balancers,
	// you can specify one private IP address per subnet from the IPv4 range of
	// the subnet. For internet-facing load balancer, you can specify one IPv6 address
	// per subnet.
	//
	// [Gateway Load Balancers] You can specify subnets from one or more Availability
	// Zones. You cannot specify Elastic IP addresses for your subnets.
	SubnetMappings []*SubnetMapping `type:"list"`

	// The IDs of the public subnets. You can specify only one subnet per Availability
	// Zone. You must specify either subnets or subnet mappings.
	//
	// [Application Load Balancers] You must specify subnets from at least two Availability
	// Zones.
	//
	// [Application Load Balancers on Outposts] You must specify one Outpost subnet.
	//
	// [Application Load Balancers on Local Zones] You can specify subnets from
	// one or more Local Zones.
	//
	// [Network Load Balancers] You can specify subnets from one or more Availability
	// Zones.
	//
	// [Gateway Load Balancers] You can specify subnets from one or more Availability
	// Zones.
	Subnets []*string `type:"list"`

	// The tags to assign to the load balancer.
	Tags []*Tag `min:"1" type:"list"`

	// The type of load balancer. The default is application.
	Type *string `type:"string" enum:"LoadBalancerTypeEnum"`
	// contains filtered or unexported fields
}

func (CreateLoadBalancerInput) GoString

func (s CreateLoadBalancerInput) GoString() string

GoString returns the string representation

func (*CreateLoadBalancerInput) SetCustomerOwnedIpv4Pool added in v1.34.19

func (s *CreateLoadBalancerInput) SetCustomerOwnedIpv4Pool(v string) *CreateLoadBalancerInput

SetCustomerOwnedIpv4Pool sets the CustomerOwnedIpv4Pool field's value.

func (*CreateLoadBalancerInput) SetIpAddressType added in v1.6.17

func (s *CreateLoadBalancerInput) SetIpAddressType(v string) *CreateLoadBalancerInput

SetIpAddressType sets the IpAddressType field's value.

func (*CreateLoadBalancerInput) SetName added in v1.5.0

SetName sets the Name field's value.

func (*CreateLoadBalancerInput) SetScheme added in v1.5.0

SetScheme sets the Scheme field's value.

func (*CreateLoadBalancerInput) SetSecurityGroups added in v1.5.0

func (s *CreateLoadBalancerInput) SetSecurityGroups(v []*string) *CreateLoadBalancerInput

SetSecurityGroups sets the SecurityGroups field's value.

func (*CreateLoadBalancerInput) SetSubnetMappings added in v1.10.40

SetSubnetMappings sets the SubnetMappings field's value.

func (*CreateLoadBalancerInput) SetSubnets added in v1.5.0

SetSubnets sets the Subnets field's value.

func (*CreateLoadBalancerInput) SetTags added in v1.5.0

SetTags sets the Tags field's value.

func (*CreateLoadBalancerInput) SetType added in v1.10.40

SetType sets the Type field's value.

func (CreateLoadBalancerInput) String

func (s CreateLoadBalancerInput) String() string

String returns the string representation

func (*CreateLoadBalancerInput) Validate

func (s *CreateLoadBalancerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateLoadBalancerOutput

type CreateLoadBalancerOutput struct {

	// Information about the load balancer.
	LoadBalancers []*LoadBalancer `type:"list"`
	// contains filtered or unexported fields
}

func (CreateLoadBalancerOutput) GoString

func (s CreateLoadBalancerOutput) GoString() string

GoString returns the string representation

func (*CreateLoadBalancerOutput) SetLoadBalancers added in v1.5.0

SetLoadBalancers sets the LoadBalancers field's value.

func (CreateLoadBalancerOutput) String

func (s CreateLoadBalancerOutput) String() string

String returns the string representation

type CreateRuleInput

type CreateRuleInput struct {

	// The actions.
	//
	// Actions is a required field
	Actions []*Action `type:"list" required:"true"`

	// The conditions.
	//
	// Conditions is a required field
	Conditions []*RuleCondition `type:"list" required:"true"`

	// The Amazon Resource Name (ARN) of the listener.
	//
	// ListenerArn is a required field
	ListenerArn *string `type:"string" required:"true"`

	// The rule priority. A listener can't have multiple rules with the same priority.
	//
	// Priority is a required field
	Priority *int64 `min:"1" type:"integer" required:"true"`

	// The tags to assign to the rule.
	Tags []*Tag `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (CreateRuleInput) GoString

func (s CreateRuleInput) GoString() string

GoString returns the string representation

func (*CreateRuleInput) SetActions added in v1.5.0

func (s *CreateRuleInput) SetActions(v []*Action) *CreateRuleInput

SetActions sets the Actions field's value.

func (*CreateRuleInput) SetConditions added in v1.5.0

func (s *CreateRuleInput) SetConditions(v []*RuleCondition) *CreateRuleInput

SetConditions sets the Conditions field's value.

func (*CreateRuleInput) SetListenerArn added in v1.5.0

func (s *CreateRuleInput) SetListenerArn(v string) *CreateRuleInput

SetListenerArn sets the ListenerArn field's value.

func (*CreateRuleInput) SetPriority added in v1.5.0

func (s *CreateRuleInput) SetPriority(v int64) *CreateRuleInput

SetPriority sets the Priority field's value.

func (*CreateRuleInput) SetTags added in v1.35.2

func (s *CreateRuleInput) SetTags(v []*Tag) *CreateRuleInput

SetTags sets the Tags field's value.

func (CreateRuleInput) String

func (s CreateRuleInput) String() string

String returns the string representation

func (*CreateRuleInput) Validate

func (s *CreateRuleInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateRuleOutput

type CreateRuleOutput struct {

	// Information about the rule.
	Rules []*Rule `type:"list"`
	// contains filtered or unexported fields
}

func (CreateRuleOutput) GoString

func (s CreateRuleOutput) GoString() string

GoString returns the string representation

func (*CreateRuleOutput) SetRules added in v1.5.0

func (s *CreateRuleOutput) SetRules(v []*Rule) *CreateRuleOutput

SetRules sets the Rules field's value.

func (CreateRuleOutput) String

func (s CreateRuleOutput) String() string

String returns the string representation

type CreateTargetGroupInput

type CreateTargetGroupInput struct {

	// Indicates whether health checks are enabled. If the target type is lambda,
	// health checks are disabled by default but can be enabled. If the target type
	// is instance or ip, health checks are always enabled and cannot be disabled.
	HealthCheckEnabled *bool `type:"boolean"`

	// The approximate amount of time, in seconds, between health checks of an individual
	// target. If the target group protocol is TCP, TLS, UDP, or TCP_UDP, the supported
	// values are 10 and 30 seconds. If the target group protocol is HTTP or HTTPS,
	// the default is 30 seconds. If the target group protocol is GENEVE, the default
	// is 10 seconds. If the target type is lambda, the default is 35 seconds.
	HealthCheckIntervalSeconds *int64 `min:"5" type:"integer"`

	// [HTTP/HTTPS health checks] The destination for health checks on the targets.
	//
	// [HTTP1 or HTTP2 protocol version] The ping path. The default is /.
	//
	// [GRPC protocol version] The path of a custom health check method with the
	// format /package.service/method. The default is /AWS.ALB/healthcheck.
	HealthCheckPath *string `min:"1" type:"string"`

	// The port the load balancer uses when performing health checks on targets.
	// If the protocol is HTTP, HTTPS, TCP, TLS, UDP, or TCP_UDP, the default is
	// traffic-port, which is the port on which each target receives traffic from
	// the load balancer. If the protocol is GENEVE, the default is port 80.
	HealthCheckPort *string `type:"string"`

	// The protocol the load balancer uses when performing health checks on targets.
	// For Application Load Balancers, the default is HTTP. For Network Load Balancers
	// and Gateway Load Balancers, the default is TCP. The TCP protocol is not supported
	// for health checks if the protocol of the target group is HTTP or HTTPS. The
	// GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.
	HealthCheckProtocol *string `type:"string" enum:"ProtocolEnum"`

	// The amount of time, in seconds, during which no response from a target means
	// a failed health check. For target groups with a protocol of HTTP, HTTPS,
	// or GENEVE, the default is 5 seconds. For target groups with a protocol of
	// TCP or TLS, this value must be 6 seconds for HTTP health checks and 10 seconds
	// for TCP and HTTPS health checks. If the target type is lambda, the default
	// is 30 seconds.
	HealthCheckTimeoutSeconds *int64 `min:"2" type:"integer"`

	// The number of consecutive health checks successes required before considering
	// an unhealthy target healthy. For target groups with a protocol of HTTP or
	// HTTPS, the default is 5. For target groups with a protocol of TCP, TLS, or
	// GENEVE, the default is 3. If the target type is lambda, the default is 5.
	HealthyThresholdCount *int64 `min:"2" type:"integer"`

	// [HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for
	// a successful response from a target.
	Matcher *Matcher `type:"structure"`

	// The name of the target group.
	//
	// This name must be unique per region per account, can have a maximum of 32
	// characters, must contain only alphanumeric characters or hyphens, and must
	// not begin or end with a hyphen.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// The port on which the targets receive traffic. This port is used unless you
	// specify a port override when registering the target. If the target is a Lambda
	// function, this parameter does not apply. If the protocol is GENEVE, the supported
	// port is 6081.
	Port *int64 `min:"1" type:"integer"`

	// The protocol to use for routing traffic to the targets. For Application Load
	// Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers,
	// the supported protocols are TCP, TLS, UDP, or TCP_UDP. For Gateway Load Balancers,
	// the supported protocol is GENEVE. A TCP_UDP listener must be associated with
	// a TCP_UDP target group. If the target is a Lambda function, this parameter
	// does not apply.
	Protocol *string `type:"string" enum:"ProtocolEnum"`

	// [HTTP/HTTPS protocol] The protocol version. Specify GRPC to send requests
	// to targets using gRPC. Specify HTTP2 to send requests to targets using HTTP/2.
	// The default is HTTP1, which sends requests to targets using HTTP/1.1.
	ProtocolVersion *string `type:"string"`

	// The tags to assign to the target group.
	Tags []*Tag `min:"1" type:"list"`

	// The type of target that you must specify when registering targets with this
	// target group. You can't specify targets for a target group using more than
	// one target type.
	//
	//    * instance - Register targets by instance ID. This is the default value.
	//
	//    * ip - Register targets by IP address. You can specify IP addresses from
	//    the subnets of the virtual private cloud (VPC) for the target group, the
	//    RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the
	//    RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP
	//    addresses.
	//
	//    * lambda - Register a single Lambda function as a target.
	TargetType *string `type:"string" enum:"TargetTypeEnum"`

	// The number of consecutive health check failures required before considering
	// a target unhealthy. If the target group protocol is HTTP or HTTPS, the default
	// is 2. If the target group protocol is TCP or TLS, this value must be the
	// same as the healthy threshold count. If the target group protocol is GENEVE,
	// the default is 3. If the target type is lambda, the default is 2.
	UnhealthyThresholdCount *int64 `min:"2" type:"integer"`

	// The identifier of the virtual private cloud (VPC). If the target is a Lambda
	// function, this parameter does not apply. Otherwise, this parameter is required.
	VpcId *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateTargetGroupInput) GoString

func (s CreateTargetGroupInput) GoString() string

GoString returns the string representation

func (*CreateTargetGroupInput) SetHealthCheckEnabled added in v1.15.87

func (s *CreateTargetGroupInput) SetHealthCheckEnabled(v bool) *CreateTargetGroupInput

SetHealthCheckEnabled sets the HealthCheckEnabled field's value.

func (*CreateTargetGroupInput) SetHealthCheckIntervalSeconds added in v1.5.0

func (s *CreateTargetGroupInput) SetHealthCheckIntervalSeconds(v int64) *CreateTargetGroupInput

SetHealthCheckIntervalSeconds sets the HealthCheckIntervalSeconds field's value.

func (*CreateTargetGroupInput) SetHealthCheckPath added in v1.5.0

func (s *CreateTargetGroupInput) SetHealthCheckPath(v string) *CreateTargetGroupInput

SetHealthCheckPath sets the HealthCheckPath field's value.

func (*CreateTargetGroupInput) SetHealthCheckPort added in v1.5.0

func (s *CreateTargetGroupInput) SetHealthCheckPort(v string) *CreateTargetGroupInput

SetHealthCheckPort sets the HealthCheckPort field's value.

func (*CreateTargetGroupInput) SetHealthCheckProtocol added in v1.5.0

func (s *CreateTargetGroupInput) SetHealthCheckProtocol(v string) *CreateTargetGroupInput

SetHealthCheckProtocol sets the HealthCheckProtocol field's value.

func (*CreateTargetGroupInput) SetHealthCheckTimeoutSeconds added in v1.5.0

func (s *CreateTargetGroupInput) SetHealthCheckTimeoutSeconds(v int64) *CreateTargetGroupInput

SetHealthCheckTimeoutSeconds sets the HealthCheckTimeoutSeconds field's value.

func (*CreateTargetGroupInput) SetHealthyThresholdCount added in v1.5.0

func (s *CreateTargetGroupInput) SetHealthyThresholdCount(v int64) *CreateTargetGroupInput

SetHealthyThresholdCount sets the HealthyThresholdCount field's value.

func (*CreateTargetGroupInput) SetMatcher added in v1.5.0

SetMatcher sets the Matcher field's value.

func (*CreateTargetGroupInput) SetName added in v1.5.0

SetName sets the Name field's value.

func (*CreateTargetGroupInput) SetPort added in v1.5.0

SetPort sets the Port field's value.

func (*CreateTargetGroupInput) SetProtocol added in v1.5.0

SetProtocol sets the Protocol field's value.

func (*CreateTargetGroupInput) SetProtocolVersion added in v1.35.18

func (s *CreateTargetGroupInput) SetProtocolVersion(v string) *CreateTargetGroupInput

SetProtocolVersion sets the ProtocolVersion field's value.

func (*CreateTargetGroupInput) SetTags added in v1.35.2

SetTags sets the Tags field's value.

func (*CreateTargetGroupInput) SetTargetType added in v1.10.36

SetTargetType sets the TargetType field's value.

func (*CreateTargetGroupInput) SetUnhealthyThresholdCount added in v1.5.0

func (s *CreateTargetGroupInput) SetUnhealthyThresholdCount(v int64) *CreateTargetGroupInput

SetUnhealthyThresholdCount sets the UnhealthyThresholdCount field's value.

func (*CreateTargetGroupInput) SetVpcId added in v1.5.0

SetVpcId sets the VpcId field's value.

func (CreateTargetGroupInput) String

func (s CreateTargetGroupInput) String() string

String returns the string representation

func (*CreateTargetGroupInput) Validate

func (s *CreateTargetGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateTargetGroupOutput

type CreateTargetGroupOutput struct {

	// Information about the target group.
	TargetGroups []*TargetGroup `type:"list"`
	// contains filtered or unexported fields
}

func (CreateTargetGroupOutput) GoString

func (s CreateTargetGroupOutput) GoString() string

GoString returns the string representation

func (*CreateTargetGroupOutput) SetTargetGroups added in v1.5.0

SetTargetGroups sets the TargetGroups field's value.

func (CreateTargetGroupOutput) String

func (s CreateTargetGroupOutput) String() string

String returns the string representation

type DeleteListenerInput

type DeleteListenerInput struct {

	// The Amazon Resource Name (ARN) of the listener.
	//
	// ListenerArn is a required field
	ListenerArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteListenerInput) GoString

func (s DeleteListenerInput) GoString() string

GoString returns the string representation

func (*DeleteListenerInput) SetListenerArn added in v1.5.0

func (s *DeleteListenerInput) SetListenerArn(v string) *DeleteListenerInput

SetListenerArn sets the ListenerArn field's value.

func (DeleteListenerInput) String

func (s DeleteListenerInput) String() string

String returns the string representation

func (*DeleteListenerInput) Validate

func (s *DeleteListenerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteListenerOutput

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

func (DeleteListenerOutput) GoString

func (s DeleteListenerOutput) GoString() string

GoString returns the string representation

func (DeleteListenerOutput) String

func (s DeleteListenerOutput) String() string

String returns the string representation

type DeleteLoadBalancerInput

type DeleteLoadBalancerInput struct {

	// The Amazon Resource Name (ARN) of the load balancer.
	//
	// LoadBalancerArn is a required field
	LoadBalancerArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteLoadBalancerInput) GoString

func (s DeleteLoadBalancerInput) GoString() string

GoString returns the string representation

func (*DeleteLoadBalancerInput) SetLoadBalancerArn added in v1.5.0

func (s *DeleteLoadBalancerInput) SetLoadBalancerArn(v string) *DeleteLoadBalancerInput

SetLoadBalancerArn sets the LoadBalancerArn field's value.

func (DeleteLoadBalancerInput) String

func (s DeleteLoadBalancerInput) String() string

String returns the string representation

func (*DeleteLoadBalancerInput) Validate

func (s *DeleteLoadBalancerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteLoadBalancerOutput

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

func (DeleteLoadBalancerOutput) GoString

func (s DeleteLoadBalancerOutput) GoString() string

GoString returns the string representation

func (DeleteLoadBalancerOutput) String

func (s DeleteLoadBalancerOutput) String() string

String returns the string representation

type DeleteRuleInput

type DeleteRuleInput struct {

	// The Amazon Resource Name (ARN) of the rule.
	//
	// RuleArn is a required field
	RuleArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteRuleInput) GoString

func (s DeleteRuleInput) GoString() string

GoString returns the string representation

func (*DeleteRuleInput) SetRuleArn added in v1.5.0

func (s *DeleteRuleInput) SetRuleArn(v string) *DeleteRuleInput

SetRuleArn sets the RuleArn field's value.

func (DeleteRuleInput) String

func (s DeleteRuleInput) String() string

String returns the string representation

func (*DeleteRuleInput) Validate

func (s *DeleteRuleInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteRuleOutput

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

func (DeleteRuleOutput) GoString

func (s DeleteRuleOutput) GoString() string

GoString returns the string representation

func (DeleteRuleOutput) String

func (s DeleteRuleOutput) String() string

String returns the string representation

type DeleteTargetGroupInput

type DeleteTargetGroupInput struct {

	// The Amazon Resource Name (ARN) of the target group.
	//
	// TargetGroupArn is a required field
	TargetGroupArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteTargetGroupInput) GoString

func (s DeleteTargetGroupInput) GoString() string

GoString returns the string representation

func (*DeleteTargetGroupInput) SetTargetGroupArn added in v1.5.0

func (s *DeleteTargetGroupInput) SetTargetGroupArn(v string) *DeleteTargetGroupInput

SetTargetGroupArn sets the TargetGroupArn field's value.

func (DeleteTargetGroupInput) String

func (s DeleteTargetGroupInput) String() string

String returns the string representation

func (*DeleteTargetGroupInput) Validate

func (s *DeleteTargetGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteTargetGroupOutput

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

func (DeleteTargetGroupOutput) GoString

func (s DeleteTargetGroupOutput) GoString() string

GoString returns the string representation

func (DeleteTargetGroupOutput) String

func (s DeleteTargetGroupOutput) String() string

String returns the string representation

type DeregisterTargetsInput

type DeregisterTargetsInput struct {

	// The Amazon Resource Name (ARN) of the target group.
	//
	// TargetGroupArn is a required field
	TargetGroupArn *string `type:"string" required:"true"`

	// The targets. If you specified a port override when you registered a target,
	// you must specify both the target ID and the port when you deregister it.
	//
	// Targets is a required field
	Targets []*TargetDescription `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DeregisterTargetsInput) GoString

func (s DeregisterTargetsInput) GoString() string

GoString returns the string representation

func (*DeregisterTargetsInput) SetTargetGroupArn added in v1.5.0

func (s *DeregisterTargetsInput) SetTargetGroupArn(v string) *DeregisterTargetsInput

SetTargetGroupArn sets the TargetGroupArn field's value.

func (*DeregisterTargetsInput) SetTargets added in v1.5.0

SetTargets sets the Targets field's value.

func (DeregisterTargetsInput) String

func (s DeregisterTargetsInput) String() string

String returns the string representation

func (*DeregisterTargetsInput) Validate

func (s *DeregisterTargetsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeregisterTargetsOutput

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

func (DeregisterTargetsOutput) GoString

func (s DeregisterTargetsOutput) GoString() string

GoString returns the string representation

func (DeregisterTargetsOutput) String

func (s DeregisterTargetsOutput) String() string

String returns the string representation

type DescribeAccountLimitsInput added in v1.8.22

type DescribeAccountLimitsInput struct {

	// The marker for the next set of results. (You received this marker from a
	// previous call.)
	Marker *string `type:"string"`

	// The maximum number of results to return with this call.
	PageSize *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

func (DescribeAccountLimitsInput) GoString added in v1.8.22

func (s DescribeAccountLimitsInput) GoString() string

GoString returns the string representation

func (*DescribeAccountLimitsInput) SetMarker added in v1.8.22

SetMarker sets the Marker field's value.

func (*DescribeAccountLimitsInput) SetPageSize added in v1.8.22

SetPageSize sets the PageSize field's value.

func (DescribeAccountLimitsInput) String added in v1.8.22

String returns the string representation

func (*DescribeAccountLimitsInput) Validate added in v1.8.22

func (s *DescribeAccountLimitsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeAccountLimitsOutput added in v1.8.22

type DescribeAccountLimitsOutput struct {

	// Information about the limits.
	Limits []*Limit `type:"list"`

	// If there are additional results, this is the marker for the next set of results.
	// Otherwise, this is null.
	NextMarker *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeAccountLimitsOutput) GoString added in v1.8.22

func (s DescribeAccountLimitsOutput) GoString() string

GoString returns the string representation

func (*DescribeAccountLimitsOutput) SetLimits added in v1.8.22

SetLimits sets the Limits field's value.

func (*DescribeAccountLimitsOutput) SetNextMarker added in v1.8.22

SetNextMarker sets the NextMarker field's value.

func (DescribeAccountLimitsOutput) String added in v1.8.22

String returns the string representation

type DescribeListenerCertificatesInput added in v1.12.8

type DescribeListenerCertificatesInput struct {

	// The Amazon Resource Names (ARN) of the listener.
	//
	// ListenerArn is a required field
	ListenerArn *string `type:"string" required:"true"`

	// The marker for the next set of results. (You received this marker from a
	// previous call.)
	Marker *string `type:"string"`

	// The maximum number of results to return with this call.
	PageSize *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

func (DescribeListenerCertificatesInput) GoString added in v1.12.8

GoString returns the string representation

func (*DescribeListenerCertificatesInput) SetListenerArn added in v1.12.8

SetListenerArn sets the ListenerArn field's value.

func (*DescribeListenerCertificatesInput) SetMarker added in v1.12.8

SetMarker sets the Marker field's value.

func (*DescribeListenerCertificatesInput) SetPageSize added in v1.12.8

SetPageSize sets the PageSize field's value.

func (DescribeListenerCertificatesInput) String added in v1.12.8

String returns the string representation

func (*DescribeListenerCertificatesInput) Validate added in v1.12.8

Validate inspects the fields of the type to determine if they are valid.

type DescribeListenerCertificatesOutput added in v1.12.8

type DescribeListenerCertificatesOutput struct {

	// Information about the certificates.
	Certificates []*Certificate `type:"list"`

	// If there are additional results, this is the marker for the next set of results.
	// Otherwise, this is null.
	NextMarker *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeListenerCertificatesOutput) GoString added in v1.12.8

GoString returns the string representation

func (*DescribeListenerCertificatesOutput) SetCertificates added in v1.12.8

SetCertificates sets the Certificates field's value.

func (*DescribeListenerCertificatesOutput) SetNextMarker added in v1.12.8

SetNextMarker sets the NextMarker field's value.

func (DescribeListenerCertificatesOutput) String added in v1.12.8

String returns the string representation

type DescribeListenersInput

type DescribeListenersInput struct {

	// The Amazon Resource Names (ARN) of the listeners.
	ListenerArns []*string `type:"list"`

	// The Amazon Resource Name (ARN) of the load balancer.
	LoadBalancerArn *string `type:"string"`

	// The marker for the next set of results. (You received this marker from a
	// previous call.)
	Marker *string `type:"string"`

	// The maximum number of results to return with this call.
	PageSize *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

func (DescribeListenersInput) GoString

func (s DescribeListenersInput) GoString() string

GoString returns the string representation

func (*DescribeListenersInput) SetListenerArns added in v1.5.0

func (s *DescribeListenersInput) SetListenerArns(v []*string) *DescribeListenersInput

SetListenerArns sets the ListenerArns field's value.

func (*DescribeListenersInput) SetLoadBalancerArn added in v1.5.0

func (s *DescribeListenersInput) SetLoadBalancerArn(v string) *DescribeListenersInput

SetLoadBalancerArn sets the LoadBalancerArn field's value.

func (*DescribeListenersInput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*DescribeListenersInput) SetPageSize added in v1.5.0

SetPageSize sets the PageSize field's value.

func (DescribeListenersInput) String

func (s DescribeListenersInput) String() string

String returns the string representation

func (*DescribeListenersInput) Validate

func (s *DescribeListenersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeListenersOutput

type DescribeListenersOutput struct {

	// Information about the listeners.
	Listeners []*Listener `type:"list"`

	// If there are additional results, this is the marker for the next set of results.
	// Otherwise, this is null.
	NextMarker *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeListenersOutput) GoString

func (s DescribeListenersOutput) GoString() string

GoString returns the string representation

func (*DescribeListenersOutput) SetListeners added in v1.5.0

SetListeners sets the Listeners field's value.

func (*DescribeListenersOutput) SetNextMarker added in v1.5.0

SetNextMarker sets the NextMarker field's value.

func (DescribeListenersOutput) String

func (s DescribeListenersOutput) String() string

String returns the string representation

type DescribeLoadBalancerAttributesInput

type DescribeLoadBalancerAttributesInput struct {

	// The Amazon Resource Name (ARN) of the load balancer.
	//
	// LoadBalancerArn is a required field
	LoadBalancerArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeLoadBalancerAttributesInput) GoString

GoString returns the string representation

func (*DescribeLoadBalancerAttributesInput) SetLoadBalancerArn added in v1.5.0

SetLoadBalancerArn sets the LoadBalancerArn field's value.

func (DescribeLoadBalancerAttributesInput) String

String returns the string representation

func (*DescribeLoadBalancerAttributesInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type DescribeLoadBalancerAttributesOutput

type DescribeLoadBalancerAttributesOutput struct {

	// Information about the load balancer attributes.
	Attributes []*LoadBalancerAttribute `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeLoadBalancerAttributesOutput) GoString

GoString returns the string representation

func (*DescribeLoadBalancerAttributesOutput) SetAttributes added in v1.5.0

SetAttributes sets the Attributes field's value.

func (DescribeLoadBalancerAttributesOutput) String

String returns the string representation

type DescribeLoadBalancersInput

type DescribeLoadBalancersInput struct {

	// The Amazon Resource Names (ARN) of the load balancers. You can specify up
	// to 20 load balancers in a single call.
	LoadBalancerArns []*string `type:"list"`

	// The marker for the next set of results. (You received this marker from a
	// previous call.)
	Marker *string `type:"string"`

	// The names of the load balancers.
	Names []*string `type:"list"`

	// The maximum number of results to return with this call.
	PageSize *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

func (DescribeLoadBalancersInput) GoString

func (s DescribeLoadBalancersInput) GoString() string

GoString returns the string representation

func (*DescribeLoadBalancersInput) SetLoadBalancerArns added in v1.5.0

func (s *DescribeLoadBalancersInput) SetLoadBalancerArns(v []*string) *DescribeLoadBalancersInput

SetLoadBalancerArns sets the LoadBalancerArns field's value.

func (*DescribeLoadBalancersInput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*DescribeLoadBalancersInput) SetNames added in v1.5.0

SetNames sets the Names field's value.

func (*DescribeLoadBalancersInput) SetPageSize added in v1.5.0

SetPageSize sets the PageSize field's value.

func (DescribeLoadBalancersInput) String

String returns the string representation

func (*DescribeLoadBalancersInput) Validate

func (s *DescribeLoadBalancersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeLoadBalancersOutput

type DescribeLoadBalancersOutput struct {

	// Information about the load balancers.
	LoadBalancers []*LoadBalancer `type:"list"`

	// If there are additional results, this is the marker for the next set of results.
	// Otherwise, this is null.
	NextMarker *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeLoadBalancersOutput) GoString

func (s DescribeLoadBalancersOutput) GoString() string

GoString returns the string representation

func (*DescribeLoadBalancersOutput) SetLoadBalancers added in v1.5.0

SetLoadBalancers sets the LoadBalancers field's value.

func (*DescribeLoadBalancersOutput) SetNextMarker added in v1.5.0

SetNextMarker sets the NextMarker field's value.

func (DescribeLoadBalancersOutput) String

String returns the string representation

type DescribeRulesInput

type DescribeRulesInput struct {

	// The Amazon Resource Name (ARN) of the listener.
	ListenerArn *string `type:"string"`

	// The marker for the next set of results. (You received this marker from a
	// previous call.)
	Marker *string `type:"string"`

	// The maximum number of results to return with this call.
	PageSize *int64 `min:"1" type:"integer"`

	// The Amazon Resource Names (ARN) of the rules.
	RuleArns []*string `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeRulesInput) GoString

func (s DescribeRulesInput) GoString() string

GoString returns the string representation

func (*DescribeRulesInput) SetListenerArn added in v1.5.0

func (s *DescribeRulesInput) SetListenerArn(v string) *DescribeRulesInput

SetListenerArn sets the ListenerArn field's value.

func (*DescribeRulesInput) SetMarker added in v1.8.33

func (s *DescribeRulesInput) SetMarker(v string) *DescribeRulesInput

SetMarker sets the Marker field's value.

func (*DescribeRulesInput) SetPageSize added in v1.8.33

func (s *DescribeRulesInput) SetPageSize(v int64) *DescribeRulesInput

SetPageSize sets the PageSize field's value.

func (*DescribeRulesInput) SetRuleArns added in v1.5.0

func (s *DescribeRulesInput) SetRuleArns(v []*string) *DescribeRulesInput

SetRuleArns sets the RuleArns field's value.

func (DescribeRulesInput) String

func (s DescribeRulesInput) String() string

String returns the string representation

func (*DescribeRulesInput) Validate added in v1.8.33

func (s *DescribeRulesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeRulesOutput

type DescribeRulesOutput struct {

	// If there are additional results, this is the marker for the next set of results.
	// Otherwise, this is null.
	NextMarker *string `type:"string"`

	// Information about the rules.
	Rules []*Rule `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeRulesOutput) GoString

func (s DescribeRulesOutput) GoString() string

GoString returns the string representation

func (*DescribeRulesOutput) SetNextMarker added in v1.8.33

func (s *DescribeRulesOutput) SetNextMarker(v string) *DescribeRulesOutput

SetNextMarker sets the NextMarker field's value.

func (*DescribeRulesOutput) SetRules added in v1.5.0

func (s *DescribeRulesOutput) SetRules(v []*Rule) *DescribeRulesOutput

SetRules sets the Rules field's value.

func (DescribeRulesOutput) String

func (s DescribeRulesOutput) String() string

String returns the string representation

type DescribeSSLPoliciesInput

type DescribeSSLPoliciesInput struct {

	// The marker for the next set of results. (You received this marker from a
	// previous call.)
	Marker *string `type:"string"`

	// The names of the policies.
	Names []*string `type:"list"`

	// The maximum number of results to return with this call.
	PageSize *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

func (DescribeSSLPoliciesInput) GoString

func (s DescribeSSLPoliciesInput) GoString() string

GoString returns the string representation

func (*DescribeSSLPoliciesInput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*DescribeSSLPoliciesInput) SetNames added in v1.5.0

SetNames sets the Names field's value.

func (*DescribeSSLPoliciesInput) SetPageSize added in v1.5.0

SetPageSize sets the PageSize field's value.

func (DescribeSSLPoliciesInput) String

func (s DescribeSSLPoliciesInput) String() string

String returns the string representation

func (*DescribeSSLPoliciesInput) Validate

func (s *DescribeSSLPoliciesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeSSLPoliciesOutput

type DescribeSSLPoliciesOutput struct {

	// If there are additional results, this is the marker for the next set of results.
	// Otherwise, this is null.
	NextMarker *string `type:"string"`

	// Information about the security policies.
	SslPolicies []*SslPolicy `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeSSLPoliciesOutput) GoString

func (s DescribeSSLPoliciesOutput) GoString() string

GoString returns the string representation

func (*DescribeSSLPoliciesOutput) SetNextMarker added in v1.5.0

SetNextMarker sets the NextMarker field's value.

func (*DescribeSSLPoliciesOutput) SetSslPolicies added in v1.5.0

SetSslPolicies sets the SslPolicies field's value.

func (DescribeSSLPoliciesOutput) String

func (s DescribeSSLPoliciesOutput) String() string

String returns the string representation

type DescribeTagsInput

type DescribeTagsInput struct {

	// The Amazon Resource Names (ARN) of the resources. You can specify up to 20
	// resources in a single call.
	//
	// ResourceArns is a required field
	ResourceArns []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeTagsInput) GoString

func (s DescribeTagsInput) GoString() string

GoString returns the string representation

func (*DescribeTagsInput) SetResourceArns added in v1.5.0

func (s *DescribeTagsInput) SetResourceArns(v []*string) *DescribeTagsInput

SetResourceArns sets the ResourceArns field's value.

func (DescribeTagsInput) String

func (s DescribeTagsInput) String() string

String returns the string representation

func (*DescribeTagsInput) Validate

func (s *DescribeTagsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeTagsOutput

type DescribeTagsOutput struct {

	// Information about the tags.
	TagDescriptions []*TagDescription `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeTagsOutput) GoString

func (s DescribeTagsOutput) GoString() string

GoString returns the string representation

func (*DescribeTagsOutput) SetTagDescriptions added in v1.5.0

func (s *DescribeTagsOutput) SetTagDescriptions(v []*TagDescription) *DescribeTagsOutput

SetTagDescriptions sets the TagDescriptions field's value.

func (DescribeTagsOutput) String

func (s DescribeTagsOutput) String() string

String returns the string representation

type DescribeTargetGroupAttributesInput

type DescribeTargetGroupAttributesInput struct {

	// The Amazon Resource Name (ARN) of the target group.
	//
	// TargetGroupArn is a required field
	TargetGroupArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeTargetGroupAttributesInput) GoString

GoString returns the string representation

func (*DescribeTargetGroupAttributesInput) SetTargetGroupArn added in v1.5.0

SetTargetGroupArn sets the TargetGroupArn field's value.

func (DescribeTargetGroupAttributesInput) String

String returns the string representation

func (*DescribeTargetGroupAttributesInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type DescribeTargetGroupAttributesOutput

type DescribeTargetGroupAttributesOutput struct {

	// Information about the target group attributes
	Attributes []*TargetGroupAttribute `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeTargetGroupAttributesOutput) GoString

GoString returns the string representation

func (*DescribeTargetGroupAttributesOutput) SetAttributes added in v1.5.0

SetAttributes sets the Attributes field's value.

func (DescribeTargetGroupAttributesOutput) String

String returns the string representation

type DescribeTargetGroupsInput

type DescribeTargetGroupsInput struct {

	// The Amazon Resource Name (ARN) of the load balancer.
	LoadBalancerArn *string `type:"string"`

	// The marker for the next set of results. (You received this marker from a
	// previous call.)
	Marker *string `type:"string"`

	// The names of the target groups.
	Names []*string `type:"list"`

	// The maximum number of results to return with this call.
	PageSize *int64 `min:"1" type:"integer"`

	// The Amazon Resource Names (ARN) of the target groups.
	TargetGroupArns []*string `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeTargetGroupsInput) GoString

func (s DescribeTargetGroupsInput) GoString() string

GoString returns the string representation

func (*DescribeTargetGroupsInput) SetLoadBalancerArn added in v1.5.0

SetLoadBalancerArn sets the LoadBalancerArn field's value.

func (*DescribeTargetGroupsInput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*DescribeTargetGroupsInput) SetNames added in v1.5.0

SetNames sets the Names field's value.

func (*DescribeTargetGroupsInput) SetPageSize added in v1.5.0

SetPageSize sets the PageSize field's value.

func (*DescribeTargetGroupsInput) SetTargetGroupArns added in v1.5.0

func (s *DescribeTargetGroupsInput) SetTargetGroupArns(v []*string) *DescribeTargetGroupsInput

SetTargetGroupArns sets the TargetGroupArns field's value.

func (DescribeTargetGroupsInput) String

func (s DescribeTargetGroupsInput) String() string

String returns the string representation

func (*DescribeTargetGroupsInput) Validate

func (s *DescribeTargetGroupsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeTargetGroupsOutput

type DescribeTargetGroupsOutput struct {

	// If there are additional results, this is the marker for the next set of results.
	// Otherwise, this is null.
	NextMarker *string `type:"string"`

	// Information about the target groups.
	TargetGroups []*TargetGroup `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeTargetGroupsOutput) GoString

func (s DescribeTargetGroupsOutput) GoString() string

GoString returns the string representation

func (*DescribeTargetGroupsOutput) SetNextMarker added in v1.5.0

SetNextMarker sets the NextMarker field's value.

func (*DescribeTargetGroupsOutput) SetTargetGroups added in v1.5.0

SetTargetGroups sets the TargetGroups field's value.

func (DescribeTargetGroupsOutput) String

String returns the string representation

type DescribeTargetHealthInput

type DescribeTargetHealthInput struct {

	// The Amazon Resource Name (ARN) of the target group.
	//
	// TargetGroupArn is a required field
	TargetGroupArn *string `type:"string" required:"true"`

	// The targets.
	Targets []*TargetDescription `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeTargetHealthInput) GoString

func (s DescribeTargetHealthInput) GoString() string

GoString returns the string representation

func (*DescribeTargetHealthInput) SetTargetGroupArn added in v1.5.0

SetTargetGroupArn sets the TargetGroupArn field's value.

func (*DescribeTargetHealthInput) SetTargets added in v1.5.0

SetTargets sets the Targets field's value.

func (DescribeTargetHealthInput) String

func (s DescribeTargetHealthInput) String() string

String returns the string representation

func (*DescribeTargetHealthInput) Validate

func (s *DescribeTargetHealthInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeTargetHealthOutput

type DescribeTargetHealthOutput struct {

	// Information about the health of the targets.
	TargetHealthDescriptions []*TargetHealthDescription `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeTargetHealthOutput) GoString

func (s DescribeTargetHealthOutput) GoString() string

GoString returns the string representation

func (*DescribeTargetHealthOutput) SetTargetHealthDescriptions added in v1.5.0

SetTargetHealthDescriptions sets the TargetHealthDescriptions field's value.

func (DescribeTargetHealthOutput) String

String returns the string representation

type ELBV2

type ELBV2 struct {
	*client.Client
}

ELBV2 provides the API operation methods for making requests to Elastic Load Balancing. See this package's package overview docs for details on the service.

ELBV2 methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *ELBV2

New creates a new instance of the ELBV2 client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a ELBV2 client from just a session.
svc := elbv2.New(mySession)

// Create a ELBV2 client with additional configuration
svc := elbv2.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*ELBV2) AddListenerCertificates added in v1.12.8

func (c *ELBV2) AddListenerCertificates(input *AddListenerCertificatesInput) (*AddListenerCertificatesOutput, error)

AddListenerCertificates API operation for Elastic Load Balancing.

Adds the specified SSL server certificate to the certificate list for the specified HTTPS or TLS listener.

If the certificate in already in the certificate list, the call is successful but the certificate is not added again.

For more information, see HTTPS listeners (https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html) in the Application Load Balancers Guide or TLS listeners (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html) in the Network Load Balancers Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Elastic Load Balancing's API operation AddListenerCertificates for usage and error information.

Returned Error Codes:

  • ErrCodeListenerNotFoundException "ListenerNotFound" The specified listener does not exist.

  • ErrCodeTooManyCertificatesException "TooManyCertificates" You've reached the limit on the number of certificates per load balancer.

  • ErrCodeCertificateNotFoundException "CertificateNotFound" The specified certificate does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/AddListenerCertificates

func (*ELBV2) AddListenerCertificatesRequest added in v1.12.8

func (c *ELBV2) AddListenerCertificatesRequest(input *AddListenerCertificatesInput) (req *request.Request, output *AddListenerCertificatesOutput)

AddListenerCertificatesRequest generates a "aws/request.Request" representing the client's request for the AddListenerCertificates operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AddListenerCertificates for more information on using the AddListenerCertificates API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AddListenerCertificatesRequest method.
req, resp := client.AddListenerCertificatesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/AddListenerCertificates

func (*ELBV2) AddListenerCertificatesWithContext added in v1.12.8

func (c *ELBV2) AddListenerCertificatesWithContext(ctx aws.Context, input *AddListenerCertificatesInput, opts ...request.Option) (*AddListenerCertificatesOutput, error)

AddListenerCertificatesWithContext is the same as AddListenerCertificates with the addition of the ability to pass a context and additional request options.

See AddListenerCertificates for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) AddTags

func (c *ELBV2) AddTags(input *AddTagsInput) (*AddTagsOutput, error)

AddTags API operation for Elastic Load Balancing.

Adds the specified tags to the specified Elastic Load Balancing resource. You can tag your Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, and rules.

Each tag consists of a key and an optional value. If a resource already has a tag with the same key, AddTags updates its value.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Elastic Load Balancing's API operation AddTags for usage and error information.

Returned Error Codes:

  • ErrCodeDuplicateTagKeysException "DuplicateTagKeys" A tag key was specified more than once.

  • ErrCodeTooManyTagsException "TooManyTags" You've reached the limit on the number of tags per load balancer.

  • ErrCodeLoadBalancerNotFoundException "LoadBalancerNotFound" The specified load balancer does not exist.

  • ErrCodeTargetGroupNotFoundException "TargetGroupNotFound" The specified target group does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/AddTags

Example (Shared00)

To add tags to a load balancer

This example adds the specified tags to the specified load balancer.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elbv2"
)

func main() {
	svc := elbv2.New(session.New())
	input := &elbv2.AddTagsInput{
		ResourceArns: []*string{
			aws.String("arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188"),
		},
		Tags: []*elbv2.Tag{
			{
				Key:   aws.String("project"),
				Value: aws.String("lima"),
			},
			{
				Key:   aws.String("department"),
				Value: aws.String("digital-media"),
			},
		},
	}

	result, err := svc.AddTags(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elbv2.ErrCodeDuplicateTagKeysException:
				fmt.Println(elbv2.ErrCodeDuplicateTagKeysException, aerr.Error())
			case elbv2.ErrCodeTooManyTagsException:
				fmt.Println(elbv2.ErrCodeTooManyTagsException, aerr.Error())
			case elbv2.ErrCodeLoadBalancerNotFoundException:
				fmt.Println(elbv2.ErrCodeLoadBalancerNotFoundException, aerr.Error())
			case elbv2.ErrCodeTargetGroupNotFoundException:
				fmt.Println(elbv2.ErrCodeTargetGroupNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ELBV2) AddTagsRequest

func (c *ELBV2) AddTagsRequest(input *AddTagsInput) (req *request.Request, output *AddTagsOutput)

AddTagsRequest generates a "aws/request.Request" representing the client's request for the AddTags operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AddTags for more information on using the AddTags API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AddTagsRequest method.
req, resp := client.AddTagsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/AddTags

func (*ELBV2) AddTagsWithContext added in v1.8.0

func (c *ELBV2) AddTagsWithContext(ctx aws.Context, input *AddTagsInput, opts ...request.Option) (*AddTagsOutput, error)

AddTagsWithContext is the same as AddTags with the addition of the ability to pass a context and additional request options.

See AddTags for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) CreateListener

func (c *ELBV2) CreateListener(input *CreateListenerInput) (*CreateListenerOutput, error)

CreateListener API operation for Elastic Load Balancing.

Creates a listener for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.

For more information, see the following:

This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple listeners with the same settings, each call succeeds.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Elastic Load Balancing's API operation CreateListener for usage and error information.

Returned Error Codes:

  • ErrCodeDuplicateListenerException "DuplicateListener" A listener with the specified port already exists.

  • ErrCodeTooManyListenersException "TooManyListeners" You've reached the limit on the number of listeners per load balancer.

  • ErrCodeTooManyCertificatesException "TooManyCertificates" You've reached the limit on the number of certificates per load balancer.

  • ErrCodeLoadBalancerNotFoundException "LoadBalancerNotFound" The specified load balancer does not exist.

  • ErrCodeTargetGroupNotFoundException "TargetGroupNotFound" The specified target group does not exist.

  • ErrCodeTargetGroupAssociationLimitException "TargetGroupAssociationLimit" You've reached the limit on the number of load balancers per target group.

  • ErrCodeInvalidConfigurationRequestException "InvalidConfigurationRequest" The requested configuration is not valid.

  • ErrCodeIncompatibleProtocolsException "IncompatibleProtocols" The specified configuration is not valid with this protocol.

  • ErrCodeSSLPolicyNotFoundException "SSLPolicyNotFound" The specified SSL policy does not exist.

  • ErrCodeCertificateNotFoundException "CertificateNotFound" The specified certificate does not exist.

  • ErrCodeUnsupportedProtocolException "UnsupportedProtocol" The specified protocol is not supported.

  • ErrCodeTooManyRegistrationsForTargetIdException "TooManyRegistrationsForTargetId" You've reached the limit on the number of times a target can be registered with a load balancer.

  • ErrCodeTooManyTargetsException "TooManyTargets" You've reached the limit on the number of targets.

  • ErrCodeTooManyActionsException "TooManyActions" You've reached the limit on the number of actions per rule.

  • ErrCodeInvalidLoadBalancerActionException "InvalidLoadBalancerAction" The requested action is not valid.

  • ErrCodeTooManyUniqueTargetGroupsPerLoadBalancerException "TooManyUniqueTargetGroupsPerLoadBalancer" You've reached the limit on the number of unique target groups per load balancer across all listeners. If a target group is used by multiple actions for a load balancer, it is counted as only one use.

  • ErrCodeALPNPolicyNotSupportedException "ALPNPolicyNotFound" The specified ALPN policy is not supported.

  • ErrCodeTooManyTagsException "TooManyTags" You've reached the limit on the number of tags per load balancer.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/CreateListener

Example (Shared00)

To create an HTTP listener

This example creates an HTTP listener for the specified load balancer that forwards requests to the specified target group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elbv2"
)

func main() {
	svc := elbv2.New(session.New())
	input := &elbv2.CreateListenerInput{
		DefaultActions: []*elbv2.Action{
			{
				TargetGroupArn: aws.String("arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"),
				Type:           aws.String("forward"),
			},
		},
		LoadBalancerArn: aws.String("arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188"),
		Port:            aws.Int64(80),
		Protocol:        aws.String("HTTP"),
	}

	result, err := svc.CreateListener(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elbv2.ErrCodeDuplicateListenerException:
				fmt.Println(elbv2.ErrCodeDuplicateListenerException, aerr.Error())
			case elbv2.ErrCodeTooManyListenersException:
				fmt.Println(elbv2.ErrCodeTooManyListenersException, aerr.Error())
			case elbv2.ErrCodeTooManyCertificatesException:
				fmt.Println(elbv2.ErrCodeTooManyCertificatesException, aerr.Error())
			case elbv2.ErrCodeLoadBalancerNotFoundException:
				fmt.Println(elbv2.ErrCodeLoadBalancerNotFoundException, aerr.Error())
			case elbv2.ErrCodeTargetGroupNotFoundException:
				fmt.Println(elbv2.ErrCodeTargetGroupNotFoundException, aerr.Error())
			case elbv2.ErrCodeTargetGroupAssociationLimitException:
				fmt.Println(elbv2.ErrCodeTargetGroupAssociationLimitException, aerr.Error())
			case elbv2.ErrCodeInvalidConfigurationRequestException:
				fmt.Println(elbv2.ErrCodeInvalidConfigurationRequestException, aerr.Error())
			case elbv2.ErrCodeIncompatibleProtocolsException:
				fmt.Println(elbv2.ErrCodeIncompatibleProtocolsException, aerr.Error())
			case elbv2.ErrCodeSSLPolicyNotFoundException:
				fmt.Println(elbv2.ErrCodeSSLPolicyNotFoundException, aerr.Error())
			case elbv2.ErrCodeCertificateNotFoundException:
				fmt.Println(elbv2.ErrCodeCertificateNotFoundException, aerr.Error())
			case elbv2.ErrCodeUnsupportedProtocolException:
				fmt.Println(elbv2.ErrCodeUnsupportedProtocolException, aerr.Error())
			case elbv2.ErrCodeTooManyRegistrationsForTargetIdException:
				fmt.Println(elbv2.ErrCodeTooManyRegistrationsForTargetIdException, aerr.Error())
			case elbv2.ErrCodeTooManyTargetsException:
				fmt.Println(elbv2.ErrCodeTooManyTargetsException, aerr.Error())
			case elbv2.ErrCodeTooManyActionsException:
				fmt.Println(elbv2.ErrCodeTooManyActionsException, aerr.Error())
			case elbv2.ErrCodeInvalidLoadBalancerActionException:
				fmt.Println(elbv2.ErrCodeInvalidLoadBalancerActionException, aerr.Error())
			case elbv2.ErrCodeTooManyUniqueTargetGroupsPerLoadBalancerException:
				fmt.Println(elbv2.ErrCodeTooManyUniqueTargetGroupsPerLoadBalancerException, aerr.Error())
			case elbv2.ErrCodeALPNPolicyNotSupportedException:
				fmt.Println(elbv2.ErrCodeALPNPolicyNotSupportedException, aerr.Error())
			case elbv2.ErrCodeTooManyTagsException:
				fmt.Println(elbv2.ErrCodeTooManyTagsException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

Example (Shared01)

To create an HTTPS listener

This example creates an HTTPS listener for the specified load balancer that forwards requests to the specified target group. Note that you must specify an SSL certificate for an HTTPS listener. You can create and manage certificates using AWS Certificate Manager (ACM). Alternatively, you can create a certificate using SSL/TLS tools, get the certificate signed by a certificate authority (CA), and upload the certificate to AWS Identity and Access Management (IAM).

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elbv2"
)

func main() {
	svc := elbv2.New(session.New())
	input := &elbv2.CreateListenerInput{
		Certificates: []*elbv2.Certificate{
			{
				CertificateArn: aws.String("arn:aws:iam::123456789012:server-certificate/my-server-cert"),
			},
		},
		DefaultActions: []*elbv2.Action{
			{
				TargetGroupArn: aws.String("arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"),
				Type:           aws.String("forward"),
			},
		},
		LoadBalancerArn: aws.String("arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188"),
		Port:            aws.Int64(443),
		Protocol:        aws.String("HTTPS"),
		SslPolicy:       aws.String("ELBSecurityPolicy-2015-05"),
	}

	result, err := svc.CreateListener(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elbv2.ErrCodeDuplicateListenerException:
				fmt.Println(elbv2.ErrCodeDuplicateListenerException, aerr.Error())
			case elbv2.ErrCodeTooManyListenersException:
				fmt.Println(elbv2.ErrCodeTooManyListenersException, aerr.Error())
			case elbv2.ErrCodeTooManyCertificatesException:
				fmt.Println(elbv2.ErrCodeTooManyCertificatesException, aerr.Error())
			case elbv2.ErrCodeLoadBalancerNotFoundException:
				fmt.Println(elbv2.ErrCodeLoadBalancerNotFoundException, aerr.Error())
			case elbv2.ErrCodeTargetGroupNotFoundException:
				fmt.Println(elbv2.ErrCodeTargetGroupNotFoundException, aerr.Error())
			case elbv2.ErrCodeTargetGroupAssociationLimitException:
				fmt.Println(elbv2.ErrCodeTargetGroupAssociationLimitException, aerr.Error())
			case elbv2.ErrCodeInvalidConfigurationRequestException:
				fmt.Println(elbv2.ErrCodeInvalidConfigurationRequestException, aerr.Error())
			case elbv2.ErrCodeIncompatibleProtocolsException:
				fmt.Println(elbv2.ErrCodeIncompatibleProtocolsException, aerr.Error())
			case elbv2.ErrCodeSSLPolicyNotFoundException:
				fmt.Println(elbv2.ErrCodeSSLPolicyNotFoundException, aerr.Error())
			case elbv2.ErrCodeCertificateNotFoundException:
				fmt.Println(elbv2.ErrCodeCertificateNotFoundException, aerr.Error())
			case elbv2.ErrCodeUnsupportedProtocolException:
				fmt.Println(elbv2.ErrCodeUnsupportedProtocolException, aerr.Error())
			case elbv2.ErrCodeTooManyRegistrationsForTargetIdException:
				fmt.Println(elbv2.ErrCodeTooManyRegistrationsForTargetIdException, aerr.Error())
			case elbv2.ErrCodeTooManyTargetsException:
				fmt.Println(elbv2.ErrCodeTooManyTargetsException, aerr.Error())
			case elbv2.ErrCodeTooManyActionsException:
				fmt.Println(elbv2.ErrCodeTooManyActionsException, aerr.Error())
			case elbv2.ErrCodeInvalidLoadBalancerActionException:
				fmt.Println(elbv2.ErrCodeInvalidLoadBalancerActionException, aerr.Error())
			case elbv2.ErrCodeTooManyUniqueTargetGroupsPerLoadBalancerException:
				fmt.Println(elbv2.ErrCodeTooManyUniqueTargetGroupsPerLoadBalancerException, aerr.Error())
			case elbv2.ErrCodeALPNPolicyNotSupportedException:
				fmt.Println(elbv2.ErrCodeALPNPolicyNotSupportedException, aerr.Error())
			case elbv2.ErrCodeTooManyTagsException:
				fmt.Println(elbv2.ErrCodeTooManyTagsException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ELBV2) CreateListenerRequest

func (c *ELBV2) CreateListenerRequest(input *CreateListenerInput) (req *request.Request, output *CreateListenerOutput)

CreateListenerRequest generates a "aws/request.Request" representing the client's request for the CreateListener operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateListener for more information on using the CreateListener API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateListenerRequest method.
req, resp := client.CreateListenerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/CreateListener

func (*ELBV2) CreateListenerWithContext added in v1.8.0

func (c *ELBV2) CreateListenerWithContext(ctx aws.Context, input *CreateListenerInput, opts ...request.Option) (*CreateListenerOutput, error)

CreateListenerWithContext is the same as CreateListener with the addition of the ability to pass a context and additional request options.

See CreateListener for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) CreateLoadBalancer

func (c *ELBV2) CreateLoadBalancer(input *CreateLoadBalancerInput) (*CreateLoadBalancerOutput, error)

CreateLoadBalancer API operation for Elastic Load Balancing.

Creates an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.

For more information, see the following:

This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple load balancers with the same settings, each call succeeds.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Elastic Load Balancing's API operation CreateLoadBalancer for usage and error information.

Returned Error Codes:

  • ErrCodeDuplicateLoadBalancerNameException "DuplicateLoadBalancerName" A load balancer with the specified name already exists.

  • ErrCodeTooManyLoadBalancersException "TooManyLoadBalancers" You've reached the limit on the number of load balancers for your AWS account.

  • ErrCodeInvalidConfigurationRequestException "InvalidConfigurationRequest" The requested configuration is not valid.

  • ErrCodeSubnetNotFoundException "SubnetNotFound" The specified subnet does not exist.

  • ErrCodeInvalidSubnetException "InvalidSubnet" The specified subnet is out of available addresses.

  • ErrCodeInvalidSecurityGroupException "InvalidSecurityGroup" The specified security group does not exist.

  • ErrCodeInvalidSchemeException "InvalidScheme" The requested scheme is not valid.

  • ErrCodeTooManyTagsException "TooManyTags" You've reached the limit on the number of tags per load balancer.

  • ErrCodeDuplicateTagKeysException "DuplicateTagKeys" A tag key was specified more than once.

  • ErrCodeResourceInUseException "ResourceInUse" A specified resource is in use.

  • ErrCodeAllocationIdNotFoundException "AllocationIdNotFound" The specified allocation ID does not exist.

  • ErrCodeAvailabilityZoneNotSupportedException "AvailabilityZoneNotSupported" The specified Availability Zone is not supported.

  • ErrCodeOperationNotPermittedException "OperationNotPermitted" This operation is not allowed.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/CreateLoadBalancer

Example (Shared00)

To create an Internet-facing load balancer

This example creates an Internet-facing load balancer and enables the Availability Zones for the specified subnets.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elbv2"
)

func main() {
	svc := elbv2.New(session.New())
	input := &elbv2.CreateLoadBalancerInput{
		Name: aws.String("my-load-balancer"),
		Subnets: []*string{
			aws.String("subnet-b7d581c0"),
			aws.String("subnet-8360a9e7"),
		},
	}

	result, err := svc.CreateLoadBalancer(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elbv2.ErrCodeDuplicateLoadBalancerNameException:
				fmt.Println(elbv2.ErrCodeDuplicateLoadBalancerNameException, aerr.Error())
			case elbv2.ErrCodeTooManyLoadBalancersException:
				fmt.Println(elbv2.ErrCodeTooManyLoadBalancersException, aerr.Error())
			case elbv2.ErrCodeInvalidConfigurationRequestException:
				fmt.Println(elbv2.ErrCodeInvalidConfigurationRequestException, aerr.Error())
			case elbv2.ErrCodeSubnetNotFoundException:
				fmt.Println(elbv2.ErrCodeSubnetNotFoundException, aerr.Error())
			case elbv2.ErrCodeInvalidSubnetException:
				fmt.Println(elbv2.ErrCodeInvalidSubnetException, aerr.Error())
			case elbv2.ErrCodeInvalidSecurityGroupException:
				fmt.Println(elbv2.ErrCodeInvalidSecurityGroupException, aerr.Error())
			case elbv2.ErrCodeInvalidSchemeException:
				fmt.Println(elbv2.ErrCodeInvalidSchemeException, aerr.Error())
			case elbv2.ErrCodeTooManyTagsException:
				fmt.Println(elbv2.ErrCodeTooManyTagsException, aerr.Error())
			case elbv2.ErrCodeDuplicateTagKeysException:
				fmt.Println(elbv2.ErrCodeDuplicateTagKeysException, aerr.Error())
			case elbv2.ErrCodeResourceInUseException:
				fmt.Println(elbv2.ErrCodeResourceInUseException, aerr.Error())
			case elbv2.ErrCodeAllocationIdNotFoundException:
				fmt.Println(elbv2.ErrCodeAllocationIdNotFoundException, aerr.Error())
			case elbv2.ErrCodeAvailabilityZoneNotSupportedException:
				fmt.Println(elbv2.ErrCodeAvailabilityZoneNotSupportedException, aerr.Error())
			case elbv2.ErrCodeOperationNotPermittedException:
				fmt.Println(elbv2.ErrCodeOperationNotPermittedException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

Example (Shared01)

To create an internal load balancer

This example creates an internal load balancer and enables the Availability Zones for the specified subnets.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elbv2"
)

func main() {
	svc := elbv2.New(session.New())
	input := &elbv2.CreateLoadBalancerInput{
		Name:   aws.String("my-internal-load-balancer"),
		Scheme: aws.String("internal"),
		Subnets: []*string{
			aws.String("subnet-b7d581c0"),
			aws.String("subnet-8360a9e7"),
		},
	}

	result, err := svc.CreateLoadBalancer(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elbv2.ErrCodeDuplicateLoadBalancerNameException:
				fmt.Println(elbv2.ErrCodeDuplicateLoadBalancerNameException, aerr.Error())
			case elbv2.ErrCodeTooManyLoadBalancersException:
				fmt.Println(elbv2.ErrCodeTooManyLoadBalancersException, aerr.Error())
			case elbv2.ErrCodeInvalidConfigurationRequestException:
				fmt.Println(elbv2.ErrCodeInvalidConfigurationRequestException, aerr.Error())
			case elbv2.ErrCodeSubnetNotFoundException:
				fmt.Println(elbv2.ErrCodeSubnetNotFoundException, aerr.Error())
			case elbv2.ErrCodeInvalidSubnetException:
				fmt.Println(elbv2.ErrCodeInvalidSubnetException, aerr.Error())
			case elbv2.ErrCodeInvalidSecurityGroupException:
				fmt.Println(elbv2.ErrCodeInvalidSecurityGroupException, aerr.Error())
			case elbv2.ErrCodeInvalidSchemeException:
				fmt.Println(elbv2.ErrCodeInvalidSchemeException, aerr.Error())
			case elbv2.ErrCodeTooManyTagsException:
				fmt.Println(elbv2.ErrCodeTooManyTagsException, aerr.Error())
			case elbv2.ErrCodeDuplicateTagKeysException:
				fmt.Println(elbv2.ErrCodeDuplicateTagKeysException, aerr.Error())
			case elbv2.ErrCodeResourceInUseException:
				fmt.Println(elbv2.ErrCodeResourceInUseException, aerr.Error())
			case elbv2.ErrCodeAllocationIdNotFoundException:
				fmt.Println(elbv2.ErrCodeAllocationIdNotFoundException, aerr.Error())
			case elbv2.ErrCodeAvailabilityZoneNotSupportedException:
				fmt.Println(elbv2.ErrCodeAvailabilityZoneNotSupportedException, aerr.Error())
			case elbv2.ErrCodeOperationNotPermittedException:
				fmt.Println(elbv2.ErrCodeOperationNotPermittedException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ELBV2) CreateLoadBalancerRequest

func (c *ELBV2) CreateLoadBalancerRequest(input *CreateLoadBalancerInput) (req *request.Request, output *CreateLoadBalancerOutput)

CreateLoadBalancerRequest generates a "aws/request.Request" representing the client's request for the CreateLoadBalancer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateLoadBalancer for more information on using the CreateLoadBalancer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateLoadBalancerRequest method.
req, resp := client.CreateLoadBalancerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/CreateLoadBalancer

func (*ELBV2) CreateLoadBalancerWithContext added in v1.8.0

func (c *ELBV2) CreateLoadBalancerWithContext(ctx aws.Context, input *CreateLoadBalancerInput, opts ...request.Option) (*CreateLoadBalancerOutput, error)

CreateLoadBalancerWithContext is the same as CreateLoadBalancer with the addition of the ability to pass a context and additional request options.

See CreateLoadBalancer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) CreateRule

func (c *ELBV2) CreateRule(input *CreateRuleInput) (*CreateRuleOutput, error)

CreateRule API operation for Elastic Load Balancing.

Creates a rule for the specified listener. The listener must be associated with an Application Load Balancer.

Each rule consists of a priority, one or more actions, and one or more conditions. Rules are evaluated in priority order, from the lowest value to the highest value. When the conditions for a rule are met, its actions are performed. If the conditions for no rules are met, the actions for the default rule are performed. For more information, see Listener rules (https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html#listener-rules) in the Application Load Balancers Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Elastic Load Balancing's API operation CreateRule for usage and error information.

Returned Error Codes:

  • ErrCodePriorityInUseException "PriorityInUse" The specified priority is in use.

  • ErrCodeTooManyTargetGroupsException "TooManyTargetGroups" You've reached the limit on the number of target groups for your AWS account.

  • ErrCodeTooManyRulesException "TooManyRules" You've reached the limit on the number of rules per load balancer.

  • ErrCodeTargetGroupAssociationLimitException "TargetGroupAssociationLimit" You've reached the limit on the number of load balancers per target group.

  • ErrCodeIncompatibleProtocolsException "IncompatibleProtocols" The specified configuration is not valid with this protocol.

  • ErrCodeListenerNotFoundException "ListenerNotFound" The specified listener does not exist.

  • ErrCodeTargetGroupNotFoundException "TargetGroupNotFound" The specified target group does not exist.

  • ErrCodeInvalidConfigurationRequestException "InvalidConfigurationRequest" The requested configuration is not valid.

  • ErrCodeTooManyRegistrationsForTargetIdException "TooManyRegistrationsForTargetId" You've reached the limit on the number of times a target can be registered with a load balancer.

  • ErrCodeTooManyTargetsException "TooManyTargets" You've reached the limit on the number of targets.

  • ErrCodeUnsupportedProtocolException "UnsupportedProtocol" The specified protocol is not supported.

  • ErrCodeTooManyActionsException "TooManyActions" You've reached the limit on the number of actions per rule.

  • ErrCodeInvalidLoadBalancerActionException "InvalidLoadBalancerAction" The requested action is not valid.

  • ErrCodeTooManyUniqueTargetGroupsPerLoadBalancerException "TooManyUniqueTargetGroupsPerLoadBalancer" You've reached the limit on the number of unique target groups per load balancer across all listeners. If a target group is used by multiple actions for a load balancer, it is counted as only one use.

  • ErrCodeTooManyTagsException "TooManyTags" You've reached the limit on the number of tags per load balancer.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/CreateRule

Example (Shared00)

To create a rule

This example creates a rule that forwards requests to the specified target group if the URL contains the specified pattern (for example, /img/*).

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elbv2"
)

func main() {
	svc := elbv2.New(session.New())
	input := &elbv2.CreateRuleInput{
		Actions: []*elbv2.Action{
			{
				TargetGroupArn: aws.String("arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"),
				Type:           aws.String("forward"),
			},
		},
		Conditions: []*elbv2.RuleCondition{
			{
				Field: aws.String("path-pattern"),
				Values: []*string{
					aws.String("/img/*"),
				},
			},
		},
		ListenerArn: aws.String("arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2"),
		Priority:    aws.Int64(10),
	}

	result, err := svc.CreateRule(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elbv2.ErrCodePriorityInUseException:
				fmt.Println(elbv2.ErrCodePriorityInUseException, aerr.Error())
			case elbv2.ErrCodeTooManyTargetGroupsException:
				fmt.Println(elbv2.ErrCodeTooManyTargetGroupsException, aerr.Error())
			case elbv2.ErrCodeTooManyRulesException:
				fmt.Println(elbv2.ErrCodeTooManyRulesException, aerr.Error())
			case elbv2.ErrCodeTargetGroupAssociationLimitException:
				fmt.Println(elbv2.ErrCodeTargetGroupAssociationLimitException, aerr.Error())
			case elbv2.ErrCodeIncompatibleProtocolsException:
				fmt.Println(elbv2.ErrCodeIncompatibleProtocolsException, aerr.Error())
			case elbv2.ErrCodeListenerNotFoundException:
				fmt.Println(elbv2.ErrCodeListenerNotFoundException, aerr.Error())
			case elbv2.ErrCodeTargetGroupNotFoundException:
				fmt.Println(elbv2.ErrCodeTargetGroupNotFoundException, aerr.Error())
			case elbv2.ErrCodeInvalidConfigurationRequestException:
				fmt.Println(elbv2.ErrCodeInvalidConfigurationRequestException, aerr.Error())
			case elbv2.ErrCodeTooManyRegistrationsForTargetIdException:
				fmt.Println(elbv2.ErrCodeTooManyRegistrationsForTargetIdException, aerr.Error())
			case elbv2.ErrCodeTooManyTargetsException:
				fmt.Println(elbv2.ErrCodeTooManyTargetsException, aerr.Error())
			case elbv2.ErrCodeUnsupportedProtocolException:
				fmt.Println(elbv2.ErrCodeUnsupportedProtocolException, aerr.Error())
			case elbv2.ErrCodeTooManyActionsException:
				fmt.Println(elbv2.ErrCodeTooManyActionsException, aerr.Error())
			case elbv2.ErrCodeInvalidLoadBalancerActionException:
				fmt.Println(elbv2.ErrCodeInvalidLoadBalancerActionException, aerr.Error())
			case elbv2.ErrCodeTooManyUniqueTargetGroupsPerLoadBalancerException:
				fmt.Println(elbv2.ErrCodeTooManyUniqueTargetGroupsPerLoadBalancerException, aerr.Error())
			case elbv2.ErrCodeTooManyTagsException:
				fmt.Println(elbv2.ErrCodeTooManyTagsException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ELBV2) CreateRuleRequest

func (c *ELBV2) CreateRuleRequest(input *CreateRuleInput) (req *request.Request, output *CreateRuleOutput)

CreateRuleRequest generates a "aws/request.Request" representing the client's request for the CreateRule operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateRule for more information on using the CreateRule API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateRuleRequest method.
req, resp := client.CreateRuleRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/CreateRule

func (*ELBV2) CreateRuleWithContext added in v1.8.0

func (c *ELBV2) CreateRuleWithContext(ctx aws.Context, input *CreateRuleInput, opts ...request.Option) (*CreateRuleOutput, error)

CreateRuleWithContext is the same as CreateRule with the addition of the ability to pass a context and additional request options.

See CreateRule for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) CreateTargetGroup

func (c *ELBV2) CreateTargetGroup(input *CreateTargetGroupInput) (*CreateTargetGroupOutput, error)

CreateTargetGroup API operation for Elastic Load Balancing.

Creates a target group.

For more information, see the following:

This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple target groups with the same settings, each call succeeds.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Elastic Load Balancing's API operation CreateTargetGroup for usage and error information.

Returned Error Codes:

  • ErrCodeDuplicateTargetGroupNameException "DuplicateTargetGroupName" A target group with the specified name already exists.

  • ErrCodeTooManyTargetGroupsException "TooManyTargetGroups" You've reached the limit on the number of target groups for your AWS account.

  • ErrCodeInvalidConfigurationRequestException "InvalidConfigurationRequest" The requested configuration is not valid.

  • ErrCodeTooManyTagsException "TooManyTags" You've reached the limit on the number of tags per load balancer.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/CreateTargetGroup

Example (Shared00)

To create a target group

This example creates a target group that you can use to route traffic to targets using HTTP on port 80. This target group uses the default health check configuration.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elbv2"
)

func main() {
	svc := elbv2.New(session.New())
	input := &elbv2.CreateTargetGroupInput{
		Name:     aws.String("my-targets"),
		Port:     aws.Int64(80),
		Protocol: aws.String("HTTP"),
		VpcId:    aws.String("vpc-3ac0fb5f"),
	}

	result, err := svc.CreateTargetGroup(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elbv2.ErrCodeDuplicateTargetGroupNameException:
				fmt.Println(elbv2.ErrCodeDuplicateTargetGroupNameException, aerr.Error())
			case elbv2.ErrCodeTooManyTargetGroupsException:
				fmt.Println(elbv2.ErrCodeTooManyTargetGroupsException, aerr.Error())
			case elbv2.ErrCodeInvalidConfigurationRequestException:
				fmt.Println(elbv2.ErrCodeInvalidConfigurationRequestException, aerr.Error())
			case elbv2.ErrCodeTooManyTagsException:
				fmt.Println(elbv2.ErrCodeTooManyTagsException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ELBV2) CreateTargetGroupRequest

func (c *ELBV2) CreateTargetGroupRequest(input *CreateTargetGroupInput) (req *request.Request, output *CreateTargetGroupOutput)

CreateTargetGroupRequest generates a "aws/request.Request" representing the client's request for the CreateTargetGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateTargetGroup for more information on using the CreateTargetGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateTargetGroupRequest method.
req, resp := client.CreateTargetGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/CreateTargetGroup

func (*ELBV2) CreateTargetGroupWithContext added in v1.8.0

func (c *ELBV2) CreateTargetGroupWithContext(ctx aws.Context, input *CreateTargetGroupInput, opts ...request.Option) (*CreateTargetGroupOutput, error)

CreateTargetGroupWithContext is the same as CreateTargetGroup with the addition of the ability to pass a context and additional request options.

See CreateTargetGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) DeleteListener

func (c *ELBV2) DeleteListener(input *DeleteListenerInput) (*DeleteListenerOutput, error)

DeleteListener API operation for Elastic Load Balancing.

Deletes the specified listener.

Alternatively, your listener is deleted when you delete the load balancer to which it is attached.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Elastic Load Balancing's API operation DeleteListener for usage and error information.

Returned Error Codes:

  • ErrCodeListenerNotFoundException "ListenerNotFound" The specified listener does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/DeleteListener

Example (Shared00)

To delete a listener

This example deletes the specified listener.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elbv2"
)

func main() {
	svc := elbv2.New(session.New())
	input := &elbv2.DeleteListenerInput{
		ListenerArn: aws.String("arn:aws:elasticloadbalancing:ua-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2"),
	}

	result, err := svc.DeleteListener(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elbv2.ErrCodeListenerNotFoundException:
				fmt.Println(elbv2.ErrCodeListenerNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ELBV2) DeleteListenerRequest

func (c *ELBV2) DeleteListenerRequest(input *DeleteListenerInput) (req *request.Request, output *DeleteListenerOutput)

DeleteListenerRequest generates a "aws/request.Request" representing the client's request for the DeleteListener operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteListener for more information on using the DeleteListener API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteListenerRequest method.
req, resp := client.DeleteListenerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/DeleteListener

func (*ELBV2) DeleteListenerWithContext added in v1.8.0

func (c *ELBV2) DeleteListenerWithContext(ctx aws.Context, input *DeleteListenerInput, opts ...request.Option) (*DeleteListenerOutput, error)

DeleteListenerWithContext is the same as DeleteListener with the addition of the ability to pass a context and additional request options.

See DeleteListener for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) DeleteLoadBalancer

func (c *ELBV2) DeleteLoadBalancer(input *DeleteLoadBalancerInput) (*DeleteLoadBalancerOutput, error)

DeleteLoadBalancer API operation for Elastic Load Balancing.

Deletes the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. Deleting a load balancer also deletes its listeners.

You can't delete a load balancer if deletion protection is enabled. If the load balancer does not exist or has already been deleted, the call succeeds.

Deleting a load balancer does not affect its registered targets. For example, your EC2 instances continue to run and are still registered to their target groups. If you no longer need these EC2 instances, you can stop or terminate them.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Elastic Load Balancing's API operation DeleteLoadBalancer for usage and error information.

Returned Error Codes:

  • ErrCodeLoadBalancerNotFoundException "LoadBalancerNotFound" The specified load balancer does not exist.

  • ErrCodeOperationNotPermittedException "OperationNotPermitted" This operation is not allowed.

  • ErrCodeResourceInUseException "ResourceInUse" A specified resource is in use.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/DeleteLoadBalancer

Example (Shared00)

To delete a load balancer

This example deletes the specified load balancer.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elbv2"
)

func main() {
	svc := elbv2.New(session.New())
	input := &elbv2.DeleteLoadBalancerInput{
		LoadBalancerArn: aws.String("arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188"),
	}

	result, err := svc.DeleteLoadBalancer(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elbv2.ErrCodeLoadBalancerNotFoundException:
				fmt.Println(elbv2.ErrCodeLoadBalancerNotFoundException, aerr.Error())
			case elbv2.ErrCodeOperationNotPermittedException:
				fmt.Println(elbv2.ErrCodeOperationNotPermittedException, aerr.Error())
			case elbv2.ErrCodeResourceInUseException:
				fmt.Println(elbv2.ErrCodeResourceInUseException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ELBV2) DeleteLoadBalancerRequest

func (c *ELBV2) DeleteLoadBalancerRequest(input *DeleteLoadBalancerInput) (req *request.Request, output *DeleteLoadBalancerOutput)

DeleteLoadBalancerRequest generates a "aws/request.Request" representing the client's request for the DeleteLoadBalancer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteLoadBalancer for more information on using the DeleteLoadBalancer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteLoadBalancerRequest method.
req, resp := client.DeleteLoadBalancerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/DeleteLoadBalancer

func (*ELBV2) DeleteLoadBalancerWithContext added in v1.8.0

func (c *ELBV2) DeleteLoadBalancerWithContext(ctx aws.Context, input *DeleteLoadBalancerInput, opts ...request.Option) (*DeleteLoadBalancerOutput, error)

DeleteLoadBalancerWithContext is the same as DeleteLoadBalancer with the addition of the ability to pass a context and additional request options.

See DeleteLoadBalancer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) DeleteRule

func (c *ELBV2) DeleteRule(input *DeleteRuleInput) (*DeleteRuleOutput, error)

DeleteRule API operation for Elastic Load Balancing.

Deletes the specified rule.

You can't delete the default rule.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Elastic Load Balancing's API operation DeleteRule for usage and error information.

Returned Error Codes:

  • ErrCodeRuleNotFoundException "RuleNotFound" The specified rule does not exist.

  • ErrCodeOperationNotPermittedException "OperationNotPermitted" This operation is not allowed.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/DeleteRule

Example (Shared00)

To delete a rule

This example deletes the specified rule.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elbv2"
)

func main() {
	svc := elbv2.New(session.New())
	input := &elbv2.DeleteRuleInput{
		RuleArn: aws.String("arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/1291d13826f405c3"),
	}

	result, err := svc.DeleteRule(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elbv2.ErrCodeRuleNotFoundException:
				fmt.Println(elbv2.ErrCodeRuleNotFoundException, aerr.Error())
			case elbv2.ErrCodeOperationNotPermittedException:
				fmt.Println(elbv2.ErrCodeOperationNotPermittedException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ELBV2) DeleteRuleRequest

func (c *ELBV2) DeleteRuleRequest(input *DeleteRuleInput) (req *request.Request, output *DeleteRuleOutput)

DeleteRuleRequest generates a "aws/request.Request" representing the client's request for the DeleteRule operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteRule for more information on using the DeleteRule API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteRuleRequest method.
req, resp := client.DeleteRuleRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/DeleteRule

func (*ELBV2) DeleteRuleWithContext added in v1.8.0

func (c *ELBV2) DeleteRuleWithContext(ctx aws.Context, input *DeleteRuleInput, opts ...request.Option) (*DeleteRuleOutput, error)

DeleteRuleWithContext is the same as DeleteRule with the addition of the ability to pass a context and additional request options.

See DeleteRule for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) DeleteTargetGroup

func (c *ELBV2) DeleteTargetGroup(input *DeleteTargetGroupInput) (*DeleteTargetGroupOutput, error)

DeleteTargetGroup API operation for Elastic Load Balancing.

Deletes the specified target group.

You can delete a target group if it is not referenced by any actions. Deleting a target group also deletes any associated health checks. Deleting a target group does not affect its registered targets. For example, any EC2 instances continue to run until you stop or terminate them.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Elastic Load Balancing's API operation DeleteTargetGroup for usage and error information.

Returned Error Codes:

  • ErrCodeResourceInUseException "ResourceInUse" A specified resource is in use.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/DeleteTargetGroup

Example (Shared00)

To delete a target group

This example deletes the specified target group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elbv2"
)

func main() {
	svc := elbv2.New(session.New())
	input := &elbv2.DeleteTargetGroupInput{
		TargetGroupArn: aws.String("arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"),
	}

	result, err := svc.DeleteTargetGroup(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elbv2.ErrCodeResourceInUseException:
				fmt.Println(elbv2.ErrCodeResourceInUseException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ELBV2) DeleteTargetGroupRequest

func (c *ELBV2) DeleteTargetGroupRequest(input *DeleteTargetGroupInput) (req *request.Request, output *DeleteTargetGroupOutput)

DeleteTargetGroupRequest generates a "aws/request.Request" representing the client's request for the DeleteTargetGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteTargetGroup for more information on using the DeleteTargetGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteTargetGroupRequest method.
req, resp := client.DeleteTargetGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/DeleteTargetGroup

func (*ELBV2) DeleteTargetGroupWithContext added in v1.8.0

func (c *ELBV2) DeleteTargetGroupWithContext(ctx aws.Context, input *DeleteTargetGroupInput, opts ...request.Option) (*DeleteTargetGroupOutput, error)

DeleteTargetGroupWithContext is the same as DeleteTargetGroup with the addition of the ability to pass a context and additional request options.

See DeleteTargetGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) DeregisterTargets

func (c *ELBV2) DeregisterTargets(input *DeregisterTargetsInput) (*DeregisterTargetsOutput, error)

DeregisterTargets API operation for Elastic Load Balancing.

Deregisters the specified targets from the specified target group. After the targets are deregistered, they no longer receive traffic from the load balancer.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Elastic Load Balancing's API operation DeregisterTargets for usage and error information.

Returned Error Codes:

  • ErrCodeTargetGroupNotFoundException "TargetGroupNotFound" The specified target group does not exist.

  • ErrCodeInvalidTargetException "InvalidTarget" The specified target does not exist, is not in the same VPC as the target group, or has an unsupported instance type.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/DeregisterTargets

Example (Shared00)

To deregister a target from a target group

This example deregisters the specified instance from the specified target group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elbv2"
)

func main() {
	svc := elbv2.New(session.New())
	input := &elbv2.DeregisterTargetsInput{
		TargetGroupArn: aws.String("arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"),
		Targets: []*elbv2.TargetDescription{
			{
				Id: aws.String("i-0f76fade"),
			},
		},
	}

	result, err := svc.DeregisterTargets(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elbv2.ErrCodeTargetGroupNotFoundException:
				fmt.Println(elbv2.ErrCodeTargetGroupNotFoundException, aerr.Error())
			case elbv2.ErrCodeInvalidTargetException:
				fmt.Println(elbv2.ErrCodeInvalidTargetException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ELBV2) DeregisterTargetsRequest

func (c *ELBV2) DeregisterTargetsRequest(input *DeregisterTargetsInput) (req *request.Request, output *DeregisterTargetsOutput)

DeregisterTargetsRequest generates a "aws/request.Request" representing the client's request for the DeregisterTargets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeregisterTargets for more information on using the DeregisterTargets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeregisterTargetsRequest method.
req, resp := client.DeregisterTargetsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/DeregisterTargets

func (*ELBV2) DeregisterTargetsWithContext added in v1.8.0

func (c *ELBV2) DeregisterTargetsWithContext(ctx aws.Context, input *DeregisterTargetsInput, opts ...request.Option) (*DeregisterTargetsOutput, error)

DeregisterTargetsWithContext is the same as DeregisterTargets with the addition of the ability to pass a context and additional request options.

See DeregisterTargets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) DescribeAccountLimits added in v1.8.22

func (c *ELBV2) DescribeAccountLimits(input *DescribeAccountLimitsInput) (*DescribeAccountLimitsOutput, error)

DescribeAccountLimits API operation for Elastic Load Balancing.

Describes the current Elastic Load Balancing resource limits for your AWS account.

For more information, see the following:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Elastic Load Balancing's API operation DescribeAccountLimits for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/DescribeAccountLimits

func (*ELBV2) DescribeAccountLimitsRequest added in v1.8.22

func (c *ELBV2) DescribeAccountLimitsRequest(input *DescribeAccountLimitsInput) (req *request.Request, output *DescribeAccountLimitsOutput)

DescribeAccountLimitsRequest generates a "aws/request.Request" representing the client's request for the DescribeAccountLimits operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAccountLimits for more information on using the DescribeAccountLimits API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeAccountLimitsRequest method.
req, resp := client.DescribeAccountLimitsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/DescribeAccountLimits

func (*ELBV2) DescribeAccountLimitsWithContext added in v1.8.22

func (c *ELBV2) DescribeAccountLimitsWithContext(ctx aws.Context, input *DescribeAccountLimitsInput, opts ...request.Option) (*DescribeAccountLimitsOutput, error)

DescribeAccountLimitsWithContext is the same as DescribeAccountLimits with the addition of the ability to pass a context and additional request options.

See DescribeAccountLimits for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) DescribeListenerCertificates added in v1.12.8

func (c *ELBV2) DescribeListenerCertificates(input *DescribeListenerCertificatesInput) (*DescribeListenerCertificatesOutput, error)

DescribeListenerCertificates API operation for Elastic Load Balancing.

Describes the default certificate and the certificate list for the specified HTTPS or TLS listener.

If the default certificate is also in the certificate list, it appears twice in the results (once with IsDefault set to true and once with IsDefault set to false).

For more information, see SSL certificates (https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#https-listener-certificates) in the Application Load Balancers Guide or Server certificates (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#tls-listener-certificate) in the Network Load Balancers Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Elastic Load Balancing's API operation DescribeListenerCertificates for usage and error information.

Returned Error Codes:

  • ErrCodeListenerNotFoundException "ListenerNotFound" The specified listener does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/DescribeListenerCertificates

func (*ELBV2) DescribeListenerCertificatesRequest added in v1.12.8

func (c *ELBV2) DescribeListenerCertificatesRequest(input *DescribeListenerCertificatesInput) (req *request.Request, output *DescribeListenerCertificatesOutput)

DescribeListenerCertificatesRequest generates a "aws/request.Request" representing the client's request for the DescribeListenerCertificates operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeListenerCertificates for more information on using the DescribeListenerCertificates API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeListenerCertificatesRequest method.
req, resp := client.DescribeListenerCertificatesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/DescribeListenerCertificates

func (*ELBV2) DescribeListenerCertificatesWithContext added in v1.12.8

func (c *ELBV2) DescribeListenerCertificatesWithContext(ctx aws.Context, input *DescribeListenerCertificatesInput, opts ...request.Option) (*DescribeListenerCertificatesOutput, error)

DescribeListenerCertificatesWithContext is the same as DescribeListenerCertificates with the addition of the ability to pass a context and additional request options.

See DescribeListenerCertificates for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) DescribeListeners

func (c *ELBV2) DescribeListeners(input *DescribeListenersInput) (*DescribeListenersOutput, error)

DescribeListeners API operation for Elastic Load Balancing.

Describes the specified listeners or the listeners for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. You must specify either a load balancer or one or more listeners.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Elastic Load Balancing's API operation DescribeListeners for usage and error information.

Returned Error Codes:

  • ErrCodeListenerNotFoundException "ListenerNotFound" The specified listener does not exist.

  • ErrCodeLoadBalancerNotFoundException "LoadBalancerNotFound" The specified load balancer does not exist.

  • ErrCodeUnsupportedProtocolException "UnsupportedProtocol" The specified protocol is not supported.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/DescribeListeners

Example (Shared00)

To describe a listener

This example describes the specified listener.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elbv2"
)

func main() {
	svc := elbv2.New(session.New())
	input := &elbv2.DescribeListenersInput{
		ListenerArns: []*string{
			aws.String("arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2"),
		},
	}

	result, err := svc.DescribeListeners(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elbv2.ErrCodeListenerNotFoundException:
				fmt.Println(elbv2.ErrCodeListenerNotFoundException, aerr.Error())
			case elbv2.ErrCodeLoadBalancerNotFoundException:
				fmt.Println(elbv2.ErrCodeLoadBalancerNotFoundException, aerr.Error())
			case elbv2.ErrCodeUnsupportedProtocolException:
				fmt.Println(elbv2.ErrCodeUnsupportedProtocolException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ELBV2) DescribeListenersPages

func (c *ELBV2) DescribeListenersPages(input *DescribeListenersInput, fn func(*DescribeListenersOutput, bool) bool) error

DescribeListenersPages iterates over the pages of a DescribeListeners operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeListeners method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeListeners operation.
pageNum := 0
err := client.DescribeListenersPages(params,
    func(page *elbv2.DescribeListenersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ELBV2) DescribeListenersPagesWithContext added in v1.8.0

func (c *ELBV2) DescribeListenersPagesWithContext(ctx aws.Context, input *DescribeListenersInput, fn func(*DescribeListenersOutput, bool) bool, opts ...request.Option) error

DescribeListenersPagesWithContext same as DescribeListenersPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) DescribeListenersRequest

func (c *ELBV2) DescribeListenersRequest(input *DescribeListenersInput) (req *request.Request, output *DescribeListenersOutput)

DescribeListenersRequest generates a "aws/request.Request" representing the client's request for the DescribeListeners operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeListeners for more information on using the DescribeListeners API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeListenersRequest method.
req, resp := client.DescribeListenersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/DescribeListeners

func (*ELBV2) DescribeListenersWithContext added in v1.8.0

func (c *ELBV2) DescribeListenersWithContext(ctx aws.Context, input *DescribeListenersInput, opts ...request.Option) (*DescribeListenersOutput, error)

DescribeListenersWithContext is the same as DescribeListeners with the addition of the ability to pass a context and additional request options.

See DescribeListeners for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) DescribeLoadBalancerAttributes

func (c *ELBV2) DescribeLoadBalancerAttributes(input *DescribeLoadBalancerAttributesInput) (*DescribeLoadBalancerAttributesOutput, error)

DescribeLoadBalancerAttributes API operation for Elastic Load Balancing.

Describes the attributes for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.

For more information, see the following:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Elastic Load Balancing's API operation DescribeLoadBalancerAttributes for usage and error information.

Returned Error Codes:

  • ErrCodeLoadBalancerNotFoundException "LoadBalancerNotFound" The specified load balancer does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/DescribeLoadBalancerAttributes

Example (Shared00)

To describe load balancer attributes

This example describes the attributes of the specified load balancer.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elbv2"
)

func main() {
	svc := elbv2.New(session.New())
	input := &elbv2.DescribeLoadBalancerAttributesInput{
		LoadBalancerArn: aws.String("arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188"),
	}

	result, err := svc.DescribeLoadBalancerAttributes(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elbv2.ErrCodeLoadBalancerNotFoundException:
				fmt.Println(elbv2.ErrCodeLoadBalancerNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ELBV2) DescribeLoadBalancerAttributesRequest

func (c *ELBV2) DescribeLoadBalancerAttributesRequest(input *DescribeLoadBalancerAttributesInput) (req *request.Request, output *DescribeLoadBalancerAttributesOutput)

DescribeLoadBalancerAttributesRequest generates a "aws/request.Request" representing the client's request for the DescribeLoadBalancerAttributes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeLoadBalancerAttributes for more information on using the DescribeLoadBalancerAttributes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeLoadBalancerAttributesRequest method.
req, resp := client.DescribeLoadBalancerAttributesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/DescribeLoadBalancerAttributes

func (*ELBV2) DescribeLoadBalancerAttributesWithContext added in v1.8.0

func (c *ELBV2) DescribeLoadBalancerAttributesWithContext(ctx aws.Context, input *DescribeLoadBalancerAttributesInput, opts ...request.Option) (*DescribeLoadBalancerAttributesOutput, error)

DescribeLoadBalancerAttributesWithContext is the same as DescribeLoadBalancerAttributes with the addition of the ability to pass a context and additional request options.

See DescribeLoadBalancerAttributes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) DescribeLoadBalancers

func (c *ELBV2) DescribeLoadBalancers(input *DescribeLoadBalancersInput) (*DescribeLoadBalancersOutput, error)

DescribeLoadBalancers API operation for Elastic Load Balancing.

Describes the specified load balancers or all of your load balancers.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Elastic Load Balancing's API operation DescribeLoadBalancers for usage and error information.

Returned Error Codes:

  • ErrCodeLoadBalancerNotFoundException "LoadBalancerNotFound" The specified load balancer does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/DescribeLoadBalancers

Example (Shared00)

To describe a load balancer

This example describes the specified load balancer.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elbv2"
)

func main() {
	svc := elbv2.New(session.New())
	input := &elbv2.DescribeLoadBalancersInput{
		LoadBalancerArns: []*string{
			aws.String("arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188"),
		},
	}

	result, err := svc.DescribeLoadBalancers(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elbv2.ErrCodeLoadBalancerNotFoundException:
				fmt.Println(elbv2.ErrCodeLoadBalancerNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ELBV2) DescribeLoadBalancersPages

func (c *ELBV2) DescribeLoadBalancersPages(input *DescribeLoadBalancersInput, fn func(*DescribeLoadBalancersOutput, bool) bool) error

DescribeLoadBalancersPages iterates over the pages of a DescribeLoadBalancers operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeLoadBalancers method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeLoadBalancers operation.
pageNum := 0
err := client.DescribeLoadBalancersPages(params,
    func(page *elbv2.DescribeLoadBalancersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ELBV2) DescribeLoadBalancersPagesWithContext added in v1.8.0

func (c *ELBV2) DescribeLoadBalancersPagesWithContext(ctx aws.Context, input *DescribeLoadBalancersInput, fn func(*DescribeLoadBalancersOutput, bool) bool, opts ...request.Option) error

DescribeLoadBalancersPagesWithContext same as DescribeLoadBalancersPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) DescribeLoadBalancersRequest

func (c *ELBV2) DescribeLoadBalancersRequest(input *DescribeLoadBalancersInput) (req *request.Request, output *DescribeLoadBalancersOutput)

DescribeLoadBalancersRequest generates a "aws/request.Request" representing the client's request for the DescribeLoadBalancers operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeLoadBalancers for more information on using the DescribeLoadBalancers API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeLoadBalancersRequest method.
req, resp := client.DescribeLoadBalancersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/DescribeLoadBalancers

func (*ELBV2) DescribeLoadBalancersWithContext added in v1.8.0

func (c *ELBV2) DescribeLoadBalancersWithContext(ctx aws.Context, input *DescribeLoadBalancersInput, opts ...request.Option) (*DescribeLoadBalancersOutput, error)

DescribeLoadBalancersWithContext is the same as DescribeLoadBalancers with the addition of the ability to pass a context and additional request options.

See DescribeLoadBalancers for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) DescribeRules

func (c *ELBV2) DescribeRules(input *DescribeRulesInput) (*DescribeRulesOutput, error)

DescribeRules API operation for Elastic Load Balancing.

Describes the specified rules or the rules for the specified listener. You must specify either a listener or one or more rules.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Elastic Load Balancing's API operation DescribeRules for usage and error information.

Returned Error Codes:

  • ErrCodeListenerNotFoundException "ListenerNotFound" The specified listener does not exist.

  • ErrCodeRuleNotFoundException "RuleNotFound" The specified rule does not exist.

  • ErrCodeUnsupportedProtocolException "UnsupportedProtocol" The specified protocol is not supported.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/DescribeRules

Example (Shared00)

To describe a rule

This example describes the specified rule.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elbv2"
)

func main() {
	svc := elbv2.New(session.New())
	input := &elbv2.DescribeRulesInput{
		RuleArns: []*string{
			aws.String("arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee"),
		},
	}

	result, err := svc.DescribeRules(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elbv2.ErrCodeListenerNotFoundException:
				fmt.Println(elbv2.ErrCodeListenerNotFoundException, aerr.Error())
			case elbv2.ErrCodeRuleNotFoundException:
				fmt.Println(elbv2.ErrCodeRuleNotFoundException, aerr.Error())
			case elbv2.ErrCodeUnsupportedProtocolException:
				fmt.Println(elbv2.ErrCodeUnsupportedProtocolException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ELBV2) DescribeRulesRequest

func (c *ELBV2) DescribeRulesRequest(input *DescribeRulesInput) (req *request.Request, output *DescribeRulesOutput)

DescribeRulesRequest generates a "aws/request.Request" representing the client's request for the DescribeRules operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeRules for more information on using the DescribeRules API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeRulesRequest method.
req, resp := client.DescribeRulesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/DescribeRules

func (*ELBV2) DescribeRulesWithContext added in v1.8.0

func (c *ELBV2) DescribeRulesWithContext(ctx aws.Context, input *DescribeRulesInput, opts ...request.Option) (*DescribeRulesOutput, error)

DescribeRulesWithContext is the same as DescribeRules with the addition of the ability to pass a context and additional request options.

See DescribeRules for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) DescribeSSLPolicies

func (c *ELBV2) DescribeSSLPolicies(input *DescribeSSLPoliciesInput) (*DescribeSSLPoliciesOutput, error)

DescribeSSLPolicies API operation for Elastic Load Balancing.

Describes the specified policies or all policies used for SSL negotiation.

For more information, see Security policies (https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies) in the Application Load Balancers Guide or Security policies (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies) in the Network Load Balancers Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Elastic Load Balancing's API operation DescribeSSLPolicies for usage and error information.

Returned Error Codes:

  • ErrCodeSSLPolicyNotFoundException "SSLPolicyNotFound" The specified SSL policy does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/DescribeSSLPolicies

Example (Shared00)

To describe a policy used for SSL negotiation

This example describes the specified policy used for SSL negotiation.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elbv2"
)

func main() {
	svc := elbv2.New(session.New())
	input := &elbv2.DescribeSSLPoliciesInput{
		Names: []*string{
			aws.String("ELBSecurityPolicy-2015-05"),
		},
	}

	result, err := svc.DescribeSSLPolicies(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elbv2.ErrCodeSSLPolicyNotFoundException:
				fmt.Println(elbv2.ErrCodeSSLPolicyNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ELBV2) DescribeSSLPoliciesRequest

func (c *ELBV2) DescribeSSLPoliciesRequest(input *DescribeSSLPoliciesInput) (req *request.Request, output *DescribeSSLPoliciesOutput)

DescribeSSLPoliciesRequest generates a "aws/request.Request" representing the client's request for the DescribeSSLPolicies operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeSSLPolicies for more information on using the DescribeSSLPolicies API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeSSLPoliciesRequest method.
req, resp := client.DescribeSSLPoliciesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/DescribeSSLPolicies

func (*ELBV2) DescribeSSLPoliciesWithContext added in v1.8.0

func (c *ELBV2) DescribeSSLPoliciesWithContext(ctx aws.Context, input *DescribeSSLPoliciesInput, opts ...request.Option) (*DescribeSSLPoliciesOutput, error)

DescribeSSLPoliciesWithContext is the same as DescribeSSLPolicies with the addition of the ability to pass a context and additional request options.

See DescribeSSLPolicies for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) DescribeTags

func (c *ELBV2) DescribeTags(input *DescribeTagsInput) (*DescribeTagsOutput, error)

DescribeTags API operation for Elastic Load Balancing.

Describes the tags for the specified Elastic Load Balancing resources. You can describe the tags for one or more Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, or rules.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Elastic Load Balancing's API operation DescribeTags for usage and error information.

Returned Error Codes:

  • ErrCodeLoadBalancerNotFoundException "LoadBalancerNotFound" The specified load balancer does not exist.

  • ErrCodeTargetGroupNotFoundException "TargetGroupNotFound" The specified target group does not exist.

  • ErrCodeListenerNotFoundException "ListenerNotFound" The specified listener does not exist.

  • ErrCodeRuleNotFoundException "RuleNotFound" The specified rule does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/DescribeTags

Example (Shared00)

To describe the tags assigned to a load balancer

This example describes the tags assigned to the specified load balancer.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elbv2"
)

func main() {
	svc := elbv2.New(session.New())
	input := &elbv2.DescribeTagsInput{
		ResourceArns: []*string{
			aws.String("arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188"),
		},
	}

	result, err := svc.DescribeTags(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elbv2.ErrCodeLoadBalancerNotFoundException:
				fmt.Println(elbv2.ErrCodeLoadBalancerNotFoundException, aerr.Error())
			case elbv2.ErrCodeTargetGroupNotFoundException:
				fmt.Println(elbv2.ErrCodeTargetGroupNotFoundException, aerr.Error())
			case elbv2.ErrCodeListenerNotFoundException:
				fmt.Println(elbv2.ErrCodeListenerNotFoundException, aerr.Error())
			case elbv2.ErrCodeRuleNotFoundException:
				fmt.Println(elbv2.ErrCodeRuleNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ELBV2) DescribeTagsRequest

func (c *ELBV2) DescribeTagsRequest(input *DescribeTagsInput) (req *request.Request, output *DescribeTagsOutput)

DescribeTagsRequest generates a "aws/request.Request" representing the client's request for the DescribeTags operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeTags for more information on using the DescribeTags API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeTagsRequest method.
req, resp := client.DescribeTagsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/DescribeTags

func (*ELBV2) DescribeTagsWithContext added in v1.8.0

func (c *ELBV2) DescribeTagsWithContext(ctx aws.Context, input *DescribeTagsInput, opts ...request.Option) (*DescribeTagsOutput, error)

DescribeTagsWithContext is the same as DescribeTags with the addition of the ability to pass a context and additional request options.

See DescribeTags for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) DescribeTargetGroupAttributes

func (c *ELBV2) DescribeTargetGroupAttributes(input *DescribeTargetGroupAttributesInput) (*DescribeTargetGroupAttributesOutput, error)

DescribeTargetGroupAttributes API operation for Elastic Load Balancing.

Describes the attributes for the specified target group.

For more information, see the following:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Elastic Load Balancing's API operation DescribeTargetGroupAttributes for usage and error information.

Returned Error Codes:

  • ErrCodeTargetGroupNotFoundException "TargetGroupNotFound" The specified target group does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/DescribeTargetGroupAttributes

Example (Shared00)

To describe target group attributes

This example describes the attributes of the specified target group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elbv2"
)

func main() {
	svc := elbv2.New(session.New())
	input := &elbv2.DescribeTargetGroupAttributesInput{
		TargetGroupArn: aws.String("arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"),
	}

	result, err := svc.DescribeTargetGroupAttributes(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elbv2.ErrCodeTargetGroupNotFoundException:
				fmt.Println(elbv2.ErrCodeTargetGroupNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ELBV2) DescribeTargetGroupAttributesRequest

func (c *ELBV2) DescribeTargetGroupAttributesRequest(input *DescribeTargetGroupAttributesInput) (req *request.Request, output *DescribeTargetGroupAttributesOutput)

DescribeTargetGroupAttributesRequest generates a "aws/request.Request" representing the client's request for the DescribeTargetGroupAttributes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeTargetGroupAttributes for more information on using the DescribeTargetGroupAttributes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeTargetGroupAttributesRequest method.
req, resp := client.DescribeTargetGroupAttributesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/DescribeTargetGroupAttributes

func (*ELBV2) DescribeTargetGroupAttributesWithContext added in v1.8.0

func (c *ELBV2) DescribeTargetGroupAttributesWithContext(ctx aws.Context, input *DescribeTargetGroupAttributesInput, opts ...request.Option) (*DescribeTargetGroupAttributesOutput, error)

DescribeTargetGroupAttributesWithContext is the same as DescribeTargetGroupAttributes with the addition of the ability to pass a context and additional request options.

See DescribeTargetGroupAttributes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) DescribeTargetGroups

func (c *ELBV2) DescribeTargetGroups(input *DescribeTargetGroupsInput) (*DescribeTargetGroupsOutput, error)

DescribeTargetGroups API operation for Elastic Load Balancing.

Describes the specified target groups or all of your target groups. By default, all target groups are described. Alternatively, you can specify one of the following to filter the results: the ARN of the load balancer, the names of one or more target groups, or the ARNs of one or more target groups.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Elastic Load Balancing's API operation DescribeTargetGroups for usage and error information.

Returned Error Codes:

  • ErrCodeLoadBalancerNotFoundException "LoadBalancerNotFound" The specified load balancer does not exist.

  • ErrCodeTargetGroupNotFoundException "TargetGroupNotFound" The specified target group does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/DescribeTargetGroups

Example (Shared00)

To describe a target group

This example describes the specified target group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elbv2"
)

func main() {
	svc := elbv2.New(session.New())
	input := &elbv2.DescribeTargetGroupsInput{
		TargetGroupArns: []*string{
			aws.String("arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"),
		},
	}

	result, err := svc.DescribeTargetGroups(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elbv2.ErrCodeLoadBalancerNotFoundException:
				fmt.Println(elbv2.ErrCodeLoadBalancerNotFoundException, aerr.Error())
			case elbv2.ErrCodeTargetGroupNotFoundException:
				fmt.Println(elbv2.ErrCodeTargetGroupNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ELBV2) DescribeTargetGroupsPages

func (c *ELBV2) DescribeTargetGroupsPages(input *DescribeTargetGroupsInput, fn func(*DescribeTargetGroupsOutput, bool) bool) error

DescribeTargetGroupsPages iterates over the pages of a DescribeTargetGroups operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeTargetGroups method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeTargetGroups operation.
pageNum := 0
err := client.DescribeTargetGroupsPages(params,
    func(page *elbv2.DescribeTargetGroupsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ELBV2) DescribeTargetGroupsPagesWithContext added in v1.8.0

func (c *ELBV2) DescribeTargetGroupsPagesWithContext(ctx aws.Context, input *DescribeTargetGroupsInput, fn func(*DescribeTargetGroupsOutput, bool) bool, opts ...request.Option) error

DescribeTargetGroupsPagesWithContext same as DescribeTargetGroupsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) DescribeTargetGroupsRequest

func (c *ELBV2) DescribeTargetGroupsRequest(input *DescribeTargetGroupsInput) (req *request.Request, output *DescribeTargetGroupsOutput)

DescribeTargetGroupsRequest generates a "aws/request.Request" representing the client's request for the DescribeTargetGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeTargetGroups for more information on using the DescribeTargetGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeTargetGroupsRequest method.
req, resp := client.DescribeTargetGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/DescribeTargetGroups

func (*ELBV2) DescribeTargetGroupsWithContext added in v1.8.0

func (c *ELBV2) DescribeTargetGroupsWithContext(ctx aws.Context, input *DescribeTargetGroupsInput, opts ...request.Option) (*DescribeTargetGroupsOutput, error)

DescribeTargetGroupsWithContext is the same as DescribeTargetGroups with the addition of the ability to pass a context and additional request options.

See DescribeTargetGroups for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) DescribeTargetHealth

func (c *ELBV2) DescribeTargetHealth(input *DescribeTargetHealthInput) (*DescribeTargetHealthOutput, error)

DescribeTargetHealth API operation for Elastic Load Balancing.

Describes the health of the specified targets or all of your targets.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Elastic Load Balancing's API operation DescribeTargetHealth for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidTargetException "InvalidTarget" The specified target does not exist, is not in the same VPC as the target group, or has an unsupported instance type.

  • ErrCodeTargetGroupNotFoundException "TargetGroupNotFound" The specified target group does not exist.

  • ErrCodeHealthUnavailableException "HealthUnavailable" The health of the specified targets could not be retrieved due to an internal error.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/DescribeTargetHealth

Example (Shared00)

To describe the health of the targets for a target group

This example describes the health of the targets for the specified target group. One target is healthy but the other is not specified in an action, so it can't receive traffic from the load balancer.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elbv2"
)

func main() {
	svc := elbv2.New(session.New())
	input := &elbv2.DescribeTargetHealthInput{
		TargetGroupArn: aws.String("arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"),
	}

	result, err := svc.DescribeTargetHealth(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elbv2.ErrCodeInvalidTargetException:
				fmt.Println(elbv2.ErrCodeInvalidTargetException, aerr.Error())
			case elbv2.ErrCodeTargetGroupNotFoundException:
				fmt.Println(elbv2.ErrCodeTargetGroupNotFoundException, aerr.Error())
			case elbv2.ErrCodeHealthUnavailableException:
				fmt.Println(elbv2.ErrCodeHealthUnavailableException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

Example (Shared01)

To describe the health of a target

This example describes the health of the specified target. This target is healthy.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elbv2"
)

func main() {
	svc := elbv2.New(session.New())
	input := &elbv2.DescribeTargetHealthInput{
		TargetGroupArn: aws.String("arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"),
		Targets: []*elbv2.TargetDescription{
			{
				Id:   aws.String("i-0f76fade"),
				Port: aws.Int64(80),
			},
		},
	}

	result, err := svc.DescribeTargetHealth(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elbv2.ErrCodeInvalidTargetException:
				fmt.Println(elbv2.ErrCodeInvalidTargetException, aerr.Error())
			case elbv2.ErrCodeTargetGroupNotFoundException:
				fmt.Println(elbv2.ErrCodeTargetGroupNotFoundException, aerr.Error())
			case elbv2.ErrCodeHealthUnavailableException:
				fmt.Println(elbv2.ErrCodeHealthUnavailableException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ELBV2) DescribeTargetHealthRequest

func (c *ELBV2) DescribeTargetHealthRequest(input *DescribeTargetHealthInput) (req *request.Request, output *DescribeTargetHealthOutput)

DescribeTargetHealthRequest generates a "aws/request.Request" representing the client's request for the DescribeTargetHealth operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeTargetHealth for more information on using the DescribeTargetHealth API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeTargetHealthRequest method.
req, resp := client.DescribeTargetHealthRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/DescribeTargetHealth

func (*ELBV2) DescribeTargetHealthWithContext added in v1.8.0

func (c *ELBV2) DescribeTargetHealthWithContext(ctx aws.Context, input *DescribeTargetHealthInput, opts ...request.Option) (*DescribeTargetHealthOutput, error)

DescribeTargetHealthWithContext is the same as DescribeTargetHealth with the addition of the ability to pass a context and additional request options.

See DescribeTargetHealth for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) ModifyListener

func (c *ELBV2) ModifyListener(input *ModifyListenerInput) (*ModifyListenerOutput, error)

ModifyListener API operation for Elastic Load Balancing.

Replaces the specified properties of the specified listener. Any properties that you do not specify remain unchanged.

Changing the protocol from HTTPS to HTTP, or from TLS to TCP, removes the security policy and default certificate properties. If you change the protocol from HTTP to HTTPS, or from TCP to TLS, you must add the security policy and default certificate properties.

To add an item to a list, remove an item from a list, or update an item in a list, you must provide the entire list. For example, to add an action, specify a list with the current actions plus the new action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Elastic Load Balancing's API operation ModifyListener for usage and error information.

Returned Error Codes:

  • ErrCodeDuplicateListenerException "DuplicateListener" A listener with the specified port already exists.

  • ErrCodeTooManyListenersException "TooManyListeners" You've reached the limit on the number of listeners per load balancer.

  • ErrCodeTooManyCertificatesException "TooManyCertificates" You've reached the limit on the number of certificates per load balancer.

  • ErrCodeListenerNotFoundException "ListenerNotFound" The specified listener does not exist.

  • ErrCodeTargetGroupNotFoundException "TargetGroupNotFound" The specified target group does not exist.

  • ErrCodeTargetGroupAssociationLimitException "TargetGroupAssociationLimit" You've reached the limit on the number of load balancers per target group.

  • ErrCodeIncompatibleProtocolsException "IncompatibleProtocols" The specified configuration is not valid with this protocol.

  • ErrCodeSSLPolicyNotFoundException "SSLPolicyNotFound" The specified SSL policy does not exist.

  • ErrCodeCertificateNotFoundException "CertificateNotFound" The specified certificate does not exist.

  • ErrCodeInvalidConfigurationRequestException "InvalidConfigurationRequest" The requested configuration is not valid.

  • ErrCodeUnsupportedProtocolException "UnsupportedProtocol" The specified protocol is not supported.

  • ErrCodeTooManyRegistrationsForTargetIdException "TooManyRegistrationsForTargetId" You've reached the limit on the number of times a target can be registered with a load balancer.

  • ErrCodeTooManyTargetsException "TooManyTargets" You've reached the limit on the number of targets.

  • ErrCodeTooManyActionsException "TooManyActions" You've reached the limit on the number of actions per rule.

  • ErrCodeInvalidLoadBalancerActionException "InvalidLoadBalancerAction" The requested action is not valid.

  • ErrCodeTooManyUniqueTargetGroupsPerLoadBalancerException "TooManyUniqueTargetGroupsPerLoadBalancer" You've reached the limit on the number of unique target groups per load balancer across all listeners. If a target group is used by multiple actions for a load balancer, it is counted as only one use.

  • ErrCodeALPNPolicyNotSupportedException "ALPNPolicyNotFound" The specified ALPN policy is not supported.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/ModifyListener

Example (Shared00)

To change the default action for a listener

This example changes the default action for the specified listener.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elbv2"
)

func main() {
	svc := elbv2.New(session.New())
	input := &elbv2.ModifyListenerInput{
		DefaultActions: []*elbv2.Action{
			{
				TargetGroupArn: aws.String("arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-targets/2453ed029918f21f"),
				Type:           aws.String("forward"),
			},
		},
		ListenerArn: aws.String("arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2"),
	}

	result, err := svc.ModifyListener(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elbv2.ErrCodeDuplicateListenerException:
				fmt.Println(elbv2.ErrCodeDuplicateListenerException, aerr.Error())
			case elbv2.ErrCodeTooManyListenersException:
				fmt.Println(elbv2.ErrCodeTooManyListenersException, aerr.Error())
			case elbv2.ErrCodeTooManyCertificatesException:
				fmt.Println(elbv2.ErrCodeTooManyCertificatesException, aerr.Error())
			case elbv2.ErrCodeListenerNotFoundException:
				fmt.Println(elbv2.ErrCodeListenerNotFoundException, aerr.Error())
			case elbv2.ErrCodeTargetGroupNotFoundException:
				fmt.Println(elbv2.ErrCodeTargetGroupNotFoundException, aerr.Error())
			case elbv2.ErrCodeTargetGroupAssociationLimitException:
				fmt.Println(elbv2.ErrCodeTargetGroupAssociationLimitException, aerr.Error())
			case elbv2.ErrCodeIncompatibleProtocolsException:
				fmt.Println(elbv2.ErrCodeIncompatibleProtocolsException, aerr.Error())
			case elbv2.ErrCodeSSLPolicyNotFoundException:
				fmt.Println(elbv2.ErrCodeSSLPolicyNotFoundException, aerr.Error())
			case elbv2.ErrCodeCertificateNotFoundException:
				fmt.Println(elbv2.ErrCodeCertificateNotFoundException, aerr.Error())
			case elbv2.ErrCodeInvalidConfigurationRequestException:
				fmt.Println(elbv2.ErrCodeInvalidConfigurationRequestException, aerr.Error())
			case elbv2.ErrCodeUnsupportedProtocolException:
				fmt.Println(elbv2.ErrCodeUnsupportedProtocolException, aerr.Error())
			case elbv2.ErrCodeTooManyRegistrationsForTargetIdException:
				fmt.Println(elbv2.ErrCodeTooManyRegistrationsForTargetIdException, aerr.Error())
			case elbv2.ErrCodeTooManyTargetsException:
				fmt.Println(elbv2.ErrCodeTooManyTargetsException, aerr.Error())
			case elbv2.ErrCodeTooManyActionsException:
				fmt.Println(elbv2.ErrCodeTooManyActionsException, aerr.Error())
			case elbv2.ErrCodeInvalidLoadBalancerActionException:
				fmt.Println(elbv2.ErrCodeInvalidLoadBalancerActionException, aerr.Error())
			case elbv2.ErrCodeTooManyUniqueTargetGroupsPerLoadBalancerException:
				fmt.Println(elbv2.ErrCodeTooManyUniqueTargetGroupsPerLoadBalancerException, aerr.Error())
			case elbv2.ErrCodeALPNPolicyNotSupportedException:
				fmt.Println(elbv2.ErrCodeALPNPolicyNotSupportedException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

Example (Shared01)

To change the server certificate

This example changes the server certificate for the specified HTTPS listener.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elbv2"
)

func main() {
	svc := elbv2.New(session.New())
	input := &elbv2.ModifyListenerInput{
		Certificates: []*elbv2.Certificate{
			{
				CertificateArn: aws.String("arn:aws:iam::123456789012:server-certificate/my-new-server-cert"),
			},
		},
		ListenerArn: aws.String("arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/0467ef3c8400ae65"),
	}

	result, err := svc.ModifyListener(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elbv2.ErrCodeDuplicateListenerException:
				fmt.Println(elbv2.ErrCodeDuplicateListenerException, aerr.Error())
			case elbv2.ErrCodeTooManyListenersException:
				fmt.Println(elbv2.ErrCodeTooManyListenersException, aerr.Error())
			case elbv2.ErrCodeTooManyCertificatesException:
				fmt.Println(elbv2.ErrCodeTooManyCertificatesException, aerr.Error())
			case elbv2.ErrCodeListenerNotFoundException:
				fmt.Println(elbv2.ErrCodeListenerNotFoundException, aerr.Error())
			case elbv2.ErrCodeTargetGroupNotFoundException:
				fmt.Println(elbv2.ErrCodeTargetGroupNotFoundException, aerr.Error())
			case elbv2.ErrCodeTargetGroupAssociationLimitException:
				fmt.Println(elbv2.ErrCodeTargetGroupAssociationLimitException, aerr.Error())
			case elbv2.ErrCodeIncompatibleProtocolsException:
				fmt.Println(elbv2.ErrCodeIncompatibleProtocolsException, aerr.Error())
			case elbv2.ErrCodeSSLPolicyNotFoundException:
				fmt.Println(elbv2.ErrCodeSSLPolicyNotFoundException, aerr.Error())
			case elbv2.ErrCodeCertificateNotFoundException:
				fmt.Println(elbv2.ErrCodeCertificateNotFoundException, aerr.Error())
			case elbv2.ErrCodeInvalidConfigurationRequestException:
				fmt.Println(elbv2.ErrCodeInvalidConfigurationRequestException, aerr.Error())
			case elbv2.ErrCodeUnsupportedProtocolException:
				fmt.Println(elbv2.ErrCodeUnsupportedProtocolException, aerr.Error())
			case elbv2.ErrCodeTooManyRegistrationsForTargetIdException:
				fmt.Println(elbv2.ErrCodeTooManyRegistrationsForTargetIdException, aerr.Error())
			case elbv2.ErrCodeTooManyTargetsException:
				fmt.Println(elbv2.ErrCodeTooManyTargetsException, aerr.Error())
			case elbv2.ErrCodeTooManyActionsException:
				fmt.Println(elbv2.ErrCodeTooManyActionsException, aerr.Error())
			case elbv2.ErrCodeInvalidLoadBalancerActionException:
				fmt.Println(elbv2.ErrCodeInvalidLoadBalancerActionException, aerr.Error())
			case elbv2.ErrCodeTooManyUniqueTargetGroupsPerLoadBalancerException:
				fmt.Println(elbv2.ErrCodeTooManyUniqueTargetGroupsPerLoadBalancerException, aerr.Error())
			case elbv2.ErrCodeALPNPolicyNotSupportedException:
				fmt.Println(elbv2.ErrCodeALPNPolicyNotSupportedException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ELBV2) ModifyListenerRequest

func (c *ELBV2) ModifyListenerRequest(input *ModifyListenerInput) (req *request.Request, output *ModifyListenerOutput)

ModifyListenerRequest generates a "aws/request.Request" representing the client's request for the ModifyListener operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifyListener for more information on using the ModifyListener API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ModifyListenerRequest method.
req, resp := client.ModifyListenerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/ModifyListener

func (*ELBV2) ModifyListenerWithContext added in v1.8.0

func (c *ELBV2) ModifyListenerWithContext(ctx aws.Context, input *ModifyListenerInput, opts ...request.Option) (*ModifyListenerOutput, error)

ModifyListenerWithContext is the same as ModifyListener with the addition of the ability to pass a context and additional request options.

See ModifyListener for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) ModifyLoadBalancerAttributes

func (c *ELBV2) ModifyLoadBalancerAttributes(input *ModifyLoadBalancerAttributesInput) (*ModifyLoadBalancerAttributesOutput, error)

ModifyLoadBalancerAttributes API operation for Elastic Load Balancing.

Modifies the specified attributes of the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.

If any of the specified attributes can't be modified as requested, the call fails. Any existing attributes that you do not modify retain their current values.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Elastic Load Balancing's API operation ModifyLoadBalancerAttributes for usage and error information.

Returned Error Codes:

  • ErrCodeLoadBalancerNotFoundException "LoadBalancerNotFound" The specified load balancer does not exist.

  • ErrCodeInvalidConfigurationRequestException "InvalidConfigurationRequest" The requested configuration is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/ModifyLoadBalancerAttributes

Example (Shared00)

To enable deletion protection

This example enables deletion protection for the specified load balancer.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elbv2"
)

func main() {
	svc := elbv2.New(session.New())
	input := &elbv2.ModifyLoadBalancerAttributesInput{
		Attributes: []*elbv2.LoadBalancerAttribute{
			{
				Key:   aws.String("deletion_protection.enabled"),
				Value: aws.String("true"),
			},
		},
		LoadBalancerArn: aws.String("arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188"),
	}

	result, err := svc.ModifyLoadBalancerAttributes(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elbv2.ErrCodeLoadBalancerNotFoundException:
				fmt.Println(elbv2.ErrCodeLoadBalancerNotFoundException, aerr.Error())
			case elbv2.ErrCodeInvalidConfigurationRequestException:
				fmt.Println(elbv2.ErrCodeInvalidConfigurationRequestException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

Example (Shared01)

To change the idle timeout

This example changes the idle timeout value for the specified load balancer.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elbv2"
)

func main() {
	svc := elbv2.New(session.New())
	input := &elbv2.ModifyLoadBalancerAttributesInput{
		Attributes: []*elbv2.LoadBalancerAttribute{
			{
				Key:   aws.String("idle_timeout.timeout_seconds"),
				Value: aws.String("30"),
			},
		},
		LoadBalancerArn: aws.String("arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188"),
	}

	result, err := svc.ModifyLoadBalancerAttributes(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elbv2.ErrCodeLoadBalancerNotFoundException:
				fmt.Println(elbv2.ErrCodeLoadBalancerNotFoundException, aerr.Error())
			case elbv2.ErrCodeInvalidConfigurationRequestException:
				fmt.Println(elbv2.ErrCodeInvalidConfigurationRequestException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

Example (Shared02)

To enable access logs

This example enables access logs for the specified load balancer. Note that the S3 bucket must exist in the same region as the load balancer and must have a policy attached that grants access to the Elastic Load Balancing service.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elbv2"
)

func main() {
	svc := elbv2.New(session.New())
	input := &elbv2.ModifyLoadBalancerAttributesInput{
		Attributes: []*elbv2.LoadBalancerAttribute{
			{
				Key:   aws.String("access_logs.s3.enabled"),
				Value: aws.String("true"),
			},
			{
				Key:   aws.String("access_logs.s3.bucket"),
				Value: aws.String("my-loadbalancer-logs"),
			},
			{
				Key:   aws.String("access_logs.s3.prefix"),
				Value: aws.String("myapp"),
			},
		},
		LoadBalancerArn: aws.String("arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188"),
	}

	result, err := svc.ModifyLoadBalancerAttributes(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elbv2.ErrCodeLoadBalancerNotFoundException:
				fmt.Println(elbv2.ErrCodeLoadBalancerNotFoundException, aerr.Error())
			case elbv2.ErrCodeInvalidConfigurationRequestException:
				fmt.Println(elbv2.ErrCodeInvalidConfigurationRequestException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ELBV2) ModifyLoadBalancerAttributesRequest

func (c *ELBV2) ModifyLoadBalancerAttributesRequest(input *ModifyLoadBalancerAttributesInput) (req *request.Request, output *ModifyLoadBalancerAttributesOutput)

ModifyLoadBalancerAttributesRequest generates a "aws/request.Request" representing the client's request for the ModifyLoadBalancerAttributes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifyLoadBalancerAttributes for more information on using the ModifyLoadBalancerAttributes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ModifyLoadBalancerAttributesRequest method.
req, resp := client.ModifyLoadBalancerAttributesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/ModifyLoadBalancerAttributes

func (*ELBV2) ModifyLoadBalancerAttributesWithContext added in v1.8.0

func (c *ELBV2) ModifyLoadBalancerAttributesWithContext(ctx aws.Context, input *ModifyLoadBalancerAttributesInput, opts ...request.Option) (*ModifyLoadBalancerAttributesOutput, error)

ModifyLoadBalancerAttributesWithContext is the same as ModifyLoadBalancerAttributes with the addition of the ability to pass a context and additional request options.

See ModifyLoadBalancerAttributes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) ModifyRule

func (c *ELBV2) ModifyRule(input *ModifyRuleInput) (*ModifyRuleOutput, error)

ModifyRule API operation for Elastic Load Balancing.

Replaces the specified properties of the specified rule. Any properties that you do not specify are unchanged.

To add an item to a list, remove an item from a list, or update an item in a list, you must provide the entire list. For example, to add an action, specify a list with the current actions plus the new action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Elastic Load Balancing's API operation ModifyRule for usage and error information.

Returned Error Codes:

  • ErrCodeTargetGroupAssociationLimitException "TargetGroupAssociationLimit" You've reached the limit on the number of load balancers per target group.

  • ErrCodeIncompatibleProtocolsException "IncompatibleProtocols" The specified configuration is not valid with this protocol.

  • ErrCodeRuleNotFoundException "RuleNotFound" The specified rule does not exist.

  • ErrCodeOperationNotPermittedException "OperationNotPermitted" This operation is not allowed.

  • ErrCodeTooManyRegistrationsForTargetIdException "TooManyRegistrationsForTargetId" You've reached the limit on the number of times a target can be registered with a load balancer.

  • ErrCodeTooManyTargetsException "TooManyTargets" You've reached the limit on the number of targets.

  • ErrCodeTargetGroupNotFoundException "TargetGroupNotFound" The specified target group does not exist.

  • ErrCodeUnsupportedProtocolException "UnsupportedProtocol" The specified protocol is not supported.

  • ErrCodeTooManyActionsException "TooManyActions" You've reached the limit on the number of actions per rule.

  • ErrCodeInvalidLoadBalancerActionException "InvalidLoadBalancerAction" The requested action is not valid.

  • ErrCodeTooManyUniqueTargetGroupsPerLoadBalancerException "TooManyUniqueTargetGroupsPerLoadBalancer" You've reached the limit on the number of unique target groups per load balancer across all listeners. If a target group is used by multiple actions for a load balancer, it is counted as only one use.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/ModifyRule

Example (Shared00)

To modify a rule

This example modifies the condition for the specified rule.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elbv2"
)

func main() {
	svc := elbv2.New(session.New())
	input := &elbv2.ModifyRuleInput{
		Conditions: []*elbv2.RuleCondition{
			{
				Field: aws.String("path-pattern"),
				Values: []*string{
					aws.String("/images/*"),
				},
			},
		},
		RuleArn: aws.String("arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee"),
	}

	result, err := svc.ModifyRule(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elbv2.ErrCodeTargetGroupAssociationLimitException:
				fmt.Println(elbv2.ErrCodeTargetGroupAssociationLimitException, aerr.Error())
			case elbv2.ErrCodeIncompatibleProtocolsException:
				fmt.Println(elbv2.ErrCodeIncompatibleProtocolsException, aerr.Error())
			case elbv2.ErrCodeRuleNotFoundException:
				fmt.Println(elbv2.ErrCodeRuleNotFoundException, aerr.Error())
			case elbv2.ErrCodeOperationNotPermittedException:
				fmt.Println(elbv2.ErrCodeOperationNotPermittedException, aerr.Error())
			case elbv2.ErrCodeTooManyRegistrationsForTargetIdException:
				fmt.Println(elbv2.ErrCodeTooManyRegistrationsForTargetIdException, aerr.Error())
			case elbv2.ErrCodeTooManyTargetsException:
				fmt.Println(elbv2.ErrCodeTooManyTargetsException, aerr.Error())
			case elbv2.ErrCodeTargetGroupNotFoundException:
				fmt.Println(elbv2.ErrCodeTargetGroupNotFoundException, aerr.Error())
			case elbv2.ErrCodeUnsupportedProtocolException:
				fmt.Println(elbv2.ErrCodeUnsupportedProtocolException, aerr.Error())
			case elbv2.ErrCodeTooManyActionsException:
				fmt.Println(elbv2.ErrCodeTooManyActionsException, aerr.Error())
			case elbv2.ErrCodeInvalidLoadBalancerActionException:
				fmt.Println(elbv2.ErrCodeInvalidLoadBalancerActionException, aerr.Error())
			case elbv2.ErrCodeTooManyUniqueTargetGroupsPerLoadBalancerException:
				fmt.Println(elbv2.ErrCodeTooManyUniqueTargetGroupsPerLoadBalancerException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ELBV2) ModifyRuleRequest

func (c *ELBV2) ModifyRuleRequest(input *ModifyRuleInput) (req *request.Request, output *ModifyRuleOutput)

ModifyRuleRequest generates a "aws/request.Request" representing the client's request for the ModifyRule operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifyRule for more information on using the ModifyRule API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ModifyRuleRequest method.
req, resp := client.ModifyRuleRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/ModifyRule

func (*ELBV2) ModifyRuleWithContext added in v1.8.0

func (c *ELBV2) ModifyRuleWithContext(ctx aws.Context, input *ModifyRuleInput, opts ...request.Option) (*ModifyRuleOutput, error)

ModifyRuleWithContext is the same as ModifyRule with the addition of the ability to pass a context and additional request options.

See ModifyRule for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) ModifyTargetGroup

func (c *ELBV2) ModifyTargetGroup(input *ModifyTargetGroupInput) (*ModifyTargetGroupOutput, error)

ModifyTargetGroup API operation for Elastic Load Balancing.

Modifies the health checks used when evaluating the health state of the targets in the specified target group.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Elastic Load Balancing's API operation ModifyTargetGroup for usage and error information.

Returned Error Codes:

  • ErrCodeTargetGroupNotFoundException "TargetGroupNotFound" The specified target group does not exist.

  • ErrCodeInvalidConfigurationRequestException "InvalidConfigurationRequest" The requested configuration is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/ModifyTargetGroup

Example (Shared00)

To modify the health check configuration for a target group

This example changes the configuration of the health checks used to evaluate the health of the targets for the specified target group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elbv2"
)

func main() {
	svc := elbv2.New(session.New())
	input := &elbv2.ModifyTargetGroupInput{
		HealthCheckPort:     aws.String("443"),
		HealthCheckProtocol: aws.String("HTTPS"),
		TargetGroupArn:      aws.String("arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-https-targets/2453ed029918f21f"),
	}

	result, err := svc.ModifyTargetGroup(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elbv2.ErrCodeTargetGroupNotFoundException:
				fmt.Println(elbv2.ErrCodeTargetGroupNotFoundException, aerr.Error())
			case elbv2.ErrCodeInvalidConfigurationRequestException:
				fmt.Println(elbv2.ErrCodeInvalidConfigurationRequestException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ELBV2) ModifyTargetGroupAttributes

func (c *ELBV2) ModifyTargetGroupAttributes(input *ModifyTargetGroupAttributesInput) (*ModifyTargetGroupAttributesOutput, error)

ModifyTargetGroupAttributes API operation for Elastic Load Balancing.

Modifies the specified attributes of the specified target group.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Elastic Load Balancing's API operation ModifyTargetGroupAttributes for usage and error information.

Returned Error Codes:

  • ErrCodeTargetGroupNotFoundException "TargetGroupNotFound" The specified target group does not exist.

  • ErrCodeInvalidConfigurationRequestException "InvalidConfigurationRequest" The requested configuration is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/ModifyTargetGroupAttributes

Example (Shared00)

To modify the deregistration delay timeout

This example sets the deregistration delay timeout to the specified value for the specified target group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elbv2"
)

func main() {
	svc := elbv2.New(session.New())
	input := &elbv2.ModifyTargetGroupAttributesInput{
		Attributes: []*elbv2.TargetGroupAttribute{
			{
				Key:   aws.String("deregistration_delay.timeout_seconds"),
				Value: aws.String("600"),
			},
		},
		TargetGroupArn: aws.String("arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"),
	}

	result, err := svc.ModifyTargetGroupAttributes(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elbv2.ErrCodeTargetGroupNotFoundException:
				fmt.Println(elbv2.ErrCodeTargetGroupNotFoundException, aerr.Error())
			case elbv2.ErrCodeInvalidConfigurationRequestException:
				fmt.Println(elbv2.ErrCodeInvalidConfigurationRequestException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ELBV2) ModifyTargetGroupAttributesRequest

func (c *ELBV2) ModifyTargetGroupAttributesRequest(input *ModifyTargetGroupAttributesInput) (req *request.Request, output *ModifyTargetGroupAttributesOutput)

ModifyTargetGroupAttributesRequest generates a "aws/request.Request" representing the client's request for the ModifyTargetGroupAttributes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifyTargetGroupAttributes for more information on using the ModifyTargetGroupAttributes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ModifyTargetGroupAttributesRequest method.
req, resp := client.ModifyTargetGroupAttributesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/ModifyTargetGroupAttributes

func (*ELBV2) ModifyTargetGroupAttributesWithContext added in v1.8.0

func (c *ELBV2) ModifyTargetGroupAttributesWithContext(ctx aws.Context, input *ModifyTargetGroupAttributesInput, opts ...request.Option) (*ModifyTargetGroupAttributesOutput, error)

ModifyTargetGroupAttributesWithContext is the same as ModifyTargetGroupAttributes with the addition of the ability to pass a context and additional request options.

See ModifyTargetGroupAttributes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) ModifyTargetGroupRequest

func (c *ELBV2) ModifyTargetGroupRequest(input *ModifyTargetGroupInput) (req *request.Request, output *ModifyTargetGroupOutput)

ModifyTargetGroupRequest generates a "aws/request.Request" representing the client's request for the ModifyTargetGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifyTargetGroup for more information on using the ModifyTargetGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ModifyTargetGroupRequest method.
req, resp := client.ModifyTargetGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/ModifyTargetGroup

func (*ELBV2) ModifyTargetGroupWithContext added in v1.8.0

func (c *ELBV2) ModifyTargetGroupWithContext(ctx aws.Context, input *ModifyTargetGroupInput, opts ...request.Option) (*ModifyTargetGroupOutput, error)

ModifyTargetGroupWithContext is the same as ModifyTargetGroup with the addition of the ability to pass a context and additional request options.

See ModifyTargetGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) RegisterTargets

func (c *ELBV2) RegisterTargets(input *RegisterTargetsInput) (*RegisterTargetsOutput, error)

RegisterTargets API operation for Elastic Load Balancing.

Registers the specified targets with the specified target group.

If the target is an EC2 instance, it must be in the running state when you register it.

By default, the load balancer routes requests to registered targets using the protocol and port for the target group. Alternatively, you can override the port for a target when you register it. You can register each EC2 instance or IP address with the same target group multiple times using different ports.

With a Network Load Balancer, you cannot register instances by instance ID if they have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1. You can register instances of these types by IP address.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Elastic Load Balancing's API operation RegisterTargets for usage and error information.

Returned Error Codes:

  • ErrCodeTargetGroupNotFoundException "TargetGroupNotFound" The specified target group does not exist.

  • ErrCodeTooManyTargetsException "TooManyTargets" You've reached the limit on the number of targets.

  • ErrCodeInvalidTargetException "InvalidTarget" The specified target does not exist, is not in the same VPC as the target group, or has an unsupported instance type.

  • ErrCodeTooManyRegistrationsForTargetIdException "TooManyRegistrationsForTargetId" You've reached the limit on the number of times a target can be registered with a load balancer.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/RegisterTargets

Example (Shared00)

To register targets with a target group

This example registers the specified instances with the specified target group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elbv2"
)

func main() {
	svc := elbv2.New(session.New())
	input := &elbv2.RegisterTargetsInput{
		TargetGroupArn: aws.String("arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"),
		Targets: []*elbv2.TargetDescription{
			{
				Id: aws.String("i-80c8dd94"),
			},
			{
				Id: aws.String("i-ceddcd4d"),
			},
		},
	}

	result, err := svc.RegisterTargets(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elbv2.ErrCodeTargetGroupNotFoundException:
				fmt.Println(elbv2.ErrCodeTargetGroupNotFoundException, aerr.Error())
			case elbv2.ErrCodeTooManyTargetsException:
				fmt.Println(elbv2.ErrCodeTooManyTargetsException, aerr.Error())
			case elbv2.ErrCodeInvalidTargetException:
				fmt.Println(elbv2.ErrCodeInvalidTargetException, aerr.Error())
			case elbv2.ErrCodeTooManyRegistrationsForTargetIdException:
				fmt.Println(elbv2.ErrCodeTooManyRegistrationsForTargetIdException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

Example (Shared01)

To register targets with a target group using port overrides

This example registers the specified instance with the specified target group using multiple ports. This enables you to register ECS containers on the same instance as targets in the target group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elbv2"
)

func main() {
	svc := elbv2.New(session.New())
	input := &elbv2.RegisterTargetsInput{
		TargetGroupArn: aws.String("arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-targets/3bb63f11dfb0faf9"),
		Targets: []*elbv2.TargetDescription{
			{
				Id:   aws.String("i-80c8dd94"),
				Port: aws.Int64(80),
			},
			{
				Id:   aws.String("i-80c8dd94"),
				Port: aws.Int64(766),
			},
		},
	}

	result, err := svc.RegisterTargets(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elbv2.ErrCodeTargetGroupNotFoundException:
				fmt.Println(elbv2.ErrCodeTargetGroupNotFoundException, aerr.Error())
			case elbv2.ErrCodeTooManyTargetsException:
				fmt.Println(elbv2.ErrCodeTooManyTargetsException, aerr.Error())
			case elbv2.ErrCodeInvalidTargetException:
				fmt.Println(elbv2.ErrCodeInvalidTargetException, aerr.Error())
			case elbv2.ErrCodeTooManyRegistrationsForTargetIdException:
				fmt.Println(elbv2.ErrCodeTooManyRegistrationsForTargetIdException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ELBV2) RegisterTargetsRequest

func (c *ELBV2) RegisterTargetsRequest(input *RegisterTargetsInput) (req *request.Request, output *RegisterTargetsOutput)

RegisterTargetsRequest generates a "aws/request.Request" representing the client's request for the RegisterTargets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RegisterTargets for more information on using the RegisterTargets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RegisterTargetsRequest method.
req, resp := client.RegisterTargetsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/RegisterTargets

func (*ELBV2) RegisterTargetsWithContext added in v1.8.0

func (c *ELBV2) RegisterTargetsWithContext(ctx aws.Context, input *RegisterTargetsInput, opts ...request.Option) (*RegisterTargetsOutput, error)

RegisterTargetsWithContext is the same as RegisterTargets with the addition of the ability to pass a context and additional request options.

See RegisterTargets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) RemoveListenerCertificates added in v1.12.8

func (c *ELBV2) RemoveListenerCertificates(input *RemoveListenerCertificatesInput) (*RemoveListenerCertificatesOutput, error)

RemoveListenerCertificates API operation for Elastic Load Balancing.

Removes the specified certificate from the certificate list for the specified HTTPS or TLS listener.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Elastic Load Balancing's API operation RemoveListenerCertificates for usage and error information.

Returned Error Codes:

  • ErrCodeListenerNotFoundException "ListenerNotFound" The specified listener does not exist.

  • ErrCodeOperationNotPermittedException "OperationNotPermitted" This operation is not allowed.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/RemoveListenerCertificates

func (*ELBV2) RemoveListenerCertificatesRequest added in v1.12.8

func (c *ELBV2) RemoveListenerCertificatesRequest(input *RemoveListenerCertificatesInput) (req *request.Request, output *RemoveListenerCertificatesOutput)

RemoveListenerCertificatesRequest generates a "aws/request.Request" representing the client's request for the RemoveListenerCertificates operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RemoveListenerCertificates for more information on using the RemoveListenerCertificates API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RemoveListenerCertificatesRequest method.
req, resp := client.RemoveListenerCertificatesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/RemoveListenerCertificates

func (*ELBV2) RemoveListenerCertificatesWithContext added in v1.12.8

func (c *ELBV2) RemoveListenerCertificatesWithContext(ctx aws.Context, input *RemoveListenerCertificatesInput, opts ...request.Option) (*RemoveListenerCertificatesOutput, error)

RemoveListenerCertificatesWithContext is the same as RemoveListenerCertificates with the addition of the ability to pass a context and additional request options.

See RemoveListenerCertificates for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) RemoveTags

func (c *ELBV2) RemoveTags(input *RemoveTagsInput) (*RemoveTagsOutput, error)

RemoveTags API operation for Elastic Load Balancing.

Removes the specified tags from the specified Elastic Load Balancing resources. You can remove the tags for one or more Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, or rules.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Elastic Load Balancing's API operation RemoveTags for usage and error information.

Returned Error Codes:

  • ErrCodeLoadBalancerNotFoundException "LoadBalancerNotFound" The specified load balancer does not exist.

  • ErrCodeTargetGroupNotFoundException "TargetGroupNotFound" The specified target group does not exist.

  • ErrCodeListenerNotFoundException "ListenerNotFound" The specified listener does not exist.

  • ErrCodeRuleNotFoundException "RuleNotFound" The specified rule does not exist.

  • ErrCodeTooManyTagsException "TooManyTags" You've reached the limit on the number of tags per load balancer.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/RemoveTags

Example (Shared00)

To remove tags from a load balancer

This example removes the specified tags from the specified load balancer.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elbv2"
)

func main() {
	svc := elbv2.New(session.New())
	input := &elbv2.RemoveTagsInput{
		ResourceArns: []*string{
			aws.String("arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188"),
		},
		TagKeys: []*string{
			aws.String("project"),
			aws.String("department"),
		},
	}

	result, err := svc.RemoveTags(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elbv2.ErrCodeLoadBalancerNotFoundException:
				fmt.Println(elbv2.ErrCodeLoadBalancerNotFoundException, aerr.Error())
			case elbv2.ErrCodeTargetGroupNotFoundException:
				fmt.Println(elbv2.ErrCodeTargetGroupNotFoundException, aerr.Error())
			case elbv2.ErrCodeListenerNotFoundException:
				fmt.Println(elbv2.ErrCodeListenerNotFoundException, aerr.Error())
			case elbv2.ErrCodeRuleNotFoundException:
				fmt.Println(elbv2.ErrCodeRuleNotFoundException, aerr.Error())
			case elbv2.ErrCodeTooManyTagsException:
				fmt.Println(elbv2.ErrCodeTooManyTagsException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ELBV2) RemoveTagsRequest

func (c *ELBV2) RemoveTagsRequest(input *RemoveTagsInput) (req *request.Request, output *RemoveTagsOutput)

RemoveTagsRequest generates a "aws/request.Request" representing the client's request for the RemoveTags operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RemoveTags for more information on using the RemoveTags API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RemoveTagsRequest method.
req, resp := client.RemoveTagsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/RemoveTags

func (*ELBV2) RemoveTagsWithContext added in v1.8.0

func (c *ELBV2) RemoveTagsWithContext(ctx aws.Context, input *RemoveTagsInput, opts ...request.Option) (*RemoveTagsOutput, error)

RemoveTagsWithContext is the same as RemoveTags with the addition of the ability to pass a context and additional request options.

See RemoveTags for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) SetIpAddressType added in v1.6.17

func (c *ELBV2) SetIpAddressType(input *SetIpAddressTypeInput) (*SetIpAddressTypeOutput, error)

SetIpAddressType API operation for Elastic Load Balancing.

Sets the type of IP addresses used by the subnets of the specified Application Load Balancer or Network Load Balancer.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Elastic Load Balancing's API operation SetIpAddressType for usage and error information.

Returned Error Codes:

  • ErrCodeLoadBalancerNotFoundException "LoadBalancerNotFound" The specified load balancer does not exist.

  • ErrCodeInvalidConfigurationRequestException "InvalidConfigurationRequest" The requested configuration is not valid.

  • ErrCodeInvalidSubnetException "InvalidSubnet" The specified subnet is out of available addresses.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/SetIpAddressType

func (*ELBV2) SetIpAddressTypeRequest added in v1.6.17

func (c *ELBV2) SetIpAddressTypeRequest(input *SetIpAddressTypeInput) (req *request.Request, output *SetIpAddressTypeOutput)

SetIpAddressTypeRequest generates a "aws/request.Request" representing the client's request for the SetIpAddressType operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SetIpAddressType for more information on using the SetIpAddressType API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the SetIpAddressTypeRequest method.
req, resp := client.SetIpAddressTypeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/SetIpAddressType

func (*ELBV2) SetIpAddressTypeWithContext added in v1.8.0

func (c *ELBV2) SetIpAddressTypeWithContext(ctx aws.Context, input *SetIpAddressTypeInput, opts ...request.Option) (*SetIpAddressTypeOutput, error)

SetIpAddressTypeWithContext is the same as SetIpAddressType with the addition of the ability to pass a context and additional request options.

See SetIpAddressType for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) SetRulePriorities

func (c *ELBV2) SetRulePriorities(input *SetRulePrioritiesInput) (*SetRulePrioritiesOutput, error)

SetRulePriorities API operation for Elastic Load Balancing.

Sets the priorities of the specified rules.

You can reorder the rules as long as there are no priority conflicts in the new order. Any existing rules that you do not specify retain their current priority.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Elastic Load Balancing's API operation SetRulePriorities for usage and error information.

Returned Error Codes:

  • ErrCodeRuleNotFoundException "RuleNotFound" The specified rule does not exist.

  • ErrCodePriorityInUseException "PriorityInUse" The specified priority is in use.

  • ErrCodeOperationNotPermittedException "OperationNotPermitted" This operation is not allowed.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/SetRulePriorities

Example (Shared00)

To set the rule priority

This example sets the priority of the specified rule.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elbv2"
)

func main() {
	svc := elbv2.New(session.New())
	input := &elbv2.SetRulePrioritiesInput{
		RulePriorities: []*elbv2.RulePriorityPair{
			{
				Priority: aws.Int64(5),
				RuleArn:  aws.String("arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/1291d13826f405c3"),
			},
		},
	}

	result, err := svc.SetRulePriorities(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elbv2.ErrCodeRuleNotFoundException:
				fmt.Println(elbv2.ErrCodeRuleNotFoundException, aerr.Error())
			case elbv2.ErrCodePriorityInUseException:
				fmt.Println(elbv2.ErrCodePriorityInUseException, aerr.Error())
			case elbv2.ErrCodeOperationNotPermittedException:
				fmt.Println(elbv2.ErrCodeOperationNotPermittedException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ELBV2) SetRulePrioritiesRequest

func (c *ELBV2) SetRulePrioritiesRequest(input *SetRulePrioritiesInput) (req *request.Request, output *SetRulePrioritiesOutput)

SetRulePrioritiesRequest generates a "aws/request.Request" representing the client's request for the SetRulePriorities operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SetRulePriorities for more information on using the SetRulePriorities API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the SetRulePrioritiesRequest method.
req, resp := client.SetRulePrioritiesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/SetRulePriorities

func (*ELBV2) SetRulePrioritiesWithContext added in v1.8.0

func (c *ELBV2) SetRulePrioritiesWithContext(ctx aws.Context, input *SetRulePrioritiesInput, opts ...request.Option) (*SetRulePrioritiesOutput, error)

SetRulePrioritiesWithContext is the same as SetRulePriorities with the addition of the ability to pass a context and additional request options.

See SetRulePriorities for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) SetSecurityGroups

func (c *ELBV2) SetSecurityGroups(input *SetSecurityGroupsInput) (*SetSecurityGroupsOutput, error)

SetSecurityGroups API operation for Elastic Load Balancing.

Associates the specified security groups with the specified Application Load Balancer. The specified security groups override the previously associated security groups.

You can't specify a security group for a Network Load Balancer or Gateway Load Balancer.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Elastic Load Balancing's API operation SetSecurityGroups for usage and error information.

Returned Error Codes:

  • ErrCodeLoadBalancerNotFoundException "LoadBalancerNotFound" The specified load balancer does not exist.

  • ErrCodeInvalidConfigurationRequestException "InvalidConfigurationRequest" The requested configuration is not valid.

  • ErrCodeInvalidSecurityGroupException "InvalidSecurityGroup" The specified security group does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/SetSecurityGroups

Example (Shared00)

To associate a security group with a load balancer

This example associates the specified security group with the specified load balancer.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elbv2"
)

func main() {
	svc := elbv2.New(session.New())
	input := &elbv2.SetSecurityGroupsInput{
		LoadBalancerArn: aws.String("arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188"),
		SecurityGroups: []*string{
			aws.String("sg-5943793c"),
		},
	}

	result, err := svc.SetSecurityGroups(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elbv2.ErrCodeLoadBalancerNotFoundException:
				fmt.Println(elbv2.ErrCodeLoadBalancerNotFoundException, aerr.Error())
			case elbv2.ErrCodeInvalidConfigurationRequestException:
				fmt.Println(elbv2.ErrCodeInvalidConfigurationRequestException, aerr.Error())
			case elbv2.ErrCodeInvalidSecurityGroupException:
				fmt.Println(elbv2.ErrCodeInvalidSecurityGroupException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ELBV2) SetSecurityGroupsRequest

func (c *ELBV2) SetSecurityGroupsRequest(input *SetSecurityGroupsInput) (req *request.Request, output *SetSecurityGroupsOutput)

SetSecurityGroupsRequest generates a "aws/request.Request" representing the client's request for the SetSecurityGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SetSecurityGroups for more information on using the SetSecurityGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the SetSecurityGroupsRequest method.
req, resp := client.SetSecurityGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/SetSecurityGroups

func (*ELBV2) SetSecurityGroupsWithContext added in v1.8.0

func (c *ELBV2) SetSecurityGroupsWithContext(ctx aws.Context, input *SetSecurityGroupsInput, opts ...request.Option) (*SetSecurityGroupsOutput, error)

SetSecurityGroupsWithContext is the same as SetSecurityGroups with the addition of the ability to pass a context and additional request options.

See SetSecurityGroups for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) SetSubnets

func (c *ELBV2) SetSubnets(input *SetSubnetsInput) (*SetSubnetsOutput, error)

SetSubnets API operation for Elastic Load Balancing.

Enables the Availability Zones for the specified public subnets for the specified Application Load Balancer or Network Load Balancer. The specified subnets replace the previously enabled subnets.

When you specify subnets for a Network Load Balancer, you must include all subnets that were enabled previously, with their existing configurations, plus any additional subnets.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Elastic Load Balancing's API operation SetSubnets for usage and error information.

Returned Error Codes:

  • ErrCodeLoadBalancerNotFoundException "LoadBalancerNotFound" The specified load balancer does not exist.

  • ErrCodeInvalidConfigurationRequestException "InvalidConfigurationRequest" The requested configuration is not valid.

  • ErrCodeSubnetNotFoundException "SubnetNotFound" The specified subnet does not exist.

  • ErrCodeInvalidSubnetException "InvalidSubnet" The specified subnet is out of available addresses.

  • ErrCodeAllocationIdNotFoundException "AllocationIdNotFound" The specified allocation ID does not exist.

  • ErrCodeAvailabilityZoneNotSupportedException "AvailabilityZoneNotSupported" The specified Availability Zone is not supported.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/SetSubnets

Example (Shared00)

To enable Availability Zones for a load balancer

This example enables the Availability Zones for the specified subnets for the specified load balancer.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elbv2"
)

func main() {
	svc := elbv2.New(session.New())
	input := &elbv2.SetSubnetsInput{
		LoadBalancerArn: aws.String("arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188"),
		Subnets: []*string{
			aws.String("subnet-8360a9e7"),
			aws.String("subnet-b7d581c0"),
		},
	}

	result, err := svc.SetSubnets(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elbv2.ErrCodeLoadBalancerNotFoundException:
				fmt.Println(elbv2.ErrCodeLoadBalancerNotFoundException, aerr.Error())
			case elbv2.ErrCodeInvalidConfigurationRequestException:
				fmt.Println(elbv2.ErrCodeInvalidConfigurationRequestException, aerr.Error())
			case elbv2.ErrCodeSubnetNotFoundException:
				fmt.Println(elbv2.ErrCodeSubnetNotFoundException, aerr.Error())
			case elbv2.ErrCodeInvalidSubnetException:
				fmt.Println(elbv2.ErrCodeInvalidSubnetException, aerr.Error())
			case elbv2.ErrCodeAllocationIdNotFoundException:
				fmt.Println(elbv2.ErrCodeAllocationIdNotFoundException, aerr.Error())
			case elbv2.ErrCodeAvailabilityZoneNotSupportedException:
				fmt.Println(elbv2.ErrCodeAvailabilityZoneNotSupportedException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ELBV2) SetSubnetsRequest

func (c *ELBV2) SetSubnetsRequest(input *SetSubnetsInput) (req *request.Request, output *SetSubnetsOutput)

SetSubnetsRequest generates a "aws/request.Request" representing the client's request for the SetSubnets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SetSubnets for more information on using the SetSubnets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the SetSubnetsRequest method.
req, resp := client.SetSubnetsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/SetSubnets

func (*ELBV2) SetSubnetsWithContext added in v1.8.0

func (c *ELBV2) SetSubnetsWithContext(ctx aws.Context, input *SetSubnetsInput, opts ...request.Option) (*SetSubnetsOutput, error)

SetSubnetsWithContext is the same as SetSubnets with the addition of the ability to pass a context and additional request options.

See SetSubnets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) WaitUntilLoadBalancerAvailable added in v1.8.1

func (c *ELBV2) WaitUntilLoadBalancerAvailable(input *DescribeLoadBalancersInput) error

WaitUntilLoadBalancerAvailable uses the Elastic Load Balancing v2 API operation DescribeLoadBalancers to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*ELBV2) WaitUntilLoadBalancerAvailableWithContext added in v1.8.1

func (c *ELBV2) WaitUntilLoadBalancerAvailableWithContext(ctx aws.Context, input *DescribeLoadBalancersInput, opts ...request.WaiterOption) error

WaitUntilLoadBalancerAvailableWithContext is an extended version of WaitUntilLoadBalancerAvailable. With the support for passing in a context and options to configure the Waiter and the underlying request options.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) WaitUntilLoadBalancerExists added in v1.8.1

func (c *ELBV2) WaitUntilLoadBalancerExists(input *DescribeLoadBalancersInput) error

WaitUntilLoadBalancerExists uses the Elastic Load Balancing v2 API operation DescribeLoadBalancers to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*ELBV2) WaitUntilLoadBalancerExistsWithContext added in v1.8.1

func (c *ELBV2) WaitUntilLoadBalancerExistsWithContext(ctx aws.Context, input *DescribeLoadBalancersInput, opts ...request.WaiterOption) error

WaitUntilLoadBalancerExistsWithContext is an extended version of WaitUntilLoadBalancerExists. With the support for passing in a context and options to configure the Waiter and the underlying request options.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) WaitUntilLoadBalancersDeleted added in v1.8.15

func (c *ELBV2) WaitUntilLoadBalancersDeleted(input *DescribeLoadBalancersInput) error

WaitUntilLoadBalancersDeleted uses the Elastic Load Balancing v2 API operation DescribeLoadBalancers to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*ELBV2) WaitUntilLoadBalancersDeletedWithContext added in v1.8.15

func (c *ELBV2) WaitUntilLoadBalancersDeletedWithContext(ctx aws.Context, input *DescribeLoadBalancersInput, opts ...request.WaiterOption) error

WaitUntilLoadBalancersDeletedWithContext is an extended version of WaitUntilLoadBalancersDeleted. With the support for passing in a context and options to configure the Waiter and the underlying request options.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) WaitUntilTargetDeregistered added in v1.10.20

func (c *ELBV2) WaitUntilTargetDeregistered(input *DescribeTargetHealthInput) error

WaitUntilTargetDeregistered uses the Elastic Load Balancing v2 API operation DescribeTargetHealth to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*ELBV2) WaitUntilTargetDeregisteredWithContext added in v1.10.20

func (c *ELBV2) WaitUntilTargetDeregisteredWithContext(ctx aws.Context, input *DescribeTargetHealthInput, opts ...request.WaiterOption) error

WaitUntilTargetDeregisteredWithContext is an extended version of WaitUntilTargetDeregistered. With the support for passing in a context and options to configure the Waiter and the underlying request options.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ELBV2) WaitUntilTargetInService added in v1.10.20

func (c *ELBV2) WaitUntilTargetInService(input *DescribeTargetHealthInput) error

WaitUntilTargetInService uses the Elastic Load Balancing v2 API operation DescribeTargetHealth to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*ELBV2) WaitUntilTargetInServiceWithContext added in v1.10.20

func (c *ELBV2) WaitUntilTargetInServiceWithContext(ctx aws.Context, input *DescribeTargetHealthInput, opts ...request.WaiterOption) error

WaitUntilTargetInServiceWithContext is an extended version of WaitUntilTargetInService. With the support for passing in a context and options to configure the Waiter and the underlying request options.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type FixedResponseActionConfig added in v1.14.33

type FixedResponseActionConfig struct {

	// The content type.
	//
	// Valid Values: text/plain | text/css | text/html | application/javascript
	// | application/json
	ContentType *string `type:"string"`

	// The message.
	MessageBody *string `type:"string"`

	// The HTTP response code (2XX, 4XX, or 5XX).
	//
	// StatusCode is a required field
	StatusCode *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Information about an action that returns a custom HTTP response.

func (FixedResponseActionConfig) GoString added in v1.14.33

func (s FixedResponseActionConfig) GoString() string

GoString returns the string representation

func (*FixedResponseActionConfig) SetContentType added in v1.14.33

SetContentType sets the ContentType field's value.

func (*FixedResponseActionConfig) SetMessageBody added in v1.14.33

SetMessageBody sets the MessageBody field's value.

func (*FixedResponseActionConfig) SetStatusCode added in v1.14.33

SetStatusCode sets the StatusCode field's value.

func (FixedResponseActionConfig) String added in v1.14.33

func (s FixedResponseActionConfig) String() string

String returns the string representation

func (*FixedResponseActionConfig) Validate added in v1.14.33

func (s *FixedResponseActionConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ForwardActionConfig added in v1.25.38

type ForwardActionConfig struct {

	// The target group stickiness for the rule.
	TargetGroupStickinessConfig *TargetGroupStickinessConfig `type:"structure"`

	// One or more target groups. For Network Load Balancers, you can specify a
	// single target group.
	TargetGroups []*TargetGroupTuple `type:"list"`
	// contains filtered or unexported fields
}

Information about a forward action.

func (ForwardActionConfig) GoString added in v1.25.38

func (s ForwardActionConfig) GoString() string

GoString returns the string representation

func (*ForwardActionConfig) SetTargetGroupStickinessConfig added in v1.25.38

func (s *ForwardActionConfig) SetTargetGroupStickinessConfig(v *TargetGroupStickinessConfig) *ForwardActionConfig

SetTargetGroupStickinessConfig sets the TargetGroupStickinessConfig field's value.

func (*ForwardActionConfig) SetTargetGroups added in v1.25.38

func (s *ForwardActionConfig) SetTargetGroups(v []*TargetGroupTuple) *ForwardActionConfig

SetTargetGroups sets the TargetGroups field's value.

func (ForwardActionConfig) String added in v1.25.38

func (s ForwardActionConfig) String() string

String returns the string representation

type HostHeaderConditionConfig added in v1.15.87

type HostHeaderConditionConfig struct {

	// One or more host names. The maximum size of each name is 128 characters.
	// The comparison is case insensitive. The following wildcard characters are
	// supported: * (matches 0 or more characters) and ? (matches exactly 1 character).
	//
	// If you specify multiple strings, the condition is satisfied if one of the
	// strings matches the host name.
	Values []*string `type:"list"`
	// contains filtered or unexported fields
}

Information about a host header condition.

func (HostHeaderConditionConfig) GoString added in v1.15.87

func (s HostHeaderConditionConfig) GoString() string

GoString returns the string representation

func (*HostHeaderConditionConfig) SetValues added in v1.15.87

SetValues sets the Values field's value.

func (HostHeaderConditionConfig) String added in v1.15.87

func (s HostHeaderConditionConfig) String() string

String returns the string representation

type HttpHeaderConditionConfig added in v1.15.87

type HttpHeaderConditionConfig struct {

	// The name of the HTTP header field. The maximum size is 40 characters. The
	// header name is case insensitive. The allowed characters are specified by
	// RFC 7230. Wildcards are not supported.
	//
	// You can't use an HTTP header condition to specify the host header. Use HostHeaderConditionConfig
	// to specify a host header condition.
	HttpHeaderName *string `type:"string"`

	// One or more strings to compare against the value of the HTTP header. The
	// maximum size of each string is 128 characters. The comparison strings are
	// case insensitive. The following wildcard characters are supported: * (matches
	// 0 or more characters) and ? (matches exactly 1 character).
	//
	// If the same header appears multiple times in the request, we search them
	// in order until a match is found.
	//
	// If you specify multiple strings, the condition is satisfied if one of the
	// strings matches the value of the HTTP header. To require that all of the
	// strings are a match, create one condition per string.
	Values []*string `type:"list"`
	// contains filtered or unexported fields
}

Information about an HTTP header condition.

There is a set of standard HTTP header fields. You can also define custom HTTP header fields.

func (HttpHeaderConditionConfig) GoString added in v1.15.87

func (s HttpHeaderConditionConfig) GoString() string

GoString returns the string representation

func (*HttpHeaderConditionConfig) SetHttpHeaderName added in v1.15.87

SetHttpHeaderName sets the HttpHeaderName field's value.

func (*HttpHeaderConditionConfig) SetValues added in v1.15.87

SetValues sets the Values field's value.

func (HttpHeaderConditionConfig) String added in v1.15.87

func (s HttpHeaderConditionConfig) String() string

String returns the string representation

type HttpRequestMethodConditionConfig added in v1.15.87

type HttpRequestMethodConditionConfig struct {

	// The name of the request method. The maximum size is 40 characters. The allowed
	// characters are A-Z, hyphen (-), and underscore (_). The comparison is case
	// sensitive. Wildcards are not supported; therefore, the method name must be
	// an exact match.
	//
	// If you specify multiple strings, the condition is satisfied if one of the
	// strings matches the HTTP request method. We recommend that you route GET
	// and HEAD requests in the same way, because the response to a HEAD request
	// may be cached.
	Values []*string `type:"list"`
	// contains filtered or unexported fields
}

Information about an HTTP method condition.

HTTP defines a set of request methods, also referred to as HTTP verbs. For more information, see the HTTP Method Registry (https://www.iana.org/assignments/http-methods/http-methods.xhtml). You can also define custom HTTP methods.

func (HttpRequestMethodConditionConfig) GoString added in v1.15.87

GoString returns the string representation

func (*HttpRequestMethodConditionConfig) SetValues added in v1.15.87

SetValues sets the Values field's value.

func (HttpRequestMethodConditionConfig) String added in v1.15.87

String returns the string representation

type Limit added in v1.8.22

type Limit struct {

	// The maximum value of the limit.
	Max *string `type:"string"`

	// The name of the limit. The possible values are:
	//
	//    * application-load-balancers
	//
	//    * condition-values-per-alb-rule
	//
	//    * condition-wildcards-per-alb-rule
	//
	//    * gateway-load-balancers
	//
	//    * gateway-load-balancers-per-vpc
	//
	//    * geneve-target-groups
	//
	//    * listeners-per-application-load-balancer
	//
	//    * listeners-per-network-load-balancer
	//
	//    * network-load-balancers
	//
	//    * rules-per-application-load-balancer
	//
	//    * target-groups
	//
	//    * target-groups-per-action-on-application-load-balancer
	//
	//    * target-groups-per-action-on-network-load-balancer
	//
	//    * target-groups-per-application-load-balancer
	//
	//    * targets-per-application-load-balancer
	//
	//    * targets-per-availability-zone-per-gateway-load-balancer
	//
	//    * targets-per-availability-zone-per-network-load-balancer
	//
	//    * targets-per-network-load-balancer
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

Information about an Elastic Load Balancing resource limit for your AWS account.

func (Limit) GoString added in v1.8.22

func (s Limit) GoString() string

GoString returns the string representation

func (*Limit) SetMax added in v1.8.22

func (s *Limit) SetMax(v string) *Limit

SetMax sets the Max field's value.

func (*Limit) SetName added in v1.8.22

func (s *Limit) SetName(v string) *Limit

SetName sets the Name field's value.

func (Limit) String added in v1.8.22

func (s Limit) String() string

String returns the string representation

type Listener

type Listener struct {

	// [TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN)
	// policy.
	AlpnPolicy []*string `type:"list"`

	// [HTTPS or TLS listener] The default certificate for the listener.
	Certificates []*Certificate `type:"list"`

	// The default actions for the listener.
	DefaultActions []*Action `type:"list"`

	// The Amazon Resource Name (ARN) of the listener.
	ListenerArn *string `type:"string"`

	// The Amazon Resource Name (ARN) of the load balancer.
	LoadBalancerArn *string `type:"string"`

	// The port on which the load balancer is listening.
	Port *int64 `min:"1" type:"integer"`

	// The protocol for connections from clients to the load balancer.
	Protocol *string `type:"string" enum:"ProtocolEnum"`

	// [HTTPS or TLS listener] The security policy that defines which protocols
	// and ciphers are supported.
	SslPolicy *string `type:"string"`
	// contains filtered or unexported fields
}

Information about a listener.

func (Listener) GoString

func (s Listener) GoString() string

GoString returns the string representation

func (*Listener) SetAlpnPolicy added in v1.31.6

func (s *Listener) SetAlpnPolicy(v []*string) *Listener

SetAlpnPolicy sets the AlpnPolicy field's value.

func (*Listener) SetCertificates added in v1.5.0

func (s *Listener) SetCertificates(v []*Certificate) *Listener

SetCertificates sets the Certificates field's value.

func (*Listener) SetDefaultActions added in v1.5.0

func (s *Listener) SetDefaultActions(v []*Action) *Listener

SetDefaultActions sets the DefaultActions field's value.

func (*Listener) SetListenerArn added in v1.5.0

func (s *Listener) SetListenerArn(v string) *Listener

SetListenerArn sets the ListenerArn field's value.

func (*Listener) SetLoadBalancerArn added in v1.5.0

func (s *Listener) SetLoadBalancerArn(v string) *Listener

SetLoadBalancerArn sets the LoadBalancerArn field's value.

func (*Listener) SetPort added in v1.5.0

func (s *Listener) SetPort(v int64) *Listener

SetPort sets the Port field's value.

func (*Listener) SetProtocol added in v1.5.0

func (s *Listener) SetProtocol(v string) *Listener

SetProtocol sets the Protocol field's value.

func (*Listener) SetSslPolicy added in v1.5.0

func (s *Listener) SetSslPolicy(v string) *Listener

SetSslPolicy sets the SslPolicy field's value.

func (Listener) String

func (s Listener) String() string

String returns the string representation

type LoadBalancer

type LoadBalancer struct {

	// The subnets for the load balancer.
	AvailabilityZones []*AvailabilityZone `type:"list"`

	// The ID of the Amazon Route 53 hosted zone associated with the load balancer.
	CanonicalHostedZoneId *string `type:"string"`

	// The date and time the load balancer was created.
	CreatedTime *time.Time `type:"timestamp"`

	// [Application Load Balancers on Outposts] The ID of the customer-owned address
	// pool.
	CustomerOwnedIpv4Pool *string `type:"string"`

	// The public DNS name of the load balancer.
	DNSName *string `type:"string"`

	// The type of IP addresses used by the subnets for your load balancer. The
	// possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and
	// IPv6 addresses).
	IpAddressType *string `type:"string" enum:"IpAddressType"`

	// The Amazon Resource Name (ARN) of the load balancer.
	LoadBalancerArn *string `type:"string"`

	// The name of the load balancer.
	LoadBalancerName *string `type:"string"`

	// The nodes of an Internet-facing load balancer have public IP addresses. The
	// DNS name of an Internet-facing load balancer is publicly resolvable to the
	// public IP addresses of the nodes. Therefore, Internet-facing load balancers
	// can route requests from clients over the internet.
	//
	// The nodes of an internal load balancer have only private IP addresses. The
	// DNS name of an internal load balancer is publicly resolvable to the private
	// IP addresses of the nodes. Therefore, internal load balancers can route requests
	// only from clients with access to the VPC for the load balancer.
	Scheme *string `type:"string" enum:"LoadBalancerSchemeEnum"`

	// The IDs of the security groups for the load balancer.
	SecurityGroups []*string `type:"list"`

	// The state of the load balancer.
	State *LoadBalancerState `type:"structure"`

	// The type of load balancer.
	Type *string `type:"string" enum:"LoadBalancerTypeEnum"`

	// The ID of the VPC for the load balancer.
	VpcId *string `type:"string"`
	// contains filtered or unexported fields
}

Information about a load balancer.

func (LoadBalancer) GoString

func (s LoadBalancer) GoString() string

GoString returns the string representation

func (*LoadBalancer) SetAvailabilityZones added in v1.5.0

func (s *LoadBalancer) SetAvailabilityZones(v []*AvailabilityZone) *LoadBalancer

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*LoadBalancer) SetCanonicalHostedZoneId added in v1.5.0

func (s *LoadBalancer) SetCanonicalHostedZoneId(v string) *LoadBalancer

SetCanonicalHostedZoneId sets the CanonicalHostedZoneId field's value.

func (*LoadBalancer) SetCreatedTime added in v1.5.0

func (s *LoadBalancer) SetCreatedTime(v time.Time) *LoadBalancer

SetCreatedTime sets the CreatedTime field's value.

func (*LoadBalancer) SetCustomerOwnedIpv4Pool added in v1.34.19

func (s *LoadBalancer) SetCustomerOwnedIpv4Pool(v string) *LoadBalancer

SetCustomerOwnedIpv4Pool sets the CustomerOwnedIpv4Pool field's value.

func (*LoadBalancer) SetDNSName added in v1.5.0

func (s *LoadBalancer) SetDNSName(v string) *LoadBalancer

SetDNSName sets the DNSName field's value.

func (*LoadBalancer) SetIpAddressType added in v1.6.17

func (s *LoadBalancer) SetIpAddressType(v string) *LoadBalancer

SetIpAddressType sets the IpAddressType field's value.

func (*LoadBalancer) SetLoadBalancerArn added in v1.5.0

func (s *LoadBalancer) SetLoadBalancerArn(v string) *LoadBalancer

SetLoadBalancerArn sets the LoadBalancerArn field's value.

func (*LoadBalancer) SetLoadBalancerName added in v1.5.0

func (s *LoadBalancer) SetLoadBalancerName(v string) *LoadBalancer

SetLoadBalancerName sets the LoadBalancerName field's value.

func (*LoadBalancer) SetScheme added in v1.5.0

func (s *LoadBalancer) SetScheme(v string) *LoadBalancer

SetScheme sets the Scheme field's value.

func (*LoadBalancer) SetSecurityGroups added in v1.5.0

func (s *LoadBalancer) SetSecurityGroups(v []*string) *LoadBalancer

SetSecurityGroups sets the SecurityGroups field's value.

func (*LoadBalancer) SetState added in v1.5.0

func (s *LoadBalancer) SetState(v *LoadBalancerState) *LoadBalancer

SetState sets the State field's value.

func (*LoadBalancer) SetType added in v1.5.0

func (s *LoadBalancer) SetType(v string) *LoadBalancer

SetType sets the Type field's value.

func (*LoadBalancer) SetVpcId added in v1.5.0

func (s *LoadBalancer) SetVpcId(v string) *LoadBalancer

SetVpcId sets the VpcId field's value.

func (LoadBalancer) String

func (s LoadBalancer) String() string

String returns the string representation

type LoadBalancerAddress added in v1.10.40

type LoadBalancerAddress struct {

	// [Network Load Balancers] The allocation ID of the Elastic IP address for
	// an internal-facing load balancer.
	AllocationId *string `type:"string"`

	// [Network Load Balancers] The IPv6 address.
	IPv6Address *string `type:"string"`

	// The static IP address.
	IpAddress *string `type:"string"`

	// [Network Load Balancers] The private IPv4 address for an internal load balancer.
	PrivateIPv4Address *string `type:"string"`
	// contains filtered or unexported fields
}

Information about a static IP address for a load balancer.

func (LoadBalancerAddress) GoString added in v1.10.40

func (s LoadBalancerAddress) GoString() string

GoString returns the string representation

func (*LoadBalancerAddress) SetAllocationId added in v1.10.40

func (s *LoadBalancerAddress) SetAllocationId(v string) *LoadBalancerAddress

SetAllocationId sets the AllocationId field's value.

func (*LoadBalancerAddress) SetIPv6Address added in v1.35.28

func (s *LoadBalancerAddress) SetIPv6Address(v string) *LoadBalancerAddress

SetIPv6Address sets the IPv6Address field's value.

func (*LoadBalancerAddress) SetIpAddress added in v1.10.40

func (s *LoadBalancerAddress) SetIpAddress(v string) *LoadBalancerAddress

SetIpAddress sets the IpAddress field's value.

func (*LoadBalancerAddress) SetPrivateIPv4Address added in v1.25.42

func (s *LoadBalancerAddress) SetPrivateIPv4Address(v string) *LoadBalancerAddress

SetPrivateIPv4Address sets the PrivateIPv4Address field's value.

func (LoadBalancerAddress) String added in v1.10.40

func (s LoadBalancerAddress) String() string

String returns the string representation

type LoadBalancerAttribute

type LoadBalancerAttribute struct {

	// The name of the attribute.
	//
	// The following attribute is supported by all load balancers:
	//
	//    * deletion_protection.enabled - Indicates whether deletion protection
	//    is enabled. The value is true or false. The default is false.
	//
	// The following attributes are supported by both Application Load Balancers
	// and Network Load Balancers:
	//
	//    * access_logs.s3.enabled - Indicates whether access logs are enabled.
	//    The value is true or false. The default is false.
	//
	//    * access_logs.s3.bucket - The name of the S3 bucket for the access logs.
	//    This attribute is required if access logs are enabled. The bucket must
	//    exist in the same region as the load balancer and have a bucket policy
	//    that grants Elastic Load Balancing permissions to write to the bucket.
	//
	//    * access_logs.s3.prefix - The prefix for the location in the S3 bucket
	//    for the access logs.
	//
	// The following attributes are supported by only Application Load Balancers:
	//
	//    * idle_timeout.timeout_seconds - The idle timeout value, in seconds. The
	//    valid range is 1-4000 seconds. The default is 60 seconds.
	//
	//    * routing.http.desync_mitigation_mode - Determines how the load balancer
	//    handles requests that might pose a security risk to your application.
	//    The possible values are monitor, defensive, and strictest. The default
	//    is defensive.
	//
	//    * routing.http.drop_invalid_header_fields.enabled - Indicates whether
	//    HTTP headers with invalid header fields are removed by the load balancer
	//    (true) or routed to targets (false). The default is false.
	//
	//    * routing.http2.enabled - Indicates whether HTTP/2 is enabled. The value
	//    is true or false. The default is true. Elastic Load Balancing requires
	//    that message header names contain only alphanumeric characters and hyphens.
	//
	//    * waf.fail_open.enabled - Indicates whether to allow a WAF-enabled load
	//    balancer to route requests to targets if it is unable to forward the request
	//    to AWS WAF. The value is true or false. The default is false.
	//
	// The following attribute is supported by Network Load Balancers and Gateway
	// Load Balancers:
	//
	//    * load_balancing.cross_zone.enabled - Indicates whether cross-zone load
	//    balancing is enabled. The value is true or false. The default is false.
	Key *string `type:"string"`

	// The value of the attribute.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

Information about a load balancer attribute.

func (LoadBalancerAttribute) GoString

func (s LoadBalancerAttribute) GoString() string

GoString returns the string representation

func (*LoadBalancerAttribute) SetKey added in v1.5.0

SetKey sets the Key field's value.

func (*LoadBalancerAttribute) SetValue added in v1.5.0

SetValue sets the Value field's value.

func (LoadBalancerAttribute) String

func (s LoadBalancerAttribute) String() string

String returns the string representation

type LoadBalancerState

type LoadBalancerState struct {

	// The state code. The initial state of the load balancer is provisioning. After
	// the load balancer is fully set up and ready to route traffic, its state is
	// active. If load balancer is routing traffic but does not have the resources
	// it needs to scale, its state isactive_impaired. If the load balancer could
	// not be set up, its state is failed.
	Code *string `type:"string" enum:"LoadBalancerStateEnum"`

	// A description of the state.
	Reason *string `type:"string"`
	// contains filtered or unexported fields
}

Information about the state of the load balancer.

func (LoadBalancerState) GoString

func (s LoadBalancerState) GoString() string

GoString returns the string representation

func (*LoadBalancerState) SetCode added in v1.5.0

SetCode sets the Code field's value.

func (*LoadBalancerState) SetReason added in v1.5.0

func (s *LoadBalancerState) SetReason(v string) *LoadBalancerState

SetReason sets the Reason field's value.

func (LoadBalancerState) String

func (s LoadBalancerState) String() string

String returns the string representation

type Matcher

type Matcher struct {

	// You can specify values between 0 and 99. You can specify multiple values
	// (for example, "0,1") or a range of values (for example, "0-5"). The default
	// value is 12.
	GrpcCode *string `type:"string"`

	// For Application Load Balancers, you can specify values between 200 and 499,
	// and the default value is 200. You can specify multiple values (for example,
	// "200,202") or a range of values (for example, "200-299").
	//
	// For Network Load Balancers and Gateway Load Balancers, this must be "200–399".
	HttpCode *string `type:"string"`
	// contains filtered or unexported fields
}

The codes to use when checking for a successful response from a target. If the protocol version is gRPC, these are gRPC codes. Otherwise, these are HTTP codes.

func (Matcher) GoString

func (s Matcher) GoString() string

GoString returns the string representation

func (*Matcher) SetGrpcCode added in v1.35.18

func (s *Matcher) SetGrpcCode(v string) *Matcher

SetGrpcCode sets the GrpcCode field's value.

func (*Matcher) SetHttpCode added in v1.5.0

func (s *Matcher) SetHttpCode(v string) *Matcher

SetHttpCode sets the HttpCode field's value.

func (Matcher) String

func (s Matcher) String() string

String returns the string representation

type ModifyListenerInput

type ModifyListenerInput struct {

	// [TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN)
	// policy. You can specify one policy name. The following are the possible values:
	//
	//    * HTTP1Only
	//
	//    * HTTP2Only
	//
	//    * HTTP2Optional
	//
	//    * HTTP2Preferred
	//
	//    * None
	//
	// For more information, see ALPN policies (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#alpn-policies)
	// in the Network Load Balancers Guide.
	AlpnPolicy []*string `type:"list"`

	// [HTTPS and TLS listeners] The default certificate for the listener. You must
	// provide exactly one certificate. Set CertificateArn to the certificate ARN
	// but do not set IsDefault.
	Certificates []*Certificate `type:"list"`

	// The actions for the default rule.
	DefaultActions []*Action `type:"list"`

	// The Amazon Resource Name (ARN) of the listener.
	//
	// ListenerArn is a required field
	ListenerArn *string `type:"string" required:"true"`

	// The port for connections from clients to the load balancer. You cannot specify
	// a port for a Gateway Load Balancer.
	Port *int64 `min:"1" type:"integer"`

	// The protocol for connections from clients to the load balancer. Application
	// Load Balancers support the HTTP and HTTPS protocols. Network Load Balancers
	// support the TCP, TLS, UDP, and TCP_UDP protocols. You can’t change the
	// protocol to UDP or TCP_UDP if dual-stack mode is enabled. You cannot specify
	// a protocol for a Gateway Load Balancer.
	Protocol *string `type:"string" enum:"ProtocolEnum"`

	// [HTTPS and TLS listeners] The security policy that defines which protocols
	// and ciphers are supported.
	//
	// For more information, see Security policies (https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies)
	// in the Application Load Balancers Guide or Security policies (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies)
	// in the Network Load Balancers Guide.
	SslPolicy *string `type:"string"`
	// contains filtered or unexported fields
}

func (ModifyListenerInput) GoString

func (s ModifyListenerInput) GoString() string

GoString returns the string representation

func (*ModifyListenerInput) SetAlpnPolicy added in v1.31.6

func (s *ModifyListenerInput) SetAlpnPolicy(v []*string) *ModifyListenerInput

SetAlpnPolicy sets the AlpnPolicy field's value.

func (*ModifyListenerInput) SetCertificates added in v1.5.0

func (s *ModifyListenerInput) SetCertificates(v []*Certificate) *ModifyListenerInput

SetCertificates sets the Certificates field's value.

func (*ModifyListenerInput) SetDefaultActions added in v1.5.0

func (s *ModifyListenerInput) SetDefaultActions(v []*Action) *ModifyListenerInput

SetDefaultActions sets the DefaultActions field's value.

func (*ModifyListenerInput) SetListenerArn added in v1.5.0

func (s *ModifyListenerInput) SetListenerArn(v string) *ModifyListenerInput

SetListenerArn sets the ListenerArn field's value.

func (*ModifyListenerInput) SetPort added in v1.5.0

SetPort sets the Port field's value.

func (*ModifyListenerInput) SetProtocol added in v1.5.0

func (s *ModifyListenerInput) SetProtocol(v string) *ModifyListenerInput

SetProtocol sets the Protocol field's value.

func (*ModifyListenerInput) SetSslPolicy added in v1.5.0

func (s *ModifyListenerInput) SetSslPolicy(v string) *ModifyListenerInput

SetSslPolicy sets the SslPolicy field's value.

func (ModifyListenerInput) String

func (s ModifyListenerInput) String() string

String returns the string representation

func (*ModifyListenerInput) Validate

func (s *ModifyListenerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ModifyListenerOutput

type ModifyListenerOutput struct {

	// Information about the modified listener.
	Listeners []*Listener `type:"list"`
	// contains filtered or unexported fields
}

func (ModifyListenerOutput) GoString

func (s ModifyListenerOutput) GoString() string

GoString returns the string representation

func (*ModifyListenerOutput) SetListeners added in v1.5.0

func (s *ModifyListenerOutput) SetListeners(v []*Listener) *ModifyListenerOutput

SetListeners sets the Listeners field's value.

func (ModifyListenerOutput) String

func (s ModifyListenerOutput) String() string

String returns the string representation

type ModifyLoadBalancerAttributesInput

type ModifyLoadBalancerAttributesInput struct {

	// The load balancer attributes.
	//
	// Attributes is a required field
	Attributes []*LoadBalancerAttribute `type:"list" required:"true"`

	// The Amazon Resource Name (ARN) of the load balancer.
	//
	// LoadBalancerArn is a required field
	LoadBalancerArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ModifyLoadBalancerAttributesInput) GoString

GoString returns the string representation

func (*ModifyLoadBalancerAttributesInput) SetAttributes added in v1.5.0

SetAttributes sets the Attributes field's value.

func (*ModifyLoadBalancerAttributesInput) SetLoadBalancerArn added in v1.5.0

SetLoadBalancerArn sets the LoadBalancerArn field's value.

func (ModifyLoadBalancerAttributesInput) String

String returns the string representation

func (*ModifyLoadBalancerAttributesInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type ModifyLoadBalancerAttributesOutput

type ModifyLoadBalancerAttributesOutput struct {

	// Information about the load balancer attributes.
	Attributes []*LoadBalancerAttribute `type:"list"`
	// contains filtered or unexported fields
}

func (ModifyLoadBalancerAttributesOutput) GoString

GoString returns the string representation

func (*ModifyLoadBalancerAttributesOutput) SetAttributes added in v1.5.0

SetAttributes sets the Attributes field's value.

func (ModifyLoadBalancerAttributesOutput) String

String returns the string representation

type ModifyRuleInput

type ModifyRuleInput struct {

	// The actions.
	Actions []*Action `type:"list"`

	// The conditions.
	Conditions []*RuleCondition `type:"list"`

	// The Amazon Resource Name (ARN) of the rule.
	//
	// RuleArn is a required field
	RuleArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ModifyRuleInput) GoString

func (s ModifyRuleInput) GoString() string

GoString returns the string representation

func (*ModifyRuleInput) SetActions added in v1.5.0

func (s *ModifyRuleInput) SetActions(v []*Action) *ModifyRuleInput

SetActions sets the Actions field's value.

func (*ModifyRuleInput) SetConditions added in v1.5.0

func (s *ModifyRuleInput) SetConditions(v []*RuleCondition) *ModifyRuleInput

SetConditions sets the Conditions field's value.

func (*ModifyRuleInput) SetRuleArn added in v1.5.0

func (s *ModifyRuleInput) SetRuleArn(v string) *ModifyRuleInput

SetRuleArn sets the RuleArn field's value.

func (ModifyRuleInput) String

func (s ModifyRuleInput) String() string

String returns the string representation

func (*ModifyRuleInput) Validate

func (s *ModifyRuleInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ModifyRuleOutput

type ModifyRuleOutput struct {

	// Information about the modified rule.
	Rules []*Rule `type:"list"`
	// contains filtered or unexported fields
}

func (ModifyRuleOutput) GoString

func (s ModifyRuleOutput) GoString() string

GoString returns the string representation

func (*ModifyRuleOutput) SetRules added in v1.5.0

func (s *ModifyRuleOutput) SetRules(v []*Rule) *ModifyRuleOutput

SetRules sets the Rules field's value.

func (ModifyRuleOutput) String

func (s ModifyRuleOutput) String() string

String returns the string representation

type ModifyTargetGroupAttributesInput

type ModifyTargetGroupAttributesInput struct {

	// The attributes.
	//
	// Attributes is a required field
	Attributes []*TargetGroupAttribute `type:"list" required:"true"`

	// The Amazon Resource Name (ARN) of the target group.
	//
	// TargetGroupArn is a required field
	TargetGroupArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ModifyTargetGroupAttributesInput) GoString

GoString returns the string representation

func (*ModifyTargetGroupAttributesInput) SetAttributes added in v1.5.0

SetAttributes sets the Attributes field's value.

func (*ModifyTargetGroupAttributesInput) SetTargetGroupArn added in v1.5.0

SetTargetGroupArn sets the TargetGroupArn field's value.

func (ModifyTargetGroupAttributesInput) String

String returns the string representation

func (*ModifyTargetGroupAttributesInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type ModifyTargetGroupAttributesOutput

type ModifyTargetGroupAttributesOutput struct {

	// Information about the attributes.
	Attributes []*TargetGroupAttribute `type:"list"`
	// contains filtered or unexported fields
}

func (ModifyTargetGroupAttributesOutput) GoString

GoString returns the string representation

func (*ModifyTargetGroupAttributesOutput) SetAttributes added in v1.5.0

SetAttributes sets the Attributes field's value.

func (ModifyTargetGroupAttributesOutput) String

String returns the string representation

type ModifyTargetGroupInput

type ModifyTargetGroupInput struct {

	// Indicates whether health checks are enabled.
	HealthCheckEnabled *bool `type:"boolean"`

	// The approximate amount of time, in seconds, between health checks of an individual
	// target. For TCP health checks, the supported values are 10 or 30 seconds.
	//
	// With Network Load Balancers, you can't modify this setting.
	HealthCheckIntervalSeconds *int64 `min:"5" type:"integer"`

	// [HTTP/HTTPS health checks] The destination for health checks on the targets.
	//
	// [HTTP1 or HTTP2 protocol version] The ping path. The default is /.
	//
	// [GRPC protocol version] The path of a custom health check method with the
	// format /package.service/method. The default is /AWS.ALB/healthcheck.
	HealthCheckPath *string `min:"1" type:"string"`

	// The port the load balancer uses when performing health checks on targets.
	HealthCheckPort *string `type:"string"`

	// The protocol the load balancer uses when performing health checks on targets.
	// The TCP protocol is supported for health checks only if the protocol of the
	// target group is TCP, TLS, UDP, or TCP_UDP. The GENEVE, TLS, UDP, and TCP_UDP
	// protocols are not supported for health checks.
	//
	// With Network Load Balancers, you can't modify this setting.
	HealthCheckProtocol *string `type:"string" enum:"ProtocolEnum"`

	// [HTTP/HTTPS health checks] The amount of time, in seconds, during which no
	// response means a failed health check.
	//
	// With Network Load Balancers, you can't modify this setting.
	HealthCheckTimeoutSeconds *int64 `min:"2" type:"integer"`

	// The number of consecutive health checks successes required before considering
	// an unhealthy target healthy.
	HealthyThresholdCount *int64 `min:"2" type:"integer"`

	// [HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for
	// a successful response from a target.
	//
	// With Network Load Balancers, you can't modify this setting.
	Matcher *Matcher `type:"structure"`

	// The Amazon Resource Name (ARN) of the target group.
	//
	// TargetGroupArn is a required field
	TargetGroupArn *string `type:"string" required:"true"`

	// The number of consecutive health check failures required before considering
	// the target unhealthy. For target groups with a protocol of TCP or TLS, this
	// value must be the same as the healthy threshold count.
	UnhealthyThresholdCount *int64 `min:"2" type:"integer"`
	// contains filtered or unexported fields
}

func (ModifyTargetGroupInput) GoString

func (s ModifyTargetGroupInput) GoString() string

GoString returns the string representation

func (*ModifyTargetGroupInput) SetHealthCheckEnabled added in v1.15.87

func (s *ModifyTargetGroupInput) SetHealthCheckEnabled(v bool) *ModifyTargetGroupInput

SetHealthCheckEnabled sets the HealthCheckEnabled field's value.

func (*ModifyTargetGroupInput) SetHealthCheckIntervalSeconds added in v1.5.0

func (s *ModifyTargetGroupInput) SetHealthCheckIntervalSeconds(v int64) *ModifyTargetGroupInput

SetHealthCheckIntervalSeconds sets the HealthCheckIntervalSeconds field's value.

func (*ModifyTargetGroupInput) SetHealthCheckPath added in v1.5.0

func (s *ModifyTargetGroupInput) SetHealthCheckPath(v string) *ModifyTargetGroupInput

SetHealthCheckPath sets the HealthCheckPath field's value.

func (*ModifyTargetGroupInput) SetHealthCheckPort added in v1.5.0

func (s *ModifyTargetGroupInput) SetHealthCheckPort(v string) *ModifyTargetGroupInput

SetHealthCheckPort sets the HealthCheckPort field's value.

func (*ModifyTargetGroupInput) SetHealthCheckProtocol added in v1.5.0

func (s *ModifyTargetGroupInput) SetHealthCheckProtocol(v string) *ModifyTargetGroupInput

SetHealthCheckProtocol sets the HealthCheckProtocol field's value.

func (*ModifyTargetGroupInput) SetHealthCheckTimeoutSeconds added in v1.5.0

func (s *ModifyTargetGroupInput) SetHealthCheckTimeoutSeconds(v int64) *ModifyTargetGroupInput

SetHealthCheckTimeoutSeconds sets the HealthCheckTimeoutSeconds field's value.

func (*ModifyTargetGroupInput) SetHealthyThresholdCount added in v1.5.0

func (s *ModifyTargetGroupInput) SetHealthyThresholdCount(v int64) *ModifyTargetGroupInput

SetHealthyThresholdCount sets the HealthyThresholdCount field's value.

func (*ModifyTargetGroupInput) SetMatcher added in v1.5.0

SetMatcher sets the Matcher field's value.

func (*ModifyTargetGroupInput) SetTargetGroupArn added in v1.5.0

func (s *ModifyTargetGroupInput) SetTargetGroupArn(v string) *ModifyTargetGroupInput

SetTargetGroupArn sets the TargetGroupArn field's value.

func (*ModifyTargetGroupInput) SetUnhealthyThresholdCount added in v1.5.0

func (s *ModifyTargetGroupInput) SetUnhealthyThresholdCount(v int64) *ModifyTargetGroupInput

SetUnhealthyThresholdCount sets the UnhealthyThresholdCount field's value.

func (ModifyTargetGroupInput) String

func (s ModifyTargetGroupInput) String() string

String returns the string representation

func (*ModifyTargetGroupInput) Validate

func (s *ModifyTargetGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ModifyTargetGroupOutput

type ModifyTargetGroupOutput struct {

	// Information about the modified target group.
	TargetGroups []*TargetGroup `type:"list"`
	// contains filtered or unexported fields
}

func (ModifyTargetGroupOutput) GoString

func (s ModifyTargetGroupOutput) GoString() string

GoString returns the string representation

func (*ModifyTargetGroupOutput) SetTargetGroups added in v1.5.0

SetTargetGroups sets the TargetGroups field's value.

func (ModifyTargetGroupOutput) String

func (s ModifyTargetGroupOutput) String() string

String returns the string representation

type PathPatternConditionConfig added in v1.15.87

type PathPatternConditionConfig struct {

	// One or more path patterns to compare against the request URL. The maximum
	// size of each string is 128 characters. The comparison is case sensitive.
	// The following wildcard characters are supported: * (matches 0 or more characters)
	// and ? (matches exactly 1 character).
	//
	// If you specify multiple strings, the condition is satisfied if one of them
	// matches the request URL. The path pattern is compared only to the path of
	// the URL, not to its query string. To compare against the query string, use
	// QueryStringConditionConfig.
	Values []*string `type:"list"`
	// contains filtered or unexported fields
}

Information about a path pattern condition.

func (PathPatternConditionConfig) GoString added in v1.15.87

func (s PathPatternConditionConfig) GoString() string

GoString returns the string representation

func (*PathPatternConditionConfig) SetValues added in v1.15.87

SetValues sets the Values field's value.

func (PathPatternConditionConfig) String added in v1.15.87

String returns the string representation

type QueryStringConditionConfig added in v1.15.87

type QueryStringConditionConfig struct {

	// One or more key/value pairs or values to find in the query string. The maximum
	// size of each string is 128 characters. The comparison is case insensitive.
	// The following wildcard characters are supported: * (matches 0 or more characters)
	// and ? (matches exactly 1 character). To search for a literal '*' or '?' character
	// in a query string, you must escape these characters in Values using a '\'
	// character.
	//
	// If you specify multiple key/value pairs or values, the condition is satisfied
	// if one of them is found in the query string.
	Values []*QueryStringKeyValuePair `type:"list"`
	// contains filtered or unexported fields
}

Information about a query string condition.

The query string component of a URI starts after the first '?' character and is terminated by either a '#' character or the end of the URI. A typical query string contains key/value pairs separated by '&' characters. The allowed characters are specified by RFC 3986. Any character can be percentage encoded.

func (QueryStringConditionConfig) GoString added in v1.15.87

func (s QueryStringConditionConfig) GoString() string

GoString returns the string representation

func (*QueryStringConditionConfig) SetValues added in v1.15.87

SetValues sets the Values field's value.

func (QueryStringConditionConfig) String added in v1.15.87

String returns the string representation

type QueryStringKeyValuePair added in v1.19.3

type QueryStringKeyValuePair struct {

	// The key. You can omit the key.
	Key *string `type:"string"`

	// The value.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

Information about a key/value pair.

func (QueryStringKeyValuePair) GoString added in v1.19.3

func (s QueryStringKeyValuePair) GoString() string

GoString returns the string representation

func (*QueryStringKeyValuePair) SetKey added in v1.19.3

SetKey sets the Key field's value.

func (*QueryStringKeyValuePair) SetValue added in v1.19.3

SetValue sets the Value field's value.

func (QueryStringKeyValuePair) String added in v1.19.3

func (s QueryStringKeyValuePair) String() string

String returns the string representation

type RedirectActionConfig added in v1.14.33

type RedirectActionConfig struct {

	// The hostname. This component is not percent-encoded. The hostname can contain
	// #{host}.
	Host *string `min:"1" type:"string"`

	// The absolute path, starting with the leading "/". This component is not percent-encoded.
	// The path can contain #{host}, #{path}, and #{port}.
	Path *string `min:"1" type:"string"`

	// The port. You can specify a value from 1 to 65535 or #{port}.
	Port *string `type:"string"`

	// The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect
	// HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS
	// to HTTP.
	Protocol *string `type:"string"`

	// The query parameters, URL-encoded when necessary, but not percent-encoded.
	// Do not include the leading "?", as it is automatically added. You can specify
	// any of the reserved keywords.
	Query *string `type:"string"`

	// The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary
	// (HTTP 302).
	//
	// StatusCode is a required field
	StatusCode *string `type:"string" required:"true" enum:"RedirectActionStatusCodeEnum"`
	// contains filtered or unexported fields
}

Information about a redirect action.

A URI consists of the following components: protocol://hostname:port/path?query. You must modify at least one of the following components to avoid a redirect loop: protocol, hostname, port, or path. Any components that you do not modify retain their original values.

You can reuse URI components using the following reserved keywords:

  • #{protocol}

  • #{host}

  • #{port}

  • #{path} (the leading "/" is removed)

  • #{query}

For example, you can change the path to "/new/#{path}", the hostname to "example.#{host}", or the query to "#{query}&value=xyz".

func (RedirectActionConfig) GoString added in v1.14.33

func (s RedirectActionConfig) GoString() string

GoString returns the string representation

func (*RedirectActionConfig) SetHost added in v1.14.33

SetHost sets the Host field's value.

func (*RedirectActionConfig) SetPath added in v1.14.33

SetPath sets the Path field's value.

func (*RedirectActionConfig) SetPort added in v1.14.33

SetPort sets the Port field's value.

func (*RedirectActionConfig) SetProtocol added in v1.14.33

SetProtocol sets the Protocol field's value.

func (*RedirectActionConfig) SetQuery added in v1.14.33

SetQuery sets the Query field's value.

func (*RedirectActionConfig) SetStatusCode added in v1.14.33

func (s *RedirectActionConfig) SetStatusCode(v string) *RedirectActionConfig

SetStatusCode sets the StatusCode field's value.

func (RedirectActionConfig) String added in v1.14.33

func (s RedirectActionConfig) String() string

String returns the string representation

func (*RedirectActionConfig) Validate added in v1.14.33

func (s *RedirectActionConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RegisterTargetsInput

type RegisterTargetsInput struct {

	// The Amazon Resource Name (ARN) of the target group.
	//
	// TargetGroupArn is a required field
	TargetGroupArn *string `type:"string" required:"true"`

	// The targets.
	//
	// Targets is a required field
	Targets []*TargetDescription `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (RegisterTargetsInput) GoString

func (s RegisterTargetsInput) GoString() string

GoString returns the string representation

func (*RegisterTargetsInput) SetTargetGroupArn added in v1.5.0

func (s *RegisterTargetsInput) SetTargetGroupArn(v string) *RegisterTargetsInput

SetTargetGroupArn sets the TargetGroupArn field's value.

func (*RegisterTargetsInput) SetTargets added in v1.5.0

SetTargets sets the Targets field's value.

func (RegisterTargetsInput) String

func (s RegisterTargetsInput) String() string

String returns the string representation

func (*RegisterTargetsInput) Validate

func (s *RegisterTargetsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RegisterTargetsOutput

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

func (RegisterTargetsOutput) GoString

func (s RegisterTargetsOutput) GoString() string

GoString returns the string representation

func (RegisterTargetsOutput) String

func (s RegisterTargetsOutput) String() string

String returns the string representation

type RemoveListenerCertificatesInput added in v1.12.8

type RemoveListenerCertificatesInput struct {

	// The certificate to remove. You can specify one certificate per call. Set
	// CertificateArn to the certificate ARN but do not set IsDefault.
	//
	// Certificates is a required field
	Certificates []*Certificate `type:"list" required:"true"`

	// The Amazon Resource Name (ARN) of the listener.
	//
	// ListenerArn is a required field
	ListenerArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RemoveListenerCertificatesInput) GoString added in v1.12.8

GoString returns the string representation

func (*RemoveListenerCertificatesInput) SetCertificates added in v1.12.8

SetCertificates sets the Certificates field's value.

func (*RemoveListenerCertificatesInput) SetListenerArn added in v1.12.8

SetListenerArn sets the ListenerArn field's value.

func (RemoveListenerCertificatesInput) String added in v1.12.8

String returns the string representation

func (*RemoveListenerCertificatesInput) Validate added in v1.12.8

func (s *RemoveListenerCertificatesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RemoveListenerCertificatesOutput added in v1.12.8

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

func (RemoveListenerCertificatesOutput) GoString added in v1.12.8

GoString returns the string representation

func (RemoveListenerCertificatesOutput) String added in v1.12.8

String returns the string representation

type RemoveTagsInput

type RemoveTagsInput struct {

	// The Amazon Resource Name (ARN) of the resource.
	//
	// ResourceArns is a required field
	ResourceArns []*string `type:"list" required:"true"`

	// The tag keys for the tags to remove.
	//
	// TagKeys is a required field
	TagKeys []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (RemoveTagsInput) GoString

func (s RemoveTagsInput) GoString() string

GoString returns the string representation

func (*RemoveTagsInput) SetResourceArns added in v1.5.0

func (s *RemoveTagsInput) SetResourceArns(v []*string) *RemoveTagsInput

SetResourceArns sets the ResourceArns field's value.

func (*RemoveTagsInput) SetTagKeys added in v1.5.0

func (s *RemoveTagsInput) SetTagKeys(v []*string) *RemoveTagsInput

SetTagKeys sets the TagKeys field's value.

func (RemoveTagsInput) String

func (s RemoveTagsInput) String() string

String returns the string representation

func (*RemoveTagsInput) Validate

func (s *RemoveTagsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RemoveTagsOutput

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

func (RemoveTagsOutput) GoString

func (s RemoveTagsOutput) GoString() string

GoString returns the string representation

func (RemoveTagsOutput) String

func (s RemoveTagsOutput) String() string

String returns the string representation

type Rule

type Rule struct {

	// The actions. Each rule must include exactly one of the following types of
	// actions: forward, redirect, or fixed-response, and it must be the last action
	// to be performed.
	Actions []*Action `type:"list"`

	// The conditions. Each rule can include zero or one of the following conditions:
	// http-request-method, host-header, path-pattern, and source-ip, and zero or
	// more of the following conditions: http-header and query-string.
	Conditions []*RuleCondition `type:"list"`

	// Indicates whether this is the default rule.
	IsDefault *bool `type:"boolean"`

	// The priority.
	Priority *string `type:"string"`

	// The Amazon Resource Name (ARN) of the rule.
	RuleArn *string `type:"string"`
	// contains filtered or unexported fields
}

Information about a rule.

func (Rule) GoString

func (s Rule) GoString() string

GoString returns the string representation

func (*Rule) SetActions added in v1.5.0

func (s *Rule) SetActions(v []*Action) *Rule

SetActions sets the Actions field's value.

func (*Rule) SetConditions added in v1.5.0

func (s *Rule) SetConditions(v []*RuleCondition) *Rule

SetConditions sets the Conditions field's value.

func (*Rule) SetIsDefault added in v1.5.0

func (s *Rule) SetIsDefault(v bool) *Rule

SetIsDefault sets the IsDefault field's value.

func (*Rule) SetPriority added in v1.5.0

func (s *Rule) SetPriority(v string) *Rule

SetPriority sets the Priority field's value.

func (*Rule) SetRuleArn added in v1.5.0

func (s *Rule) SetRuleArn(v string) *Rule

SetRuleArn sets the RuleArn field's value.

func (Rule) String

func (s Rule) String() string

String returns the string representation

type RuleCondition

type RuleCondition struct {

	// The field in the HTTP request. The following are the possible values:
	//
	//    * http-header
	//
	//    * http-request-method
	//
	//    * host-header
	//
	//    * path-pattern
	//
	//    * query-string
	//
	//    * source-ip
	Field *string `type:"string"`

	// Information for a host header condition. Specify only when Field is host-header.
	HostHeaderConfig *HostHeaderConditionConfig `type:"structure"`

	// Information for an HTTP header condition. Specify only when Field is http-header.
	HttpHeaderConfig *HttpHeaderConditionConfig `type:"structure"`

	// Information for an HTTP method condition. Specify only when Field is http-request-method.
	HttpRequestMethodConfig *HttpRequestMethodConditionConfig `type:"structure"`

	// Information for a path pattern condition. Specify only when Field is path-pattern.
	PathPatternConfig *PathPatternConditionConfig `type:"structure"`

	// Information for a query string condition. Specify only when Field is query-string.
	QueryStringConfig *QueryStringConditionConfig `type:"structure"`

	// Information for a source IP condition. Specify only when Field is source-ip.
	SourceIpConfig *SourceIpConditionConfig `type:"structure"`

	// The condition value. Specify only when Field is host-header or path-pattern.
	// Alternatively, to specify multiple host names or multiple path patterns,
	// use HostHeaderConfig or PathPatternConfig.
	//
	// If Field is host-header and you are not using HostHeaderConfig, you can specify
	// a single host name (for example, my.example.com) in Values. A host name is
	// case insensitive, can be up to 128 characters in length, and can contain
	// any of the following characters.
	//
	//    * A-Z, a-z, 0-9
	//
	//    * - .
	//
	//    * * (matches 0 or more characters)
	//
	//    * ? (matches exactly 1 character)
	//
	// If Field is path-pattern and you are not using PathPatternConfig, you can
	// specify a single path pattern (for example, /img/*) in Values. A path pattern
	// is case-sensitive, can be up to 128 characters in length, and can contain
	// any of the following characters.
	//
	//    * A-Z, a-z, 0-9
	//
	//    * _ - . $ / ~ " ' @ : +
	//
	//    * & (using &)
	//
	//    * * (matches 0 or more characters)
	//
	//    * ? (matches exactly 1 character)
	Values []*string `type:"list"`
	// contains filtered or unexported fields
}

Information about a condition for a rule.

Each rule can optionally include up to one of each of the following conditions: http-request-method, host-header, path-pattern, and source-ip. Each rule can also optionally include one or more of each of the following conditions: http-header and query-string.

func (RuleCondition) GoString

func (s RuleCondition) GoString() string

GoString returns the string representation

func (*RuleCondition) SetField added in v1.5.0

func (s *RuleCondition) SetField(v string) *RuleCondition

SetField sets the Field field's value.

func (*RuleCondition) SetHostHeaderConfig added in v1.15.87

func (s *RuleCondition) SetHostHeaderConfig(v *HostHeaderConditionConfig) *RuleCondition

SetHostHeaderConfig sets the HostHeaderConfig field's value.

func (*RuleCondition) SetHttpHeaderConfig added in v1.15.87

func (s *RuleCondition) SetHttpHeaderConfig(v *HttpHeaderConditionConfig) *RuleCondition

SetHttpHeaderConfig sets the HttpHeaderConfig field's value.

func (*RuleCondition) SetHttpRequestMethodConfig added in v1.15.87

func (s *RuleCondition) SetHttpRequestMethodConfig(v *HttpRequestMethodConditionConfig) *RuleCondition

SetHttpRequestMethodConfig sets the HttpRequestMethodConfig field's value.

func (*RuleCondition) SetPathPatternConfig added in v1.15.87

func (s *RuleCondition) SetPathPatternConfig(v *PathPatternConditionConfig) *RuleCondition

SetPathPatternConfig sets the PathPatternConfig field's value.

func (*RuleCondition) SetQueryStringConfig added in v1.15.87

func (s *RuleCondition) SetQueryStringConfig(v *QueryStringConditionConfig) *RuleCondition

SetQueryStringConfig sets the QueryStringConfig field's value.

func (*RuleCondition) SetSourceIpConfig added in v1.19.3

func (s *RuleCondition) SetSourceIpConfig(v *SourceIpConditionConfig) *RuleCondition

SetSourceIpConfig sets the SourceIpConfig field's value.

func (*RuleCondition) SetValues added in v1.5.0

func (s *RuleCondition) SetValues(v []*string) *RuleCondition

SetValues sets the Values field's value.

func (RuleCondition) String

func (s RuleCondition) String() string

String returns the string representation

type RulePriorityPair

type RulePriorityPair struct {

	// The rule priority.
	Priority *int64 `min:"1" type:"integer"`

	// The Amazon Resource Name (ARN) of the rule.
	RuleArn *string `type:"string"`
	// contains filtered or unexported fields
}

Information about the priorities for the rules for a listener.

func (RulePriorityPair) GoString

func (s RulePriorityPair) GoString() string

GoString returns the string representation

func (*RulePriorityPair) SetPriority added in v1.5.0

func (s *RulePriorityPair) SetPriority(v int64) *RulePriorityPair

SetPriority sets the Priority field's value.

func (*RulePriorityPair) SetRuleArn added in v1.5.0

func (s *RulePriorityPair) SetRuleArn(v string) *RulePriorityPair

SetRuleArn sets the RuleArn field's value.

func (RulePriorityPair) String

func (s RulePriorityPair) String() string

String returns the string representation

func (*RulePriorityPair) Validate

func (s *RulePriorityPair) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SetIpAddressTypeInput added in v1.6.17

type SetIpAddressTypeInput struct {

	// The IP address type. The possible values are ipv4 (for IPv4 addresses) and
	// dualstack (for IPv4 and IPv6 addresses). Internal load balancers must use
	// ipv4. You can’t specify dualstack for a load balancer with a UDP or TCP_UDP
	// listener.
	//
	// IpAddressType is a required field
	IpAddressType *string `type:"string" required:"true" enum:"IpAddressType"`

	// The Amazon Resource Name (ARN) of the load balancer.
	//
	// LoadBalancerArn is a required field
	LoadBalancerArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (SetIpAddressTypeInput) GoString added in v1.6.17

func (s SetIpAddressTypeInput) GoString() string

GoString returns the string representation

func (*SetIpAddressTypeInput) SetIpAddressType added in v1.6.17

func (s *SetIpAddressTypeInput) SetIpAddressType(v string) *SetIpAddressTypeInput

SetIpAddressType sets the IpAddressType field's value.

func (*SetIpAddressTypeInput) SetLoadBalancerArn added in v1.6.17

func (s *SetIpAddressTypeInput) SetLoadBalancerArn(v string) *SetIpAddressTypeInput

SetLoadBalancerArn sets the LoadBalancerArn field's value.

func (SetIpAddressTypeInput) String added in v1.6.17

func (s SetIpAddressTypeInput) String() string

String returns the string representation

func (*SetIpAddressTypeInput) Validate added in v1.6.17

func (s *SetIpAddressTypeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SetIpAddressTypeOutput added in v1.6.17

type SetIpAddressTypeOutput struct {

	// The IP address type.
	IpAddressType *string `type:"string" enum:"IpAddressType"`
	// contains filtered or unexported fields
}

func (SetIpAddressTypeOutput) GoString added in v1.6.17

func (s SetIpAddressTypeOutput) GoString() string

GoString returns the string representation

func (*SetIpAddressTypeOutput) SetIpAddressType added in v1.6.17

func (s *SetIpAddressTypeOutput) SetIpAddressType(v string) *SetIpAddressTypeOutput

SetIpAddressType sets the IpAddressType field's value.

func (SetIpAddressTypeOutput) String added in v1.6.17

func (s SetIpAddressTypeOutput) String() string

String returns the string representation

type SetRulePrioritiesInput

type SetRulePrioritiesInput struct {

	// The rule priorities.
	//
	// RulePriorities is a required field
	RulePriorities []*RulePriorityPair `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (SetRulePrioritiesInput) GoString

func (s SetRulePrioritiesInput) GoString() string

GoString returns the string representation

func (*SetRulePrioritiesInput) SetRulePriorities added in v1.5.0

SetRulePriorities sets the RulePriorities field's value.

func (SetRulePrioritiesInput) String

func (s SetRulePrioritiesInput) String() string

String returns the string representation

func (*SetRulePrioritiesInput) Validate

func (s *SetRulePrioritiesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SetRulePrioritiesOutput

type SetRulePrioritiesOutput struct {

	// Information about the rules.
	Rules []*Rule `type:"list"`
	// contains filtered or unexported fields
}

func (SetRulePrioritiesOutput) GoString

func (s SetRulePrioritiesOutput) GoString() string

GoString returns the string representation

func (*SetRulePrioritiesOutput) SetRules added in v1.5.0

SetRules sets the Rules field's value.

func (SetRulePrioritiesOutput) String

func (s SetRulePrioritiesOutput) String() string

String returns the string representation

type SetSecurityGroupsInput

type SetSecurityGroupsInput struct {

	// The Amazon Resource Name (ARN) of the load balancer.
	//
	// LoadBalancerArn is a required field
	LoadBalancerArn *string `type:"string" required:"true"`

	// The IDs of the security groups.
	//
	// SecurityGroups is a required field
	SecurityGroups []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (SetSecurityGroupsInput) GoString

func (s SetSecurityGroupsInput) GoString() string

GoString returns the string representation

func (*SetSecurityGroupsInput) SetLoadBalancerArn added in v1.5.0

func (s *SetSecurityGroupsInput) SetLoadBalancerArn(v string) *SetSecurityGroupsInput

SetLoadBalancerArn sets the LoadBalancerArn field's value.

func (*SetSecurityGroupsInput) SetSecurityGroups added in v1.5.0

func (s *SetSecurityGroupsInput) SetSecurityGroups(v []*string) *SetSecurityGroupsInput

SetSecurityGroups sets the SecurityGroups field's value.

func (SetSecurityGroupsInput) String

func (s SetSecurityGroupsInput) String() string

String returns the string representation

func (*SetSecurityGroupsInput) Validate

func (s *SetSecurityGroupsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SetSecurityGroupsOutput

type SetSecurityGroupsOutput struct {

	// The IDs of the security groups associated with the load balancer.
	SecurityGroupIds []*string `type:"list"`
	// contains filtered or unexported fields
}

func (SetSecurityGroupsOutput) GoString

func (s SetSecurityGroupsOutput) GoString() string

GoString returns the string representation

func (*SetSecurityGroupsOutput) SetSecurityGroupIds added in v1.5.0

func (s *SetSecurityGroupsOutput) SetSecurityGroupIds(v []*string) *SetSecurityGroupsOutput

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (SetSecurityGroupsOutput) String

func (s SetSecurityGroupsOutput) String() string

String returns the string representation

type SetSubnetsInput

type SetSubnetsInput struct {

	// [Network Load Balancers] The type of IP addresses used by the subnets for
	// your load balancer. The possible values are ipv4 (for IPv4 addresses) and
	// dualstack (for IPv4 and IPv6 addresses). You can’t specify dualstack for
	// a load balancer with a UDP or TCP_UDP listener. Internal load balancers must
	// use ipv4.
	IpAddressType *string `type:"string" enum:"IpAddressType"`

	// The Amazon Resource Name (ARN) of the load balancer.
	//
	// LoadBalancerArn is a required field
	LoadBalancerArn *string `type:"string" required:"true"`

	// The IDs of the public subnets. You can specify only one subnet per Availability
	// Zone. You must specify either subnets or subnet mappings.
	//
	// [Application Load Balancers] You must specify subnets from at least two Availability
	// Zones. You cannot specify Elastic IP addresses for your subnets.
	//
	// [Application Load Balancers on Outposts] You must specify one Outpost subnet.
	//
	// [Application Load Balancers on Local Zones] You can specify subnets from
	// one or more Local Zones.
	//
	// [Network Load Balancers] You can specify subnets from one or more Availability
	// Zones. You can specify one Elastic IP address per subnet if you need static
	// IP addresses for your internet-facing load balancer. For internal load balancers,
	// you can specify one private IP address per subnet from the IPv4 range of
	// the subnet. For internet-facing load balancer, you can specify one IPv6 address
	// per subnet.
	SubnetMappings []*SubnetMapping `type:"list"`

	// The IDs of the public subnets. You can specify only one subnet per Availability
	// Zone. You must specify either subnets or subnet mappings.
	//
	// [Application Load Balancers] You must specify subnets from at least two Availability
	// Zones.
	//
	// [Application Load Balancers on Outposts] You must specify one Outpost subnet.
	//
	// [Application Load Balancers on Local Zones] You can specify subnets from
	// one or more Local Zones.
	//
	// [Network Load Balancers] You can specify subnets from one or more Availability
	// Zones.
	Subnets []*string `type:"list"`
	// contains filtered or unexported fields
}

func (SetSubnetsInput) GoString

func (s SetSubnetsInput) GoString() string

GoString returns the string representation

func (*SetSubnetsInput) SetIpAddressType added in v1.35.28

func (s *SetSubnetsInput) SetIpAddressType(v string) *SetSubnetsInput

SetIpAddressType sets the IpAddressType field's value.

func (*SetSubnetsInput) SetLoadBalancerArn added in v1.5.0

func (s *SetSubnetsInput) SetLoadBalancerArn(v string) *SetSubnetsInput

SetLoadBalancerArn sets the LoadBalancerArn field's value.

func (*SetSubnetsInput) SetSubnetMappings added in v1.10.40

func (s *SetSubnetsInput) SetSubnetMappings(v []*SubnetMapping) *SetSubnetsInput

SetSubnetMappings sets the SubnetMappings field's value.

func (*SetSubnetsInput) SetSubnets added in v1.5.0

func (s *SetSubnetsInput) SetSubnets(v []*string) *SetSubnetsInput

SetSubnets sets the Subnets field's value.

func (SetSubnetsInput) String

func (s SetSubnetsInput) String() string

String returns the string representation

func (*SetSubnetsInput) Validate

func (s *SetSubnetsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SetSubnetsOutput

type SetSubnetsOutput struct {

	// Information about the subnets.
	AvailabilityZones []*AvailabilityZone `type:"list"`

	// [Network Load Balancers] The IP address type.
	IpAddressType *string `type:"string" enum:"IpAddressType"`
	// contains filtered or unexported fields
}

func (SetSubnetsOutput) GoString

func (s SetSubnetsOutput) GoString() string

GoString returns the string representation

func (*SetSubnetsOutput) SetAvailabilityZones added in v1.5.0

func (s *SetSubnetsOutput) SetAvailabilityZones(v []*AvailabilityZone) *SetSubnetsOutput

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*SetSubnetsOutput) SetIpAddressType added in v1.35.28

func (s *SetSubnetsOutput) SetIpAddressType(v string) *SetSubnetsOutput

SetIpAddressType sets the IpAddressType field's value.

func (SetSubnetsOutput) String

func (s SetSubnetsOutput) String() string

String returns the string representation

type SourceIpConditionConfig added in v1.19.3

type SourceIpConditionConfig struct {

	// One or more source IP addresses, in CIDR format. You can use both IPv4 and
	// IPv6 addresses. Wildcards are not supported.
	//
	// If you specify multiple addresses, the condition is satisfied if the source
	// IP address of the request matches one of the CIDR blocks. This condition
	// is not satisfied by the addresses in the X-Forwarded-For header. To search
	// for addresses in the X-Forwarded-For header, use HttpHeaderConditionConfig.
	Values []*string `type:"list"`
	// contains filtered or unexported fields
}

Information about a source IP condition.

You can use this condition to route based on the IP address of the source that connects to the load balancer. If a client is behind a proxy, this is the IP address of the proxy not the IP address of the client.

func (SourceIpConditionConfig) GoString added in v1.19.3

func (s SourceIpConditionConfig) GoString() string

GoString returns the string representation

func (*SourceIpConditionConfig) SetValues added in v1.19.3

SetValues sets the Values field's value.

func (SourceIpConditionConfig) String added in v1.19.3

func (s SourceIpConditionConfig) String() string

String returns the string representation

type SslPolicy

type SslPolicy struct {

	// The ciphers.
	Ciphers []*Cipher `type:"list"`

	// The name of the policy.
	Name *string `type:"string"`

	// The protocols.
	SslProtocols []*string `type:"list"`
	// contains filtered or unexported fields
}

Information about a policy used for SSL negotiation.

func (SslPolicy) GoString

func (s SslPolicy) GoString() string

GoString returns the string representation

func (*SslPolicy) SetCiphers added in v1.5.0

func (s *SslPolicy) SetCiphers(v []*Cipher) *SslPolicy

SetCiphers sets the Ciphers field's value.

func (*SslPolicy) SetName added in v1.5.0

func (s *SslPolicy) SetName(v string) *SslPolicy

SetName sets the Name field's value.

func (*SslPolicy) SetSslProtocols added in v1.5.0

func (s *SslPolicy) SetSslProtocols(v []*string) *SslPolicy

SetSslProtocols sets the SslProtocols field's value.

func (SslPolicy) String

func (s SslPolicy) String() string

String returns the string representation

type SubnetMapping added in v1.10.40

type SubnetMapping struct {

	// [Network Load Balancers] The allocation ID of the Elastic IP address for
	// an internet-facing load balancer.
	AllocationId *string `type:"string"`

	// [Network Load Balancers] The IPv6 address.
	IPv6Address *string `type:"string"`

	// [Network Load Balancers] The private IPv4 address for an internal load balancer.
	PrivateIPv4Address *string `type:"string"`

	// The ID of the subnet.
	SubnetId *string `type:"string"`
	// contains filtered or unexported fields
}

Information about a subnet mapping.

func (SubnetMapping) GoString added in v1.10.40

func (s SubnetMapping) GoString() string

GoString returns the string representation

func (*SubnetMapping) SetAllocationId added in v1.10.40

func (s *SubnetMapping) SetAllocationId(v string) *SubnetMapping

SetAllocationId sets the AllocationId field's value.

func (*SubnetMapping) SetIPv6Address added in v1.35.28

func (s *SubnetMapping) SetIPv6Address(v string) *SubnetMapping

SetIPv6Address sets the IPv6Address field's value.

func (*SubnetMapping) SetPrivateIPv4Address added in v1.25.42

func (s *SubnetMapping) SetPrivateIPv4Address(v string) *SubnetMapping

SetPrivateIPv4Address sets the PrivateIPv4Address field's value.

func (*SubnetMapping) SetSubnetId added in v1.10.40

func (s *SubnetMapping) SetSubnetId(v string) *SubnetMapping

SetSubnetId sets the SubnetId field's value.

func (SubnetMapping) String added in v1.10.40

func (s SubnetMapping) String() string

String returns the string representation

type Tag

type Tag struct {

	// The key of the tag.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// The value of the tag.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

Information about a tag.

func (Tag) GoString

func (s Tag) GoString() string

GoString returns the string representation

func (*Tag) SetKey added in v1.5.0

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.5.0

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagDescription

type TagDescription struct {

	// The Amazon Resource Name (ARN) of the resource.
	ResourceArn *string `type:"string"`

	// Information about the tags.
	Tags []*Tag `min:"1" type:"list"`
	// contains filtered or unexported fields
}

The tags associated with a resource.

func (TagDescription) GoString

func (s TagDescription) GoString() string

GoString returns the string representation

func (*TagDescription) SetResourceArn added in v1.5.0

func (s *TagDescription) SetResourceArn(v string) *TagDescription

SetResourceArn sets the ResourceArn field's value.

func (*TagDescription) SetTags added in v1.5.0

func (s *TagDescription) SetTags(v []*Tag) *TagDescription

SetTags sets the Tags field's value.

func (TagDescription) String

func (s TagDescription) String() string

String returns the string representation

type TargetDescription

type TargetDescription struct {

	// An Availability Zone or all. This determines whether the target receives
	// traffic from the load balancer nodes in the specified Availability Zone or
	// from all enabled Availability Zones for the load balancer.
	//
	// This parameter is not supported if the target type of the target group is
	// instance.
	//
	// If the target type is ip and the IP address is in a subnet of the VPC for
	// the target group, the Availability Zone is automatically detected and this
	// parameter is optional. If the IP address is outside the VPC, this parameter
	// is required.
	//
	// With an Application Load Balancer, if the target type is ip and the IP address
	// is outside the VPC for the target group, the only supported value is all.
	//
	// If the target type is lambda, this parameter is optional and the only supported
	// value is all.
	AvailabilityZone *string `type:"string"`

	// The ID of the target. If the target type of the target group is instance,
	// specify an instance ID. If the target type is ip, specify an IP address.
	// If the target type is lambda, specify the ARN of the Lambda function.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`

	// The port on which the target is listening. If the target group protocol is
	// GENEVE, the supported port is 6081. Not used if the target is a Lambda function.
	Port *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

Information about a target.

func (TargetDescription) GoString

func (s TargetDescription) GoString() string

GoString returns the string representation

func (*TargetDescription) SetAvailabilityZone added in v1.10.36

func (s *TargetDescription) SetAvailabilityZone(v string) *TargetDescription

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*TargetDescription) SetId added in v1.5.0

SetId sets the Id field's value.

func (*TargetDescription) SetPort added in v1.5.0

func (s *TargetDescription) SetPort(v int64) *TargetDescription

SetPort sets the Port field's value.

func (TargetDescription) String

func (s TargetDescription) String() string

String returns the string representation

func (*TargetDescription) Validate

func (s *TargetDescription) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TargetGroup

type TargetGroup struct {

	// Indicates whether health checks are enabled.
	HealthCheckEnabled *bool `type:"boolean"`

	// The approximate amount of time, in seconds, between health checks of an individual
	// target.
	HealthCheckIntervalSeconds *int64 `min:"5" type:"integer"`

	// The destination for health checks on the targets.
	HealthCheckPath *string `min:"1" type:"string"`

	// The port to use to connect with the target.
	HealthCheckPort *string `type:"string"`

	// The protocol to use to connect with the target. The GENEVE, TLS, UDP, and
	// TCP_UDP protocols are not supported for health checks.
	HealthCheckProtocol *string `type:"string" enum:"ProtocolEnum"`

	// The amount of time, in seconds, during which no response means a failed health
	// check.
	HealthCheckTimeoutSeconds *int64 `min:"2" type:"integer"`

	// The number of consecutive health checks successes required before considering
	// an unhealthy target healthy.
	HealthyThresholdCount *int64 `min:"2" type:"integer"`

	// The Amazon Resource Names (ARN) of the load balancers that route traffic
	// to this target group.
	LoadBalancerArns []*string `type:"list"`

	// The HTTP or gRPC codes to use when checking for a successful response from
	// a target.
	Matcher *Matcher `type:"structure"`

	// The port on which the targets are listening. Not used if the target is a
	// Lambda function.
	Port *int64 `min:"1" type:"integer"`

	// The protocol to use for routing traffic to the targets.
	Protocol *string `type:"string" enum:"ProtocolEnum"`

	// [HTTP/HTTPS protocol] The protocol version. The possible values are GRPC,
	// HTTP1, and HTTP2.
	ProtocolVersion *string `type:"string"`

	// The Amazon Resource Name (ARN) of the target group.
	TargetGroupArn *string `type:"string"`

	// The name of the target group.
	TargetGroupName *string `type:"string"`

	// The type of target that you must specify when registering targets with this
	// target group. The possible values are instance (register targets by instance
	// ID), ip (register targets by IP address), or lambda (register a single Lambda
	// function as a target).
	TargetType *string `type:"string" enum:"TargetTypeEnum"`

	// The number of consecutive health check failures required before considering
	// the target unhealthy.
	UnhealthyThresholdCount *int64 `min:"2" type:"integer"`

	// The ID of the VPC for the targets.
	VpcId *string `type:"string"`
	// contains filtered or unexported fields
}

Information about a target group.

func (TargetGroup) GoString

func (s TargetGroup) GoString() string

GoString returns the string representation

func (*TargetGroup) SetHealthCheckEnabled added in v1.15.87

func (s *TargetGroup) SetHealthCheckEnabled(v bool) *TargetGroup

SetHealthCheckEnabled sets the HealthCheckEnabled field's value.

func (*TargetGroup) SetHealthCheckIntervalSeconds added in v1.5.0

func (s *TargetGroup) SetHealthCheckIntervalSeconds(v int64) *TargetGroup

SetHealthCheckIntervalSeconds sets the HealthCheckIntervalSeconds field's value.

func (*TargetGroup) SetHealthCheckPath added in v1.5.0

func (s *TargetGroup) SetHealthCheckPath(v string) *TargetGroup

SetHealthCheckPath sets the HealthCheckPath field's value.

func (*TargetGroup) SetHealthCheckPort added in v1.5.0

func (s *TargetGroup) SetHealthCheckPort(v string) *TargetGroup

SetHealthCheckPort sets the HealthCheckPort field's value.

func (*TargetGroup) SetHealthCheckProtocol added in v1.5.0

func (s *TargetGroup) SetHealthCheckProtocol(v string) *TargetGroup

SetHealthCheckProtocol sets the HealthCheckProtocol field's value.

func (*TargetGroup) SetHealthCheckTimeoutSeconds added in v1.5.0

func (s *TargetGroup) SetHealthCheckTimeoutSeconds(v int64) *TargetGroup

SetHealthCheckTimeoutSeconds sets the HealthCheckTimeoutSeconds field's value.

func (*TargetGroup) SetHealthyThresholdCount added in v1.5.0

func (s *TargetGroup) SetHealthyThresholdCount(v int64) *TargetGroup

SetHealthyThresholdCount sets the HealthyThresholdCount field's value.

func (*TargetGroup) SetLoadBalancerArns added in v1.5.0

func (s *TargetGroup) SetLoadBalancerArns(v []*string) *TargetGroup

SetLoadBalancerArns sets the LoadBalancerArns field's value.

func (*TargetGroup) SetMatcher added in v1.5.0

func (s *TargetGroup) SetMatcher(v *Matcher) *TargetGroup

SetMatcher sets the Matcher field's value.

func (*TargetGroup) SetPort added in v1.5.0

func (s *TargetGroup) SetPort(v int64) *TargetGroup

SetPort sets the Port field's value.

func (*TargetGroup) SetProtocol added in v1.5.0

func (s *TargetGroup) SetProtocol(v string) *TargetGroup

SetProtocol sets the Protocol field's value.

func (*TargetGroup) SetProtocolVersion added in v1.35.18

func (s *TargetGroup) SetProtocolVersion(v string) *TargetGroup

SetProtocolVersion sets the ProtocolVersion field's value.

func (*TargetGroup) SetTargetGroupArn added in v1.5.0

func (s *TargetGroup) SetTargetGroupArn(v string) *TargetGroup

SetTargetGroupArn sets the TargetGroupArn field's value.

func (*TargetGroup) SetTargetGroupName added in v1.5.0

func (s *TargetGroup) SetTargetGroupName(v string) *TargetGroup

SetTargetGroupName sets the TargetGroupName field's value.

func (*TargetGroup) SetTargetType added in v1.10.36

func (s *TargetGroup) SetTargetType(v string) *TargetGroup

SetTargetType sets the TargetType field's value.

func (*TargetGroup) SetUnhealthyThresholdCount added in v1.5.0

func (s *TargetGroup) SetUnhealthyThresholdCount(v int64) *TargetGroup

SetUnhealthyThresholdCount sets the UnhealthyThresholdCount field's value.

func (*TargetGroup) SetVpcId added in v1.5.0

func (s *TargetGroup) SetVpcId(v string) *TargetGroup

SetVpcId sets the VpcId field's value.

func (TargetGroup) String

func (s TargetGroup) String() string

String returns the string representation

type TargetGroupAttribute

type TargetGroupAttribute struct {

	// The name of the attribute.
	//
	// The following attribute is supported by all load balancers:
	//
	//    * deregistration_delay.timeout_seconds - The amount of time, in seconds,
	//    for Elastic Load Balancing to wait before changing the state of a deregistering
	//    target from draining to unused. The range is 0-3600 seconds. The default
	//    value is 300 seconds. If the target is a Lambda function, this attribute
	//    is not supported.
	//
	// The following attributes are supported by both Application Load Balancers
	// and Network Load Balancers:
	//
	//    * stickiness.enabled - Indicates whether sticky sessions are enabled.
	//    The value is true or false. The default is false.
	//
	//    * stickiness.type - The type of sticky sessions. The possible values are
	//    lb_cookie and app_cookie for Application Load Balancers or source_ip for
	//    Network Load Balancers.
	//
	// The following attributes are supported only if the load balancer is an Application
	// Load Balancer and the target is an instance or an IP address:
	//
	//    * load_balancing.algorithm.type - The load balancing algorithm determines
	//    how the load balancer selects targets when routing requests. The value
	//    is round_robin or least_outstanding_requests. The default is round_robin.
	//
	//    * slow_start.duration_seconds - The time period, in seconds, during which
	//    a newly registered target receives an increasing share of the traffic
	//    to the target group. After this time period ends, the target receives
	//    its full share of traffic. The range is 30-900 seconds (15 minutes). The
	//    default is 0 seconds (disabled).
	//
	//    * stickiness.app_cookie.cookie_name - Indicates the name of the application-based
	//    cookie. Names that start with the following names are not allowed: AWSALB,
	//    AWSALBAPP, and AWSALBTG. They're reserved for use by the load balancer.
	//
	//    * stickiness.app_cookie.duration_seconds - The time period, in seconds,
	//    during which requests from a client should be routed to the same target.
	//    After this time period expires, the application-based cookie is considered
	//    stale. The range is 1 second to 1 week (604800 seconds). The default value
	//    is 1 day (86400 seconds).
	//
	//    * stickiness.lb_cookie.duration_seconds - The time period, in seconds,
	//    during which requests from a client should be routed to the same target.
	//    After this time period expires, the load balancer-generated cookie is
	//    considered stale. The range is 1 second to 1 week (604800 seconds). The
	//    default value is 1 day (86400 seconds).
	//
	// The following attribute is supported only if the load balancer is an Application
	// Load Balancer and the target is a Lambda function:
	//
	//    * lambda.multi_value_headers.enabled - Indicates whether the request and
	//    response headers that are exchanged between the load balancer and the
	//    Lambda function include arrays of values or strings. The value is true
	//    or false. The default is false. If the value is false and the request
	//    contains a duplicate header field name or query parameter key, the load
	//    balancer uses the last value sent by the client.
	//
	// The following attributes are supported only by Network Load Balancers:
	//
	//    * deregistration_delay.connection_termination.enabled - Indicates whether
	//    the load balancer terminates connections at the end of the deregistration
	//    timeout. The value is true or false. The default is false.
	//
	//    * preserve_client_ip.enabled - Indicates whether client IP preservation
	//    is enabled. The value is true or false. The default is disabled if the
	//    target group type is IP address and the target group protocol is TCP or
	//    TLS. Otherwise, the default is enabled. Client IP preservation cannot
	//    be disabled for UDP and TCP_UDP target groups.
	//
	//    * proxy_protocol_v2.enabled - Indicates whether Proxy Protocol version
	//    2 is enabled. The value is true or false. The default is false.
	Key *string `type:"string"`

	// The value of the attribute.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

Information about a target group attribute.

func (TargetGroupAttribute) GoString

func (s TargetGroupAttribute) GoString() string

GoString returns the string representation

func (*TargetGroupAttribute) SetKey added in v1.5.0

SetKey sets the Key field's value.

func (*TargetGroupAttribute) SetValue added in v1.5.0

SetValue sets the Value field's value.

func (TargetGroupAttribute) String

func (s TargetGroupAttribute) String() string

String returns the string representation

type TargetGroupStickinessConfig added in v1.25.38

type TargetGroupStickinessConfig struct {

	// The time period, in seconds, during which requests from a client should be
	// routed to the same target group. The range is 1-604800 seconds (7 days).
	DurationSeconds *int64 `type:"integer"`

	// Indicates whether target group stickiness is enabled.
	Enabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Information about the target group stickiness for a rule.

func (TargetGroupStickinessConfig) GoString added in v1.25.38

func (s TargetGroupStickinessConfig) GoString() string

GoString returns the string representation

func (*TargetGroupStickinessConfig) SetDurationSeconds added in v1.25.38

SetDurationSeconds sets the DurationSeconds field's value.

func (*TargetGroupStickinessConfig) SetEnabled added in v1.25.38

SetEnabled sets the Enabled field's value.

func (TargetGroupStickinessConfig) String added in v1.25.38

String returns the string representation

type TargetGroupTuple added in v1.25.38

type TargetGroupTuple struct {

	// The Amazon Resource Name (ARN) of the target group.
	TargetGroupArn *string `type:"string"`

	// The weight. The range is 0 to 999.
	Weight *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Information about how traffic will be distributed between multiple target groups in a forward rule.

func (TargetGroupTuple) GoString added in v1.25.38

func (s TargetGroupTuple) GoString() string

GoString returns the string representation

func (*TargetGroupTuple) SetTargetGroupArn added in v1.25.38

func (s *TargetGroupTuple) SetTargetGroupArn(v string) *TargetGroupTuple

SetTargetGroupArn sets the TargetGroupArn field's value.

func (*TargetGroupTuple) SetWeight added in v1.25.38

func (s *TargetGroupTuple) SetWeight(v int64) *TargetGroupTuple

SetWeight sets the Weight field's value.

func (TargetGroupTuple) String added in v1.25.38

func (s TargetGroupTuple) String() string

String returns the string representation

type TargetHealth

type TargetHealth struct {

	// A description of the target health that provides additional details. If the
	// state is healthy, a description is not provided.
	Description *string `type:"string"`

	// The reason code.
	//
	// If the target state is healthy, a reason code is not provided.
	//
	// If the target state is initial, the reason code can be one of the following
	// values:
	//
	//    * Elb.RegistrationInProgress - The target is in the process of being registered
	//    with the load balancer.
	//
	//    * Elb.InitialHealthChecking - The load balancer is still sending the target
	//    the minimum number of health checks required to determine its health status.
	//
	// If the target state is unhealthy, the reason code can be one of the following
	// values:
	//
	//    * Target.ResponseCodeMismatch - The health checks did not return an expected
	//    HTTP code. Applies only to Application Load Balancers and Gateway Load
	//    Balancers.
	//
	//    * Target.Timeout - The health check requests timed out. Applies only to
	//    Application Load Balancers and Gateway Load Balancers.
	//
	//    * Target.FailedHealthChecks - The load balancer received an error while
	//    establishing a connection to the target or the target response was malformed.
	//
	//    * Elb.InternalError - The health checks failed due to an internal error.
	//    Applies only to Application Load Balancers.
	//
	// If the target state is unused, the reason code can be one of the following
	// values:
	//
	//    * Target.NotRegistered - The target is not registered with the target
	//    group.
	//
	//    * Target.NotInUse - The target group is not used by any load balancer
	//    or the target is in an Availability Zone that is not enabled for its load
	//    balancer.
	//
	//    * Target.InvalidState - The target is in the stopped or terminated state.
	//
	//    * Target.IpUnusable - The target IP address is reserved for use by a load
	//    balancer.
	//
	// If the target state is draining, the reason code can be the following value:
	//
	//    * Target.DeregistrationInProgress - The target is in the process of being
	//    deregistered and the deregistration delay period has not expired.
	//
	// If the target state is unavailable, the reason code can be the following
	// value:
	//
	//    * Target.HealthCheckDisabled - Health checks are disabled for the target
	//    group. Applies only to Application Load Balancers.
	//
	//    * Elb.InternalError - Target health is unavailable due to an internal
	//    error. Applies only to Network Load Balancers.
	Reason *string `type:"string" enum:"TargetHealthReasonEnum"`

	// The state of the target.
	State *string `type:"string" enum:"TargetHealthStateEnum"`
	// contains filtered or unexported fields
}

Information about the current health of a target.

func (TargetHealth) GoString

func (s TargetHealth) GoString() string

GoString returns the string representation

func (*TargetHealth) SetDescription added in v1.5.0

func (s *TargetHealth) SetDescription(v string) *TargetHealth

SetDescription sets the Description field's value.

func (*TargetHealth) SetReason added in v1.5.0

func (s *TargetHealth) SetReason(v string) *TargetHealth

SetReason sets the Reason field's value.

func (*TargetHealth) SetState added in v1.5.0

func (s *TargetHealth) SetState(v string) *TargetHealth

SetState sets the State field's value.

func (TargetHealth) String

func (s TargetHealth) String() string

String returns the string representation

type TargetHealthDescription

type TargetHealthDescription struct {

	// The port to use to connect with the target.
	HealthCheckPort *string `type:"string"`

	// The description of the target.
	Target *TargetDescription `type:"structure"`

	// The health information for the target.
	TargetHealth *TargetHealth `type:"structure"`
	// contains filtered or unexported fields
}

Information about the health of a target.

func (TargetHealthDescription) GoString

func (s TargetHealthDescription) GoString() string

GoString returns the string representation

func (*TargetHealthDescription) SetHealthCheckPort added in v1.5.0

func (s *TargetHealthDescription) SetHealthCheckPort(v string) *TargetHealthDescription

SetHealthCheckPort sets the HealthCheckPort field's value.

func (*TargetHealthDescription) SetTarget added in v1.5.0

SetTarget sets the Target field's value.

func (*TargetHealthDescription) SetTargetHealth added in v1.5.0

SetTargetHealth sets the TargetHealth field's value.

func (TargetHealthDescription) String

func (s TargetHealthDescription) String() string

String returns the string representation

Directories

Path Synopsis
Package elbv2iface provides an interface to enable mocking the Elastic Load Balancing service client for testing your code.
Package elbv2iface provides an interface to enable mocking the Elastic Load Balancing service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL