CfnWorkforcePropsMixin

class aws_cdk.cfn_property_mixins.aws_sagemaker.CfnWorkforcePropsMixin(props, *, strategy=None)

Bases: Mixin

Resource Type definition for AWS::SageMaker::Workforce.

Use to create a private workforce that you can use to label your training data using Amazon SageMaker Ground Truth.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workforce.html
CloudformationResource:: AWS::SageMaker::Workforce
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

# merge_strategy: cdk.IMergeStrategy

cfn_workforce_props_mixin = sagemaker.CfnWorkforcePropsMixin(sagemaker.CfnWorkforceMixinProps(
    cognito_config=sagemaker.CfnWorkforcePropsMixin.CognitoConfigProperty(
        client_id="clientId",
        user_pool="userPool"
    ),
    ip_address_type="ipAddressType",
    oidc_config=sagemaker.CfnWorkforcePropsMixin.OidcConfigProperty(
        authentication_request_extra_params={
            "authentication_request_extra_params_key": "authenticationRequestExtraParams"
        },
        authorization_endpoint="authorizationEndpoint",
        client_id="clientId",
        client_secret="clientSecret",
        issuer="issuer",
        jwks_uri="jwksUri",
        logout_endpoint="logoutEndpoint",
        scope="scope",
        token_endpoint="tokenEndpoint",
        user_info_endpoint="userInfoEndpoint"
    ),
    source_ip_config=sagemaker.CfnWorkforcePropsMixin.SourceIpConfigProperty(
        cidrs=["cidrs"]
    ),
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )],
    workforce_name="workforceName",
    workforce_vpc_config=sagemaker.CfnWorkforcePropsMixin.WorkforceVpcConfigRequestProperty(
        security_group_ids=["securityGroupIds"],
        subnets=["subnets"],
        vpc_id="vpcId"
    )
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::SageMaker::Workforce.

Parameters:

props (Union[CfnWorkforceMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['cognitoConfig', 'ipAddressType', 'oidcConfig', 'sourceIpConfig', 'tags', 'workforceName', 'workforceVpcConfig']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

CognitoConfigProperty

class CfnWorkforcePropsMixin.CognitoConfigProperty(*, client_id=None, user_pool=None)

Bases: object

The configuration of an Amazon Cognito workforce.

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

Parameters:

client_id (Optional[str]) – The client ID for your Amazon Cognito user pool.
user_pool (Optional[str]) – The ID for your Amazon Cognito user pool.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

cognito_config_property = sagemaker.CfnWorkforcePropsMixin.CognitoConfigProperty(
    client_id="clientId",
    user_pool="userPool"
)

Attributes

client_id

The client ID for your Amazon Cognito user pool.

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

user_pool

The ID for your Amazon Cognito user pool.

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

OidcConfigProperty

class CfnWorkforcePropsMixin.OidcConfigProperty(*, authentication_request_extra_params=None, authorization_endpoint=None, client_id=None, client_secret=None, issuer=None, jwks_uri=None, logout_endpoint=None, scope=None, token_endpoint=None, user_info_endpoint=None)

Bases: object

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

Parameters:

authentication_request_extra_params (Union[IResolvable, Mapping[str, str], None]) – A string to string map of identifiers specific to the custom identity provider (IdP) being used.
authorization_endpoint (Optional[str]) – The OIDC IdP authorization endpoint used to configure your private workforce.
client_id (Optional[str]) – The OIDC IdP client ID used to configure your private workforce.
client_secret (Optional[str]) – The OIDC IdP client secret used to configure your private workforce.
issuer (Optional[str]) – The OIDC IdP issuer used to configure your private workforce.
jwks_uri (Optional[str]) – The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
logout_endpoint (Optional[str]) – The OIDC IdP logout endpoint used to configure your private workforce.
scope (Optional[str]) – An array of string identifiers used to refer to the specific pieces of user data or claims that the client application wants to access.
token_endpoint (Optional[str]) – The OIDC IdP token endpoint used to configure your private workforce.
user_info_endpoint (Optional[str]) – The OIDC IdP user info endpoint used to configure your private workforce.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

oidc_config_property = sagemaker.CfnWorkforcePropsMixin.OidcConfigProperty(
    authentication_request_extra_params={
        "authentication_request_extra_params_key": "authenticationRequestExtraParams"
    },
    authorization_endpoint="authorizationEndpoint",
    client_id="clientId",
    client_secret="clientSecret",
    issuer="issuer",
    jwks_uri="jwksUri",
    logout_endpoint="logoutEndpoint",
    scope="scope",
    token_endpoint="tokenEndpoint",
    user_info_endpoint="userInfoEndpoint"
)

Attributes

authentication_request_extra_params

A string to string map of identifiers specific to the custom identity provider (IdP) being used.

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

authorization_endpoint

The OIDC IdP authorization endpoint used to configure your private workforce.

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

client_id

The OIDC IdP client ID used to configure your private workforce.

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

client_secret

The OIDC IdP client secret used to configure your private workforce.

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

issuer

The OIDC IdP issuer used to configure your private workforce.

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

jwks_uri

The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.

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

logout_endpoint

The OIDC IdP logout endpoint used to configure your private workforce.

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

scope

An array of string identifiers used to refer to the specific pieces of user data or claims that the client application wants to access.

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

token_endpoint

The OIDC IdP token endpoint used to configure your private workforce.

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

user_info_endpoint

The OIDC IdP user info endpoint used to configure your private workforce.

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

SourceIpConfigProperty

class CfnWorkforcePropsMixin.SourceIpConfigProperty(*, cidrs=None)

Bases: object

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

Parameters:: cidrs (Optional[Sequence[str]]) – A list of one to ten Classless Inter-Domain Routing (CIDR) values.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-workforce-sourceipconfig.html
ExampleMetadata:: fixture=_generated

Example:

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

source_ip_config_property = sagemaker.CfnWorkforcePropsMixin.SourceIpConfigProperty(
    cidrs=["cidrs"]
)

Attributes

cidrs

A list of one to ten Classless Inter-Domain Routing (CIDR) values.

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

WorkforceVpcConfigRequestProperty

class CfnWorkforcePropsMixin.WorkforceVpcConfigRequestProperty(*, security_group_ids=None, subnets=None, vpc_id=None)

Bases: object

The VPC configuration for the workforce.

Parameters:

security_group_ids (Optional[Sequence[str]]) – The VPC security group IDs.
subnets (Optional[Sequence[str]]) – The VPC subnets.
vpc_id (Optional[str]) – The ID of the VPC.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

workforce_vpc_config_request_property = sagemaker.CfnWorkforcePropsMixin.WorkforceVpcConfigRequestProperty(
    security_group_ids=["securityGroupIds"],
    subnets=["subnets"],
    vpc_id="vpcId"
)

Attributes

security_group_ids

The VPC security group IDs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-workforce-workforcevpcconfigrequest.html#cfn-sagemaker-workforce-workforcevpcconfigrequest-securitygroupids

subnets

The VPC subnets.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-workforce-workforcevpcconfigrequest.html#cfn-sagemaker-workforce-workforcevpcconfigrequest-subnets

vpc_id

The ID of the VPC.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-workforce-workforcevpcconfigrequest.html#cfn-sagemaker-workforce-workforcevpcconfigrequest-vpcid