Package software.amazon.awscdk.services.sagemaker

Interface CfnWorkforce.OidcConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWorkforce.OidcConfigProperty.Jsii$Proxy

Enclosing class:

CfnWorkforce

@Stability(Stable)
public static interface CfnWorkforce.OidcConfigProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sagemaker.*;
 OidcConfigProperty oidcConfigProperty = OidcConfigProperty.builder()
         .authorizationEndpoint("authorizationEndpoint")
         .clientId("clientId")
         .issuer("issuer")
         .jwksUri("jwksUri")
         .logoutEndpoint("logoutEndpoint")
         .tokenEndpoint("tokenEndpoint")
         .userInfoEndpoint("userInfoEndpoint")
         // the properties below are optional
         .authenticationRequestExtraParams(Map.of(
                 "authenticationRequestExtraParamsKey", "authenticationRequestExtraParams"))
         .clientSecret("clientSecret")
         .scope("scope")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnWorkforce.OidcConfigProperty.Builder	A builder for CfnWorkforce.OidcConfigProperty
static final class	CfnWorkforce.OidcConfigProperty.Jsii$Proxy	An implementation for CfnWorkforce.OidcConfigProperty

Method Summary

Modifier and Type	Method	Description
static CfnWorkforce.OidcConfigProperty.Builder	builder()
default Object	getAuthenticationRequestExtraParams()	A string to string map of identifiers specific to the custom identity provider (IdP) being used.
String	getAuthorizationEndpoint()	The OIDC IdP authorization endpoint used to configure your private workforce.
String	getClientId()	The OIDC IdP client ID used to configure your private workforce.
default String	getClientSecret()	The OIDC IdP client secret used to configure your private workforce.
String	getIssuer()	The OIDC IdP issuer used to configure your private workforce.
String	getJwksUri()	The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
String	getLogoutEndpoint()	The OIDC IdP logout endpoint used to configure your private workforce.
default String	getScope()	An array of string identifiers used to refer to the specific pieces of user data or claims that the client application wants to access.
String	getTokenEndpoint()	The OIDC IdP token endpoint used to configure your private workforce.
String	getUserInfoEndpoint()	The OIDC IdP user info endpoint used to configure your private workforce.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAuthorizationEndpoint

@Stability(Stable)
@NotNull
String getAuthorizationEndpoint()

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

getClientId

@Stability(Stable)
@NotNull
String getClientId()

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

getIssuer

@Stability(Stable)
@NotNull
String getIssuer()

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

getJwksUri

@Stability(Stable)
@NotNull
String getJwksUri()

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

getLogoutEndpoint

@Stability(Stable)
@NotNull
String getLogoutEndpoint()

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

getTokenEndpoint

@Stability(Stable)
@NotNull
String getTokenEndpoint()

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

getUserInfoEndpoint

@Stability(Stable)
@NotNull
String getUserInfoEndpoint()

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

getAuthenticationRequestExtraParams

@Stability(Stable)
@Nullable
default Object getAuthenticationRequestExtraParams()

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

Returns union: either IResolvable or Mapinvalid input: '<'String, String>

See Also:

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

getClientSecret

@Stability(Stable)
@Nullable
default String getClientSecret()

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

getScope

@Stability(Stable)
@Nullable
default String getScope()

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

builder

@Stability(Stable)
static CfnWorkforce.OidcConfigProperty.Builder builder()

Returns:

a CfnWorkforce.OidcConfigProperty.Builder of CfnWorkforce.OidcConfigProperty