Package com.pulumi.aws.sagemaker

Class ModelCard

  • public class ModelCard
extends com.pulumi.resources.CustomResource
    Manage an Amazon SageMaker Model Card. ## Example Usage Basic usage: 
     
 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());
 
     }
 }
    ## Import Using `pulumi import`, import model cards using the `modelCardName`. For example: ```sh $ pulumi import aws:sagemaker/modelCard:ModelCard example my-model-card ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      ModelCard​(java.lang.String name)  
      ModelCard​(java.lang.String name, ModelCardArgs args)  
      ModelCard​(java.lang.String name, ModelCardArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> content()  
      static ModelCard get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ModelCardState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> modelCardArn()  
      com.pulumi.core.Output<java.lang.String> modelCardName()  
      com.pulumi.core.Output<java.lang.String> modelCardStatus()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<ModelCardSecurityConfig>> securityConfig()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.util.Optional<ModelCardTimeouts>> timeouts()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ModelCard

        public ModelCard​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • ModelCard

        public ModelCard​(java.lang.String name,
                 ModelCardArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • ModelCard

        public ModelCard​(java.lang.String name,
                 ModelCardArgs args,
                 @Nullable
                 com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • content

        public com.pulumi.core.Output<java.lang.String> content()
        Returns:
        Content of the model card in [model card JSON schema](https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema).

      • modelCardArn

        public com.pulumi.core.Output<java.lang.String> modelCardArn()
        Returns:
        ARN of the model card.

      • modelCardName

        public com.pulumi.core.Output<java.lang.String> modelCardName()
        Returns:
        Name of the model card.

      • modelCardStatus

        public com.pulumi.core.Output<java.lang.String> modelCardStatus()
        Returns:
        Approval status of the model card. Valid values: `Draft`, `PendingReview`, `Approved`, `Archived`.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • securityConfig

        public com.pulumi.core.Output<java.util.Optional<ModelCardSecurityConfig>> securityConfig()
        Returns:
        KMS key to encrypt, decrypt, and re-encrypt model card content. Fields are documented below.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        A mapping of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • timeouts

        public com.pulumi.core.Output<java.util.Optional<ModelCardTimeouts>> timeouts()

      • get

        public static ModelCard get​(java.lang.String name,
                            com.pulumi.core.Output<java.lang.String> id,
                            @Nullable
                            ModelCardState state,
                            @Nullable
                            com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.