Skip to content
v2.275.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_bedrockagentcore as bedrockagentcore } from 'aws-cdk-lib';
const cfnCapacityProviderProps: bedrockagentcore.CfnCapacityProviderProps = {
  computeConfiguration: {
    ec2Configuration: {
      launchTemplateSource: {
        launchParameters: {
          instanceRequirements: {
            allowedInstanceTypes: ['allowedInstanceTypes'],
          },
          operatingSystem: 'operatingSystem',

          // the properties below are optional
          capacityReservationSpecification: {
            capacityReservationPreference: 'capacityReservationPreference',
            capacityReservationTarget: {
              capacityReservationId: 'capacityReservationId',
              capacityReservationResourceGroupArn: 'capacityReservationResourceGroupArn',
            },
          },
          ephemeralVolumes: [{
            deviceName: 'deviceName',
            ebs: {
              ebsCardIndex: 123,
              encrypted: false,
              iops: 123,
              kmsKeyId: 'kmsKeyId',
              snapshotId: 'snapshotId',
              throughput: 123,
              volumeInitializationRate: 123,
              volumeSize: 123,
              volumeType: 'volumeType',
            },
            virtualName: 'virtualName',
          }],
          instanceProfileArn: 'instanceProfileArn',
          licenseSpecifications: [{
            licenseConfigurationArn: 'licenseConfigurationArn',
          }],
          monitoring: 'monitoring',
          propagatedTags: {
            propagatedTagsKey: 'propagatedTags',
          },
          sshKeyName: 'sshKeyName',
        },
      },
      vpcConfiguration: {
        securityGroups: ['securityGroups'],
        subnets: ['subnets'],
      },

      // the properties below are optional
      lifecycleConfiguration: {
        idleInstanceTimeout: 123,
        maxLifetime: 123,
      },
      rootVolume: {
        encrypted: false,
        freeSpaceGiB: 123,
        iops: 123,
        kmsKeyId: 'kmsKeyId',
        throughput: 123,
        volumeType: 'volumeType',
      },
      volumes: [{
        ebsConfiguration: {
          name: 'name',
          sizeGiB: 123,

          // the properties below are optional
          encrypted: false,
          iops: 123,
          kmsKeyId: 'kmsKeyId',
          snapshotId: 'snapshotId',
          throughput: 123,
          volumeType: 'volumeType',
        },
      }],
    },
  },
  name: 'name',
  permissionsConfiguration: {
    capacityProviderOperatorRoleArn: 'capacityProviderOperatorRoleArn',
  },

  // the properties below are optional
  description: 'description',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

computeConfigurationIResolvable | CfnCapacityProvider.ComputeConfigurationPropertycompute_configurationtyping.Union[IResolvable, ComputeConfigurationProperty]computeConfigurationIResolvableComputeConfigurationIResolvableComputeConfigurationinterface{}required#
The capacity configuration for the capacity provider.

Defines the compute resources for this capacity provider.

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
An optional description of the capacity provider.
namestringnamestrnameStringNamestringName*stringrequired#
The name of the capacity provider.
permissionsConfigurationIResolvable | CfnCapacityProvider.PermissionsConfigurationPropertypermissions_configurationtyping.Union[IResolvable, PermissionsConfigurationProperty]permissionsConfigurationIResolvablePermissionsConfigurationIResolvablePermissionsConfigurationinterface{}required#
Configuration for permissions associated with a capacity provider.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
An array of key-value pairs to apply to the capacity provider.