interface CfnCapacityProviderProps

Language	Type name
.NET	`Amazon.CDK.AWS.Lambda.CfnCapacityProviderProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awslambda#CfnCapacityProviderProps`
Java	`software.amazon.awscdk.services.lambda.CfnCapacityProviderProps`
Python	`aws_cdk.aws_lambda.CfnCapacityProviderProps`
TypeScript	`aws-cdk-lib` » `aws_lambda` » `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 { aws_lambda as lambda } from 'aws-cdk-lib';
const cfnCapacityProviderProps: lambda.CfnCapacityProviderProps = {
  permissionsConfig: {
    capacityProviderOperatorRoleArn: 'capacityProviderOperatorRoleArn',
  },
  vpcConfig: {
    securityGroupIds: ['securityGroupIds'],
    subnetIds: ['subnetIds'],
  },

  // the properties below are optional
  capacityProviderName: 'capacityProviderName',
  capacityProviderScalingConfig: {
    maxVCpuCount: 123,
    scalingMode: 'scalingMode',
    scalingPolicies: [{
      predefinedMetricType: 'predefinedMetricType',
      targetValue: 123,
    }],
  },
  instanceRequirements: {
    allowedInstanceTypes: ['allowedInstanceTypes'],
    architectures: ['architectures'],
    excludedInstanceTypes: ['excludedInstanceTypes'],
  },
  kmsKeyArn: 'kmsKeyArn',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
permissionsConfig	`IResolvable` `\|` `CapacityProviderPermissionsConfigProperty`	IAM permissions configuration for the capacity provider.
vpcConfig	`IResolvable` `\|` `CapacityProviderVpcConfigProperty`	VPC configuration for the capacity provider.
capacityProviderName?	`string`	The name of the capacity provider.
capacityProviderScalingConfig?	`IResolvable` `\|` `CapacityProviderScalingConfigProperty`	The scaling configuration for the capacity provider.
instanceRequirements?	`IResolvable` `\|` `InstanceRequirementsProperty`	Specifications for the types of EC2 instances that the capacity provider can use.
kmsKeyArn?	`string`	The ARN of the AWS Key Management Service (KMS) key used by the capacity provider.
tags?	`CfnTag[]`	A list of tags to apply to the capacity provider.

permissionsConfig

Type: IResolvable | CapacityProviderPermissionsConfigProperty

IAM permissions configuration for the capacity provider.

vpcConfig

Type: IResolvable | CapacityProviderVpcConfigProperty

VPC configuration for the capacity provider.

capacityProviderName?

Type: string (optional)

The name of the capacity provider.

The name must be unique within your AWS account and region. If you don't specify a name, CloudFormation generates one.

capacityProviderScalingConfig?

Type: IResolvable | CapacityProviderScalingConfigProperty (optional)

The scaling configuration for the capacity provider.

instanceRequirements?

Type: IResolvable | InstanceRequirementsProperty (optional)

Specifications for the types of EC2 instances that the capacity provider can use.

kmsKeyArn?

Type: string (optional)

The ARN of the AWS Key Management Service (KMS) key used by the capacity provider.

tags?

Type: CfnTag[] (optional)

A list of tags to apply to the capacity provider.

AWS CDK

2.232.2