CfnWorkforceProps

class aws_cdk.aws_sagemaker.CfnWorkforceProps(*, workforce_name, cognito_config=None, ip_address_type=None, oidc_config=None, source_ip_config=None, tags=None, workforce_vpc_config=None)

Bases: object

Properties for defining a CfnWorkforce.

Parameters:

workforce_name (str) – The name of the private workforce.
cognito_config (Union[IResolvable, CognitoConfigProperty, Dict[str, Any], None]) – The configuration of an Amazon Cognito workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.
ip_address_type (Optional[str]) – The IP address type for the workforce. IPv4 only or dualstack (IPv4 and IPv6).
oidc_config (Union[IResolvable, OidcConfigProperty, Dict[str, Any], None]) – The configuration of an OIDC Identity Provider (IdP) private workforce.
source_ip_config (Union[IResolvable, SourceIpConfigProperty, Dict[str, Any], None]) – A list of IP address ranges used to access your training data.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs.
workforce_vpc_config (Union[IResolvable, WorkforceVpcConfigRequestProperty, Dict[str, Any], None]) – The VPC configuration for the workforce.

See:

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

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sagemaker as sagemaker

cfn_workforce_props = sagemaker.CfnWorkforceProps(
    workforce_name="workforceName",

    # the properties below are optional
    cognito_config=sagemaker.CfnWorkforce.CognitoConfigProperty(
        client_id="clientId",
        user_pool="userPool"
    ),
    ip_address_type="ipAddressType",
    oidc_config=sagemaker.CfnWorkforce.OidcConfigProperty(
        authorization_endpoint="authorizationEndpoint",
        client_id="clientId",
        issuer="issuer",
        jwks_uri="jwksUri",
        logout_endpoint="logoutEndpoint",
        token_endpoint="tokenEndpoint",
        user_info_endpoint="userInfoEndpoint",

        # the properties below are optional
        authentication_request_extra_params={
            "authentication_request_extra_params_key": "authenticationRequestExtraParams"
        },
        client_secret="clientSecret",
        scope="scope"
    ),
    source_ip_config=sagemaker.CfnWorkforce.SourceIpConfigProperty(
        cidrs=["cidrs"]
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    workforce_vpc_config=sagemaker.CfnWorkforce.WorkforceVpcConfigRequestProperty(
        security_group_ids=["securityGroupIds"],
        subnets=["subnets"],
        vpc_id="vpcId"
    )
)