1.204.0

interface CfnCapacityProviderProps

LanguageType name
.NETAmazon.CDK.AWS.ECS.CfnCapacityProviderProps
Javasoftware.amazon.awscdk.services.ecs.CfnCapacityProviderProps
Pythonaws_cdk.aws_ecs.CfnCapacityProviderProps
TypeScript @aws-cdk/aws-ecs » CfnCapacityProviderProps

Properties for defining a CfnCapacityProvider.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as ecs from '@aws-cdk/aws-ecs';
const cfnCapacityProviderProps: ecs.CfnCapacityProviderProps = {
  autoScalingGroupProvider: {
    autoScalingGroupArn: 'autoScalingGroupArn',

    // the properties below are optional
    managedScaling: {
      instanceWarmupPeriod: 123,
      maximumScalingStepSize: 123,
      minimumScalingStepSize: 123,
      status: 'status',
      targetCapacity: 123,
    },
    managedTerminationProtection: 'managedTerminationProtection',
  },

  // the properties below are optional
  name: 'name',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
autoScalingGroupProviderAutoScalingGroupProviderProperty | IResolvableThe Auto Scaling group settings for the capacity provider.
name?stringThe name of the capacity provider.
tags?CfnTag[]The metadata that you apply to the capacity provider to help you categorize and organize it.

autoScalingGroupProvider

Type: AutoScalingGroupProviderProperty | IResolvable

The Auto Scaling group settings for the capacity provider.

name?

Type: string (optional)

The name of the capacity provider.

If a name is specified, it cannot start with aws , ecs , or fargate . If no name is specified, a default name in the CFNStackName-CFNResourceName-RandomString format is used.

tags?

Type: CfnTag[] (optional)

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

Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50
  • For each resource, each tag key must be unique, and each tag key can have only one value.
  • Maximum key length - 128 Unicode characters in UTF-8
  • Maximum value length - 256 Unicode characters in UTF-8
  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
  • Tag keys and values are case-sensitive.
  • Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
← PreviousNext →