View a markdown version of this page

AWS::SageMaker::Workforce CognitoConfig - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

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

AWS::SageMaker::Workforce CognitoConfig

Use this parameter to configure your Amazon Cognito workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.

Syntax

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

JSON

{
  "ClientId" : String,
  "UserPool" : String
}

YAML

  ClientId: String
  UserPool: String

Properties

ClientId

The client ID for your Amazon Cognito user pool.

Required: Yes

Type: String

Pattern: [ -~]+

Minimum: 1

Maximum: 1024

Update requires: Replacement

UserPool

A user pool is a user directory in Amazon Cognito. With a user pool, your users can sign in to your web or mobile app through Amazon Cognito. Your users can also sign in through social identity providers like Google, Facebook, Amazon, or Apple, and through SAML identity providers.

Required: Yes

Type: String

Pattern: [\w-]+_[0-9a-zA-Z]+

Minimum: 1

Maximum: 55

Update requires: Replacement