Interface CfnCapacityProviderProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnCapacityProviderProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
date="2025-12-01T16:02:23.535Z")
@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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnCapacityProviderPropsstatic final classAn implementation forCfnCapacityProviderProps -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default StringThe name of the capacity provider.default ObjectThe scaling configuration for the capacity provider.default ObjectSpecifications for the types of EC2 instances that the capacity provider can use.default StringThe ARN of the AWS Key Management Service (KMS) key used by the capacity provider.IAM permissions configuration for the capacity provider.getTags()A list of tags to apply to the capacity provider.VPC configuration for the capacity provider.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getPermissionsConfig
IAM permissions configuration for the capacity provider.Returns union: either
IResolvableorCfnCapacityProvider.CapacityProviderPermissionsConfigProperty- See Also:
-
getVpcConfig
VPC configuration for the capacity provider.Returns union: either
IResolvableorCfnCapacityProvider.CapacityProviderVpcConfigProperty- See Also:
-
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:
-
getCapacityProviderScalingConfig
The scaling configuration for the capacity provider.Returns union: either
IResolvableorCfnCapacityProvider.CapacityProviderScalingConfigProperty- See Also:
-
getInstanceRequirements
Specifications for the types of EC2 instances that the capacity provider can use.Returns union: either
IResolvableorCfnCapacityProvider.InstanceRequirementsProperty- See Also:
-
getKmsKeyArn
The ARN of the AWS Key Management Service (KMS) key used by the capacity provider.- See Also:
-
getTags
A list of tags to apply to the capacity provider.- See Also:
-
builder
- Returns:
- a
CfnCapacityProviderProps.BuilderofCfnCapacityProviderProps
-