AgentcoreWorkloadIdentity class
Manages an AWS Bedrock AgentCore Workload Identity. Workload Identity provides OAuth2-based authentication and authorization for AI agents to access external resources securely.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.bedrock.AgentcoreWorkloadIdentity("example", {
name: "example-workload-identity",
allowedResourceOauth2ReturnUrls: ["https://example.com/callback"],
});
import pulumi
import pulumi_aws as aws
example = aws.bedrock.AgentcoreWorkloadIdentity("example",
name="example-workload-identity",
allowed_resource_oauth2_return_urls=["https://example.com/callback"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Bedrock.AgentcoreWorkloadIdentity("example", new()
{
Name = "example-workload-identity",
AllowedResourceOauth2ReturnUrls = new[]
{
"https://example.com/callback",
},
});
});
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.NewAgentcoreWorkloadIdentity(ctx, "example", &bedrock.AgentcoreWorkloadIdentityArgs{
Name: pulumi.String("example-workload-identity"),
AllowedResourceOauth2ReturnUrls: pulumi.StringArray{
pulumi.String("https://example.com/callback"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_bedrock_agentcoreworkloadidentity" "example" {
name = "example-workload-identity"
allowed_resource_oauth2_return_urls = ["https://example.com/callback"]
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.bedrock.AgentcoreWorkloadIdentity;
import com.pulumi.aws.bedrock.AgentcoreWorkloadIdentityArgs;
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 AgentcoreWorkloadIdentity("example", AgentcoreWorkloadIdentityArgs.builder()
.name("example-workload-identity")
.allowedResourceOauth2ReturnUrls("https://example.com/callback")
.build());
}
}
resources:
example:
type: aws:bedrock:AgentcoreWorkloadIdentity
properties:
name: example-workload-identity
allowedResourceOauth2ReturnUrls:
- https://example.com/callback
Workload Identity with Multiple Return URLs
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.bedrock.AgentcoreWorkloadIdentity("example", {
name: "example-workload-identity",
allowedResourceOauth2ReturnUrls: [
"https://app.example.com/oauth/callback",
"https://api.example.com/auth/return",
"https://example.com/callback",
],
});
import pulumi
import pulumi_aws as aws
example = aws.bedrock.AgentcoreWorkloadIdentity("example",
name="example-workload-identity",
allowed_resource_oauth2_return_urls=[
"https://app.example.com/oauth/callback",
"https://api.example.com/auth/return",
"https://example.com/callback",
])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Bedrock.AgentcoreWorkloadIdentity("example", new()
{
Name = "example-workload-identity",
AllowedResourceOauth2ReturnUrls = new[]
{
"https://app.example.com/oauth/callback",
"https://api.example.com/auth/return",
"https://example.com/callback",
},
});
});
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.NewAgentcoreWorkloadIdentity(ctx, "example", &bedrock.AgentcoreWorkloadIdentityArgs{
Name: pulumi.String("example-workload-identity"),
AllowedResourceOauth2ReturnUrls: pulumi.StringArray{
pulumi.String("https://app.example.com/oauth/callback"),
pulumi.String("https://api.example.com/auth/return"),
pulumi.String("https://example.com/callback"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_bedrock_agentcoreworkloadidentity" "example" {
name = "example-workload-identity"
allowed_resource_oauth2_return_urls = ["https://app.example.com/oauth/callback", "https://api.example.com/auth/return", "https://example.com/callback"]
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.bedrock.AgentcoreWorkloadIdentity;
import com.pulumi.aws.bedrock.AgentcoreWorkloadIdentityArgs;
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 AgentcoreWorkloadIdentity("example", AgentcoreWorkloadIdentityArgs.builder()
.name("example-workload-identity")
.allowedResourceOauth2ReturnUrls(
"https://app.example.com/oauth/callback",
"https://api.example.com/auth/return",
"https://example.com/callback")
.build());
}
}
resources:
example:
type: aws:bedrock:AgentcoreWorkloadIdentity
properties:
name: example-workload-identity
allowedResourceOauth2ReturnUrls:
- https://app.example.com/oauth/callback
- https://api.example.com/auth/return
- https://example.com/callback
Import
Using pulumi import, import Bedrock AgentCore Workload Identity using the workload identity name. For example:
$ pulumi import aws:bedrock/agentcoreWorkloadIdentity:AgentcoreWorkloadIdentity example example-workload-identity
Constructors
- AgentcoreWorkloadIdentity(String name, {AgentcoreWorkloadIdentityArgs? args, CustomResourceOptions? options})
-
Creates a new AgentcoreWorkloadIdentity.
nameThe Pulumi resource name.argsArguments used to configure this AgentcoreWorkloadIdentity. The set of arguments for AgentcoreWorkloadIdentity.optionsResource options controlling this resource's behavior. - AgentcoreWorkloadIdentity.reference(String urn)
- Creates a typed reference to an existing AgentcoreWorkloadIdentity resource.
Properties
-
allowedResourceOauth2ReturnUrls
↔ Output<
List< String> ?> -
Set of allowed OAuth2 return URLs for resources associated with this workload identity. These URLs are used as valid redirect targets during OAuth2 authentication flows.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- 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 workload identity. Must be 3-255 characters and contain only alphanumeric characters, hyphens, periods, and underscores.
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
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
workloadIdentityArn
↔ Output<
String> -
ARN of the Workload Identity.
latefinal
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, {AgentcoreWorkloadIdentityState? state, CustomResourceOptions? options}) → AgentcoreWorkloadIdentity -
Gets an existing AgentcoreWorkloadIdentity resource's state with the given
nameandid.