ModelCard class
Manage an Amazon SageMaker Model Card.
Example Usage
Basic usage:
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.sagemaker.ModelCard("example", {
modelCardName: "my-model-card",
modelCardStatus: "Draft",
content: `{
\\"business_details\\": {
\\"business_problem\\": \\"Quality\\"
},
\\"intended_uses\\": {
\\"intended_uses\\": \\"Testing\\"
},
\\"additional_information\\": {
\\"caveats_and_recommendations\\": \\"Use this\\"
}
}
`,
});
import pulumi
import pulumi_aws as aws
example = aws.sagemaker.ModelCard("example",
model_card_name="my-model-card",
model_card_status="Draft",
content="""{
\"business_details\": {
\"business_problem\": \"Quality\"
},
\"intended_uses\": {
\"intended_uses\": \"Testing\"
},
\"additional_information\": {
\"caveats_and_recommendations\": \"Use this\"
}
}
""")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Sagemaker.ModelCard("example", new()
{
ModelCardName = "my-model-card",
ModelCardStatus = "Draft",
Content = @"{
\""business_details\"": {
\""business_problem\"": \""Quality\""
},
\""intended_uses\"": {
\""intended_uses\"": \""Testing\""
},
\""additional_information\"": {
\""caveats_and_recommendations\"": \""Use this\""
}
}
",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/sagemaker"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := sagemaker.NewModelCard(ctx, "example", &sagemaker.ModelCardArgs{
ModelCardName: pulumi.String("my-model-card"),
ModelCardStatus: pulumi.String("Draft"),
Content: pulumi.String(`{
\"business_details\": {
\"business_problem\": \"Quality\"
},
\"intended_uses\": {
\"intended_uses\": \"Testing\"
},
\"additional_information\": {
\"caveats_and_recommendations\": \"Use this\"
}
}
`),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_sagemaker_modelcard" "example" {
model_card_name = "my-model-card"
model_card_status = "Draft"
content = "{\n \\\"business_details\\\": {\n \\\"business_problem\\\": \\\"Quality\\\"\n },\n \\\"intended_uses\\\": {\n \\\"intended_uses\\\": \\\"Testing\\\"\n },\n \\\"additional_information\\\": {\n \\\"caveats_and_recommendations\\\": \\\"Use this\\\"\n }\n}\n"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sagemaker.ModelCard;
import com.pulumi.aws.sagemaker.ModelCardArgs;
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 ModelCard("example", ModelCardArgs.builder()
.modelCardName("my-model-card")
.modelCardStatus("Draft")
.content("""
{
\"business_details\": {
\"business_problem\": \"Quality\"
},
\"intended_uses\": {
\"intended_uses\": \"Testing\"
},
\"additional_information\": {
\"caveats_and_recommendations\": \"Use this\"
}
}
""")
.build());
}
}
resources:
example:
type: aws:sagemaker:ModelCard
properties:
modelCardName: my-model-card
modelCardStatus: Draft
content: |
{
\"business_details\": {
\"business_problem\": \"Quality\"
},
\"intended_uses\": {
\"intended_uses\": \"Testing\"
},
\"additional_information\": {
\"caveats_and_recommendations\": \"Use this\"
}
}
Import
Using pulumi import, import model cards using the modelCardName. For example:
$ pulumi import aws:sagemaker/modelCard:ModelCard example my-model-card
Constructors
- ModelCard(String name, {ModelCardArgs? args, CustomResourceOptions? options})
-
Creates a new ModelCard.
nameThe Pulumi resource name.argsArguments used to configure this ModelCard. The set of arguments for ModelCard.optionsResource options controlling this resource's behavior. - ModelCard.reference(String urn)
- Creates a typed reference to an existing ModelCard resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
content
↔ Output<
String> -
Content of the model card in model card JSON schema.
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
-
modelCardArn
↔ Output<
String> -
ARN of the model card.
latefinal
-
modelCardName
↔ Output<
String> -
Name of the model card.
latefinal
-
modelCardStatus
↔ Output<
String> -
Approval status of the model card. Valid values:
Draft,PendingReview,Approved,Archived.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
-
securityConfig
↔ Output<
ModelCardSecurityConfig?> -
KMS key to encrypt, decrypt, and re-encrypt model card content. Fields are documented below.
latefinal
-
A mapping of tags to assign to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
timeouts
↔ Output<
ModelCardTimeouts?> -
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