Package software.amazon.awscdk.cfnpropertymixins.services.bedrockagentcore

Interface CfnOAuth2CredentialProviderPropsMixin.CustomOauth2ProviderConfigInputProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnOAuth2CredentialProviderPropsMixin.CustomOauth2ProviderConfigInputProperty.Jsii$Proxy

Enclosing class:

CfnOAuth2CredentialProviderPropsMixin

@Stability(Stable)
public static interface CfnOAuth2CredentialProviderPropsMixin.CustomOauth2ProviderConfigInputProperty
extends software.amazon.jsii.JsiiSerializable

Input configuration for a custom OAuth2 provider.

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.bedrockagentcore.*;
 CustomOauth2ProviderConfigInputProperty customOauth2ProviderConfigInputProperty = CustomOauth2ProviderConfigInputProperty.builder()
         .clientAuthenticationMethod("clientAuthenticationMethod")
         .clientId("clientId")
         .clientSecret("clientSecret")
         .clientSecretConfig(SecretReferenceProperty.builder()
                 .jsonKey("jsonKey")
                 .secretId("secretId")
                 .build())
         .clientSecretSource("clientSecretSource")
         .oauthDiscovery(Oauth2DiscoveryProperty.builder()
                 .authorizationServerMetadata(Oauth2AuthorizationServerMetadataProperty.builder()
                         .authorizationEndpoint("authorizationEndpoint")
                         .issuer("issuer")
                         .responseTypes(List.of("responseTypes"))
                         .tokenEndpoint("tokenEndpoint")
                         .build())
                 .discoveryUrl("discoveryUrl")
                 .build())
         .onBehalfOfTokenExchangeConfig(OnBehalfOfTokenExchangeConfigProperty.builder()
                 .grantType("grantType")
                 .tokenExchangeGrantTypeConfig(TokenExchangeGrantTypeConfigProperty.builder()
                         .actorTokenContent("actorTokenContent")
                         .actorTokenScopes(List.of("actorTokenScopes"))
                         .build())
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnOAuth2CredentialProviderPropsMixin.CustomOauth2ProviderConfigInputProperty.Builder	builder()
default String	getClientAuthenticationMethod()	The client authentication method to use when authenticating with the token endpoint.
default String	getClientId()	The client ID for the custom OAuth2 provider.
default String	getClientSecret()	The client secret for the custom OAuth2 provider.
default Object	getClientSecretConfig()	A reference to a customer-provided secret stored in AWS Secrets Manager.
default String	getClientSecretSource()	The source of the client secret.
default Object	getOauthDiscovery()	Discovery information for an OAuth2 provider.
default Object	getOnBehalfOfTokenExchangeConfig()	Configuration for on-behalf-of token exchange.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getClientAuthenticationMethod

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

The client authentication method to use when authenticating with the token endpoint.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput-clientauthenticationmethod

getClientId

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

The client ID for the custom OAuth2 provider.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput-clientid

getClientSecret

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

The client secret for the custom OAuth2 provider.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput-clientsecret

getClientSecretConfig

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

A reference to a customer-provided secret stored in AWS Secrets Manager.

Returns union: either IResolvable or CfnOAuth2CredentialProviderPropsMixin.SecretReferenceProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput-clientsecretconfig

getClientSecretSource

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

The source of the client secret.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput-clientsecretsource

getOauthDiscovery

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

Discovery information for an OAuth2 provider.

Returns union: either IResolvable or CfnOAuth2CredentialProviderPropsMixin.Oauth2DiscoveryProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput-oauthdiscovery

getOnBehalfOfTokenExchangeConfig

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

Configuration for on-behalf-of token exchange.

Returns union: either IResolvable or CfnOAuth2CredentialProviderPropsMixin.OnBehalfOfTokenExchangeConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput-onbehalfoftokenexchangeconfig

builder

@Stability(Stable)
static CfnOAuth2CredentialProviderPropsMixin.CustomOauth2ProviderConfigInputProperty.Builder builder()

Returns:

a CfnOAuth2CredentialProviderPropsMixin.CustomOauth2ProviderConfigInputProperty.Builder of CfnOAuth2CredentialProviderPropsMixin.CustomOauth2ProviderConfigInputProperty