Update Capacity Provider

ecs_update_capacity_provider

R Documentation

Modifies the parameters for a capacity provider

Description

Modifies the parameters for a capacity provider.

These changes only apply to new Amazon ECS Managed Instances, or EC2 instances, not existing ones.

Usage

ecs_update_capacity_provider(name, cluster, autoScalingGroupProvider,
  managedInstancesProvider)

Arguments

name	[required] The name of the capacity provider to update.
cluster	The name of the cluster that contains the capacity provider to update. Managed instances capacity providers are cluster-scoped and can only be updated within their associated cluster.
autoScalingGroupProvider	An object that represent the parameters to update for the Auto Scaling group capacity provider.
managedInstancesProvider	The updated configuration for the Amazon ECS Managed Instances provider. You can modify the infrastructure role, instance launch template, and tag propagation settings. Changes take effect for new instances launched after the update.

Value

A list with the following syntax:

list(
  capacityProvider = list(
    capacityProviderArn = "string",
    name = "string",
    cluster = "string",
    status = "PROVISIONING"|"ACTIVE"|"DEPROVISIONING"|"INACTIVE",
    autoScalingGroupProvider = list(
      autoScalingGroupArn = "string",
      managedScaling = list(
        status = "ENABLED"|"DISABLED",
        targetCapacity = 123,
        minimumScalingStepSize = 123,
        maximumScalingStepSize = 123,
        instanceWarmupPeriod = 123
      ),
      managedTerminationProtection = "ENABLED"|"DISABLED",
      managedDraining = "ENABLED"|"DISABLED"
    ),
    managedInstancesProvider = list(
      infrastructureRoleArn = "string",
      instanceLaunchTemplate = list(
        ec2InstanceProfileArn = "string",
        networkConfiguration = list(
          subnets = list(
            "string"
          ),
          securityGroups = list(
            "string"
          )
        ),
        storageConfiguration = list(
          storageSizeGiB = 123
        ),
        localStorageConfiguration = list(
          useLocalStorage = TRUE|FALSE
        ),
        monitoring = "BASIC"|"DETAILED",
        capacityOptionType = "ON_DEMAND"|"SPOT"|"RESERVED",
        instanceMetadataTagsPropagation = TRUE|FALSE,
        instanceRequirements = list(
          vCpuCount = list(
            min = 123,
            max = 123
          ),
          memoryMiB = list(
            min = 123,
            max = 123
          ),
          cpuManufacturers = list(
            "intel"|"amd"|"amazon-web-services"
          ),
          memoryGiBPerVCpu = list(
            min = 123.0,
            max = 123.0
          ),
          excludedInstanceTypes = list(
            "string"
          ),
          instanceGenerations = list(
            "current"|"previous"
          ),
          spotMaxPricePercentageOverLowestPrice = 123,
          onDemandMaxPricePercentageOverLowestPrice = 123,
          bareMetal = "included"|"required"|"excluded",
          burstablePerformance = "included"|"required"|"excluded",
          requireHibernateSupport = TRUE|FALSE,
          networkInterfaceCount = list(
            min = 123,
            max = 123
          ),
          localStorage = "included"|"required"|"excluded",
          localStorageTypes = list(
            "hdd"|"ssd"
          ),
          totalLocalStorageGB = list(
            min = 123.0,
            max = 123.0
          ),
          baselineEbsBandwidthMbps = list(
            min = 123,
            max = 123
          ),
          acceleratorTypes = list(
            "gpu"|"fpga"|"inference"
          ),
          acceleratorCount = list(
            min = 123,
            max = 123
          ),
          acceleratorManufacturers = list(
            "amazon-web-services"|"amd"|"nvidia"|"xilinx"|"habana"
          ),
          acceleratorNames = list(
            "a100"|"inferentia"|"k520"|"k80"|"m60"|"radeon-pro-v520"|"t4"|"vu9p"|"v100"|"a10g"|"h100"|"t4g"
          ),
          acceleratorTotalMemoryMiB = list(
            min = 123,
            max = 123
          ),
          networkBandwidthGbps = list(
            min = 123.0,
            max = 123.0
          ),
          allowedInstanceTypes = list(
            "string"
          ),
          maxSpotPriceAsPercentageOfOptimalOnDemandPrice = 123
        ),
        fipsEnabled = TRUE|FALSE,
        capacityReservations = list(
          reservationGroupArn = "string",
          reservationPreference = "RESERVATIONS_ONLY"|"RESERVATIONS_FIRST"|"RESERVATIONS_EXCLUDED"
        )
      ),
      propagateTags = "CAPACITY_PROVIDER"|"NONE",
      infrastructureOptimization = list(
        scaleInAfter = 123
      ),
      autoRepairConfiguration = list(
        actionsStatus = "ENABLED"|"DISABLED"
      )
    ),
    updateStatus = "CREATE_IN_PROGRESS"|"CREATE_COMPLETE"|"CREATE_FAILED"|"DELETE_IN_PROGRESS"|"DELETE_COMPLETE"|"DELETE_FAILED"|"UPDATE_IN_PROGRESS"|"UPDATE_COMPLETE"|"UPDATE_FAILED",
    updateStatusReason = "string",
    tags = list(
      list(
        key = "string",
        value = "string"
      )
    ),
    type = "EC2_AUTOSCALING"|"MANAGED_INSTANCES"|"FARGATE"|"FARGATE_SPOT"
  )
)

Request syntax

svc$update_capacity_provider(
  name = "string",
  cluster = "string",
  autoScalingGroupProvider = list(
    managedScaling = list(
      status = "ENABLED"|"DISABLED",
      targetCapacity = 123,
      minimumScalingStepSize = 123,
      maximumScalingStepSize = 123,
      instanceWarmupPeriod = 123
    ),
    managedTerminationProtection = "ENABLED"|"DISABLED",
    managedDraining = "ENABLED"|"DISABLED"
  ),
  managedInstancesProvider = list(
    infrastructureRoleArn = "string",
    instanceLaunchTemplate = list(
      ec2InstanceProfileArn = "string",
      networkConfiguration = list(
        subnets = list(
          "string"
        ),
        securityGroups = list(
          "string"
        )
      ),
      storageConfiguration = list(
        storageSizeGiB = 123
      ),
      instanceMetadataTagsPropagation = TRUE|FALSE,
      localStorageConfiguration = list(
        useLocalStorage = TRUE|FALSE
      ),
      monitoring = "BASIC"|"DETAILED",
      instanceRequirements = list(
        vCpuCount = list(
          min = 123,
          max = 123
        ),
        memoryMiB = list(
          min = 123,
          max = 123
        ),
        cpuManufacturers = list(
          "intel"|"amd"|"amazon-web-services"
        ),
        memoryGiBPerVCpu = list(
          min = 123.0,
          max = 123.0
        ),
        excludedInstanceTypes = list(
          "string"
        ),
        instanceGenerations = list(
          "current"|"previous"
        ),
        spotMaxPricePercentageOverLowestPrice = 123,
        onDemandMaxPricePercentageOverLowestPrice = 123,
        bareMetal = "included"|"required"|"excluded",
        burstablePerformance = "included"|"required"|"excluded",
        requireHibernateSupport = TRUE|FALSE,
        networkInterfaceCount = list(
          min = 123,
          max = 123
        ),
        localStorage = "included"|"required"|"excluded",
        localStorageTypes = list(
          "hdd"|"ssd"
        ),
        totalLocalStorageGB = list(
          min = 123.0,
          max = 123.0
        ),
        baselineEbsBandwidthMbps = list(
          min = 123,
          max = 123
        ),
        acceleratorTypes = list(
          "gpu"|"fpga"|"inference"
        ),
        acceleratorCount = list(
          min = 123,
          max = 123
        ),
        acceleratorManufacturers = list(
          "amazon-web-services"|"amd"|"nvidia"|"xilinx"|"habana"
        ),
        acceleratorNames = list(
          "a100"|"inferentia"|"k520"|"k80"|"m60"|"radeon-pro-v520"|"t4"|"vu9p"|"v100"|"a10g"|"h100"|"t4g"
        ),
        acceleratorTotalMemoryMiB = list(
          min = 123,
          max = 123
        ),
        networkBandwidthGbps = list(
          min = 123.0,
          max = 123.0
        ),
        allowedInstanceTypes = list(
          "string"
        ),
        maxSpotPriceAsPercentageOfOptimalOnDemandPrice = 123
      ),
      capacityReservations = list(
        reservationGroupArn = "string",
        reservationPreference = "RESERVATIONS_ONLY"|"RESERVATIONS_FIRST"|"RESERVATIONS_EXCLUDED"
      )
    ),
    propagateTags = "CAPACITY_PROVIDER"|"NONE",
    infrastructureOptimization = list(
      scaleInAfter = 123
    ),
    autoRepairConfiguration = list(
      actionsStatus = "ENABLED"|"DISABLED"
    )
  )
)