AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class Action

Information about an action.

Class AddListenerCertificatesRequest

Container for the parameters to the AddListenerCertificates operation. Adds the specified certificate to the specified secure listener.

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

To list the certificates for your listener, use DescribeListenerCertificates. To remove certificates from your listener, use RemoveListenerCertificates.

Class AddListenerCertificatesResponse

This is the response object from the AddListenerCertificates operation.

Class AddTagsRequest

Container for the parameters to the AddTags operation. Adds the specified tags to the specified Elastic Load Balancing resource. You can tag your Application Load Balancers, Network Load Balancers, and your target groups.

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.

To list the current tags for your resources, use DescribeTags. To remove tags from your resources, use RemoveTags.

Class AddTagsResponse

This is the response object from the AddTags operation.

Class AllocationIdNotFoundException

ElasticLoadBalancingV2 exception

Class AvailabilityZone

Information about an Availability Zone.

Class AvailabilityZoneNotSupportedException

ElasticLoadBalancingV2 exception

Class Certificate

Information about an SSL server certificate.

Class CertificateNotFoundException

ElasticLoadBalancingV2 exception

Class Cipher

Information about a cipher used in a policy.

Class CreateListenerRequest

Container for the parameters to the CreateListener operation. Creates a listener for the specified Application Load Balancer or Network Load Balancer.

To update a listener, use ModifyListener. When you are finished with a listener, you can delete it using DeleteListener. If you are finished with both the listener and the load balancer, you can delete them both using DeleteLoadBalancer.

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.

For more information, see Listeners for Your Application Load Balancers in the Application Load Balancers Guide and Listeners for Your Network Load Balancers in the Network Load Balancers Guide.

Class CreateListenerResponse

This is the response object from the CreateListener operation.

Class CreateLoadBalancerRequest

Container for the parameters to the CreateLoadBalancer operation. Creates an Application Load Balancer or a Network Load Balancer.

When you create a load balancer, you can specify security groups, subnets, IP address type, and tags. Otherwise, you could do so later using SetSecurityGroups, SetSubnets, SetIpAddressType, and AddTags.

To create listeners for your load balancer, use CreateListener. To describe your current load balancers, see DescribeLoadBalancers. When you are finished with a load balancer, you can delete it using DeleteLoadBalancer.

For limit information, see Limits for Your Application Load Balancer in the Application Load Balancers Guide and Limits for Your Network Load Balancer in the Network Load Balancers Guide.

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.

For more information, see Application Load Balancers in the Application Load Balancers Guide and Network Load Balancers in the Network Load Balancers Guide.

Class CreateLoadBalancerResponse

This is the response object from the CreateLoadBalancer operation.

Class CreateRuleRequest

Container for the parameters to the CreateRule operation. Creates a rule for the specified listener. The listener must be associated with an Application Load Balancer.

Rules are evaluated in priority order, from the lowest value to the highest value. When the condition for a rule is met, the specified action is taken. If no conditions are met, the action for the default rule is taken. For more information, see Listener Rules in the Application Load Balancers Guide.

To view your current rules, use DescribeRules. To update a rule, use ModifyRule. To set the priorities of your rules, use SetRulePriorities. To delete a rule, use DeleteRule.

Class CreateRuleResponse

This is the response object from the CreateRule operation.

Class CreateTargetGroupRequest

Container for the parameters to the CreateTargetGroup operation. Creates a target group.

To register targets with the target group, use RegisterTargets. To update the health check settings for the target group, use ModifyTargetGroup. To monitor the health of targets in the target group, use DescribeTargetHealth.

To route traffic to the targets in a target group, specify the target group in an action using CreateListener or CreateRule.

To delete a target group, use DeleteTargetGroup.

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.

For more information, see Target Groups for Your Application Load Balancers in the Application Load Balancers Guide or Target Groups for Your Network Load Balancers in the Network Load Balancers Guide.

Class CreateTargetGroupResponse

This is the response object from the CreateTargetGroup operation.

Class DeleteListenerRequest

Container for the parameters to the DeleteListener operation. Deletes the specified listener.

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

Class DeleteListenerResponse

This is the response object from the DeleteListener operation.

Class DeleteLoadBalancerRequest

Container for the parameters to the DeleteLoadBalancer operation. Deletes the specified Application Load Balancer or Network Load Balancer and its attached 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.

Class DeleteLoadBalancerResponse

This is the response object from the DeleteLoadBalancer operation.

Class DeleteRuleRequest

Container for the parameters to the DeleteRule operation. Deletes the specified rule.

Class DeleteRuleResponse

This is the response object from the DeleteRule operation.

Class DeleteTargetGroupRequest

Container for the parameters to the DeleteTargetGroup operation. 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.

Class DeleteTargetGroupResponse

This is the response object from the DeleteTargetGroup operation.

Class DeregisterTargetsRequest

Container for the parameters to the DeregisterTargets operation. Deregisters the specified targets from the specified target group. After the targets are deregistered, they no longer receive traffic from the load balancer.

Class DeregisterTargetsResponse

This is the response object from the DeregisterTargets operation.

Class DescribeAccountLimitsRequest

Container for the parameters to the DescribeAccountLimits operation. Describes the current Elastic Load Balancing resource limits for your AWS account.

For more information, see Limits for Your Application Load Balancers in the Application Load Balancer Guide or Limits for Your Network Load Balancers in the Network Load Balancers Guide.

Class DescribeAccountLimitsResponse

This is the response object from the DescribeAccountLimits operation.

Class DescribeListenerCertificatesRequest

Container for the parameters to the DescribeListenerCertificates operation. Describes the certificates for the specified secure listener.

Class DescribeListenerCertificatesResponse

This is the response object from the DescribeListenerCertificates operation.

Class DescribeListenersRequest

Container for the parameters to the DescribeListeners operation. Describes the specified listeners or the listeners for the specified Application Load Balancer or Network Load Balancer. You must specify either a load balancer or one or more listeners.

Class DescribeListenersResponse

This is the response object from the DescribeListeners operation.

Class DescribeLoadBalancerAttributesRequest

Container for the parameters to the DescribeLoadBalancerAttributes operation. Describes the attributes for the specified Application Load Balancer or Network Load Balancer.

Class DescribeLoadBalancerAttributesResponse

This is the response object from the DescribeLoadBalancerAttributes operation.

Class DescribeLoadBalancersRequest

Container for the parameters to the DescribeLoadBalancers operation. Describes the specified load balancers or all of your load balancers.

To describe the listeners for a load balancer, use DescribeListeners. To describe the attributes for a load balancer, use DescribeLoadBalancerAttributes.

Class DescribeLoadBalancersResponse

This is the response object from the DescribeLoadBalancers operation.

Class DescribeRulesRequest

Container for the parameters to the DescribeRules operation. Describes the specified rules or the rules for the specified listener. You must specify either a listener or one or more rules.

Class DescribeRulesResponse

This is the response object from the DescribeRules operation.

Class DescribeSSLPoliciesRequest

Container for the parameters to the DescribeSSLPolicies operation. Describes the specified policies or all policies used for SSL negotiation.

For more information, see Security Policies in the Application Load Balancers Guide.

Class DescribeSSLPoliciesResponse

This is the response object from the DescribeSSLPolicies operation.

Class DescribeTagsRequest

Container for the parameters to the DescribeTags operation. Describes the tags for the specified resources. You can describe the tags for one or more Application Load Balancers, Network Load Balancers, and target groups.

Class DescribeTagsResponse

This is the response object from the DescribeTags operation.

Class DescribeTargetGroupAttributesRequest

Container for the parameters to the DescribeTargetGroupAttributes operation. Describes the attributes for the specified target group.

Class DescribeTargetGroupAttributesResponse

This is the response object from the DescribeTargetGroupAttributes operation.

Class DescribeTargetGroupsRequest

Container for the parameters to the DescribeTargetGroups operation. 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.

To describe the targets for a target group, use DescribeTargetHealth. To describe the attributes of a target group, use DescribeTargetGroupAttributes.

Class DescribeTargetGroupsResponse

This is the response object from the DescribeTargetGroups operation.

Class DescribeTargetHealthRequest

Container for the parameters to the DescribeTargetHealth operation. Describes the health of the specified targets or all of your targets.

Class DescribeTargetHealthResponse

This is the response object from the DescribeTargetHealth operation.

Class DuplicateListenerException

ElasticLoadBalancingV2 exception

Class DuplicateLoadBalancerNameException

ElasticLoadBalancingV2 exception

Class DuplicateTagKeysException

ElasticLoadBalancingV2 exception

Class DuplicateTargetGroupNameException

ElasticLoadBalancingV2 exception

Class HealthUnavailableException

ElasticLoadBalancingV2 exception

Class IncompatibleProtocolsException

ElasticLoadBalancingV2 exception

Class InvalidConfigurationRequestException

ElasticLoadBalancingV2 exception

Class InvalidSchemeException

ElasticLoadBalancingV2 exception

Class InvalidSecurityGroupException

ElasticLoadBalancingV2 exception

Class InvalidSubnetException

ElasticLoadBalancingV2 exception

Class InvalidTargetException

ElasticLoadBalancingV2 exception

Class Limit

Information about an Elastic Load Balancing resource limit for your AWS account.

Class Listener

Information about a listener.

Class ListenerNotFoundException

ElasticLoadBalancingV2 exception

Class LoadBalancer

Information about a load balancer.

Class LoadBalancerAddress

Information about a static IP address for a load balancer.

Class LoadBalancerAttribute

Information about a load balancer attribute.

Class LoadBalancerNotFoundException

ElasticLoadBalancingV2 exception

Class LoadBalancerState

Information about the state of the load balancer.

Class Matcher

Information to use when checking for a successful response from a target.

Class ModifyListenerRequest

Container for the parameters to the ModifyListener operation. Modifies the specified properties of the specified listener.

Any properties that you do not specify retain their current values. However, changing the protocol from HTTPS to HTTP removes the security policy and SSL certificate properties. If you change the protocol from HTTP to HTTPS, you must add the security policy and server certificate.

Class ModifyListenerResponse

This is the response object from the ModifyListener operation.

Class ModifyLoadBalancerAttributesRequest

Container for the parameters to the ModifyLoadBalancerAttributes operation. Modifies the specified attributes of the specified Application Load Balancer or Network 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.

Class ModifyLoadBalancerAttributesResponse

This is the response object from the ModifyLoadBalancerAttributes operation.

Class ModifyRuleRequest

Container for the parameters to the ModifyRule operation. Modifies the specified rule.

Any existing properties that you do not modify retain their current values.

To modify the default action, use ModifyListener.

Class ModifyRuleResponse

This is the response object from the ModifyRule operation.

Class ModifyTargetGroupAttributesRequest

Container for the parameters to the ModifyTargetGroupAttributes operation. Modifies the specified attributes of the specified target group.

Class ModifyTargetGroupAttributesResponse

This is the response object from the ModifyTargetGroupAttributes operation.

Class ModifyTargetGroupRequest

Container for the parameters to the ModifyTargetGroup operation. Modifies the health checks used when evaluating the health state of the targets in the specified target group.

To monitor the health of the targets, use DescribeTargetHealth.

Class ModifyTargetGroupResponse

This is the response object from the ModifyTargetGroup operation.

Class OperationNotPermittedException

ElasticLoadBalancingV2 exception

Class PriorityInUseException

ElasticLoadBalancingV2 exception

Class RegisterTargetsRequest

Container for the parameters to the RegisterTargets operation. Registers the specified targets with the specified target group.

You can register targets by instance ID or by IP address. 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.

To remove a target from a target group, use DeregisterTargets.

Class RegisterTargetsResponse

This is the response object from the RegisterTargets operation.

Class RemoveListenerCertificatesRequest

Container for the parameters to the RemoveListenerCertificates operation. Removes the specified certificate from the specified secure listener.

You can't remove the default certificate for a listener. To replace the default certificate, call ModifyListener.

To list the certificates for your listener, use DescribeListenerCertificates.

Class RemoveListenerCertificatesResponse

This is the response object from the RemoveListenerCertificates operation.

Class RemoveTagsRequest

Container for the parameters to the RemoveTags operation. Removes the specified tags from the specified Elastic Load Balancing resource.

To list the current tags for your resources, use DescribeTags.

Class RemoveTagsResponse

This is the response object from the RemoveTags operation.

Class ResourceInUseException

ElasticLoadBalancingV2 exception

Class Rule

Information about a rule.

Class RuleCondition

Information about a condition for a rule.

Class RuleNotFoundException

ElasticLoadBalancingV2 exception

Class RulePriorityPair

Information about the priorities for the rules for a listener.

Class SetIpAddressTypeRequest

Container for the parameters to the SetIpAddressType operation. Sets the type of IP addresses used by the subnets of the specified Application Load Balancer or Network Load Balancer.

Note that Network Load Balancers must use ipv4.

Class SetIpAddressTypeResponse

This is the response object from the SetIpAddressType operation.

Class SetRulePrioritiesRequest

Container for the parameters to the SetRulePriorities operation. 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.

Class SetRulePrioritiesResponse

This is the response object from the SetRulePriorities operation.

Class SetSecurityGroupsRequest

Container for the parameters to the SetSecurityGroups operation. Associates the specified security groups with the specified Application Load Balancer. The specified security groups override the previously associated security groups.

Note that you can't specify a security group for a Network Load Balancer.

Class SetSecurityGroupsResponse

This is the response object from the SetSecurityGroups operation.

Class SetSubnetsRequest

Container for the parameters to the SetSubnets operation. Enables the Availability Zone for the specified subnets for the specified Application Load Balancer. The specified subnets replace the previously enabled subnets.

Note that you can't change the subnets for a Network Load Balancer.

Class SetSubnetsResponse

This is the response object from the SetSubnets operation.

Class SslPolicy

Information about a policy used for SSL negotiation.

Class SSLPolicyNotFoundException

ElasticLoadBalancingV2 exception

Class SubnetMapping

Information about a subnet mapping.

Class SubnetNotFoundException

ElasticLoadBalancingV2 exception

Class Tag

Information about a tag.

Class TagDescription

The tags associated with a resource.

Class TargetDescription

Information about a target.

Class TargetGroup

Information about a target group.

Class TargetGroupAssociationLimitException

ElasticLoadBalancingV2 exception

Class TargetGroupAttribute

Information about a target group attribute.

Class TargetGroupNotFoundException

ElasticLoadBalancingV2 exception

Class TargetHealth

Information about the current health of a target.

Class TargetHealthDescription

Information about the health of a target.

Class TooManyCertificatesException

ElasticLoadBalancingV2 exception

Class TooManyListenersException

ElasticLoadBalancingV2 exception

Class TooManyLoadBalancersException

ElasticLoadBalancingV2 exception

Class TooManyRegistrationsForTargetIdException

ElasticLoadBalancingV2 exception

Class TooManyRulesException

ElasticLoadBalancingV2 exception

Class TooManyTagsException

ElasticLoadBalancingV2 exception

Class TooManyTargetGroupsException

ElasticLoadBalancingV2 exception

Class TooManyTargetsException

ElasticLoadBalancingV2 exception

Class UnsupportedProtocolException

ElasticLoadBalancingV2 exception