Package software.amazon.awscdk.services.lambda

Interface CfnCapacityProviderProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCapacityProviderProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.125.0 (build fdbe357)",
           date="2026-01-19T12:03:56.757Z")
@Stability(Stable)
public interface CfnCapacityProviderProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.lambda.*;
 CfnCapacityProviderProps cfnCapacityProviderProps = CfnCapacityProviderProps.builder()
         .permissionsConfig(CapacityProviderPermissionsConfigProperty.builder()
                 .capacityProviderOperatorRoleArn("capacityProviderOperatorRoleArn")
                 .build())
         .vpcConfig(CapacityProviderVpcConfigProperty.builder()
                 .securityGroupIds(List.of("securityGroupIds"))
                 .subnetIds(List.of("subnetIds"))
                 .build())
         // the properties below are optional
         .capacityProviderName("capacityProviderName")
         .capacityProviderScalingConfig(CapacityProviderScalingConfigProperty.builder()
                 .maxVCpuCount(123)
                 .scalingMode("scalingMode")
                 .scalingPolicies(List.of(TargetTrackingScalingPolicyProperty.builder()
                         .predefinedMetricType("predefinedMetricType")
                         .targetValue(123)
                         .build()))
                 .build())
         .instanceRequirements(InstanceRequirementsProperty.builder()
                 .allowedInstanceTypes(List.of("allowedInstanceTypes"))
                 .architectures(List.of("architectures"))
                 .excludedInstanceTypes(List.of("excludedInstanceTypes"))
                 .build())
         .kmsKeyArn("kmsKeyArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnCapacityProviderProps.Builder	A builder for CfnCapacityProviderProps
static final class	CfnCapacityProviderProps.Jsii$Proxy	An implementation for CfnCapacityProviderProps

Method Summary

Modifier and Type	Method	Description
static CfnCapacityProviderProps.Builder	builder()
default String	getCapacityProviderName()	The name of the capacity provider.
default Object	getCapacityProviderScalingConfig()	The scaling configuration for the capacity provider.
default Object	getInstanceRequirements()	The instance requirements for compute resources managed by the capacity provider.
default String	getKmsKeyArn()	The ARN of the KMS key used to encrypt the capacity provider's resources.
Object	getPermissionsConfig()	The permissions configuration for the capacity provider.
default List<CfnTag>	getTags()	A key-value pair that provides metadata for the capacity provider.
Object	getVpcConfig()	The VPC configuration for the capacity provider.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPermissionsConfig

@Stability(Stable)
@NotNull
Object getPermissionsConfig()

The permissions configuration for the capacity provider.

Returns union: either IResolvable or CfnCapacityProvider.CapacityProviderPermissionsConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-permissionsconfig

getVpcConfig

@Stability(Stable)
@NotNull
Object getVpcConfig()

The VPC configuration for the capacity provider.

Returns union: either IResolvable or CfnCapacityProvider.CapacityProviderVpcConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-vpcconfig

getCapacityProviderName

@Stability(Stable)
@Nullable
default String getCapacityProviderName()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-capacityprovidername

getCapacityProviderScalingConfig

@Stability(Stable)
@Nullable
default Object getCapacityProviderScalingConfig()

The scaling configuration for the capacity provider.

Returns union: either IResolvable or CfnCapacityProvider.CapacityProviderScalingConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-capacityproviderscalingconfig

getInstanceRequirements

@Stability(Stable)
@Nullable
default Object getInstanceRequirements()

The instance requirements for compute resources managed by the capacity provider.

Returns union: either IResolvable or CfnCapacityProvider.InstanceRequirementsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-instancerequirements

getKmsKeyArn

@Stability(Stable)
@Nullable
default String getKmsKeyArn()

The ARN of the KMS key used to encrypt the capacity provider's resources.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-kmskeyarn

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

A key-value pair that provides metadata for the capacity provider.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-tags

builder

@Stability(Stable)
static CfnCapacityProviderProps.Builder builder()

Returns:

a CfnCapacityProviderProps.Builder of CfnCapacityProviderProps