UseCaseForModelAccess class
Manages an AWS Bedrock Use Case For Model Access.
This is an advanced resource and has special caveats to be aware of when using it. Please read this document in its entirety before using this resource.
The aws.bedrock.UseCaseForModelAccess resource behaves differently from normal resources in that if an Use Case For Model Access already exists, Terraform does not create this resource, but instead "adopts" it into management if it is the same. As the ability to update doesn't exist, changes compared to the existing resource generate an error.
If no Use Case For Model Access exists, Terraform creates a new Use Case For Model Access.
By default, terraform destroy does not delete the Use Case For Model Access but does remove the resource from Terraform state. Real deletion does not exist for this resource.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.bedrock.UseCaseForModelAccess("example", {formData: JSON.stringify({
companyName: "AWS Provider",
companyWebsite: "https://www.test.com",
intendedUsers: "0",
industryOption: "Energy",
otherIndustryOption: "",
useCases: `. - Generating developer documentation
- Code generation/refactoring
- Summarization of issues / documents`,
})});
import pulumi
import json
import pulumi_aws as aws
example = aws.bedrock.UseCaseForModelAccess("example", form_data=json.dumps({
"companyName": "AWS Provider",
"companyWebsite": "https://www.test.com",
"intendedUsers": "0",
"industryOption": "Energy",
"otherIndustryOption": "",
"useCases": """. - Generating developer documentation
- Code generation/refactoring
- Summarization of issues / documents""",
}))
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Bedrock.UseCaseForModelAccess("example", new()
{
FormData = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["companyName"] = "AWS Provider",
["companyWebsite"] = "https://www.test.com",
["intendedUsers"] = "0",
["industryOption"] = "Energy",
["otherIndustryOption"] = "",
["useCases"] = @". - Generating developer documentation
- Code generation/refactoring
- Summarization of issues / documents",
}),
});
});
package main
import (
"encoding/json"
"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 {
tmpJSON0, err := json.Marshal(map[string]string{
"companyName": "AWS Provider",
"companyWebsite": "https://www.test.com",
"intendedUsers": "0",
"industryOption": "Energy",
"otherIndustryOption": "",
"useCases": ". - Generating developer documentation\n- Code generation/refactoring\n- Summarization of issues / documents",
})
if err != nil {
return err
}
json0 := string(tmpJSON0)
_, err = bedrock.NewUseCaseForModelAccess(ctx, "example", &bedrock.UseCaseForModelAccessArgs{
FormData: pulumi.String(json0),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_bedrock_usecaseformodelaccess" "example" {
form_data = jsonencode({
"companyName" = "AWS Provider"
"companyWebsite" = "https://www.test.com"
"intendedUsers" = "0"
"industryOption" = "Energy"
"otherIndustryOption" = ""
"useCases" = ". - Generating developer documentation\n- Code generation/refactoring\n- Summarization of issues / documents"
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.bedrock.UseCaseForModelAccess;
import com.pulumi.aws.bedrock.UseCaseForModelAccessArgs;
import static com.pulumi.codegen.internal.Serialization.*;
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 UseCaseForModelAccess("example", UseCaseForModelAccessArgs.builder()
.formData(serializeJson(
jsonObject(
jsonProperty("companyName", "AWS Provider"),
jsonProperty("companyWebsite", "https://www.test.com"),
jsonProperty("intendedUsers", "0"),
jsonProperty("industryOption", "Energy"),
jsonProperty("otherIndustryOption", ""),
jsonProperty("useCases", """
. - Generating developer documentation
- Code generation/refactoring
- Summarization of issues / documents """)
)))
.build());
}
}
resources:
example:
type: aws:bedrock:UseCaseForModelAccess
properties:
formData:
fn::toJSON:
companyName: AWS Provider
companyWebsite: https://www.test.com
intendedUsers: '0'
industryOption: Energy
otherIndustryOption: ""
useCases: |-
. - Generating developer documentation
- Code generation/refactoring
- Summarization of issues / documents
Import
Identity Schema
Optional
accountId(String) AWS Account where this resource is managed.
Using pulumi import, import AWS Bedrock Use Case For Model Access resources using the AWS account ID. For example:
$ pulumi import aws:bedrock/useCaseForModelAccess:UseCaseForModelAccess example 123456789012
Constructors
- UseCaseForModelAccess(String name, {UseCaseForModelAccessArgs? args, CustomResourceOptions? options})
-
Creates a new UseCaseForModelAccess.
nameThe Pulumi resource name.argsArguments used to configure this UseCaseForModelAccess. The set of arguments for UseCaseForModelAccess.optionsResource options controlling this resource's behavior. - UseCaseForModelAccess.reference(String urn)
- Creates a typed reference to an existing UseCaseForModelAccess resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
formData
↔ Output<
String> -
Form data from the Anthropic first time user request. See also the example payload.
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
-
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
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, {UseCaseForModelAccessState? state, CustomResourceOptions? options}) → UseCaseForModelAccess -
Gets an existing UseCaseForModelAccess resource's state with the given
nameandid.