We recommend new projects start with resources from the AWS provider.
published on Monday, Jun 15, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
published on Monday, Jun 15, 2026 by Pulumi
Resource Type definition for AWS::BedrockAgentCore::ApiKeyCredentialProvider
Create ApiKeyCredentialProvider Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ApiKeyCredentialProvider(name: string, args?: ApiKeyCredentialProviderArgs, opts?: CustomResourceOptions);@overload
def ApiKeyCredentialProvider(resource_name: str,
args: Optional[ApiKeyCredentialProviderArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def ApiKeyCredentialProvider(resource_name: str,
opts: Optional[ResourceOptions] = None,
api_key: Optional[str] = None,
api_key_secret_config: Optional[ApiKeyCredentialProviderSecretReferenceArgs] = None,
api_key_secret_source: Optional[ApiKeyCredentialProviderApiKeySecretSource] = None,
name: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None)func NewApiKeyCredentialProvider(ctx *Context, name string, args *ApiKeyCredentialProviderArgs, opts ...ResourceOption) (*ApiKeyCredentialProvider, error)public ApiKeyCredentialProvider(string name, ApiKeyCredentialProviderArgs? args = null, CustomResourceOptions? opts = null)
public ApiKeyCredentialProvider(String name, ApiKeyCredentialProviderArgs args)
public ApiKeyCredentialProvider(String name, ApiKeyCredentialProviderArgs args, CustomResourceOptions options)
type: aws-native:bedrockagentcore:ApiKeyCredentialProvider
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "aws-native_bedrockagentcore_apikeycredentialprovider" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args ApiKeyCredentialProviderArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ApiKeyCredentialProviderArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ApiKeyCredentialProviderArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ApiKeyCredentialProviderArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ApiKeyCredentialProviderArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
ApiKeyCredentialProvider Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ApiKeyCredentialProvider resource accepts the following input properties:
- Api
Key string - The API key to use for authentication
- Api
Key Pulumi.Secret Config Aws Native. Bedrock Agent Core. Inputs. Api Key Credential Provider Secret Reference - Configuration for a customer-provided secret containing the API key
- Api
Key Pulumi.Secret Source Aws Native. Bedrock Agent Core. Api Key Credential Provider Api Key Secret Source - The source of the API key secret. Use MANAGED for service-managed secrets or EXTERNAL for customer-provided secrets.
- Name string
- The name of the API key credential provider
-
List<Pulumi.
Aws Native. Inputs. Tag> - Tags to assign to the API key credential provider
- Api
Key string - The API key to use for authentication
- Api
Key ApiSecret Config Key Credential Provider Secret Reference Args - Configuration for a customer-provided secret containing the API key
- Api
Key ApiSecret Source Key Credential Provider Api Key Secret Source - The source of the API key secret. Use MANAGED for service-managed secrets or EXTERNAL for customer-provided secrets.
- Name string
- The name of the API key credential provider
-
Tag
Args - Tags to assign to the API key credential provider
- api_
key string - The API key to use for authentication
- api_
key_ objectsecret_ config - Configuration for a customer-provided secret containing the API key
- api_
key_ "MANAGED" | "EXTERNAL"secret_ source - The source of the API key secret. Use MANAGED for service-managed secrets or EXTERNAL for customer-provided secrets.
- name string
- The name of the API key credential provider
- list(object)
- Tags to assign to the API key credential provider
- api
Key String - The API key to use for authentication
- api
Key ApiSecret Config Key Credential Provider Secret Reference - Configuration for a customer-provided secret containing the API key
- api
Key ApiSecret Source Key Credential Provider Api Key Secret Source - The source of the API key secret. Use MANAGED for service-managed secrets or EXTERNAL for customer-provided secrets.
- name String
- The name of the API key credential provider
- List<Tag>
- Tags to assign to the API key credential provider
- api
Key string - The API key to use for authentication
- api
Key ApiSecret Config Key Credential Provider Secret Reference - Configuration for a customer-provided secret containing the API key
- api
Key ApiSecret Source Key Credential Provider Api Key Secret Source - The source of the API key secret. Use MANAGED for service-managed secrets or EXTERNAL for customer-provided secrets.
- name string
- The name of the API key credential provider
- Tag[]
- Tags to assign to the API key credential provider
- api_
key str - The API key to use for authentication
- api_
key_ Apisecret_ config Key Credential Provider Secret Reference Args - Configuration for a customer-provided secret containing the API key
- api_
key_ Apisecret_ source Key Credential Provider Api Key Secret Source - The source of the API key secret. Use MANAGED for service-managed secrets or EXTERNAL for customer-provided secrets.
- name str
- The name of the API key credential provider
-
Sequence[Tag
Args] - Tags to assign to the API key credential provider
- api
Key String - The API key to use for authentication
- api
Key Property MapSecret Config - Configuration for a customer-provided secret containing the API key
- api
Key "MANAGED" | "EXTERNAL"Secret Source - The source of the API key secret. Use MANAGED for service-managed secrets or EXTERNAL for customer-provided secrets.
- name String
- The name of the API key credential provider
- List<Property Map>
- Tags to assign to the API key credential provider
Outputs
All input properties are implicitly available as output properties. Additionally, the ApiKeyCredentialProvider resource produces the following output properties:
- Api
Key Pulumi.Secret Arn Aws Native. Bedrock Agent Core. Outputs. Api Key Credential Provider Api Key Secret Arn - The ARN of the API key secret in AWS Secrets Manager
- Api
Key stringSecret Json Key - The JSON key within the secret that contains the API key value
- Created
Time string - The timestamp when the credential provider was created
- Credential
Provider stringArn - The Amazon Resource Name (ARN) of the API key credential provider
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Updated stringTime - The timestamp when the credential provider was last updated
- Api
Key ApiSecret Arn Key Credential Provider Api Key Secret Arn - The ARN of the API key secret in AWS Secrets Manager
- Api
Key stringSecret Json Key - The JSON key within the secret that contains the API key value
- Created
Time string - The timestamp when the credential provider was created
- Credential
Provider stringArn - The Amazon Resource Name (ARN) of the API key credential provider
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Updated stringTime - The timestamp when the credential provider was last updated
- api_
key_ objectsecret_ arn - The ARN of the API key secret in AWS Secrets Manager
- api_
key_ stringsecret_ json_ key - The JSON key within the secret that contains the API key value
- created_
time string - The timestamp when the credential provider was created
- credential_
provider_ stringarn - The Amazon Resource Name (ARN) of the API key credential provider
- id string
- The provider-assigned unique ID for this managed resource.
- last_
updated_ stringtime - The timestamp when the credential provider was last updated
- api
Key ApiSecret Arn Key Credential Provider Api Key Secret Arn - The ARN of the API key secret in AWS Secrets Manager
- api
Key StringSecret Json Key - The JSON key within the secret that contains the API key value
- created
Time String - The timestamp when the credential provider was created
- credential
Provider StringArn - The Amazon Resource Name (ARN) of the API key credential provider
- id String
- The provider-assigned unique ID for this managed resource.
- last
Updated StringTime - The timestamp when the credential provider was last updated
- api
Key ApiSecret Arn Key Credential Provider Api Key Secret Arn - The ARN of the API key secret in AWS Secrets Manager
- api
Key stringSecret Json Key - The JSON key within the secret that contains the API key value
- created
Time string - The timestamp when the credential provider was created
- credential
Provider stringArn - The Amazon Resource Name (ARN) of the API key credential provider
- id string
- The provider-assigned unique ID for this managed resource.
- last
Updated stringTime - The timestamp when the credential provider was last updated
- api_
key_ Apisecret_ arn Key Credential Provider Api Key Secret Arn - The ARN of the API key secret in AWS Secrets Manager
- api_
key_ strsecret_ json_ key - The JSON key within the secret that contains the API key value
- created_
time str - The timestamp when the credential provider was created
- credential_
provider_ strarn - The Amazon Resource Name (ARN) of the API key credential provider
- id str
- The provider-assigned unique ID for this managed resource.
- last_
updated_ strtime - The timestamp when the credential provider was last updated
- api
Key Property MapSecret Arn - The ARN of the API key secret in AWS Secrets Manager
- api
Key StringSecret Json Key - The JSON key within the secret that contains the API key value
- created
Time String - The timestamp when the credential provider was created
- credential
Provider StringArn - The Amazon Resource Name (ARN) of the API key credential provider
- id String
- The provider-assigned unique ID for this managed resource.
- last
Updated StringTime - The timestamp when the credential provider was last updated
Supporting Types
ApiKeyCredentialProviderApiKeySecretArn, ApiKeyCredentialProviderApiKeySecretArnArgs
Contains information about the API key secret in AWS Secrets Manager- Secret
Arn string - The ARN of the secret in AWS Secrets Manager
- Secret
Arn string - The ARN of the secret in AWS Secrets Manager
- secret_
arn string - The ARN of the secret in AWS Secrets Manager
- secret
Arn String - The ARN of the secret in AWS Secrets Manager
- secret
Arn string - The ARN of the secret in AWS Secrets Manager
- secret_
arn str - The ARN of the secret in AWS Secrets Manager
- secret
Arn String - The ARN of the secret in AWS Secrets Manager
ApiKeyCredentialProviderApiKeySecretSource, ApiKeyCredentialProviderApiKeySecretSourceArgs
- Managed
MANAGED- External
EXTERNAL
- Api
Key Credential Provider Api Key Secret Source Managed MANAGED- Api
Key Credential Provider Api Key Secret Source External EXTERNAL
- "MANAGED"
MANAGED- "EXTERNAL"
EXTERNAL
- Managed
MANAGED- External
EXTERNAL
- Managed
MANAGED- External
EXTERNAL
- MANAGED
MANAGED- EXTERNAL
EXTERNAL
- "MANAGED"
MANAGED- "EXTERNAL"
EXTERNAL
ApiKeyCredentialProviderSecretReference, ApiKeyCredentialProviderSecretReferenceArgs
A reference to a customer-provided secret stored in AWS Secrets ManagerTag, TagArgs
A set of tags to apply to the resource.Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Monday, Jun 15, 2026 by Pulumi