Package software.amazon.awscdk.services.sagemaker

Interface CfnWorkforceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWorkforceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-02T11:03:18.847Z")
@Stability(Stable)
public interface CfnWorkforceProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnWorkforce.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sagemaker.*;
 CfnWorkforceProps cfnWorkforceProps = CfnWorkforceProps.builder()
         .workforceName("workforceName")
         // the properties below are optional
         .cognitoConfig(CognitoConfigProperty.builder()
                 .clientId("clientId")
                 .userPool("userPool")
                 .build())
         .ipAddressType("ipAddressType")
         .oidcConfig(OidcConfigProperty.builder()
                 .authorizationEndpoint("authorizationEndpoint")
                 .clientId("clientId")
                 .issuer("issuer")
                 .jwksUri("jwksUri")
                 .logoutEndpoint("logoutEndpoint")
                 .tokenEndpoint("tokenEndpoint")
                 .userInfoEndpoint("userInfoEndpoint")
                 // the properties below are optional
                 .authenticationRequestExtraParams(Map.of(
                         "authenticationRequestExtraParamsKey", "authenticationRequestExtraParams"))
                 .clientSecret("clientSecret")
                 .scope("scope")
                 .build())
         .sourceIpConfig(SourceIpConfigProperty.builder()
                 .cidrs(List.of("cidrs"))
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .workforceVpcConfig(WorkforceVpcConfigRequestProperty.builder()
                 .securityGroupIds(List.of("securityGroupIds"))
                 .subnets(List.of("subnets"))
                 .vpcId("vpcId")
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnWorkforceProps.Builder	A builder for CfnWorkforceProps
static final class	CfnWorkforceProps.Jsii$Proxy	An implementation for CfnWorkforceProps

Method Summary

Modifier and Type	Method	Description
static CfnWorkforceProps.Builder	builder()
default Object	getCognitoConfig()	The configuration of an Amazon Cognito workforce.
default String	getIpAddressType()	The IP address type for the workforce.
default Object	getOidcConfig()	The configuration of an OIDC Identity Provider (IdP) private workforce.
default Object	getSourceIpConfig()	A list of IP address ranges used to access your training data.
default List<CfnTag>	getTags()	An array of key-value pairs.
String	getWorkforceName()	The name of the private workforce.
default Object	getWorkforceVpcConfig()	The VPC configuration for the workforce.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getWorkforceName

@Stability(Stable)
@NotNull
String getWorkforceName()

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

getCognitoConfig

@Stability(Stable)
@Nullable
default Object getCognitoConfig()

The configuration of an Amazon Cognito workforce.

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

Returns union: either IResolvable or CfnWorkforce.CognitoConfigProperty

See Also:

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

getIpAddressType

@Stability(Stable)
@Nullable
default String getIpAddressType()

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

getOidcConfig

@Stability(Stable)
@Nullable
default Object getOidcConfig()

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

Returns union: either IResolvable or CfnWorkforce.OidcConfigProperty

See Also:

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

getSourceIpConfig

@Stability(Stable)
@Nullable
default Object getSourceIpConfig()

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

Returns union: either IResolvable or CfnWorkforce.SourceIpConfigProperty

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

getWorkforceVpcConfig

@Stability(Stable)
@Nullable
default Object getWorkforceVpcConfig()

The VPC configuration for the workforce.

Returns union: either IResolvable or CfnWorkforce.WorkforceVpcConfigRequestProperty

See Also:

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

builder

@Stability(Stable)
static CfnWorkforceProps.Builder builder()

Returns:

a CfnWorkforceProps.Builder of CfnWorkforceProps