# CfnWorkforceProps

Properties for defining a `CfnWorkforce`.

Extends: CfnWorkforceProps
Used as props by: CfnWorkforce

- Source: Generated code
- Type last changed: v2.268.0 · 2 Sep 2026

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from 'aws-cdk-lib';
const cfnWorkforceProps: sagemaker.CfnWorkforceProps = {
  workforceName: 'workforceName',

  // the properties below are optional
  cognitoConfig: {
    clientId: 'clientId',
    userPool: 'userPool',
  },
  ipAddressType: 'ipAddressType',
  oidcConfig: {
    authorizationEndpoint: 'authorizationEndpoint',
    clientId: 'clientId',
    issuer: 'issuer',
    jwksUri: 'jwksUri',
    logoutEndpoint: 'logoutEndpoint',
    tokenEndpoint: 'tokenEndpoint',
    userInfoEndpoint: 'userInfoEndpoint',

    // the properties below are optional
    authenticationRequestExtraParams: {
      authenticationRequestExtraParamsKey: 'authenticationRequestExtraParams',
    },
    clientSecret: 'clientSecret',
    scope: 'scope',
  },
  sourceIpConfig: {
    cidrs: ['cidrs'],
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  workforceVpcConfig: {
    securityGroupIds: ['securityGroupIds'],
    subnets: ['subnets'],
    vpcId: 'vpcId',
  },
};
```

## Properties

- `cognitoConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnWorkforce.CognitoConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnWorkforce.CognitoConfigProperty.html) — The configuration of an Amazon Cognito workforce.

  A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.

- `ipAddressType`: string — The IP address type for the workforce.

  IPv4 only or dualstack (IPv4 and IPv6).

- `oidcConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnWorkforce.OidcConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnWorkforce.OidcConfigProperty.html) — The configuration of an OIDC Identity Provider (IdP) private workforce.

- `sourceIpConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnWorkforce.SourceIpConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnWorkforce.SourceIpConfigProperty.html) — A list of IP address ranges used to access your training data.

- `tags`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — An array of key-value pairs.

- `workforceName`: string (required) — The name of the private workforce.

- `workforceVpcConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnWorkforce.WorkforceVpcConfigRequestProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnWorkforce.WorkforceVpcConfigRequestProperty.html) — The VPC configuration for the workforce.