Package software.amazon.awscdk.services.bedrockagentcore

Class CfnOAuth2CredentialProvider

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.bedrockagentcore.CfnOAuth2CredentialProvider
All Implemented Interfaces:
IInspectable, IOAuth2CredentialProviderRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-04-14T18:31:50.116Z") @Stability(Stable) public class CfnOAuth2CredentialProvider extends CfnResource implements IInspectable, IOAuth2CredentialProviderRef, ITaggableV2
Resource Type definition for AWS::BedrockAgentCore::OAuth2CredentialProvider.

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.*;
 CfnOAuth2CredentialProvider cfnOAuth2CredentialProvider = CfnOAuth2CredentialProvider.Builder.create(this, "MyCfnOAuth2CredentialProvider")
         .credentialProviderVendor("credentialProviderVendor")
         .name("name")
         // the properties below are optional
         .oauth2ProviderConfigInput(Oauth2ProviderConfigInputProperty.builder()
                 .atlassianOauth2ProviderConfig(AtlassianOauth2ProviderConfigInputProperty.builder()
                         .clientId("clientId")
                         .clientSecret("clientSecret")
                         .build())
                 .customOauth2ProviderConfig(CustomOauth2ProviderConfigInputProperty.builder()
                         .clientId("clientId")
                         .clientSecret("clientSecret")
                         .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())
                         .build())
                 .githubOauth2ProviderConfig(GithubOauth2ProviderConfigInputProperty.builder()
                         .clientId("clientId")
                         .clientSecret("clientSecret")
                         .build())
                 .googleOauth2ProviderConfig(GoogleOauth2ProviderConfigInputProperty.builder()
                         .clientId("clientId")
                         .clientSecret("clientSecret")
                         .build())
                 .includedOauth2ProviderConfig(IncludedOauth2ProviderConfigInputProperty.builder()
                         .clientId("clientId")
                         .clientSecret("clientSecret")
                         // the properties below are optional
                         .authorizationEndpoint("authorizationEndpoint")
                         .issuer("issuer")
                         .tokenEndpoint("tokenEndpoint")
                         .build())
                 .linkedinOauth2ProviderConfig(LinkedinOauth2ProviderConfigInputProperty.builder()
                         .clientId("clientId")
                         .clientSecret("clientSecret")
                         .build())
                 .microsoftOauth2ProviderConfig(MicrosoftOauth2ProviderConfigInputProperty.builder()
                         .clientId("clientId")
                         .clientSecret("clientSecret")
                         // the properties below are optional
                         .tenantId("tenantId")
                         .build())
                 .salesforceOauth2ProviderConfig(SalesforceOauth2ProviderConfigInputProperty.builder()
                         .clientId("clientId")
                         .clientSecret("clientSecret")
                         .build())
                 .slackOauth2ProviderConfig(SlackOauth2ProviderConfigInputProperty.builder()
                         .clientId("clientId")
                         .clientSecret("clientSecret")
                         .build())
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnOAuth2CredentialProvider

      protected CfnOAuth2CredentialProvider(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnOAuth2CredentialProvider

      protected CfnOAuth2CredentialProvider(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnOAuth2CredentialProvider

      @Stability(Stable) public CfnOAuth2CredentialProvider(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnOAuth2CredentialProviderProps props)
      Create a new AWS::BedrockAgentCore::OAuth2CredentialProvider.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • isCfnOAuth2CredentialProvider

      @Stability(Stable) @NotNull public static Boolean isCfnOAuth2CredentialProvider(@NotNull Object x)
      Checks whether the given object is a CfnOAuth2CredentialProvider.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrCallbackUrl

      @Stability(Stable) @NotNull public String getAttrCallbackUrl()
      The callback URL for the OAuth2 authorization flow.

    • getAttrClientSecretArn

      @Stability(Stable) @NotNull public IResolvable getAttrClientSecretArn()
      Contains information about a secret in AWS Secrets Manager.

    • getAttrCreatedTime

      @Stability(Stable) @NotNull public String getAttrCreatedTime()
      The timestamp when the credential provider was created.

    • getAttrCredentialProviderArn

      @Stability(Stable) @NotNull public String getAttrCredentialProviderArn()
      The Amazon Resource Name (ARN) of the OAuth2 credential provider.

    • getAttrLastUpdatedTime

      @Stability(Stable) @NotNull public String getAttrLastUpdatedTime()
      The timestamp when the credential provider was last updated.

    • getAttrOauth2ProviderConfigOutput

      @Stability(Stable) @NotNull public IResolvable getAttrOauth2ProviderConfigOutput()
      Output configuration for an OAuth2 provider.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getOAuth2CredentialProviderRef

      @Stability(Stable) @NotNull public OAuth2CredentialProviderReference getOAuth2CredentialProviderRef()
      A reference to a OAuth2CredentialProvider resource.
      Specified by:
      getOAuth2CredentialProviderRef in interface IOAuth2CredentialProviderRef

    • getCredentialProviderVendor

      @Stability(Stable) @NotNull public String getCredentialProviderVendor()
      The vendor of the OAuth2 credential provider.

    • setCredentialProviderVendor

      @Stability(Stable) public void setCredentialProviderVendor(@NotNull String value)
      The vendor of the OAuth2 credential provider.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the OAuth2 credential provider.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the OAuth2 credential provider.

    • getOauth2ProviderConfigInput

      @Stability(Stable) @Nullable public Object getOauth2ProviderConfigInput()
      Input configuration for an OAuth2 provider.

      Returns union: either IResolvable or CfnOAuth2CredentialProvider.Oauth2ProviderConfigInputProperty

    • setOauth2ProviderConfigInput

      @Stability(Stable) public void setOauth2ProviderConfigInput(@Nullable IResolvable value)
      Input configuration for an OAuth2 provider.

    • setOauth2ProviderConfigInput

      @Stability(Stable) public void setOauth2ProviderConfigInput(@Nullable CfnOAuth2CredentialProvider.Oauth2ProviderConfigInputProperty value)
      Input configuration for an OAuth2 provider.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      Tags to assign to the OAuth2 credential provider.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      Tags to assign to the OAuth2 credential provider.