Skip to content
v2.274.0

CfnCapacityProviderProps Struct ​

Properties for defining a CfnCapacityProvider.

Example ​

ts
// 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',
  propagateTags: {
    explicitTags: [{
      key: 'key',
      value: 'value',
    }],
    mode: 'mode',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  telemetryConfig: {
    loggingConfig: {
      logGroup: 'logGroup',
      systemLogLevel: 'systemLogLevel',
    },
  },
};

Properties ​

capacityProviderNamestringcapacity_provider_namestrcapacityProviderNameStringCapacityProviderNamestringCapacityProviderName*string#
capacityProviderScalingConfigIResolvable | CfnCapacityProvider.CapacityProviderScalingConfigPropertycapacity_provider_scaling_configtyping.Union[IResolvable, CapacityProviderScalingConfigProperty]capacityProviderScalingConfigIResolvableCapacityProviderScalingConfigIResolvableCapacityProviderScalingConfiginterface{}#
The scaling configuration for the capacity provider.
instanceRequirementsIResolvable | CfnCapacityProvider.InstanceRequirementsPropertyinstance_requirementstyping.Union[IResolvable, InstanceRequirementsProperty]instanceRequirementsIResolvableInstanceRequirementsIResolvableInstanceRequirementsinterface{}#
The instance requirements for compute resources managed by the capacity provider.
kmsKeyArnstringkms_key_arnstrkmsKeyArnStringKmsKeyArnstringKmsKeyArn*string#
The ARN of the KMS key used to encrypt the capacity provider's resources.
permissionsConfigIResolvable | CfnCapacityProvider.CapacityProviderPermissionsConfigPropertypermissions_configtyping.Union[IResolvable, CapacityProviderPermissionsConfigProperty]permissionsConfigIResolvablePermissionsConfigIResolvablePermissionsConfiginterface{}required#
The permissions configuration for the capacity provider.
propagateTagsIResolvable | CfnCapacityProvider.PropagateTagsConfigPropertypropagate_tagstyping.Union[IResolvable, PropagateTagsConfigProperty]propagateTagsIResolvablePropagateTagsIResolvablePropagateTagsinterface{}#
Configuration that defines how tags are propagated to managed resources.
tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#
A key-value pair that provides metadata for the capacity provider.
telemetryConfigIResolvable | CfnCapacityProvider.CapacityProviderTelemetryConfigPropertytelemetry_configtyping.Union[IResolvable, CapacityProviderTelemetryConfigProperty]telemetryConfigIResolvableTelemetryConfigIResolvableTelemetryConfiginterface{}#
Configuration that specifies the telemetry collection for the capacity provider.
The VPC configuration for the capacity provider.