View a markdown version of this page

AWS::SageMaker::Workforce - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::SageMaker::Workforce

A single private workforce, which is automatically created when you create your first private work team. You can create one private work force in each AWS Region. By default, any workforce-related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::SageMaker::Workforce",
  "Properties" : {
      "CognitoConfig" : CognitoConfig,
      "IpAddressType" : String,
      "OidcConfig" : OidcConfig,
      "SourceIpConfig" : SourceIpConfig,
      "Tags" : [ Tag, ... ],
      "WorkforceName" : String,
      "WorkforceVpcConfig" : WorkforceVpcConfigRequest
    }
}

Properties

CognitoConfig

The configuration of an Amazon Cognito workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.

Required: No

Type: CognitoConfig

Update requires: Replacement

IpAddressType

The IP address type you specify - either IPv4 only or dualstack (IPv4 and IPv6) - to support your labeling workforce.

Required: No

Type: String

Allowed values: ipv4 | dualstack

Update requires: No interruption

OidcConfig

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

Required: No

Type: OidcConfig

Update requires: No interruption

SourceIpConfig

A list of one to ten IP address ranges (CIDRs) to be added to the workforce allow list. By default, a workforce isn't restricted to specific IP addresses.

Required: No

Type: SourceIpConfig

Update requires: No interruption

Tags

Property description not available.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

WorkforceName

The name of the private workforce.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9]([a-zA-Z0-9\-]){0,62}$

Minimum: 1

Maximum: 63

Update requires: Replacement

WorkforceVpcConfig

The configuration of a VPC workforce.

Required: No

Type: WorkforceVpcConfigRequest

Update requires: No interruption

Return values

Ref

Fn::GetAtt

SubDomain

The subdomain for your OIDC Identity Provider.

WorkforceArn

The Amazon Resource Name (ARN) of the private workforce.