AgentcoreApiKeyCredentialProvider class

Manages an AWS Bedrock AgentCore API Key Credential Provider. API Key credential providers enable secure authentication with external services that use API key-based authentication for agent runtimes.

> Note: Write-Only argument apiKeyWo is available to use in place of apiKey. Write-Only arguments are supported in HashiCorp Terraform 1.11.0 and later. Learn more.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.bedrock.AgentcoreApiKeyCredentialProvider("example", {
    name: "example-api-key-provider",
    apiKey: "your-api-key-here",
});
import pulumi
import pulumi_aws as aws

example = aws.bedrock.AgentcoreApiKeyCredentialProvider("example",
    name="example-api-key-provider",
    api_key="your-api-key-here")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Bedrock.AgentcoreApiKeyCredentialProvider("example", new()
    {
        Name = "example-api-key-provider",
        ApiKey = "your-api-key-here",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/bedrock"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := bedrock.NewAgentcoreApiKeyCredentialProvider(ctx, "example", &bedrock.AgentcoreApiKeyCredentialProviderArgs{
			Name:   pulumi.String("example-api-key-provider"),
			ApiKey: pulumi.String("your-api-key-here"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_bedrock_agentcoreapikeycredentialprovider" "example" {
  name    = "example-api-key-provider"
  api_key = "your-api-key-here"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.bedrock.AgentcoreApiKeyCredentialProvider;
import com.pulumi.aws.bedrock.AgentcoreApiKeyCredentialProviderArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new AgentcoreApiKeyCredentialProvider("example", AgentcoreApiKeyCredentialProviderArgs.builder()
            .name("example-api-key-provider")
            .apiKey("your-api-key-here")
            .build());

    }
}
resources:
  example:
    type: aws:bedrock:AgentcoreApiKeyCredentialProvider
    properties:
      name: example-api-key-provider
      apiKey: your-api-key-here
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.bedrock.AgentcoreApiKeyCredentialProvider("example", {
    name: "example-api-key-provider",
    apiKeyWo: "your-api-key-here",
    apiKeyWoVersion: 1,
});
import pulumi
import pulumi_aws as aws

example = aws.bedrock.AgentcoreApiKeyCredentialProvider("example",
    name="example-api-key-provider",
    api_key_wo="your-api-key-here",
    api_key_wo_version=1)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Bedrock.AgentcoreApiKeyCredentialProvider("example", new()
    {
        Name = "example-api-key-provider",
        ApiKeyWo = "your-api-key-here",
        ApiKeyWoVersion = 1,
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/bedrock"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := bedrock.NewAgentcoreApiKeyCredentialProvider(ctx, "example", &bedrock.AgentcoreApiKeyCredentialProviderArgs{
			Name:            pulumi.String("example-api-key-provider"),
			ApiKeyWo:        pulumi.String("your-api-key-here"),
			ApiKeyWoVersion: pulumi.Int(1),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_bedrock_agentcoreapikeycredentialprovider" "example" {
  name               = "example-api-key-provider"
  api_key_wo         = "your-api-key-here"
  api_key_wo_version = 1
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.bedrock.AgentcoreApiKeyCredentialProvider;
import com.pulumi.aws.bedrock.AgentcoreApiKeyCredentialProviderArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new AgentcoreApiKeyCredentialProvider("example", AgentcoreApiKeyCredentialProviderArgs.builder()
            .name("example-api-key-provider")
            .apiKeyWo("your-api-key-here")
            .apiKeyWoVersion(1)
            .build());

    }
}
resources:
  example:
    type: aws:bedrock:AgentcoreApiKeyCredentialProvider
    properties:
      name: example-api-key-provider
      apiKeyWo: your-api-key-here
      apiKeyWoVersion: 1

Import

Using pulumi import, import Bedrock AgentCore API Key Credential Provider using the provider name. For example:

$ pulumi import aws:bedrock/agentcoreApiKeyCredentialProvider:AgentcoreApiKeyCredentialProvider example example-api-key-provider

Constructors

AgentcoreApiKeyCredentialProvider(String name, {AgentcoreApiKeyCredentialProviderArgs? args, CustomResourceOptions? options})
Creates a new AgentcoreApiKeyCredentialProvider. name The Pulumi resource name. args Arguments used to configure this AgentcoreApiKeyCredentialProvider. The set of arguments for AgentcoreApiKeyCredentialProvider. options Resource options controlling this resource's behavior.
AgentcoreApiKeyCredentialProvider.reference(String urn)
Creates a typed reference to an existing AgentcoreApiKeyCredentialProvider resource.

Properties

apiKey ↔ Output<String?>
API key value. Cannot be used with apiKeyWo. This value will be visible in pulumi preview outputs and logs.
latefinal
apiKeySecretArns ↔ Output<List<AgentcoreApiKeyCredentialProviderApiKeySecretArn>>
ARN of the AWS Secrets Manager secret containing the API key.
latefinal
apiKeyWo ↔ Output<String?>
NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only API key value. Cannot be used with apiKey. Must be used together with apiKeyWoVersion.
latefinal
apiKeyWoVersion ↔ Output<int?>
Used together with apiKeyWo to trigger an update. Increment this value when an update to apiKeyWo is required.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
credentialProviderArn ↔ Output<String>
ARN of the API Key credential provider.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
name ↔ Output<String>
Name of the API Key credential provider. Forces replacement when changed.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags ↔ Output<Map<String, String>?>
Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {AgentcoreApiKeyCredentialProviderState? state, CustomResourceOptions? options}) → AgentcoreApiKeyCredentialProvider
Gets an existing AgentcoreApiKeyCredentialProvider resource's state with the given name and id.