interface CfnWorkforceProps

Language	Type name
.NET	Amazon.CDK.AWS.Sagemaker.CfnWorkforceProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awssagemaker#CfnWorkforceProps
Java	software.amazon.awscdk.services.sagemaker.CfnWorkforceProps
Python	aws_cdk.aws_sagemaker.CfnWorkforceProps
TypeScript	aws-cdk-lib » aws_sagemaker » CfnWorkforceProps

Properties for defining a CfnWorkforce.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workforce.html

Example

// 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

Name	Type	Description
workforceName	string	The name of the private workforce.
cognitoConfig?	IResolvable | CognitoConfigProperty	The configuration of an Amazon Cognito workforce.
ipAddressType?	string	The IP address type for the workforce.
oidcConfig?	IResolvable | OidcConfigProperty	The configuration of an OIDC Identity Provider (IdP) private workforce.
sourceIpConfig?	IResolvable | SourceIpConfigProperty	A list of IP address ranges used to access your training data.
tags?	CfnTag[]	An array of key-value pairs.
workforceVpcConfig?	IResolvable | WorkforceVpcConfigRequestProperty	The VPC configuration for the workforce.

---

workforceName

Type: string

The name of the private workforce.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workforce.html#cfn-sagemaker-workforce-workforcename

---

cognitoConfig?

Type: IResolvable | CognitoConfigProperty (optional)

The configuration of an Amazon Cognito workforce.

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workforce.html#cfn-sagemaker-workforce-cognitoconfig

---

ipAddressType?

Type: string (optional)

The IP address type for the workforce.

IPv4 only or dualstack (IPv4 and IPv6).

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workforce.html#cfn-sagemaker-workforce-ipaddresstype

---

oidcConfig?

Type: IResolvable | OidcConfigProperty (optional)

The configuration of an OIDC Identity Provider (IdP) private workforce.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workforce.html#cfn-sagemaker-workforce-oidcconfig

---

sourceIpConfig?

Type: IResolvable | SourceIpConfigProperty (optional)

A list of IP address ranges used to access your training data.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workforce.html#cfn-sagemaker-workforce-sourceipconfig

---

tags?

Type: CfnTag[] (optional)

An array of key-value pairs.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workforce.html#cfn-sagemaker-workforce-tags

---

workforceVpcConfig?

Type: IResolvable | WorkforceVpcConfigRequestProperty (optional)

The VPC configuration for the workforce.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workforce.html#cfn-sagemaker-workforce-workforcevpcconfig