AWS CDK

2.268.0

interface OidcConfigProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Sagemaker.CfnWorkforce.OidcConfigProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awssagemaker#CfnWorkforce_OidcConfigProperty`
Java	`software.amazon.awscdk.services.sagemaker.CfnWorkforce.OidcConfigProperty`
Python	`aws_cdk.aws_sagemaker.CfnWorkforce.OidcConfigProperty`
TypeScript	`aws-cdk-lib` » `aws_sagemaker` » `CfnWorkforce` » `OidcConfigProperty`

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

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from 'aws-cdk-lib';
const oidcConfigProperty: sagemaker.CfnWorkforce.OidcConfigProperty = {
  authorizationEndpoint: 'authorizationEndpoint',
  clientId: 'clientId',
  issuer: 'issuer',
  jwksUri: 'jwksUri',
  logoutEndpoint: 'logoutEndpoint',
  tokenEndpoint: 'tokenEndpoint',
  userInfoEndpoint: 'userInfoEndpoint',

  // the properties below are optional
  authenticationRequestExtraParams: {
    authenticationRequestExtraParamsKey: 'authenticationRequestExtraParams',
  },
  clientSecret: 'clientSecret',
  scope: 'scope',
};

Properties

Name	Type	Description
authorizationEndpoint	`string`	The OIDC IdP authorization endpoint used to configure your private workforce.
clientId	`string`	The OIDC IdP client ID used to configure your private workforce.
issuer	`string`	The OIDC IdP issuer used to configure your private workforce.
jwksUri	`string`	The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
logoutEndpoint	`string`	The OIDC IdP logout endpoint used to configure your private workforce.
tokenEndpoint	`string`	The OIDC IdP token endpoint used to configure your private workforce.
userInfoEndpoint	`string`	The OIDC IdP user info endpoint used to configure your private workforce.
authenticationRequestExtraParams?	`IResolvable` `\| { [string]: string }`	A string to string map of identifiers specific to the custom identity provider (IdP) being used.
clientSecret?	`string`	The OIDC IdP client secret used to configure your private workforce.
scope?	`string`	An array of string identifiers used to refer to the specific pieces of user data or claims that the client application wants to access.

authorizationEndpoint

Type: string

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

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

clientId

Type: string

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

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

issuer

Type: string

The OIDC IdP issuer used to configure your private workforce.

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

jwksUri

Type: string

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

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

logoutEndpoint

Type: string

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

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

tokenEndpoint

Type: string

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

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

userInfoEndpoint

Type: string

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

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

authenticationRequestExtraParams?

Type: IResolvable | { [string]: string } (optional)

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

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

clientSecret?

Type: string (optional)

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

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

scope?

Type: string (optional)

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 also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-workforce-oidcconfig.html#cfn-sagemaker-workforce-oidcconfig-scope

← Previous Next →