interface CfnCapacityProviderProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.ECS.CfnCapacityProviderProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsecs#CfnCapacityProviderProps |
![]() | software.amazon.awscdk.services.ecs.CfnCapacityProviderProps |
![]() | aws_cdk.aws_ecs.CfnCapacityProviderProps |
![]() | aws-cdk-lib » aws_ecs » CfnCapacityProviderProps |
Properties for defining a CfnCapacityProvider
.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-capacityprovider.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ecs as ecs } from 'aws-cdk-lib';
const cfnCapacityProviderProps: ecs.CfnCapacityProviderProps = {
autoScalingGroupProvider: {
autoScalingGroupArn: 'autoScalingGroupArn',
// the properties below are optional
managedDraining: 'managedDraining',
managedScaling: {
instanceWarmupPeriod: 123,
maximumScalingStepSize: 123,
minimumScalingStepSize: 123,
status: 'status',
targetCapacity: 123,
},
managedTerminationProtection: 'managedTerminationProtection',
},
clusterName: 'clusterName',
managedInstancesProvider: {
infrastructureRoleArn: 'infrastructureRoleArn',
instanceLaunchTemplate: {
ec2InstanceProfileArn: 'ec2InstanceProfileArn',
networkConfiguration: {
subnets: ['subnets'],
// the properties below are optional
securityGroups: ['securityGroups'],
},
// the properties below are optional
instanceRequirements: {
memoryMiB: {
min: 123,
// the properties below are optional
max: 123,
},
vCpuCount: {
min: 123,
// the properties below are optional
max: 123,
},
// the properties below are optional
acceleratorCount: {
max: 123,
min: 123,
},
acceleratorManufacturers: ['acceleratorManufacturers'],
acceleratorNames: ['acceleratorNames'],
acceleratorTotalMemoryMiB: {
max: 123,
min: 123,
},
acceleratorTypes: ['acceleratorTypes'],
allowedInstanceTypes: ['allowedInstanceTypes'],
bareMetal: 'bareMetal',
baselineEbsBandwidthMbps: {
max: 123,
min: 123,
},
burstablePerformance: 'burstablePerformance',
cpuManufacturers: ['cpuManufacturers'],
excludedInstanceTypes: ['excludedInstanceTypes'],
instanceGenerations: ['instanceGenerations'],
localStorage: 'localStorage',
localStorageTypes: ['localStorageTypes'],
maxSpotPriceAsPercentageOfOptimalOnDemandPrice: 123,
memoryGiBPerVCpu: {
max: 123,
min: 123,
},
networkBandwidthGbps: {
max: 123,
min: 123,
},
networkInterfaceCount: {
max: 123,
min: 123,
},
onDemandMaxPricePercentageOverLowestPrice: 123,
requireHibernateSupport: false,
spotMaxPricePercentageOverLowestPrice: 123,
totalLocalStorageGb: {
max: 123,
min: 123,
},
},
monitoring: 'monitoring',
storageConfiguration: {
storageSizeGiB: 123,
},
},
// the properties below are optional
propagateTags: 'propagateTags',
},
name: 'name',
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
Name | Type | Description |
---|---|---|
auto | IResolvable | Auto | The Auto Scaling group settings for the capacity provider. |
cluster | string | |
managed | IResolvable | Managed | The configuration for the Amazon ECS Managed Instances provider. |
name? | string | The name of the capacity provider. |
tags? | Cfn [] | The metadata that you apply to the capacity provider to help you categorize and organize it. |
autoScalingGroupProvider?
Type:
IResolvable
|
Auto
(optional)
The Auto Scaling group settings for the capacity provider.
clusterName?
Type:
string
(optional)
managedInstancesProvider?
Type:
IResolvable
|
Managed
(optional)
The configuration for the Amazon ECS Managed Instances provider.
This includes the infrastructure role, the launch template configuration, and tag propagation settings.
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:
Cfn
[]
(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: + - = . _ : /