Package software.amazon.awscdk.services.bedrockagentcore

Class CfnApiKeyCredentialProvider

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.CfnApiKeyCredentialProvider
All Implemented Interfaces:
IInspectable, IApiKeyCredentialProviderRef, 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.046Z") @Stability(Stable) public class CfnApiKeyCredentialProvider extends CfnResource implements IInspectable, IApiKeyCredentialProviderRef, ITaggableV2
Resource Type definition for AWS::BedrockAgentCore::ApiKeyCredentialProvider.

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.*;
 CfnApiKeyCredentialProvider cfnApiKeyCredentialProvider = CfnApiKeyCredentialProvider.Builder.create(this, "MyCfnApiKeyCredentialProvider")
         .name("name")
         // the properties below are optional
         .apiKey("apiKey")
         .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

    • CfnApiKeyCredentialProvider

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

    • CfnApiKeyCredentialProvider

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

    • CfnApiKeyCredentialProvider

      @Stability(Stable) public CfnApiKeyCredentialProvider(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnApiKeyCredentialProviderProps props)
      Create a new AWS::BedrockAgentCore::ApiKeyCredentialProvider.

      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

    • isCfnApiKeyCredentialProvider

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

      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.

    • getApiKeyCredentialProviderRef

      @Stability(Stable) @NotNull public ApiKeyCredentialProviderReference getApiKeyCredentialProviderRef()
      A reference to a ApiKeyCredentialProvider resource.
      Specified by:
      getApiKeyCredentialProviderRef in interface IApiKeyCredentialProviderRef

    • getAttrApiKeySecretArn

      @Stability(Stable) @NotNull public IResolvable getAttrApiKeySecretArn()
      Contains information about the API key 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 API key credential provider.

    • getAttrLastUpdatedTime

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

    • 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

    • getName

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

    • setName

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

    • getApiKey

      @Stability(Stable) @Nullable public String getApiKey()
      The API key to use for authentication.

    • setApiKey

      @Stability(Stable) public void setApiKey(@Nullable String value)
      The API key to use for authentication.

    • getTags

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

    • setTags

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