Package software.amazon.awscdk.services.cleanroomsml

Class CfnConfiguredModelAlgorithm

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.cleanroomsml.CfnConfiguredModelAlgorithm
All Implemented Interfaces:
IInspectable, IConfiguredModelAlgorithmRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-31T09:54:26.662Z") @Stability(Stable) public class CfnConfiguredModelAlgorithm extends CfnResource implements IInspectable, IConfiguredModelAlgorithmRef, ITaggableV2
Definition of AWS::CleanRoomsML::ConfiguredModelAlgorithm Resource Type.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cleanroomsml.*;
 CfnConfiguredModelAlgorithm cfnConfiguredModelAlgorithm = CfnConfiguredModelAlgorithm.Builder.create(this, "MyCfnConfiguredModelAlgorithm")
         .name("name")
         .roleArn("roleArn")
         // the properties below are optional
         .description("description")
         .inferenceContainerConfig(InferenceContainerConfigProperty.builder()
                 .imageUri("imageUri")
                 .build())
         .kmsKeyArn("kmsKeyArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .trainingContainerConfig(ContainerConfigProperty.builder()
                 .imageUri("imageUri")
                 // the properties below are optional
                 .arguments(List.of("arguments"))
                 .entrypoint(List.of("entrypoint"))
                 .metricDefinitions(List.of(MetricDefinitionProperty.builder()
                         .name("name")
                         .regex("regex")
                         .build()))
                 .build())
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnConfiguredModelAlgorithm

      protected CfnConfiguredModelAlgorithm(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnConfiguredModelAlgorithm

      protected CfnConfiguredModelAlgorithm(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnConfiguredModelAlgorithm

      @Stability(Stable) public CfnConfiguredModelAlgorithm(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnConfiguredModelAlgorithmProps props)
      Create a new AWS::CleanRoomsML::ConfiguredModelAlgorithm.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForConfiguredModelAlgorithm

      @Stability(Stable) @NotNull public static String arnForConfiguredModelAlgorithm(@NotNull IConfiguredModelAlgorithmRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnConfiguredModelAlgorithm

      @Stability(Stable) @NotNull public static Boolean isCfnConfiguredModelAlgorithm(@NotNull Object x)
      Checks whether the given object is a CfnConfiguredModelAlgorithm.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrConfiguredModelAlgorithmArn

      @Stability(Stable) @NotNull public String getAttrConfiguredModelAlgorithmArn()

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getConfiguredModelAlgorithmRef

      @Stability(Stable) @NotNull public ConfiguredModelAlgorithmReference getConfiguredModelAlgorithmRef()
      A reference to a ConfiguredModelAlgorithm resource.
      Specified by:
      getConfiguredModelAlgorithmRef in interface IConfiguredModelAlgorithmRef

    • getName

      @Stability(Stable) @NotNull public String getName()

    • setName

      @Stability(Stable) public void setName(@NotNull String value)

    • getRoleArn

      @Stability(Stable) @NotNull public String getRoleArn()

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@NotNull String value)

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)

    • getInferenceContainerConfig

      @Stability(Stable) @Nullable public Object getInferenceContainerConfig()
      Returns union: either IResolvable or CfnConfiguredModelAlgorithm.InferenceContainerConfigProperty

    • setInferenceContainerConfig

      @Stability(Stable) public void setInferenceContainerConfig(@Nullable IResolvable value)

    • setInferenceContainerConfig

      @Stability(Stable) public void setInferenceContainerConfig(@Nullable CfnConfiguredModelAlgorithm.InferenceContainerConfigProperty value)

    • getKmsKeyArn

      @Stability(Stable) @Nullable public String getKmsKeyArn()

    • setKmsKeyArn

      @Stability(Stable) public void setKmsKeyArn(@Nullable String value)

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An arbitrary set of tags (key-value pairs) for this cleanrooms-ml configured model algorithm.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An arbitrary set of tags (key-value pairs) for this cleanrooms-ml configured model algorithm.

    • getTrainingContainerConfig

      @Stability(Stable) @Nullable public Object getTrainingContainerConfig()
      Returns union: either IResolvable or CfnConfiguredModelAlgorithm.ContainerConfigProperty

    • setTrainingContainerConfig

      @Stability(Stable) public void setTrainingContainerConfig(@Nullable IResolvable value)

    • setTrainingContainerConfig

      @Stability(Stable) public void setTrainingContainerConfig(@Nullable CfnConfiguredModelAlgorithm.ContainerConfigProperty value)