CfnWorkforceProps Struct
Properties for defining a CfnWorkforce.
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
cognitoConfigoptionalIResolvable | CfnWorkforce.CognitoConfigPropertycognito_configoptionaltyping.Union[IResolvable, CognitoConfigProperty]cognitoConfigoptionalIResolvableCognitoConfigoptionalIResolvableCognitoConfigoptionalinterface{}#The configuration of an Amazon Cognito workforce.
A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.
ipAddressTypeoptionalstringip_address_typeoptionalstripAddressTypeoptionalStringIpAddressTypeoptionalstringIpAddressTypeoptional*string#The IP address type for the workforce.
IPv4 only or dualstack (IPv4 and IPv6).
oidcConfigoptionalIResolvable | CfnWorkforce.OidcConfigPropertyoidc_configoptionaltyping.Union[IResolvable, OidcConfigProperty]oidcConfigoptionalIResolvableOidcConfigoptionalIResolvableOidcConfigoptionalinterface{}#The configuration of an OIDC Identity Provider (IdP) private workforce.
sourceIpConfigoptionalIResolvable | CfnWorkforce.SourceIpConfigPropertysource_ip_configoptionaltyping.Union[IResolvable, SourceIpConfigProperty]sourceIpConfigoptionalIResolvableSourceIpConfigoptionalIResolvableSourceIpConfigoptionalinterface{}#A list of IP address ranges used to access your training data.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#An array of key-value pairs.
workforceNamestringworkforce_namestrworkforceNameStringWorkforceNamestringWorkforceName*stringrequired#The name of the private workforce.
workforceVpcConfigoptionalIResolvable | CfnWorkforce.WorkforceVpcConfigRequestPropertyworkforce_vpc_configoptionaltyping.Union[IResolvable, WorkforceVpcConfigRequestProperty]workforceVpcConfigoptionalIResolvableWorkforceVpcConfigoptionalIResolvableWorkforceVpcConfigoptionalinterface{}#The VPC configuration for the workforce.