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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-sagemaker/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

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`.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html

Returns:



9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 9510

class CreateWorkforceRequest < Struct.new(
  :cognito_config,
  :oidc_config,
  :source_ip_config,
  :workforce_name,
  :tags,
  :workforce_vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#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:



9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 9510

class CreateWorkforceRequest < Struct.new(
  :cognito_config,
  :oidc_config,
  :source_ip_config,
  :workforce_name,
  :tags,
  :workforce_vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#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.

[1]: docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html

Returns:



9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 9510

class CreateWorkforceRequest < Struct.new(
  :cognito_config,
  :oidc_config,
  :source_ip_config,
  :workforce_name,
  :tags,
  :workforce_vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#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:



9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 9510

class CreateWorkforceRequest < Struct.new(
  :cognito_config,
  :oidc_config,
  :source_ip_config,
  :workforce_name,
  :tags,
  :workforce_vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#workforce_name ⇒ String

The name of the private workforce.

Returns:

  • (String) 


9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 9510

class CreateWorkforceRequest < Struct.new(
  :cognito_config,
  :oidc_config,
  :source_ip_config,
  :workforce_name,
  :tags,
  :workforce_vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#workforce_vpc_config ⇒ Types::WorkforceVpcConfigRequest

Use this parameter to configure a workforce using VPC.

Returns:



9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 9510

class CreateWorkforceRequest < Struct.new(
  :cognito_config,
  :oidc_config,
  :source_ip_config,
  :workforce_name,
  :tags,
  :workforce_vpc_config)
  SENSITIVE = []
  include Aws::Structure
end