AWS SDK for .NET Documentation
Amazon.ElasticLoadBalancing.Model Namespace
AmazonAmazon.ElasticLoadBalancing.Model Did this page help you?   Yes   No    Tell us about it...
 
Declaration Syntax
C#
namespace Amazon.ElasticLoadBalancing.Model
Types
All TypesClasses
IconTypeDescription
AppCookieStickinessPolicy

The AppCookieStickinessPolicy data type.


ApplySecurityGroupsToLoadBalancerRequest
Container for the parameters to the ApplySecurityGroupsToLoadBalancer operation.

Associates one or more security groups with your LoadBalancer in VPC. The provided security group IDs will override any currently applied security groups.


ApplySecurityGroupsToLoadBalancerResponse
Returns information about the ApplySecurityGroupsToLoadBalancerResult response and response metadata.

ApplySecurityGroupsToLoadBalancerResult

The out for the ApplySecurityGroupsToLoadBalancer action.


AttachLoadBalancerToSubnetsRequest
Container for the parameters to the AttachLoadBalancerToSubnets operation.

Adds one or more subnets to the set of configured subnets in the VPC for the LoadBalancer.

The Loadbalancers evenly distribute requests across all of the registered subnets.


AttachLoadBalancerToSubnetsResponse
Returns information about the AttachLoadBalancerToSubnetsResult response and response metadata.

AttachLoadBalancerToSubnetsResult

The output for the AttachLoadBalancerToSubnets action.


BackendServerDescription

This data type is used as a response element in the DescribeLoadBalancers action to describe the configuration of the back-end server.


CertificateNotFoundException
AmazonElasticLoadBalancing exception

ConfigureHealthCheckRequest
Container for the parameters to the ConfigureHealthCheck operation.

Enables the client to define an application healthcheck for the instances.


ConfigureHealthCheckResponse
Returns information about the ConfigureHealthCheckResult response and response metadata.

ConfigureHealthCheckResult

The output for the ConfigureHealthCheck action.


CreateAppCookieStickinessPolicyRequest
Container for the parameters to the CreateAppCookieStickinessPolicy operation.

Generates a stickiness policy with sticky session lifetimes that follow that of an application-generated cookie. This policy can be associated only with HTTP/HTTPS listeners.

This policy is similar to the policy created by CreateLBCookieStickinessPolicy, except that the lifetime of the special Elastic Load Balancing cookie follows the lifetime of the application-generated cookie specified in the policy configuration. The LoadBalancer only inserts a new stickiness cookie when the application response includes a new application cookie.

If the application cookie is explicitly removed or expires, the session stops being sticky until a new application cookie is issued.

NOTE: An application client must receive and send two cookies: the application-generated cookie and the special Elastic Load Balancing cookie named AWSELB. This is the default behavior for many common web browsers.


CreateAppCookieStickinessPolicyResponse
Returns information about the CreateAppCookieStickinessPolicyResult response and response metadata.

CreateAppCookieStickinessPolicyResult

The output for the CreateAppCookieStickinessPolicy action.


CreateLBCookieStickinessPolicyRequest
Container for the parameters to the CreateLBCookieStickinessPolicy operation.

Generates a stickiness policy with sticky session lifetimes controlled by the lifetime of the browser (user-agent) or a specified expiration period. This policy can be associated only with HTTP/HTTPS listeners.

When a LoadBalancer implements this policy, the LoadBalancer uses a special cookie to track the backend server instance for each request. When the LoadBalancer receives a request, it first checks to see if this cookie is present in the request. If so, the LoadBalancer sends the request to the application server specified in the cookie. If not, the LoadBalancer sends the request to a server that is chosen based on the existing load balancing algorithm.

A cookie is inserted into the response for binding subsequent requests from the same user to that server. The validity of the cookie is based on the cookie expiration time, which is specified in the policy configuration.


CreateLBCookieStickinessPolicyResponse
Returns information about the CreateLBCookieStickinessPolicyResult response and response metadata.

CreateLBCookieStickinessPolicyResult

The output for the CreateLBCookieStickinessPolicy action.


CreateLoadBalancerListenersRequest
Container for the parameters to the CreateLoadBalancerListeners operation.

Creates one or more listeners on a LoadBalancer for the specified port. If a listener with the given port does not already exist, it will be created; otherwise, the properties of the new listener must match the properties of the existing listener.


CreateLoadBalancerListenersResponse
Returns information about the CreateLoadBalancerListenersResult response and response metadata.

CreateLoadBalancerListenersResult

The output for the CreateLoadBalancerListeners action.


CreateLoadBalancerPolicyRequest
Container for the parameters to the CreateLoadBalancerPolicy operation.

Creates a new policy that contains the necessary attributes depending on the policy type. Policies are settings that are saved for your Elastic LoadBalancer and that can be applied to the front-end listener, or the back-end application server, depending on your policy type.


CreateLoadBalancerPolicyResponse
Returns information about the CreateLoadBalancerPolicyResult response and response metadata.

CreateLoadBalancerPolicyResult

The output for the CreateLoadBalancerPolicy action.


CreateLoadBalancerRequest
Container for the parameters to the CreateLoadBalancer operation.

Creates a new LoadBalancer.

After the call has completed successfully, a new LoadBalancer is created; however, it will not be usable until at least one instance has been registered. When the LoadBalancer creation is completed, the client can check whether or not it is usable by using the DescribeInstanceHealth action. The LoadBalancer is usable as soon as any registered instance is InService .

NOTE: Currently, the client's quota of LoadBalancers is limited to ten per Region.

NOTE: LoadBalancer DNS names vary depending on the Region they're created in. For LoadBalancers created in the United States, the DNS name ends with: us-east-1.elb.amazonaws.com (for the US Standard Region) us-west-1.elb.amazonaws.com (for the Northern California Region) For LoadBalancers created in the EU (Ireland) Region, the DNS name ends with: eu-west-1.elb.amazonaws.com

For information on using CreateLoadBalancer to create a new LoadBalancer in Amazon EC2, go to Using Query API section in the Creating a Load Balancer With SSL Cipher Settings and Back-end Authentication topic of the Elastic Load Balancing Developer Guide .

For information on using CreateLoadBalancer to create a new LoadBalancer in Amazon VPC, go to Using Query API section in the Creating a Basic Load Balancer in Amazon VPC topic of the Elastic Load Balancing Developer Guide .


CreateLoadBalancerResponse
Returns information about the CreateLoadBalancerResult response and response metadata.

CreateLoadBalancerResult

The output for the CreateLoadBalancer action.


DeleteLoadBalancerListenersRequest
Container for the parameters to the DeleteLoadBalancerListeners operation.

Deletes listeners from the LoadBalancer for the specified port.


DeleteLoadBalancerListenersResponse
Returns information about the DeleteLoadBalancerListenersResult response and response metadata.

DeleteLoadBalancerListenersResult

The output for the DeleteLoadBalancerListeners action.


DeleteLoadBalancerPolicyRequest
Container for the parameters to the DeleteLoadBalancerPolicy operation.

Deletes a policy from the LoadBalancer. The specified policy must not be enabled for any listeners.


DeleteLoadBalancerPolicyResponse
Returns information about the DeleteLoadBalancerPolicyResult response and response metadata.

DeleteLoadBalancerPolicyResult

The output for the DeleteLoadBalancerPolicy action.


DeleteLoadBalancerRequest
Container for the parameters to the DeleteLoadBalancer operation.

Deletes the specified LoadBalancer.

If attempting to recreate the LoadBalancer, the client must reconfigure all the settings. The DNS name associated with a deleted LoadBalancer will no longer be usable. Once deleted, the name and associated DNS record of the LoadBalancer no longer exist and traffic sent to any of its IP addresses will no longer be delivered to client instances. The client will not receive the same DNS name even if a new LoadBalancer with same LoadBalancerName is created.

To successfully call this API, the client must provide the same account credentials as were used to create the LoadBalancer.

NOTE: By design, if the LoadBalancer does not exist or has already been deleted, DeleteLoadBalancer still succeeds.


DeleteLoadBalancerResponse
Returns information about the DeleteLoadBalancerResult response and response metadata.

DeleteLoadBalancerResult

The output for the DeleteLoadBalander action.


DeregisterInstancesFromLoadBalancerRequest
Container for the parameters to the DeregisterInstancesFromLoadBalancer operation.

Deregisters instances from the LoadBalancer. Once the instance is deregistered, it will stop receiving traffic from the LoadBalancer.

In order to successfully call this API, the same account credentials as those used to create the LoadBalancer must be provided.


DeregisterInstancesFromLoadBalancerResponse
Returns information about the DeregisterInstancesFromLoadBalancerResult response and response metadata.

DeregisterInstancesFromLoadBalancerResult

The output for the DeregisterInstancesFromLoadBalancer action.


DescribeInstanceHealthRequest
Container for the parameters to the DescribeInstanceHealth operation.

Returns the current state of the instances of the specified LoadBalancer. If no instances are specified, the state of all the instances for the LoadBalancer is returned.

NOTE: The client must have created the specified input LoadBalancer in order to retrieve this information; the client must provide the same account credentials as those that were used to create the LoadBalancer.


DescribeInstanceHealthResponse
Returns information about the DescribeInstanceHealthResult response and response metadata.

DescribeInstanceHealthResult

The output for the DescribeInstanceHealth action.


DescribeLoadBalancerPoliciesRequest
Container for the parameters to the DescribeLoadBalancerPolicies operation.

Returns detailed descriptions of the policies. If you specify a LoadBalancer name, the operation returns either the descriptions of the specified policies, or descriptions of all the policies created for the LoadBalancer. If you don't specify a LoadBalancer name, the operation returns descriptions of the specified sample policies, or descriptions of all the sample policies. The names of the sample policies have the ELBSample- prefix.


DescribeLoadBalancerPoliciesResponse
Returns information about the DescribeLoadBalancerPoliciesResult response and response metadata.

DescribeLoadBalancerPoliciesResult

The output for the DescribeLoadBalancerPolicies action.


DescribeLoadBalancerPolicyTypesRequest
Container for the parameters to the DescribeLoadBalancerPolicyTypes operation.

Returns meta-information on the specified LoadBalancer policies defined by the Elastic Load Balancing service. The policy types that are returned from this action can be used in a CreateLoadBalancerPolicy action to instantiate specific policy configurations that will be applied to an Elastic LoadBalancer.


DescribeLoadBalancerPolicyTypesResponse
Returns information about the DescribeLoadBalancerPolicyTypesResult response and response metadata.

DescribeLoadBalancerPolicyTypesResult

The output for the DescribeLoadBalancerPolicyTypes action.


DescribeLoadBalancersRequest
Container for the parameters to the DescribeLoadBalancers operation.

Returns detailed configuration information for the specified LoadBalancers. If no LoadBalancers are specified, the operation returns configuration information for all LoadBalancers created by the caller.

NOTE: The client must have created the specified input LoadBalancers in order to retrieve this information; the client must provide the same account credentials as those that were used to create the LoadBalancer.


DescribeLoadBalancersResponse
Returns information about the DescribeLoadBalancersResult response and response metadata.

DescribeLoadBalancersResult

The output for the DescribeLoadBalancers action.


DetachLoadBalancerFromSubnetsRequest
Container for the parameters to the DetachLoadBalancerFromSubnets operation.

Removes subnets from the set of configured subnets in the VPC for the LoadBalancer.

After a subnet is removed all of the EndPoints registered with the LoadBalancer that are in the removed subnet will go into the OutOfService state. When a subnet is removed, the LoadBalancer will balance the traffic among the remaining routable subnets for the LoadBalancer.


DetachLoadBalancerFromSubnetsResponse
Returns information about the DetachLoadBalancerFromSubnetsResult response and response metadata.

DetachLoadBalancerFromSubnetsResult

The output for the DetachLoadBalancerFromSubnets action.


DisableAvailabilityZonesForLoadBalancerRequest
Container for the parameters to the DisableAvailabilityZonesForLoadBalancer operation.

Removes the specified EC2 Availability Zones from the set of configured Availability Zones for the LoadBalancer.

There must be at least one Availability Zone registered with a LoadBalancer at all times. A client cannot remove all the Availability Zones from a LoadBalancer. Once an Availability Zone is removed, all the instances registered with the LoadBalancer that are in the removed Availability Zone go into the OutOfService state. Upon Availability Zone removal, the LoadBalancer attempts to equally balance the traffic among its remaining usable Availability Zones. Trying to remove an Availability Zone that was not associated with the LoadBalancer does nothing.

NOTE: In order for this call to be successful, the client must have created the LoadBalancer. The client must provide the same account credentials as those that were used to create the LoadBalancer.


DisableAvailabilityZonesForLoadBalancerResponse
Returns information about the DisableAvailabilityZonesForLoadBalancerResult response and response metadata.

DisableAvailabilityZonesForLoadBalancerResult

The output for the DisableAvailabilityZonesForLoadBalancer action.


DuplicateListenerException
AmazonElasticLoadBalancing exception

DuplicateLoadBalancerNameException
AmazonElasticLoadBalancing exception

DuplicatePolicyNameException
AmazonElasticLoadBalancing exception

EnableAvailabilityZonesForLoadBalancerRequest
Container for the parameters to the EnableAvailabilityZonesForLoadBalancer operation.

Adds one or more EC2 Availability Zones to the LoadBalancer.

The LoadBalancer evenly distributes requests across all its registered Availability Zones that contain instances. As a result, the client must ensure that its LoadBalancer is appropriately scaled for each registered Availability Zone.

NOTE: The new EC2 Availability Zones to be added must be in the same EC2 Region as the Availability Zones for which the LoadBalancer was created.


EnableAvailabilityZonesForLoadBalancerResponse
Returns information about the EnableAvailabilityZonesForLoadBalancerResult response and response metadata.

EnableAvailabilityZonesForLoadBalancerResult

The output for the EnableAvailabilityZonesForLoadBalancer action.


HealthCheck

The HealthCheck data type.


Instance

The Instance data type.


InstanceState

The InstanceState data type.


InvalidConfigurationRequestException
AmazonElasticLoadBalancing exception

InvalidInstanceException
AmazonElasticLoadBalancing exception

InvalidSchemeException
AmazonElasticLoadBalancing exception

InvalidSecurityGroupException
AmazonElasticLoadBalancing exception

InvalidSubnetException
AmazonElasticLoadBalancing exception

LBCookieStickinessPolicy

The LBCookieStickinessPolicy data type.


Listener

The Listener data type.


ListenerDescription

The ListenerDescription data type.


ListenerNotFoundException
AmazonElasticLoadBalancing exception

LoadBalancerDescription

Contains the result of a successful invocation of DescribeLoadBalancers.


LoadBalancerNotFoundException
AmazonElasticLoadBalancing exception

Policies

The policies data type.


PolicyAttribute

The PolicyAttribute data type. This data type contains a key/value pair that defines properties of a specific policy.


PolicyAttributeDescription

The PolicyAttributeDescription data type. This data type is used to describe the attributes and values associated with a policy.


PolicyAttributeTypeDescription

The PolicyAttributeTypeDescription data type. This data type is used to describe values that are acceptable for the policy attribute.


PolicyDescription

The PolicyDescription data type.


PolicyNotFoundException
AmazonElasticLoadBalancing exception

PolicyTypeDescription

The PolicyTypeDescription data type.


PolicyTypeNotFoundException
AmazonElasticLoadBalancing exception

RegisterInstancesWithLoadBalancerRequest
Container for the parameters to the RegisterInstancesWithLoadBalancer operation.

Adds new instances to the LoadBalancer.

Once the instance is registered, it starts receiving traffic and requests from the LoadBalancer. Any instance that is not in any of the Availability Zones registered for the LoadBalancer will be moved to the OutOfService state. It will move to the InService state when the Availability Zone is added to the LoadBalancer.

NOTE: In order for this call to be successful, the client must have created the LoadBalancer. The client must provide the same account credentials as those that were used to create the LoadBalancer.

NOTE: Completion of this API does not guarantee that operation has completed. Rather, it means that the request has been registered and the changes will happen shortly.


RegisterInstancesWithLoadBalancerResponse
Returns information about the RegisterInstancesWithLoadBalancerResult response and response metadata.

RegisterInstancesWithLoadBalancerResult

The output for the RegisterInstancesWithLoadBalancer action.


SetLoadBalancerListenerSSLCertificateRequest
Container for the parameters to the SetLoadBalancerListenerSSLCertificate operation.

Sets the certificate that terminates the specified listener's SSL connections. The specified certificate replaces any prior certificate that was used on the same LoadBalancer and port.

For information on using SetLoadBalancerListenerSSLCertificate, go to Using the Query API in Updating an SSL Certificate for a Load Balancer section of the Elastic Load Balancing Developer Guide .


SetLoadBalancerListenerSSLCertificateResponse
Returns information about the SetLoadBalancerListenerSSLCertificateResult response and response metadata.

SetLoadBalancerListenerSSLCertificateResult

The output for the SetLoadBalancerListenerSSLCertificate action.


SetLoadBalancerPoliciesForBackendServerRequest
Container for the parameters to the SetLoadBalancerPoliciesForBackendServer operation.

Replaces the current set of policies associated with a port on which the back-end server is listening with a new set of policies. After the policies have been created using CreateLoadBalancerPolicy, they can be applied here as a list. At this time, only the back-end server authentication policy type can be applied to the back-end ports; this policy type is composed of multiple public key policies.


SetLoadBalancerPoliciesForBackendServerResponse
Returns information about the SetLoadBalancerPoliciesForBackendServerResult response and response metadata.

SetLoadBalancerPoliciesForBackendServerResult

The output for the SetLoadBalancerPoliciesForBackendServer action.


SetLoadBalancerPoliciesOfListenerRequest
Container for the parameters to the SetLoadBalancerPoliciesOfListener operation.

Associates, updates, or disables a policy with a listener on the LoadBalancer. You can associate multiple policies with a listener.


SetLoadBalancerPoliciesOfListenerResponse
Returns information about the SetLoadBalancerPoliciesOfListenerResult response and response metadata.

SetLoadBalancerPoliciesOfListenerResult

The output for the SetLoadBalancerPoliciesOfListener action.


SourceSecurityGroup

This data type is used as a response element in the DescribeLoadBalancers action. For information about Elastic Load Balancing security groups, go to Using Security Groups With Elastic Load Balancing in the Elastic Load Balancing Developer Guide .


SubnetNotFoundException
AmazonElasticLoadBalancing exception

TooManyLoadBalancersException
AmazonElasticLoadBalancing exception

TooManyPoliciesException
AmazonElasticLoadBalancing exception