paws.networking (version 0.1.9)

elbv2: Elastic Load Balancing

Description

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, and Classic Load Balancers. This reference covers Application Load Balancers and Network Load Balancers.

An Application Load Balancer makes routing and load balancing decisions at the application layer (HTTP/HTTPS). A Network Load Balancer makes routing and load balancing decisions at the transport layer (TCP/TLS). Both Application Load Balancers and Network Load Balancers can route requests to one or more ports on each EC2 instance or container instance in your virtual private cloud (VPC). 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.

Usage

elbv2(config = list())

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Service syntax

svc <- elbv2(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

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
create_listener	Creates a listener for the specified Application Load Balancer or Network Load Balancer
create_load_balancer	Creates an Application Load Balancer or a Network Load Balancer
create_rule	Creates a rule for the specified listener
create_target_group	Creates a target group
delete_listener	Deletes the specified listener
delete_load_balancer	Deletes the specified Application Load Balancer or Network Load Balancer and its attached listeners
delete_rule	Deletes the specified rule
delete_target_group	Deletes the specified target group
deregister_targets	Deregisters the specified targets from the specified target group
describe_account_limits	Describes the current Elastic Load Balancing resource limits for your AWS 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 or Network Load Balancer
describe_load_balancer_attributes	Describes the attributes for the specified Application Load Balancer or Network 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 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
modify_listener	Replaces the specified properties of the specified listener
modify_load_balancer_attributes	Modifies the specified attributes of the specified Application Load Balancer or Network 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
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 resource
set_ip_address_type	Sets the type of IP addresses used by the subnets of the specified Application Load Balancer or Network 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

Examples

# NOT RUN {
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/my-load-balancer/5..."
  ),
  Tags = list(
    list(
      Key = "project",
      Value = "lima"
    ),
    list(
      Key = "department",
      Value = "digital-media"
    )
  )
)
# }
# NOT RUN {
# }