capacity_reservations

Creates, updates, deletes, gets or lists a capacity_reservations resource.

Overview

Name	capacity_reservations
Type	Resource
Id	aws.elbv2.capacity_reservations

Fields

The following fields are returned by SELECT queries:

describe_capacity_reservation

Name	Datatype	Description
availability_zone	string	Information about the Availability Zone.
effective_capacity_units	number	The number of effective capacity units.
state	string	The state of the capacity reservation.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_capacity_reservation	select	LoadBalancerArn, region		Describes the capacity reservation status for the specified load balancer.
modify_capacity_reservation	update	LoadBalancerArn, region	MinimumLoadBalancerCapacity, ResetCapacityReservation	Modifies the capacity reservation of the specified load balancer. When modifying capacity reservation, you must include at least one MinimumLoadBalancerCapacity or ResetCapacityReservation.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
LoadBalancerArn	string	The Amazon Resource Name (ARN) of the load balancer.
region	string	AWS region (default: us-east-1)
MinimumLoadBalancerCapacity	object	The minimum load balancer capacity reserved.
ResetCapacityReservation	boolean	Resets the capacity reservation.

SELECT examples

describe_capacity_reservation

Describes the capacity reservation status for the specified load balancer.

SELECT
availability_zone,
effective_capacity_units,
state
FROM aws.elbv2.capacity_reservations
WHERE LoadBalancerArn = '{{ LoadBalancerArn }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

modify_capacity_reservation

Modifies the capacity reservation of the specified load balancer. When modifying capacity reservation, you must include at least one MinimumLoadBalancerCapacity or ResetCapacityReservation.

UPDATE aws.elbv2.capacity_reservations
SET 
-- No updatable properties
WHERE 
LoadBalancerArn = '{{ LoadBalancerArn }}' --required
AND region = '{{ region }}' --required
AND MinimumLoadBalancerCapacity = '{{ MinimumLoadBalancerCapacity}}'
AND ResetCapacityReservation = {{ ResetCapacityReservation}}
RETURNING
line_items;