bandwidth_rate_limit_schedules

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

Overview

Name	bandwidth_rate_limit_schedules
Type	Resource
Id	aws.backup_gateway.bandwidth_rate_limit_schedules

Fields

The following fields are returned by SELECT queries:

get_bandwidth_rate_limit_schedule

Name	Datatype	Description
bandwidth_rate_limit_intervals	array	An array containing bandwidth rate limit schedule intervals for a gateway. When no bandwidth rate limit intervals have been scheduled, the array is empty.
gateway_arn	string	The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region. (pattern: <code>arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}/[a-zA-Z-0-9]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_bandwidth_rate_limit_schedule	select	region		Retrieves the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to get a gateway's bandwidth rate limit schedule.
put_bandwidth_rate_limit_schedule	replace	region, GatewayArn, BandwidthRateLimitIntervals		This action sets the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have a bandwidth rate limit schedule, which means no bandwidth rate limiting is in effect. Use this to initiate a gateway's bandwidth rate limit schedule.

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
region	string	AWS region (default: us-east-1)

SELECT examples

get_bandwidth_rate_limit_schedule

Retrieves the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to get a gateway's bandwidth rate limit schedule.

SELECT
bandwidth_rate_limit_intervals,
gateway_arn
FROM aws.backup_gateway.bandwidth_rate_limit_schedules
WHERE region = '{{ region }}' -- required
;

REPLACE examples

put_bandwidth_rate_limit_schedule

This action sets the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have a bandwidth rate limit schedule, which means no bandwidth rate limiting is in effect. Use this to initiate a gateway's bandwidth rate limit schedule.

REPLACE aws.backup_gateway.bandwidth_rate_limit_schedules
SET 
GatewayArn = '{{ GatewayArn }}',
BandwidthRateLimitIntervals = '{{ BandwidthRateLimitIntervals }}'
WHERE 
region = '{{ region }}' --required
AND GatewayArn = '{{ GatewayArn }}' --required
AND BandwidthRateLimitIntervals = '{{ BandwidthRateLimitIntervals }}' --required
RETURNING
gateway_arn;