You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::SageMaker::Types::CreateWorkforceRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateWorkforceRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  cognito_config: {
    user_pool: "CognitoUserPool", # required
    client_id: "ClientId", # required
  },
  oidc_config: {
    client_id: "ClientId", # required
    client_secret: "ClientSecret", # required
    issuer: "OidcEndpoint", # required
    authorization_endpoint: "OidcEndpoint", # required
    token_endpoint: "OidcEndpoint", # required
    user_info_endpoint: "OidcEndpoint", # required
    logout_endpoint: "OidcEndpoint", # required
    jwks_uri: "OidcEndpoint", # required
  },
  source_ip_config: {
    cidrs: ["Cidr"], # required
  },
  workforce_name: "WorkforceName", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#cognito_config ⇒ Types::CognitoConfig

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

Do not use OidcConfig if you specify values for CognitoConfig.

Returns:

#oidc_config ⇒ Types::OidcConfig

Use this parameter to configure a private workforce using your own OIDC Identity Provider.

Do not use CognitoConfig if you specify values for OidcConfig.

Returns:

  • (Types::OidcConfig) —

    Use this parameter to configure a private workforce using your own OIDC Identity Provider.

#source_ip_config ⇒ Types::SourceIpConfig

A list of IP address ranges (CIDRs). Used to create an allow list of IP addresses for a private workforce. Workers will only be able to login to their worker portal from an IP address within this range. By default, a workforce isn't restricted to specific IP addresses.

Returns:

#tags ⇒ Array<Types::Tag>

An array of key-value pairs that contain metadata to help you categorize and organize our workforce. Each tag consists of a key and a value, both of which you define.

Returns:

  • (Array<Types::Tag>) —

    An array of key-value pairs that contain metadata to help you categorize and organize our workforce.

#workforce_name ⇒ String

The name of the private workforce.

Returns:

  • (String) —

    The name of the private workforce.