Interface IOAuth2CredentialProvider.Jsii$Default

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IEnvironmentAware, IEnvironmentAware.Jsii$Default, IGrantable, IGrantable.Jsii$Default, IOAuth2CredentialProvider, IOAuth2CredentialProviderRef, IOAuth2CredentialProviderRef.Jsii$Default, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
IOAuth2CredentialProvider.Jsii$Proxy
Enclosing interface:
IOAuth2CredentialProvider

@Internal public static interface IOAuth2CredentialProvider.Jsii$Default extends IOAuth2CredentialProvider, IResource.Jsii$Default, IOAuth2CredentialProviderRef.Jsii$Default, IGrantable.Jsii$Default
Internal default implementation for IOAuth2CredentialProvider.
  • Method Details

    • getCredentialProviderArn

      @Stability(Stable) @NotNull default String getCredentialProviderArn()
      The ARN of this credential provider.
      Specified by:
      getCredentialProviderArn in interface IOAuth2CredentialProvider
    • getCredentialProviderVendor

      @Stability(Stable) @NotNull default String getCredentialProviderVendor()
      OAuth2 vendor string passed to CloudFormation.
      Specified by:
      getCredentialProviderVendor in interface IOAuth2CredentialProvider
    • getCallbackUrl

      @Stability(Stable) @Nullable default String getCallbackUrl()
      Callback URL for the OAuth2 authorization flow.
      Specified by:
      getCallbackUrl in interface IOAuth2CredentialProvider
    • getClientSecretArn

      @Stability(Stable) @Nullable default String getClientSecretArn()
      The ARN of the Secrets Manager secret for the OAuth2 client credentials.

      May be undefined for resources imported without this attribute.

      Specified by:
      getClientSecretArn in interface IOAuth2CredentialProvider
    • getCreatedTime

      @Stability(Stable) @Nullable default String getCreatedTime()
      Timestamp when the credential provider was created.
      Specified by:
      getCreatedTime in interface IOAuth2CredentialProvider
    • getLastUpdatedTime

      @Stability(Stable) @Nullable default String getLastUpdatedTime()
      Timestamp when the credential provider was last updated.
      Specified by:
      getLastUpdatedTime in interface IOAuth2CredentialProvider
    • bindForGatewayOAuthTarget

      @Stability(Stable) @NotNull default GatewayOAuth2IdentityBinding bindForGatewayOAuthTarget(@NotNull List<String> scopes, @Nullable Map<String,String> customParameters)
      ARNs and OAuth scopes for gateway targets (GatewayCredentialProvider.fromOauthIdentity or fromOauthIdentityArn).

      Specified by:
      bindForGatewayOAuthTarget in interface IOAuth2CredentialProvider
      Parameters:
      scopes - This parameter is required.
      customParameters -
    • bindForGatewayOAuthTarget

      @Stability(Stable) @NotNull default GatewayOAuth2IdentityBinding bindForGatewayOAuthTarget(@NotNull List<String> scopes)
      ARNs and OAuth scopes for gateway targets (GatewayCredentialProvider.fromOauthIdentity or fromOauthIdentityArn).

      Specified by:
      bindForGatewayOAuthTarget in interface IOAuth2CredentialProvider
      Parameters:
      scopes - This parameter is required.
    • grant

      @Stability(Stable) @NotNull default Grant grant(@NotNull IGrantable grantee, @NotNull String... actions)
      Grants IAM actions to the IAM principal.

      Specified by:
      grant in interface IOAuth2CredentialProvider
      Parameters:
      grantee - This parameter is required.
      actions - This parameter is required.
    • grantAdmin

      @Stability(Stable) @NotNull default Grant grantAdmin(@NotNull IGrantable grantee)
      Grant control plane permissions to manage this provider.

      Specified by:
      grantAdmin in interface IOAuth2CredentialProvider
      Parameters:
      grantee - This parameter is required.
    • grantFullAccess

      @Stability(Stable) @NotNull default Grant grantFullAccess(@NotNull IGrantable grantee)
      Grant read, admin, and token retrieval permissions.

      Specified by:
      grantFullAccess in interface IOAuth2CredentialProvider
      Parameters:
      grantee - This parameter is required.
    • grantRead

      @Stability(Stable) @NotNull default Grant grantRead(@NotNull IGrantable grantee)
      Grant GetOauth2CredentialProvider and ListOauth2CredentialProviders, scoped to this provider and parent resources required by the Bedrock AgentCore authorization model.

      Specified by:
      grantRead in interface IOAuth2CredentialProvider
      Parameters:
      grantee - This parameter is required.
    • grantUse

      @Stability(Stable) @NotNull default Grant grantUse(@NotNull IGrantable grantee)
      Grant permission to retrieve OAuth tokens (GetResourceOauth2Token, CompleteResourceTokenAuth).

      Specified by:
      grantUse in interface IOAuth2CredentialProvider
      Parameters:
      grantee - This parameter is required.