class CfnCapacityProviderPropsMixin

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.ECS.CfnCapacityProviderPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsecs#CfnCapacityProviderPropsMixin
Java	software.amazon.awscdk.cfnpropertymixins.services.ecs.CfnCapacityProviderPropsMixin
Python	aws_cdk.cfn_property_mixins.aws_ecs.CfnCapacityProviderPropsMixin
TypeScript	@aws-cdk/cfn-property-mixins » aws_ecs » CfnCapacityProviderPropsMixin

Implements IMixin

Extends Mixin

Creates a capacity provider.

Capacity providers are associated with a cluster and are used in capacity provider strategies to facilitate cluster auto scaling. You can create capacity providers for Amazon ECS Managed Instances and EC2 instances. AWS Fargate has the predefined FARGATE and FARGATE_SPOT capacity providers.

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/cfn-property-mixins';
import * as cdk from 'aws-cdk-lib';

declare const mergeStrategy: cdk.IMergeStrategy;
const cfnCapacityProviderPropsMixin = new ecs.CfnCapacityProviderPropsMixin({
  autoScalingGroupProvider: {
    autoScalingGroupArn: 'autoScalingGroupArn',
    managedDraining: 'managedDraining',
    managedScaling: {
      instanceWarmupPeriod: 123,
      maximumScalingStepSize: 123,
      minimumScalingStepSize: 123,
      status: 'status',
      targetCapacity: 123,
    },
    managedTerminationProtection: 'managedTerminationProtection',
  },
  clusterName: 'clusterName',
  managedInstancesProvider: {
    infrastructureOptimization: {
      scaleInAfter: 123,
    },
    infrastructureRoleArn: 'infrastructureRoleArn',
    instanceLaunchTemplate: {
      capacityOptionType: 'capacityOptionType',
      capacityReservations: {
        reservationGroupArn: 'reservationGroupArn',
        reservationPreference: 'reservationPreference',
      },
      ec2InstanceProfileArn: 'ec2InstanceProfileArn',
      fipsEnabled: false,
      instanceRequirements: {
        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,
        },
        memoryMiB: {
          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,
        },
        vCpuCount: {
          max: 123,
          min: 123,
        },
      },
      monitoring: 'monitoring',
      networkConfiguration: {
        securityGroups: ['securityGroups'],
        subnets: ['subnets'],
      },
      storageConfiguration: {
        storageSizeGiB: 123,
      },
    },
    propagateTags: 'propagateTags',
  },
  name: 'name',
  tags: [{
    key: 'key',
    value: 'value',
  }],
}, /* all optional props */ {
  strategy: mergeStrategy,
});

Initializer

new CfnCapacityProviderPropsMixin(props: CfnCapacityProviderMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnCapacityProviderMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::ECS::CapacityProvider.

Properties

Name	Type	Description
props	CfnCapacityProviderMixinProps
strategy	IMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnCapacityProviderMixinProps

---

strategy

Type: IMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): void

Parameters

• construct IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.