Package software.amazon.awscdk.services.bedrockagentcore

Interface IApiKeyCredentialProvider.Jsii$Default

All Superinterfaces:
IApiKeyCredentialProvider, IApiKeyCredentialProviderRef, IApiKeyCredentialProviderRef.Jsii$Default, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IEnvironmentAware, IEnvironmentAware.Jsii$Default, IGrantable, IGrantable.Jsii$Default, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
IApiKeyCredentialProvider.Jsii$Proxy
Enclosing interface:
IApiKeyCredentialProvider
@Internal public static interface IApiKeyCredentialProvider.Jsii$Default extends IApiKeyCredentialProvider, IResource.Jsii$Default, IApiKeyCredentialProviderRef.Jsii$Default, IGrantable.Jsii$Default
Internal default implementation for IApiKeyCredentialProvider.

  • Method Details

    • getCredentialProviderArn

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

    • getApiKeySecretArn

      @Stability(Stable) @Nullable default String getApiKeySecretArn()
      The ARN of the Secrets Manager secret that stores the API key after the resource is created.

      May be undefined for resources imported without this attribute.

      Specified by:
      getApiKeySecretArn in interface IApiKeyCredentialProvider

    • getCreatedTime

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

    • getLastUpdatedTime

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

    • bindForGatewayApiKeyTarget

      @Stability(Stable) @NotNull default GatewayApiKeyIdentityBinding bindForGatewayApiKeyTarget()
      ARNs for use with gateway targets (GatewayCredentialProvider.fromApiKeyIdentity or fromApiKeyIdentityArn).
      Specified by:
      bindForGatewayApiKeyTarget in interface IApiKeyCredentialProvider

    • 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 IApiKeyCredentialProvider
      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 IApiKeyCredentialProvider
      Parameters:
      grantee - This parameter is required.

    • grantFullAccess

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

      Specified by:
      grantFullAccess in interface IApiKeyCredentialProvider
      Parameters:
      grantee - This parameter is required.

    • grantRead

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

      Specified by:
      grantRead in interface IApiKeyCredentialProvider
      Parameters:
      grantee - This parameter is required.

    • grantUse

      @Stability(Stable) @NotNull default Grant grantUse(@NotNull IGrantable grantee)
      Grant permission to retrieve API key material for outbound calls (GetResourceApiKey).

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