Package software.amazon.awscdk.cfnpropertymixins.services.sagemaker

Interface CfnWorkforcePropsMixin.OidcConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWorkforcePropsMixin.OidcConfigProperty.Jsii$Proxy

Enclosing class:

CfnWorkforcePropsMixin

@Stability(Stable)
public static interface CfnWorkforcePropsMixin.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.cfnpropertymixins.services.sagemaker.*;
 OidcConfigProperty oidcConfigProperty = OidcConfigProperty.builder()
         .authenticationRequestExtraParams(Map.of(
                 "authenticationRequestExtraParamsKey", "authenticationRequestExtraParams"))
         .authorizationEndpoint("authorizationEndpoint")
         .clientId("clientId")
         .clientSecret("clientSecret")
         .issuer("issuer")
         .jwksUri("jwksUri")
         .logoutEndpoint("logoutEndpoint")
         .scope("scope")
         .tokenEndpoint("tokenEndpoint")
         .userInfoEndpoint("userInfoEndpoint")
         .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	CfnWorkforcePropsMixin.OidcConfigProperty.Builder	A builder for CfnWorkforcePropsMixin.OidcConfigProperty
static final class	CfnWorkforcePropsMixin.OidcConfigProperty.Jsii$Proxy	An implementation for CfnWorkforcePropsMixin.OidcConfigProperty

Method Summary

Modifier and Type	Method	Description
static CfnWorkforcePropsMixin.OidcConfigProperty.Builder	builder()
default Object	getAuthenticationRequestExtraParams()	A string to string map of identifiers specific to the custom identity provider (IdP) being used.
default String	getAuthorizationEndpoint()	The OIDC IdP authorization endpoint used to configure your private workforce.
default 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.
default String	getIssuer()	The OIDC IdP issuer used to configure your private workforce.
default String	getJwksUri()	The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
default 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.
default String	getTokenEndpoint()	The OIDC IdP token endpoint used to configure your private workforce.
default 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

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

getAuthorizationEndpoint

@Stability(Stable)
@Nullable
default 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)
@Nullable
default 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

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

getIssuer

@Stability(Stable)
@Nullable
default 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)
@Nullable
default 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)
@Nullable
default 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

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

getTokenEndpoint

@Stability(Stable)
@Nullable
default 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)
@Nullable
default 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

builder

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

Returns:

a CfnWorkforcePropsMixin.OidcConfigProperty.Builder of CfnWorkforcePropsMixin.OidcConfigProperty