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.
All Elastic Load Balancing operations are idempotent, which means that they complete at most one time. If you repeat an operation, it succeeds.
elbv2(config = list(), credentials = list(), endpoint = NULL, region = NULL)A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Optional configuration of credentials, endpoint, and/or region.
credentials:
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
Optional credentials shorthand for the config parameter
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
Optional shorthand for complete URL to use for the constructed client.
Optional shorthand for AWS Region used in instantiating the client.
svc <- elbv2(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
| add_listener_certificates | Adds the specified SSL server certificate to the certificate list for the specified HTTPS or TLS listener |
| add_tags | Adds the specified tags to the specified Elastic Load Balancing resource |
| add_trust_store_revocations | Adds the specified revocation file to the specified trust store |
| create_listener | Creates a listener for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer |
| create_load_balancer | Creates an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer |
| create_rule | Creates a rule for the specified listener |
| create_target_group | Creates a target group |
| create_trust_store | Creates a trust store |
| delete_listener | Deletes the specified listener |
| delete_load_balancer | Deletes the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer |
| delete_rule | Deletes the specified rule |
| delete_target_group | Deletes the specified target group |
| delete_trust_store | Deletes a trust store |
| deregister_targets | Deregisters the specified targets from the specified target group |
| describe_account_limits | Describes the current Elastic Load Balancing resource limits for your Amazon Web Services account |
| describe_listener_certificates | Describes the default certificate and the certificate list for the specified HTTPS or TLS listener |
| describe_listeners | Describes the specified listeners or the listeners for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer |
| describe_load_balancer_attributes | Describes the attributes for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer |
| describe_load_balancers | Describes the specified load balancers or all of your load balancers |
| describe_rules | Describes the specified rules or the rules for the specified listener |
| describe_ssl_policies | Describes the specified policies or all policies used for SSL negotiation |
| describe_tags | Describes the tags for the specified Elastic Load Balancing resources |
| describe_target_group_attributes | Describes the attributes for the specified target group |
| describe_target_groups | Describes the specified target groups or all of your target groups |
| describe_target_health | Describes the health of the specified targets or all of your targets |
| describe_trust_store_associations | Describes all resources associated with the specified trust store |
| describe_trust_store_revocations | Describes the revocation files in use by the specified trust store arn, or revocation ID |
| describe_trust_stores | Describes all trust stores for a given account by trust store arn’s or name |
| get_trust_store_ca_certificates_bundle | Retrieves the ca certificate bundle |
| get_trust_store_revocation_content | Retrieves the specified revocation file |
| modify_listener | Replaces the specified properties of the specified listener |
| modify_load_balancer_attributes | Modifies the specified attributes of the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer |
| modify_rule | Replaces the specified properties of the specified rule |
| modify_target_group | Modifies the health checks used when evaluating the health state of the targets in the specified target group |
| modify_target_group_attributes | Modifies the specified attributes of the specified target group |
| modify_trust_store | Update the ca certificate bundle for a given trust store |
| register_targets | Registers the specified targets with the specified target group |
| remove_listener_certificates | Removes the specified certificate from the certificate list for the specified HTTPS or TLS listener |
| remove_tags | Removes the specified tags from the specified Elastic Load Balancing resources |
| remove_trust_store_revocations | Removes the specified revocation file from the specified trust store |
| set_ip_address_type | Sets the type of IP addresses used by the subnets of the specified load balancer |
| set_rule_priorities | Sets the priorities of the specified rules |
| set_security_groups | Associates the specified security groups with the specified Application Load Balancer or Network Load Balancer |
| set_subnets | Enables the Availability Zones for the specified public subnets for the specified Application Load Balancer, Network Load Balancer or Gateway Load Balancer |
if (FALSE) {
svc <- elbv2()
# This example adds the specified tags to the specified load balancer.
svc$add_tags(
ResourceArns = list(
"arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/m..."
),
Tags = list(
list(
Key = "project",
Value = "lima"
),
list(
Key = "department",
Value = "digital-media"
)
)
)
}
Run the code above in your browser using DataLab