Package software.amazon.awscdk.services.bedrockagentcore

Interface CfnOAuth2CredentialProvider.Oauth2ProviderConfigInputProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnOAuth2CredentialProvider.Oauth2ProviderConfigInputProperty.Jsii$Proxy

Enclosing class:

CfnOAuth2CredentialProvider

@Stability(Stable)
public static interface CfnOAuth2CredentialProvider.Oauth2ProviderConfigInputProperty
extends software.amazon.jsii.JsiiSerializable

Input configuration for an 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.services.bedrockagentcore.*;
 Oauth2ProviderConfigInputProperty oauth2ProviderConfigInputProperty = Oauth2ProviderConfigInputProperty.builder()
         .atlassianOauth2ProviderConfig(AtlassianOauth2ProviderConfigInputProperty.builder()
                 .clientId("clientId")
                 // the properties below are optional
                 .clientSecret("clientSecret")
                 .clientSecretConfig(SecretReferenceProperty.builder()
                         .jsonKey("jsonKey")
                         .secretId("secretId")
                         .build())
                 .clientSecretSource("clientSecretSource")
                 .build())
         .customOauth2ProviderConfig(CustomOauth2ProviderConfigInputProperty.builder()
                 .oauthDiscovery(Oauth2DiscoveryProperty.builder()
                         .authorizationServerMetadata(Oauth2AuthorizationServerMetadataProperty.builder()
                                 .authorizationEndpoint("authorizationEndpoint")
                                 .issuer("issuer")
                                 .tokenEndpoint("tokenEndpoint")
                                 // the properties below are optional
                                 .responseTypes(List.of("responseTypes"))
                                 .build())
                         .discoveryUrl("discoveryUrl")
                         .build())
                 // the properties below are optional
                 .clientAuthenticationMethod("clientAuthenticationMethod")
                 .clientId("clientId")
                 .clientSecret("clientSecret")
                 .clientSecretConfig(SecretReferenceProperty.builder()
                         .jsonKey("jsonKey")
                         .secretId("secretId")
                         .build())
                 .clientSecretSource("clientSecretSource")
                 .onBehalfOfTokenExchangeConfig(OnBehalfOfTokenExchangeConfigProperty.builder()
                         .grantType("grantType")
                         // the properties below are optional
                         .tokenExchangeGrantTypeConfig(TokenExchangeGrantTypeConfigProperty.builder()
                                 .actorTokenContent("actorTokenContent")
                                 // the properties below are optional
                                 .actorTokenScopes(List.of("actorTokenScopes"))
                                 .build())
                         .build())
                 .privateEndpoint(PrivateEndpointProperty.builder()
                         .managedVpcResource(ManagedVpcResourceProperty.builder()
                                 .endpointIpAddressType("endpointIpAddressType")
                                 .subnetIds(List.of("subnetIds"))
                                 .vpcIdentifier("vpcIdentifier")
                                 // the properties below are optional
                                 .routingDomain("routingDomain")
                                 .securityGroupIds(List.of("securityGroupIds"))
                                 .tags(Map.of(
                                         "tagsKey", "tags"))
                                 .build())
                         .selfManagedLatticeResource(SelfManagedLatticeResourceProperty.builder()
                                 .resourceConfigurationIdentifier("resourceConfigurationIdentifier")
                                 .build())
                         .build())
                 .privateEndpointOverrides(List.of(PrivateEndpointOverrideProperty.builder()
                         .domain("domain")
                         .privateEndpoint(PrivateEndpointProperty.builder()
                                 .managedVpcResource(ManagedVpcResourceProperty.builder()
                                         .endpointIpAddressType("endpointIpAddressType")
                                         .subnetIds(List.of("subnetIds"))
                                         .vpcIdentifier("vpcIdentifier")
                                         // the properties below are optional
                                         .routingDomain("routingDomain")
                                         .securityGroupIds(List.of("securityGroupIds"))
                                         .tags(Map.of(
                                                 "tagsKey", "tags"))
                                         .build())
                                 .selfManagedLatticeResource(SelfManagedLatticeResourceProperty.builder()
                                         .resourceConfigurationIdentifier("resourceConfigurationIdentifier")
                                         .build())
                                 .build())
                         .build()))
                 .privateKeyJwtConfig(PrivateKeyJwtConfigProperty.builder()
                         .additionalHeaderClaims(Map.of(
                                 "additionalHeaderClaimsKey", "additionalHeaderClaims"))
                         .additionalPayloadClaims(Map.of(
                                 "additionalPayloadClaimsKey", "additionalPayloadClaims"))
                         .privateKeySource(PrivateKeySourceProperty.builder()
                                 .kmsKeySource(KmsKeySourceTypeProperty.builder()
                                         .kmsKeyArn("kmsKeyArn")
                                         .build())
                                 .build())
                         .signingAlgorithm("signingAlgorithm")
                         .build())
                 .build())
         .githubOauth2ProviderConfig(GithubOauth2ProviderConfigInputProperty.builder()
                 .clientId("clientId")
                 // the properties below are optional
                 .clientSecret("clientSecret")
                 .clientSecretConfig(SecretReferenceProperty.builder()
                         .jsonKey("jsonKey")
                         .secretId("secretId")
                         .build())
                 .clientSecretSource("clientSecretSource")
                 .build())
         .googleOauth2ProviderConfig(GoogleOauth2ProviderConfigInputProperty.builder()
                 .clientId("clientId")
                 // the properties below are optional
                 .clientSecret("clientSecret")
                 .clientSecretConfig(SecretReferenceProperty.builder()
                         .jsonKey("jsonKey")
                         .secretId("secretId")
                         .build())
                 .clientSecretSource("clientSecretSource")
                 .build())
         .includedOauth2ProviderConfig(IncludedOauth2ProviderConfigInputProperty.builder()
                 .clientId("clientId")
                 // the properties below are optional
                 .authorizationEndpoint("authorizationEndpoint")
                 .clientSecret("clientSecret")
                 .clientSecretConfig(SecretReferenceProperty.builder()
                         .jsonKey("jsonKey")
                         .secretId("secretId")
                         .build())
                 .clientSecretSource("clientSecretSource")
                 .issuer("issuer")
                 .tokenEndpoint("tokenEndpoint")
                 .build())
         .linkedinOauth2ProviderConfig(LinkedinOauth2ProviderConfigInputProperty.builder()
                 .clientId("clientId")
                 // the properties below are optional
                 .clientSecret("clientSecret")
                 .clientSecretConfig(SecretReferenceProperty.builder()
                         .jsonKey("jsonKey")
                         .secretId("secretId")
                         .build())
                 .clientSecretSource("clientSecretSource")
                 .build())
         .microsoftOauth2ProviderConfig(MicrosoftOauth2ProviderConfigInputProperty.builder()
                 .clientId("clientId")
                 // the properties below are optional
                 .clientSecret("clientSecret")
                 .clientSecretConfig(SecretReferenceProperty.builder()
                         .jsonKey("jsonKey")
                         .secretId("secretId")
                         .build())
                 .clientSecretSource("clientSecretSource")
                 .tenantId("tenantId")
                 .build())
         .salesforceOauth2ProviderConfig(SalesforceOauth2ProviderConfigInputProperty.builder()
                 .clientId("clientId")
                 // the properties below are optional
                 .clientSecret("clientSecret")
                 .clientSecretConfig(SecretReferenceProperty.builder()
                         .jsonKey("jsonKey")
                         .secretId("secretId")
                         .build())
                 .clientSecretSource("clientSecretSource")
                 .build())
         .slackOauth2ProviderConfig(SlackOauth2ProviderConfigInputProperty.builder()
                 .clientId("clientId")
                 // the properties below are optional
                 .clientSecret("clientSecret")
                 .clientSecretConfig(SecretReferenceProperty.builder()
                         .jsonKey("jsonKey")
                         .secretId("secretId")
                         .build())
                 .clientSecretSource("clientSecretSource")
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnOAuth2CredentialProvider.Oauth2ProviderConfigInputProperty.Builder	builder()
default Object	getAtlassianOauth2ProviderConfig()	Input configuration for an Atlassian OAuth2 provider.
default Object	getCustomOauth2ProviderConfig()	Input configuration for a custom OAuth2 provider.
default Object	getGithubOauth2ProviderConfig()	Input configuration for a GitHub OAuth2 provider.
default Object	getGoogleOauth2ProviderConfig()	Input configuration for a Google OAuth2 provider.
default Object	getIncludedOauth2ProviderConfig()	Input configuration for a supported non-custom OAuth2 provider.
default Object	getLinkedinOauth2ProviderConfig()	Input configuration for a LinkedIn OAuth2 provider.
default Object	getMicrosoftOauth2ProviderConfig()	Input configuration for a Microsoft OAuth2 provider.
default Object	getSalesforceOauth2ProviderConfig()	Input configuration for a Salesforce OAuth2 provider.
default Object	getSlackOauth2ProviderConfig()	Input configuration for a Slack OAuth2 provider.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAtlassianOauth2ProviderConfig

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

Input configuration for an Atlassian OAuth2 provider.

Returns union: either IResolvable or CfnOAuth2CredentialProvider.AtlassianOauth2ProviderConfigInputProperty

See Also:

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

getCustomOauth2ProviderConfig

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

Input configuration for a custom OAuth2 provider.

Returns union: either IResolvable or CfnOAuth2CredentialProvider.CustomOauth2ProviderConfigInputProperty

See Also:

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

getGithubOauth2ProviderConfig

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

Input configuration for a GitHub OAuth2 provider.

Returns union: either IResolvable or CfnOAuth2CredentialProvider.GithubOauth2ProviderConfigInputProperty

See Also:

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

getGoogleOauth2ProviderConfig

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

Input configuration for a Google OAuth2 provider.

Returns union: either IResolvable or CfnOAuth2CredentialProvider.GoogleOauth2ProviderConfigInputProperty

See Also:

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

getIncludedOauth2ProviderConfig

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

Input configuration for a supported non-custom OAuth2 provider.

Returns union: either IResolvable or CfnOAuth2CredentialProvider.IncludedOauth2ProviderConfigInputProperty

See Also:

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

getLinkedinOauth2ProviderConfig

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

Input configuration for a LinkedIn OAuth2 provider.

Returns union: either IResolvable or CfnOAuth2CredentialProvider.LinkedinOauth2ProviderConfigInputProperty

See Also:

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

getMicrosoftOauth2ProviderConfig

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

Input configuration for a Microsoft OAuth2 provider.

Returns union: either IResolvable or CfnOAuth2CredentialProvider.MicrosoftOauth2ProviderConfigInputProperty

See Also:

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

getSalesforceOauth2ProviderConfig

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

Input configuration for a Salesforce OAuth2 provider.

Returns union: either IResolvable or CfnOAuth2CredentialProvider.SalesforceOauth2ProviderConfigInputProperty

See Also:

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

getSlackOauth2ProviderConfig

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

Input configuration for a Slack OAuth2 provider.

Returns union: either IResolvable or CfnOAuth2CredentialProvider.SlackOauth2ProviderConfigInputProperty

See Also:

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

builder

@Stability(Stable)
static CfnOAuth2CredentialProvider.Oauth2ProviderConfigInputProperty.Builder builder()

Returns:

a CfnOAuth2CredentialProvider.Oauth2ProviderConfigInputProperty.Builder of CfnOAuth2CredentialProvider.Oauth2ProviderConfigInputProperty