ecs_create_capacity_provider {aws.ecx}R Documentation

Create Capacity Provider

Description

Creates a new capacity provider. Capacity providers are associated with an Amazon ECS cluster and are used in capacity provider strategies to facilitate cluster auto scaling.

Usage

ecs_create_capacity_provider(
  name = NULL,
  autoScalingGroupProvider = NULL,
  tags = NULL,
  simplify = TRUE,
  others = list(),
  print_on_error = aws_get_print_on_error(),
  retry_time = aws_get_retry_time(),
  network_timeout = aws_get_network_timeout(),
  region = aws_get_region()
)

Arguments

name

Character. The name of the capacity provider.

autoScalingGroupProvider

Object. The details of the Auto Scaling group for the capacity provider.

tags

List. The metadata that you apply to the capacity provider to help you categorize and organize them.

simplify

Logical. Whether to simplify the result and handle nextToken in the response[optional]

others

Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]

print_on_error

Logical. Whether to show an error message when a network error occurs.

retry_time

Integer. Number of retries for a REST request when encounter the network issue. If the request has been sent retry_time times but still not be able to get the response, an error will be thrown.

network_timeout

Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.

region

Character. The region of the AWS service.

Value

A list object or a character vector

name

The name of the capacity provider. Up to 255 characters are allowed, including letters (upper and lowercase), numbers, underscores, and hyphens. The name cannot be prefixed with \'aws\', \'ecs\', or \'fargate\'.

autoScalingGroupProvider

The details of the Auto Scaling group for the capacity provider.

tags

The metadata that you apply to the capacity provider to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:


[Package aws.ecx version 1.0.5 Index]