io.cloudshiftdev.awscdk.services.sagemaker.CfnInferenceComponent.kt Maven / Gradle / Ivy
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package io.cloudshiftdev.awscdk.services.sagemaker
import io.cloudshiftdev.awscdk.CfnResource
import io.cloudshiftdev.awscdk.CfnTag
import io.cloudshiftdev.awscdk.IInspectable
import io.cloudshiftdev.awscdk.IResolvable
import io.cloudshiftdev.awscdk.ITaggableV2
import io.cloudshiftdev.awscdk.TagManager
import io.cloudshiftdev.awscdk.TreeInspector
import io.cloudshiftdev.awscdk.common.CdkDslMarker
import io.cloudshiftdev.awscdk.common.CdkObject
import io.cloudshiftdev.awscdk.common.CdkObjectWrappers
import kotlin.Any
import kotlin.Number
import kotlin.String
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
import kotlin.jvm.JvmName
import io.cloudshiftdev.constructs.Construct as CloudshiftdevConstructsConstruct
import software.constructs.Construct as SoftwareConstructsConstruct
/**
* Creates an inference component, which is a SageMaker hosting object that you can use to deploy a
* model to an endpoint.
*
* In the inference component settings, you specify the model, the endpoint, and how the model
* utilizes the resources that the endpoint hosts. You can optimize resource utilization by tailoring
* how the required CPU cores, accelerators, and memory are allocated. You can deploy multiple
* inference components to an endpoint, where each inference component contains one model and the
* resource utilization needs for that individual model. After you deploy an inference component, you
* can directly invoke the associated model when you use the InvokeEndpoint API action.
*
* Example:
*
* ```
* // The code below shows an example of how to instantiate this type.
* // The values are placeholders you should change.
* import io.cloudshiftdev.awscdk.services.sagemaker.*;
* CfnInferenceComponent cfnInferenceComponent = CfnInferenceComponent.Builder.create(this,
* "MyCfnInferenceComponent")
* .endpointName("endpointName")
* .runtimeConfig(InferenceComponentRuntimeConfigProperty.builder()
* .copyCount(123)
* .currentCopyCount(123)
* .desiredCopyCount(123)
* .build())
* .specification(InferenceComponentSpecificationProperty.builder()
* .computeResourceRequirements(InferenceComponentComputeResourceRequirementsProperty.builder()
* .maxMemoryRequiredInMb(123)
* .minMemoryRequiredInMb(123)
* .numberOfAcceleratorDevicesRequired(123)
* .numberOfCpuCoresRequired(123)
* .build())
* // the properties below are optional
* .container(InferenceComponentContainerSpecificationProperty.builder()
* .artifactUrl("artifactUrl")
* .deployedImage(DeployedImageProperty.builder()
* .resolutionTime("resolutionTime")
* .resolvedImage("resolvedImage")
* .specifiedImage("specifiedImage")
* .build())
* .environment(Map.of(
* "environmentKey", "environment"))
* .image("image")
* .build())
* .modelName("modelName")
* .startupParameters(InferenceComponentStartupParametersProperty.builder()
* .containerStartupHealthCheckTimeoutInSeconds(123)
* .modelDataDownloadTimeoutInSeconds(123)
* .build())
* .build())
* .variantName("variantName")
* // the properties below are optional
* .endpointArn("endpointArn")
* .inferenceComponentName("inferenceComponentName")
* .tags(List.of(CfnTag.builder()
* .key("key")
* .value("value")
* .build()))
* .build();
* ```
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html)
*/
public open class CfnInferenceComponent(
cdkObject: software.amazon.awscdk.services.sagemaker.CfnInferenceComponent,
) : CfnResource(cdkObject),
IInspectable,
ITaggableV2 {
public constructor(
scope: CloudshiftdevConstructsConstruct,
id: String,
props: CfnInferenceComponentProps,
) :
this(software.amazon.awscdk.services.sagemaker.CfnInferenceComponent(scope.let(CloudshiftdevConstructsConstruct.Companion::unwrap),
id, props.let(CfnInferenceComponentProps.Companion::unwrap))
)
public constructor(
scope: CloudshiftdevConstructsConstruct,
id: String,
props: CfnInferenceComponentProps.Builder.() -> Unit,
) : this(scope, id, CfnInferenceComponentProps(props)
)
/**
* The time when the inference component was created.
*/
public open fun attrCreationTime(): String = unwrap(this).getAttrCreationTime()
/**
* The failure reason if the inference component is in a failed state.
*/
public open fun attrFailureReason(): String = unwrap(this).getAttrFailureReason()
/**
* The Amazon Resource Name (ARN) of the inference component.
*/
public open fun attrInferenceComponentArn(): String = unwrap(this).getAttrInferenceComponentArn()
/**
* The status of the inference component.
*/
public open fun attrInferenceComponentStatus(): String =
unwrap(this).getAttrInferenceComponentStatus()
/**
* The time when the inference component was last updated.
*/
public open fun attrLastModifiedTime(): String = unwrap(this).getAttrLastModifiedTime()
/**
* The number of runtime copies of the model container that are currently deployed.
*/
public open fun attrRuntimeConfigCurrentCopyCount(): Number =
unwrap(this).getAttrRuntimeConfigCurrentCopyCount()
/**
* The number of runtime copies of the model container that you requested to deploy with the
* inference component.
*/
public open fun attrRuntimeConfigDesiredCopyCount(): Number =
unwrap(this).getAttrRuntimeConfigDesiredCopyCount()
/**
*
*/
public open fun attrSpecificationContainerDeployedImage(): IResolvable =
unwrap(this).getAttrSpecificationContainerDeployedImage().let(IResolvable::wrap)
/**
* Tag Manager which manages the tags for this resource.
*/
public override fun cdkTagManager(): TagManager =
unwrap(this).getCdkTagManager().let(TagManager::wrap)
/**
* The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.
*/
public open fun endpointArn(): String? = unwrap(this).getEndpointArn()
/**
* The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.
*/
public open fun endpointArn(`value`: String) {
unwrap(this).setEndpointArn(`value`)
}
/**
* The name of the endpoint that hosts the inference component.
*/
public open fun endpointName(): String = unwrap(this).getEndpointName()
/**
* The name of the endpoint that hosts the inference component.
*/
public open fun endpointName(`value`: String) {
unwrap(this).setEndpointName(`value`)
}
/**
* The name of the inference component.
*/
public open fun inferenceComponentName(): String? = unwrap(this).getInferenceComponentName()
/**
* The name of the inference component.
*/
public open fun inferenceComponentName(`value`: String) {
unwrap(this).setInferenceComponentName(`value`)
}
/**
* Examines the CloudFormation resource and discloses attributes.
*
* @param inspector tree inspector to collect and process attributes.
*/
public override fun inspect(inspector: TreeInspector) {
unwrap(this).inspect(inspector.let(TreeInspector.Companion::unwrap))
}
/**
* The runtime config for the inference component.
*/
public open fun runtimeConfig(): Any = unwrap(this).getRuntimeConfig()
/**
* The runtime config for the inference component.
*/
public open fun runtimeConfig(`value`: IResolvable) {
unwrap(this).setRuntimeConfig(`value`.let(IResolvable.Companion::unwrap))
}
/**
* The runtime config for the inference component.
*/
public open fun runtimeConfig(`value`: InferenceComponentRuntimeConfigProperty) {
unwrap(this).setRuntimeConfig(`value`.let(InferenceComponentRuntimeConfigProperty.Companion::unwrap))
}
/**
* The runtime config for the inference component.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("df395dd72cc8a0a25d1c75ea2c1ab61453578df2ea59f8c9d4be8fa98876dbb2")
public open
fun runtimeConfig(`value`: InferenceComponentRuntimeConfigProperty.Builder.() -> Unit): Unit =
runtimeConfig(InferenceComponentRuntimeConfigProperty(`value`))
/**
* The specification for the inference component.
*/
public open fun specification(): Any = unwrap(this).getSpecification()
/**
* The specification for the inference component.
*/
public open fun specification(`value`: IResolvable) {
unwrap(this).setSpecification(`value`.let(IResolvable.Companion::unwrap))
}
/**
* The specification for the inference component.
*/
public open fun specification(`value`: InferenceComponentSpecificationProperty) {
unwrap(this).setSpecification(`value`.let(InferenceComponentSpecificationProperty.Companion::unwrap))
}
/**
* The specification for the inference component.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("bca15f5e1adf3b33786cab41801739fff5bc2f74aac0f5a3a9940b5e0236b802")
public open
fun specification(`value`: InferenceComponentSpecificationProperty.Builder.() -> Unit): Unit =
specification(InferenceComponentSpecificationProperty(`value`))
/**
* An array of tags to apply to the resource.
*/
public open fun tags(): List = unwrap(this).getTags()?.map(CfnTag::wrap) ?: emptyList()
/**
* An array of tags to apply to the resource.
*/
public open fun tags(`value`: List) {
unwrap(this).setTags(`value`.map(CfnTag.Companion::unwrap))
}
/**
* An array of tags to apply to the resource.
*/
public open fun tags(vararg `value`: CfnTag): Unit = tags(`value`.toList())
/**
* The name of the production variant that hosts the inference component.
*/
public open fun variantName(): String = unwrap(this).getVariantName()
/**
* The name of the production variant that hosts the inference component.
*/
public open fun variantName(`value`: String) {
unwrap(this).setVariantName(`value`)
}
/**
* A fluent builder for [io.cloudshiftdev.awscdk.services.sagemaker.CfnInferenceComponent].
*/
@CdkDslMarker
public interface Builder {
/**
* The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-endpointarn)
* @param endpointArn The Amazon Resource Name (ARN) of the endpoint that hosts the inference
* component.
*/
public fun endpointArn(endpointArn: String)
/**
* The name of the endpoint that hosts the inference component.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-endpointname)
* @param endpointName The name of the endpoint that hosts the inference component.
*/
public fun endpointName(endpointName: String)
/**
* The name of the inference component.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-inferencecomponentname)
* @param inferenceComponentName The name of the inference component.
*/
public fun inferenceComponentName(inferenceComponentName: String)
/**
* The runtime config for the inference component.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-runtimeconfig)
* @param runtimeConfig The runtime config for the inference component.
*/
public fun runtimeConfig(runtimeConfig: IResolvable)
/**
* The runtime config for the inference component.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-runtimeconfig)
* @param runtimeConfig The runtime config for the inference component.
*/
public fun runtimeConfig(runtimeConfig: InferenceComponentRuntimeConfigProperty)
/**
* The runtime config for the inference component.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-runtimeconfig)
* @param runtimeConfig The runtime config for the inference component.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("6afac6df923c3d8419f2d3ff5f1def435217dfa9f6a56e2e3094dea054a47711")
public
fun runtimeConfig(runtimeConfig: InferenceComponentRuntimeConfigProperty.Builder.() -> Unit)
/**
* The specification for the inference component.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-specification)
* @param specification The specification for the inference component.
*/
public fun specification(specification: IResolvable)
/**
* The specification for the inference component.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-specification)
* @param specification The specification for the inference component.
*/
public fun specification(specification: InferenceComponentSpecificationProperty)
/**
* The specification for the inference component.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-specification)
* @param specification The specification for the inference component.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("7829741ee3827433f0932668ce991537fd59ad2432d6b2302f8cd800ef7cdb17")
public
fun specification(specification: InferenceComponentSpecificationProperty.Builder.() -> Unit)
/**
* An array of tags to apply to the resource.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-tags)
* @param tags An array of tags to apply to the resource.
*/
public fun tags(tags: List)
/**
* An array of tags to apply to the resource.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-tags)
* @param tags An array of tags to apply to the resource.
*/
public fun tags(vararg tags: CfnTag)
/**
* The name of the production variant that hosts the inference component.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-variantname)
* @param variantName The name of the production variant that hosts the inference component.
*/
public fun variantName(variantName: String)
}
private class BuilderImpl(
scope: SoftwareConstructsConstruct,
id: String,
) : Builder {
private val cdkBuilder: software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.Builder
= software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.Builder.create(scope, id)
/**
* The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-endpointarn)
* @param endpointArn The Amazon Resource Name (ARN) of the endpoint that hosts the inference
* component.
*/
override fun endpointArn(endpointArn: String) {
cdkBuilder.endpointArn(endpointArn)
}
/**
* The name of the endpoint that hosts the inference component.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-endpointname)
* @param endpointName The name of the endpoint that hosts the inference component.
*/
override fun endpointName(endpointName: String) {
cdkBuilder.endpointName(endpointName)
}
/**
* The name of the inference component.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-inferencecomponentname)
* @param inferenceComponentName The name of the inference component.
*/
override fun inferenceComponentName(inferenceComponentName: String) {
cdkBuilder.inferenceComponentName(inferenceComponentName)
}
/**
* The runtime config for the inference component.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-runtimeconfig)
* @param runtimeConfig The runtime config for the inference component.
*/
override fun runtimeConfig(runtimeConfig: IResolvable) {
cdkBuilder.runtimeConfig(runtimeConfig.let(IResolvable.Companion::unwrap))
}
/**
* The runtime config for the inference component.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-runtimeconfig)
* @param runtimeConfig The runtime config for the inference component.
*/
override fun runtimeConfig(runtimeConfig: InferenceComponentRuntimeConfigProperty) {
cdkBuilder.runtimeConfig(runtimeConfig.let(InferenceComponentRuntimeConfigProperty.Companion::unwrap))
}
/**
* The runtime config for the inference component.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-runtimeconfig)
* @param runtimeConfig The runtime config for the inference component.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("6afac6df923c3d8419f2d3ff5f1def435217dfa9f6a56e2e3094dea054a47711")
override
fun runtimeConfig(runtimeConfig: InferenceComponentRuntimeConfigProperty.Builder.() -> Unit):
Unit = runtimeConfig(InferenceComponentRuntimeConfigProperty(runtimeConfig))
/**
* The specification for the inference component.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-specification)
* @param specification The specification for the inference component.
*/
override fun specification(specification: IResolvable) {
cdkBuilder.specification(specification.let(IResolvable.Companion::unwrap))
}
/**
* The specification for the inference component.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-specification)
* @param specification The specification for the inference component.
*/
override fun specification(specification: InferenceComponentSpecificationProperty) {
cdkBuilder.specification(specification.let(InferenceComponentSpecificationProperty.Companion::unwrap))
}
/**
* The specification for the inference component.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-specification)
* @param specification The specification for the inference component.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("7829741ee3827433f0932668ce991537fd59ad2432d6b2302f8cd800ef7cdb17")
override
fun specification(specification: InferenceComponentSpecificationProperty.Builder.() -> Unit):
Unit = specification(InferenceComponentSpecificationProperty(specification))
/**
* An array of tags to apply to the resource.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-tags)
* @param tags An array of tags to apply to the resource.
*/
override fun tags(tags: List) {
cdkBuilder.tags(tags.map(CfnTag.Companion::unwrap))
}
/**
* An array of tags to apply to the resource.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-tags)
* @param tags An array of tags to apply to the resource.
*/
override fun tags(vararg tags: CfnTag): Unit = tags(tags.toList())
/**
* The name of the production variant that hosts the inference component.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-variantname)
* @param variantName The name of the production variant that hosts the inference component.
*/
override fun variantName(variantName: String) {
cdkBuilder.variantName(variantName)
}
public fun build(): software.amazon.awscdk.services.sagemaker.CfnInferenceComponent =
cdkBuilder.build()
}
public companion object {
public val CFN_RESOURCE_TYPE_NAME: String =
software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.CFN_RESOURCE_TYPE_NAME
public operator fun invoke(
scope: CloudshiftdevConstructsConstruct,
id: String,
block: Builder.() -> Unit = {},
): CfnInferenceComponent {
val builderImpl = BuilderImpl(CloudshiftdevConstructsConstruct.unwrap(scope), id)
return CfnInferenceComponent(builderImpl.apply(block).build())
}
internal fun wrap(cdkObject: software.amazon.awscdk.services.sagemaker.CfnInferenceComponent):
CfnInferenceComponent = CfnInferenceComponent(cdkObject)
internal fun unwrap(wrapped: CfnInferenceComponent):
software.amazon.awscdk.services.sagemaker.CfnInferenceComponent = wrapped.cdkObject as
software.amazon.awscdk.services.sagemaker.CfnInferenceComponent
}
/**
* Gets the Amazon EC2 Container Registry path of the docker image of the model that is hosted in
* this
* [ProductionVariant](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariant.html)
* .
*
* If you used the `registry/repository[:tag]` form to specify the image path of the primary
* container when you created the model hosted in this `ProductionVariant` , the path resolves to a
* path of the form `registry/repository[@digest]` . A digest is a hash value that identifies a
* specific version of an image. For information about Amazon ECR paths, see [Pulling an
* Image](https://docs.aws.amazon.com//AmazonECR/latest/userguide/docker-pull-ecr-image.html) in the
* *Amazon ECR User Guide* .
*
* Example:
*
* ```
* // The code below shows an example of how to instantiate this type.
* // The values are placeholders you should change.
* import io.cloudshiftdev.awscdk.services.sagemaker.*;
* DeployedImageProperty deployedImageProperty = DeployedImageProperty.builder()
* .resolutionTime("resolutionTime")
* .resolvedImage("resolvedImage")
* .specifiedImage("specifiedImage")
* .build();
* ```
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-deployedimage.html)
*/
public interface DeployedImageProperty {
/**
* The date and time when the image path for the model resolved to the `ResolvedImage`.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-deployedimage.html#cfn-sagemaker-inferencecomponent-deployedimage-resolutiontime)
*/
public fun resolutionTime(): String? = unwrap(this).getResolutionTime()
/**
* The specific digest path of the image hosted in this `ProductionVariant` .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-deployedimage.html#cfn-sagemaker-inferencecomponent-deployedimage-resolvedimage)
*/
public fun resolvedImage(): String? = unwrap(this).getResolvedImage()
/**
* The image path you specified when you created the model.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-deployedimage.html#cfn-sagemaker-inferencecomponent-deployedimage-specifiedimage)
*/
public fun specifiedImage(): String? = unwrap(this).getSpecifiedImage()
/**
* A builder for [DeployedImageProperty]
*/
@CdkDslMarker
public interface Builder {
/**
* @param resolutionTime The date and time when the image path for the model resolved to the
* `ResolvedImage`.
*/
public fun resolutionTime(resolutionTime: String)
/**
* @param resolvedImage The specific digest path of the image hosted in this
* `ProductionVariant` .
*/
public fun resolvedImage(resolvedImage: String)
/**
* @param specifiedImage The image path you specified when you created the model.
*/
public fun specifiedImage(specifiedImage: String)
}
private class BuilderImpl : Builder {
private val cdkBuilder:
software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.DeployedImageProperty.Builder
=
software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.DeployedImageProperty.builder()
/**
* @param resolutionTime The date and time when the image path for the model resolved to the
* `ResolvedImage`.
*/
override fun resolutionTime(resolutionTime: String) {
cdkBuilder.resolutionTime(resolutionTime)
}
/**
* @param resolvedImage The specific digest path of the image hosted in this
* `ProductionVariant` .
*/
override fun resolvedImage(resolvedImage: String) {
cdkBuilder.resolvedImage(resolvedImage)
}
/**
* @param specifiedImage The image path you specified when you created the model.
*/
override fun specifiedImage(specifiedImage: String) {
cdkBuilder.specifiedImage(specifiedImage)
}
public fun build():
software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.DeployedImageProperty =
cdkBuilder.build()
}
private class Wrapper(
cdkObject: software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.DeployedImageProperty,
) : CdkObject(cdkObject),
DeployedImageProperty {
/**
* The date and time when the image path for the model resolved to the `ResolvedImage`.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-deployedimage.html#cfn-sagemaker-inferencecomponent-deployedimage-resolutiontime)
*/
override fun resolutionTime(): String? = unwrap(this).getResolutionTime()
/**
* The specific digest path of the image hosted in this `ProductionVariant` .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-deployedimage.html#cfn-sagemaker-inferencecomponent-deployedimage-resolvedimage)
*/
override fun resolvedImage(): String? = unwrap(this).getResolvedImage()
/**
* The image path you specified when you created the model.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-deployedimage.html#cfn-sagemaker-inferencecomponent-deployedimage-specifiedimage)
*/
override fun specifiedImage(): String? = unwrap(this).getSpecifiedImage()
}
public companion object {
public operator fun invoke(block: Builder.() -> Unit = {}): DeployedImageProperty {
val builderImpl = BuilderImpl()
return Wrapper(builderImpl.apply(block).build())
}
internal
fun wrap(cdkObject: software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.DeployedImageProperty):
DeployedImageProperty = CdkObjectWrappers.wrap(cdkObject) as? DeployedImageProperty ?:
Wrapper(cdkObject)
internal fun unwrap(wrapped: DeployedImageProperty):
software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.DeployedImageProperty =
(wrapped as CdkObject).cdkObject as
software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.DeployedImageProperty
}
}
/**
* Defines the compute resources to allocate to run a model that you assign to an inference
* component.
*
* These resources include CPU cores, accelerators, and memory.
*
* Example:
*
* ```
* // The code below shows an example of how to instantiate this type.
* // The values are placeholders you should change.
* import io.cloudshiftdev.awscdk.services.sagemaker.*;
* InferenceComponentComputeResourceRequirementsProperty
* inferenceComponentComputeResourceRequirementsProperty =
* InferenceComponentComputeResourceRequirementsProperty.builder()
* .maxMemoryRequiredInMb(123)
* .minMemoryRequiredInMb(123)
* .numberOfAcceleratorDevicesRequired(123)
* .numberOfCpuCoresRequired(123)
* .build();
* ```
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements.html)
*/
public interface InferenceComponentComputeResourceRequirementsProperty {
/**
* The maximum MB of memory to allocate to run a model that you assign to an inference
* component.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements.html#cfn-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements-maxmemoryrequiredinmb)
*/
public fun maxMemoryRequiredInMb(): Number? = unwrap(this).getMaxMemoryRequiredInMb()
/**
* The minimum MB of memory to allocate to run a model that you assign to an inference
* component.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements.html#cfn-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements-minmemoryrequiredinmb)
*/
public fun minMemoryRequiredInMb(): Number? = unwrap(this).getMinMemoryRequiredInMb()
/**
* The number of accelerators to allocate to run a model that you assign to an inference
* component.
*
* Accelerators include GPUs and AWS Inferentia.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements.html#cfn-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements-numberofacceleratordevicesrequired)
*/
public fun numberOfAcceleratorDevicesRequired(): Number? =
unwrap(this).getNumberOfAcceleratorDevicesRequired()
/**
* The number of CPU cores to allocate to run a model that you assign to an inference component.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements.html#cfn-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements-numberofcpucoresrequired)
*/
public fun numberOfCpuCoresRequired(): Number? = unwrap(this).getNumberOfCpuCoresRequired()
/**
* A builder for [InferenceComponentComputeResourceRequirementsProperty]
*/
@CdkDslMarker
public interface Builder {
/**
* @param maxMemoryRequiredInMb The maximum MB of memory to allocate to run a model that you
* assign to an inference component.
*/
public fun maxMemoryRequiredInMb(maxMemoryRequiredInMb: Number)
/**
* @param minMemoryRequiredInMb The minimum MB of memory to allocate to run a model that you
* assign to an inference component.
*/
public fun minMemoryRequiredInMb(minMemoryRequiredInMb: Number)
/**
* @param numberOfAcceleratorDevicesRequired The number of accelerators to allocate to run a
* model that you assign to an inference component.
* Accelerators include GPUs and AWS Inferentia.
*/
public fun numberOfAcceleratorDevicesRequired(numberOfAcceleratorDevicesRequired: Number)
/**
* @param numberOfCpuCoresRequired The number of CPU cores to allocate to run a model that you
* assign to an inference component.
*/
public fun numberOfCpuCoresRequired(numberOfCpuCoresRequired: Number)
}
private class BuilderImpl : Builder {
private val cdkBuilder:
software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.InferenceComponentComputeResourceRequirementsProperty.Builder
=
software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.InferenceComponentComputeResourceRequirementsProperty.builder()
/**
* @param maxMemoryRequiredInMb The maximum MB of memory to allocate to run a model that you
* assign to an inference component.
*/
override fun maxMemoryRequiredInMb(maxMemoryRequiredInMb: Number) {
cdkBuilder.maxMemoryRequiredInMb(maxMemoryRequiredInMb)
}
/**
* @param minMemoryRequiredInMb The minimum MB of memory to allocate to run a model that you
* assign to an inference component.
*/
override fun minMemoryRequiredInMb(minMemoryRequiredInMb: Number) {
cdkBuilder.minMemoryRequiredInMb(minMemoryRequiredInMb)
}
/**
* @param numberOfAcceleratorDevicesRequired The number of accelerators to allocate to run a
* model that you assign to an inference component.
* Accelerators include GPUs and AWS Inferentia.
*/
override fun numberOfAcceleratorDevicesRequired(numberOfAcceleratorDevicesRequired: Number) {
cdkBuilder.numberOfAcceleratorDevicesRequired(numberOfAcceleratorDevicesRequired)
}
/**
* @param numberOfCpuCoresRequired The number of CPU cores to allocate to run a model that you
* assign to an inference component.
*/
override fun numberOfCpuCoresRequired(numberOfCpuCoresRequired: Number) {
cdkBuilder.numberOfCpuCoresRequired(numberOfCpuCoresRequired)
}
public fun build():
software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.InferenceComponentComputeResourceRequirementsProperty
= cdkBuilder.build()
}
private class Wrapper(
cdkObject: software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.InferenceComponentComputeResourceRequirementsProperty,
) : CdkObject(cdkObject),
InferenceComponentComputeResourceRequirementsProperty {
/**
* The maximum MB of memory to allocate to run a model that you assign to an inference
* component.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements.html#cfn-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements-maxmemoryrequiredinmb)
*/
override fun maxMemoryRequiredInMb(): Number? = unwrap(this).getMaxMemoryRequiredInMb()
/**
* The minimum MB of memory to allocate to run a model that you assign to an inference
* component.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements.html#cfn-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements-minmemoryrequiredinmb)
*/
override fun minMemoryRequiredInMb(): Number? = unwrap(this).getMinMemoryRequiredInMb()
/**
* The number of accelerators to allocate to run a model that you assign to an inference
* component.
*
* Accelerators include GPUs and AWS Inferentia.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements.html#cfn-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements-numberofacceleratordevicesrequired)
*/
override fun numberOfAcceleratorDevicesRequired(): Number? =
unwrap(this).getNumberOfAcceleratorDevicesRequired()
/**
* The number of CPU cores to allocate to run a model that you assign to an inference
* component.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements.html#cfn-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements-numberofcpucoresrequired)
*/
override fun numberOfCpuCoresRequired(): Number? = unwrap(this).getNumberOfCpuCoresRequired()
}
public companion object {
public operator fun invoke(block: Builder.() -> Unit = {}):
InferenceComponentComputeResourceRequirementsProperty {
val builderImpl = BuilderImpl()
return Wrapper(builderImpl.apply(block).build())
}
internal
fun wrap(cdkObject: software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.InferenceComponentComputeResourceRequirementsProperty):
InferenceComponentComputeResourceRequirementsProperty = CdkObjectWrappers.wrap(cdkObject)
as? InferenceComponentComputeResourceRequirementsProperty ?: Wrapper(cdkObject)
internal fun unwrap(wrapped: InferenceComponentComputeResourceRequirementsProperty):
software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.InferenceComponentComputeResourceRequirementsProperty
= (wrapped as CdkObject).cdkObject as
software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.InferenceComponentComputeResourceRequirementsProperty
}
}
/**
* Defines a container that provides the runtime environment for a model that you deploy with an
* inference component.
*
* Example:
*
* ```
* // The code below shows an example of how to instantiate this type.
* // The values are placeholders you should change.
* import io.cloudshiftdev.awscdk.services.sagemaker.*;
* InferenceComponentContainerSpecificationProperty
* inferenceComponentContainerSpecificationProperty =
* InferenceComponentContainerSpecificationProperty.builder()
* .artifactUrl("artifactUrl")
* .deployedImage(DeployedImageProperty.builder()
* .resolutionTime("resolutionTime")
* .resolvedImage("resolvedImage")
* .specifiedImage("specifiedImage")
* .build())
* .environment(Map.of(
* "environmentKey", "environment"))
* .image("image")
* .build();
* ```
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcontainerspecification.html)
*/
public interface InferenceComponentContainerSpecificationProperty {
/**
* The Amazon S3 path where the model artifacts, which result from model training, are stored.
*
* This path must point to a single gzip compressed tar archive (.tar.gz suffix).
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcontainerspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentcontainerspecification-artifacturl)
*/
public fun artifactUrl(): String? = unwrap(this).getArtifactUrl()
/**
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcontainerspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentcontainerspecification-deployedimage)
*/
public fun deployedImage(): Any? = unwrap(this).getDeployedImage()
/**
* The environment variables to set in the Docker container.
*
* Each key and value in the Environment string-to-string map can have length of up to 1024. We
* support up to 16 entries in the map.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcontainerspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentcontainerspecification-environment)
*/
public fun environment(): Any? = unwrap(this).getEnvironment()
/**
* The Amazon Elastic Container Registry (Amazon ECR) path where the Docker image for the model
* is stored.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcontainerspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentcontainerspecification-image)
*/
public fun image(): String? = unwrap(this).getImage()
/**
* A builder for [InferenceComponentContainerSpecificationProperty]
*/
@CdkDslMarker
public interface Builder {
/**
* @param artifactUrl The Amazon S3 path where the model artifacts, which result from model
* training, are stored.
* This path must point to a single gzip compressed tar archive (.tar.gz suffix).
*/
public fun artifactUrl(artifactUrl: String)
/**
* @param deployedImage the value to be set.
*/
public fun deployedImage(deployedImage: IResolvable)
/**
* @param deployedImage the value to be set.
*/
public fun deployedImage(deployedImage: DeployedImageProperty)
/**
* @param deployedImage the value to be set.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("9230b33ebfbb5888d5f4fd74a9405daa0aed42d3dd6a28687ba27a7f7e9f033e")
public fun deployedImage(deployedImage: DeployedImageProperty.Builder.() -> Unit)
/**
* @param environment The environment variables to set in the Docker container.
* Each key and value in the Environment string-to-string map can have length of up to 1024.
* We support up to 16 entries in the map.
*/
public fun environment(environment: IResolvable)
/**
* @param environment The environment variables to set in the Docker container.
* Each key and value in the Environment string-to-string map can have length of up to 1024.
* We support up to 16 entries in the map.
*/
public fun environment(environment: Map)
/**
* @param image The Amazon Elastic Container Registry (Amazon ECR) path where the Docker image
* for the model is stored.
*/
public fun image(image: String)
}
private class BuilderImpl : Builder {
private val cdkBuilder:
software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.InferenceComponentContainerSpecificationProperty.Builder
=
software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.InferenceComponentContainerSpecificationProperty.builder()
/**
* @param artifactUrl The Amazon S3 path where the model artifacts, which result from model
* training, are stored.
* This path must point to a single gzip compressed tar archive (.tar.gz suffix).
*/
override fun artifactUrl(artifactUrl: String) {
cdkBuilder.artifactUrl(artifactUrl)
}
/**
* @param deployedImage the value to be set.
*/
override fun deployedImage(deployedImage: IResolvable) {
cdkBuilder.deployedImage(deployedImage.let(IResolvable.Companion::unwrap))
}
/**
* @param deployedImage the value to be set.
*/
override fun deployedImage(deployedImage: DeployedImageProperty) {
cdkBuilder.deployedImage(deployedImage.let(DeployedImageProperty.Companion::unwrap))
}
/**
* @param deployedImage the value to be set.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("9230b33ebfbb5888d5f4fd74a9405daa0aed42d3dd6a28687ba27a7f7e9f033e")
override fun deployedImage(deployedImage: DeployedImageProperty.Builder.() -> Unit): Unit =
deployedImage(DeployedImageProperty(deployedImage))
/**
* @param environment The environment variables to set in the Docker container.
* Each key and value in the Environment string-to-string map can have length of up to 1024.
* We support up to 16 entries in the map.
*/
override fun environment(environment: IResolvable) {
cdkBuilder.environment(environment.let(IResolvable.Companion::unwrap))
}
/**
* @param environment The environment variables to set in the Docker container.
* Each key and value in the Environment string-to-string map can have length of up to 1024.
* We support up to 16 entries in the map.
*/
override fun environment(environment: Map) {
cdkBuilder.environment(environment)
}
/**
* @param image The Amazon Elastic Container Registry (Amazon ECR) path where the Docker image
* for the model is stored.
*/
override fun image(image: String) {
cdkBuilder.image(image)
}
public fun build():
software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.InferenceComponentContainerSpecificationProperty
= cdkBuilder.build()
}
private class Wrapper(
cdkObject: software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.InferenceComponentContainerSpecificationProperty,
) : CdkObject(cdkObject),
InferenceComponentContainerSpecificationProperty {
/**
* The Amazon S3 path where the model artifacts, which result from model training, are stored.
*
* This path must point to a single gzip compressed tar archive (.tar.gz suffix).
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcontainerspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentcontainerspecification-artifacturl)
*/
override fun artifactUrl(): String? = unwrap(this).getArtifactUrl()
/**
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcontainerspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentcontainerspecification-deployedimage)
*/
override fun deployedImage(): Any? = unwrap(this).getDeployedImage()
/**
* The environment variables to set in the Docker container.
*
* Each key and value in the Environment string-to-string map can have length of up to 1024.
* We support up to 16 entries in the map.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcontainerspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentcontainerspecification-environment)
*/
override fun environment(): Any? = unwrap(this).getEnvironment()
/**
* The Amazon Elastic Container Registry (Amazon ECR) path where the Docker image for the
* model is stored.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcontainerspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentcontainerspecification-image)
*/
override fun image(): String? = unwrap(this).getImage()
}
public companion object {
public operator fun invoke(block: Builder.() -> Unit = {}):
InferenceComponentContainerSpecificationProperty {
val builderImpl = BuilderImpl()
return Wrapper(builderImpl.apply(block).build())
}
internal
fun wrap(cdkObject: software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.InferenceComponentContainerSpecificationProperty):
InferenceComponentContainerSpecificationProperty = CdkObjectWrappers.wrap(cdkObject) as?
InferenceComponentContainerSpecificationProperty ?: Wrapper(cdkObject)
internal fun unwrap(wrapped: InferenceComponentContainerSpecificationProperty):
software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.InferenceComponentContainerSpecificationProperty
= (wrapped as CdkObject).cdkObject as
software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.InferenceComponentContainerSpecificationProperty
}
}
/**
* Runtime settings for a model that is deployed with an inference component.
*
* Example:
*
* ```
* // The code below shows an example of how to instantiate this type.
* // The values are placeholders you should change.
* import io.cloudshiftdev.awscdk.services.sagemaker.*;
* InferenceComponentRuntimeConfigProperty inferenceComponentRuntimeConfigProperty =
* InferenceComponentRuntimeConfigProperty.builder()
* .copyCount(123)
* .currentCopyCount(123)
* .desiredCopyCount(123)
* .build();
* ```
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentruntimeconfig.html)
*/
public interface InferenceComponentRuntimeConfigProperty {
/**
* The number of runtime copies of the model container to deploy with the inference component.
*
* Each copy can serve inference requests.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentruntimeconfig.html#cfn-sagemaker-inferencecomponent-inferencecomponentruntimeconfig-copycount)
*/
public fun copyCount(): Number? = unwrap(this).getCopyCount()
/**
* The number of runtime copies of the model container that are currently deployed.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentruntimeconfig.html#cfn-sagemaker-inferencecomponent-inferencecomponentruntimeconfig-currentcopycount)
*/
public fun currentCopyCount(): Number? = unwrap(this).getCurrentCopyCount()
/**
* The number of runtime copies of the model container that you requested to deploy with the
* inference component.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentruntimeconfig.html#cfn-sagemaker-inferencecomponent-inferencecomponentruntimeconfig-desiredcopycount)
*/
public fun desiredCopyCount(): Number? = unwrap(this).getDesiredCopyCount()
/**
* A builder for [InferenceComponentRuntimeConfigProperty]
*/
@CdkDslMarker
public interface Builder {
/**
* @param copyCount The number of runtime copies of the model container to deploy with the
* inference component.
* Each copy can serve inference requests.
*/
public fun copyCount(copyCount: Number)
/**
* @param currentCopyCount The number of runtime copies of the model container that are
* currently deployed.
*/
public fun currentCopyCount(currentCopyCount: Number)
/**
* @param desiredCopyCount The number of runtime copies of the model container that you
* requested to deploy with the inference component.
*/
public fun desiredCopyCount(desiredCopyCount: Number)
}
private class BuilderImpl : Builder {
private val cdkBuilder:
software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.InferenceComponentRuntimeConfigProperty.Builder
=
software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.InferenceComponentRuntimeConfigProperty.builder()
/**
* @param copyCount The number of runtime copies of the model container to deploy with the
* inference component.
* Each copy can serve inference requests.
*/
override fun copyCount(copyCount: Number) {
cdkBuilder.copyCount(copyCount)
}
/**
* @param currentCopyCount The number of runtime copies of the model container that are
* currently deployed.
*/
override fun currentCopyCount(currentCopyCount: Number) {
cdkBuilder.currentCopyCount(currentCopyCount)
}
/**
* @param desiredCopyCount The number of runtime copies of the model container that you
* requested to deploy with the inference component.
*/
override fun desiredCopyCount(desiredCopyCount: Number) {
cdkBuilder.desiredCopyCount(desiredCopyCount)
}
public fun build():
software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.InferenceComponentRuntimeConfigProperty
= cdkBuilder.build()
}
private class Wrapper(
cdkObject: software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.InferenceComponentRuntimeConfigProperty,
) : CdkObject(cdkObject),
InferenceComponentRuntimeConfigProperty {
/**
* The number of runtime copies of the model container to deploy with the inference component.
*
* Each copy can serve inference requests.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentruntimeconfig.html#cfn-sagemaker-inferencecomponent-inferencecomponentruntimeconfig-copycount)
*/
override fun copyCount(): Number? = unwrap(this).getCopyCount()
/**
* The number of runtime copies of the model container that are currently deployed.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentruntimeconfig.html#cfn-sagemaker-inferencecomponent-inferencecomponentruntimeconfig-currentcopycount)
*/
override fun currentCopyCount(): Number? = unwrap(this).getCurrentCopyCount()
/**
* The number of runtime copies of the model container that you requested to deploy with the
* inference component.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentruntimeconfig.html#cfn-sagemaker-inferencecomponent-inferencecomponentruntimeconfig-desiredcopycount)
*/
override fun desiredCopyCount(): Number? = unwrap(this).getDesiredCopyCount()
}
public companion object {
public operator fun invoke(block: Builder.() -> Unit = {}):
InferenceComponentRuntimeConfigProperty {
val builderImpl = BuilderImpl()
return Wrapper(builderImpl.apply(block).build())
}
internal
fun wrap(cdkObject: software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.InferenceComponentRuntimeConfigProperty):
InferenceComponentRuntimeConfigProperty = CdkObjectWrappers.wrap(cdkObject) as?
InferenceComponentRuntimeConfigProperty ?: Wrapper(cdkObject)
internal fun unwrap(wrapped: InferenceComponentRuntimeConfigProperty):
software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.InferenceComponentRuntimeConfigProperty
= (wrapped as CdkObject).cdkObject as
software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.InferenceComponentRuntimeConfigProperty
}
}
/**
* Details about the resources to deploy with this inference component, including the model,
* container, and compute resources.
*
* Example:
*
* ```
* // The code below shows an example of how to instantiate this type.
* // The values are placeholders you should change.
* import io.cloudshiftdev.awscdk.services.sagemaker.*;
* InferenceComponentSpecificationProperty inferenceComponentSpecificationProperty =
* InferenceComponentSpecificationProperty.builder()
* .computeResourceRequirements(InferenceComponentComputeResourceRequirementsProperty.builder()
* .maxMemoryRequiredInMb(123)
* .minMemoryRequiredInMb(123)
* .numberOfAcceleratorDevicesRequired(123)
* .numberOfCpuCoresRequired(123)
* .build())
* // the properties below are optional
* .container(InferenceComponentContainerSpecificationProperty.builder()
* .artifactUrl("artifactUrl")
* .deployedImage(DeployedImageProperty.builder()
* .resolutionTime("resolutionTime")
* .resolvedImage("resolvedImage")
* .specifiedImage("specifiedImage")
* .build())
* .environment(Map.of(
* "environmentKey", "environment"))
* .image("image")
* .build())
* .modelName("modelName")
* .startupParameters(InferenceComponentStartupParametersProperty.builder()
* .containerStartupHealthCheckTimeoutInSeconds(123)
* .modelDataDownloadTimeoutInSeconds(123)
* .build())
* .build();
* ```
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentspecification.html)
*/
public interface InferenceComponentSpecificationProperty {
/**
* The compute resources allocated to run the model assigned to the inference component.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentspecification-computeresourcerequirements)
*/
public fun computeResourceRequirements(): Any
/**
* Defines a container that provides the runtime environment for a model that you deploy with an
* inference component.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentspecification-container)
*/
public fun container(): Any? = unwrap(this).getContainer()
/**
* The name of an existing SageMaker model object in your account that you want to deploy with
* the inference component.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentspecification-modelname)
*/
public fun modelName(): String? = unwrap(this).getModelName()
/**
* Settings that take effect while the model container starts up.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentspecification-startupparameters)
*/
public fun startupParameters(): Any? = unwrap(this).getStartupParameters()
/**
* A builder for [InferenceComponentSpecificationProperty]
*/
@CdkDslMarker
public interface Builder {
/**
* @param computeResourceRequirements The compute resources allocated to run the model
* assigned to the inference component.
*/
public fun computeResourceRequirements(computeResourceRequirements: IResolvable)
/**
* @param computeResourceRequirements The compute resources allocated to run the model
* assigned to the inference component.
*/
public
fun computeResourceRequirements(computeResourceRequirements: InferenceComponentComputeResourceRequirementsProperty)
/**
* @param computeResourceRequirements The compute resources allocated to run the model
* assigned to the inference component.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("db00219b7dbb581ee5a0820364523ece8e2c71181d72bb3cc72165ffd178a63a")
public
fun computeResourceRequirements(computeResourceRequirements: InferenceComponentComputeResourceRequirementsProperty.Builder.() -> Unit)
/**
* @param container Defines a container that provides the runtime environment for a model that
* you deploy with an inference component.
*/
public fun container(container: IResolvable)
/**
* @param container Defines a container that provides the runtime environment for a model that
* you deploy with an inference component.
*/
public fun container(container: InferenceComponentContainerSpecificationProperty)
/**
* @param container Defines a container that provides the runtime environment for a model that
* you deploy with an inference component.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("c159431fed6e3b661da5cd1940492ea428fd171e79db76570eba05437585428d")
public
fun container(container: InferenceComponentContainerSpecificationProperty.Builder.() -> Unit)
/**
* @param modelName The name of an existing SageMaker model object in your account that you
* want to deploy with the inference component.
*/
public fun modelName(modelName: String)
/**
* @param startupParameters Settings that take effect while the model container starts up.
*/
public fun startupParameters(startupParameters: IResolvable)
/**
* @param startupParameters Settings that take effect while the model container starts up.
*/
public fun startupParameters(startupParameters: InferenceComponentStartupParametersProperty)
/**
* @param startupParameters Settings that take effect while the model container starts up.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("26f6720eb665a9db2971614a7e88275897ea49410b838f9a5782e76ebd0833ff")
public
fun startupParameters(startupParameters: InferenceComponentStartupParametersProperty.Builder.() -> Unit)
}
private class BuilderImpl : Builder {
private val cdkBuilder:
software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.InferenceComponentSpecificationProperty.Builder
=
software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.InferenceComponentSpecificationProperty.builder()
/**
* @param computeResourceRequirements The compute resources allocated to run the model
* assigned to the inference component.
*/
override fun computeResourceRequirements(computeResourceRequirements: IResolvable) {
cdkBuilder.computeResourceRequirements(computeResourceRequirements.let(IResolvable.Companion::unwrap))
}
/**
* @param computeResourceRequirements The compute resources allocated to run the model
* assigned to the inference component.
*/
override
fun computeResourceRequirements(computeResourceRequirements: InferenceComponentComputeResourceRequirementsProperty) {
cdkBuilder.computeResourceRequirements(computeResourceRequirements.let(InferenceComponentComputeResourceRequirementsProperty.Companion::unwrap))
}
/**
* @param computeResourceRequirements The compute resources allocated to run the model
* assigned to the inference component.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("db00219b7dbb581ee5a0820364523ece8e2c71181d72bb3cc72165ffd178a63a")
override
fun computeResourceRequirements(computeResourceRequirements: InferenceComponentComputeResourceRequirementsProperty.Builder.() -> Unit):
Unit =
computeResourceRequirements(InferenceComponentComputeResourceRequirementsProperty(computeResourceRequirements))
/**
* @param container Defines a container that provides the runtime environment for a model that
* you deploy with an inference component.
*/
override fun container(container: IResolvable) {
cdkBuilder.container(container.let(IResolvable.Companion::unwrap))
}
/**
* @param container Defines a container that provides the runtime environment for a model that
* you deploy with an inference component.
*/
override fun container(container: InferenceComponentContainerSpecificationProperty) {
cdkBuilder.container(container.let(InferenceComponentContainerSpecificationProperty.Companion::unwrap))
}
/**
* @param container Defines a container that provides the runtime environment for a model that
* you deploy with an inference component.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("c159431fed6e3b661da5cd1940492ea428fd171e79db76570eba05437585428d")
override
fun container(container: InferenceComponentContainerSpecificationProperty.Builder.() -> Unit):
Unit = container(InferenceComponentContainerSpecificationProperty(container))
/**
* @param modelName The name of an existing SageMaker model object in your account that you
* want to deploy with the inference component.
*/
override fun modelName(modelName: String) {
cdkBuilder.modelName(modelName)
}
/**
* @param startupParameters Settings that take effect while the model container starts up.
*/
override fun startupParameters(startupParameters: IResolvable) {
cdkBuilder.startupParameters(startupParameters.let(IResolvable.Companion::unwrap))
}
/**
* @param startupParameters Settings that take effect while the model container starts up.
*/
override
fun startupParameters(startupParameters: InferenceComponentStartupParametersProperty) {
cdkBuilder.startupParameters(startupParameters.let(InferenceComponentStartupParametersProperty.Companion::unwrap))
}
/**
* @param startupParameters Settings that take effect while the model container starts up.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("26f6720eb665a9db2971614a7e88275897ea49410b838f9a5782e76ebd0833ff")
override
fun startupParameters(startupParameters: InferenceComponentStartupParametersProperty.Builder.() -> Unit):
Unit = startupParameters(InferenceComponentStartupParametersProperty(startupParameters))
public fun build():
software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.InferenceComponentSpecificationProperty
= cdkBuilder.build()
}
private class Wrapper(
cdkObject: software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.InferenceComponentSpecificationProperty,
) : CdkObject(cdkObject),
InferenceComponentSpecificationProperty {
/**
* The compute resources allocated to run the model assigned to the inference component.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentspecification-computeresourcerequirements)
*/
override fun computeResourceRequirements(): Any =
unwrap(this).getComputeResourceRequirements()
/**
* Defines a container that provides the runtime environment for a model that you deploy with
* an inference component.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentspecification-container)
*/
override fun container(): Any? = unwrap(this).getContainer()
/**
* The name of an existing SageMaker model object in your account that you want to deploy with
* the inference component.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentspecification-modelname)
*/
override fun modelName(): String? = unwrap(this).getModelName()
/**
* Settings that take effect while the model container starts up.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentspecification-startupparameters)
*/
override fun startupParameters(): Any? = unwrap(this).getStartupParameters()
}
public companion object {
public operator fun invoke(block: Builder.() -> Unit = {}):
InferenceComponentSpecificationProperty {
val builderImpl = BuilderImpl()
return Wrapper(builderImpl.apply(block).build())
}
internal
fun wrap(cdkObject: software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.InferenceComponentSpecificationProperty):
InferenceComponentSpecificationProperty = CdkObjectWrappers.wrap(cdkObject) as?
InferenceComponentSpecificationProperty ?: Wrapper(cdkObject)
internal fun unwrap(wrapped: InferenceComponentSpecificationProperty):
software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.InferenceComponentSpecificationProperty
= (wrapped as CdkObject).cdkObject as
software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.InferenceComponentSpecificationProperty
}
}
/**
* Settings that take effect while the model container starts up.
*
* Example:
*
* ```
* // The code below shows an example of how to instantiate this type.
* // The values are placeholders you should change.
* import io.cloudshiftdev.awscdk.services.sagemaker.*;
* InferenceComponentStartupParametersProperty inferenceComponentStartupParametersProperty =
* InferenceComponentStartupParametersProperty.builder()
* .containerStartupHealthCheckTimeoutInSeconds(123)
* .modelDataDownloadTimeoutInSeconds(123)
* .build();
* ```
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentstartupparameters.html)
*/
public interface InferenceComponentStartupParametersProperty {
/**
* The timeout value, in seconds, for your inference container to pass health check by Amazon S3
* Hosting.
*
* For more information about health check, see [How Your Container Should Respond to Health
* Check (Ping)
* Requests](https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-inference-code.html#your-algorithms-inference-algo-ping-requests)
* .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentstartupparameters.html#cfn-sagemaker-inferencecomponent-inferencecomponentstartupparameters-containerstartuphealthchecktimeoutinseconds)
*/
public fun containerStartupHealthCheckTimeoutInSeconds(): Number? =
unwrap(this).getContainerStartupHealthCheckTimeoutInSeconds()
/**
* The timeout value, in seconds, to download and extract the model that you want to host from
* Amazon S3 to the individual inference instance associated with this inference component.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentstartupparameters.html#cfn-sagemaker-inferencecomponent-inferencecomponentstartupparameters-modeldatadownloadtimeoutinseconds)
*/
public fun modelDataDownloadTimeoutInSeconds(): Number? =
unwrap(this).getModelDataDownloadTimeoutInSeconds()
/**
* A builder for [InferenceComponentStartupParametersProperty]
*/
@CdkDslMarker
public interface Builder {
/**
* @param containerStartupHealthCheckTimeoutInSeconds The timeout value, in seconds, for your
* inference container to pass health check by Amazon S3 Hosting.
* For more information about health check, see [How Your Container Should Respond to Health
* Check (Ping)
* Requests](https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-inference-code.html#your-algorithms-inference-algo-ping-requests)
* .
*/
public
fun containerStartupHealthCheckTimeoutInSeconds(containerStartupHealthCheckTimeoutInSeconds: Number)
/**
* @param modelDataDownloadTimeoutInSeconds The timeout value, in seconds, to download and
* extract the model that you want to host from Amazon S3 to the individual inference instance
* associated with this inference component.
*/
public fun modelDataDownloadTimeoutInSeconds(modelDataDownloadTimeoutInSeconds: Number)
}
private class BuilderImpl : Builder {
private val cdkBuilder:
software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.InferenceComponentStartupParametersProperty.Builder
=
software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.InferenceComponentStartupParametersProperty.builder()
/**
* @param containerStartupHealthCheckTimeoutInSeconds The timeout value, in seconds, for your
* inference container to pass health check by Amazon S3 Hosting.
* For more information about health check, see [How Your Container Should Respond to Health
* Check (Ping)
* Requests](https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-inference-code.html#your-algorithms-inference-algo-ping-requests)
* .
*/
override
fun containerStartupHealthCheckTimeoutInSeconds(containerStartupHealthCheckTimeoutInSeconds: Number) {
cdkBuilder.containerStartupHealthCheckTimeoutInSeconds(containerStartupHealthCheckTimeoutInSeconds)
}
/**
* @param modelDataDownloadTimeoutInSeconds The timeout value, in seconds, to download and
* extract the model that you want to host from Amazon S3 to the individual inference instance
* associated with this inference component.
*/
override fun modelDataDownloadTimeoutInSeconds(modelDataDownloadTimeoutInSeconds: Number) {
cdkBuilder.modelDataDownloadTimeoutInSeconds(modelDataDownloadTimeoutInSeconds)
}
public fun build():
software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.InferenceComponentStartupParametersProperty
= cdkBuilder.build()
}
private class Wrapper(
cdkObject: software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.InferenceComponentStartupParametersProperty,
) : CdkObject(cdkObject),
InferenceComponentStartupParametersProperty {
/**
* The timeout value, in seconds, for your inference container to pass health check by Amazon
* S3 Hosting.
*
* For more information about health check, see [How Your Container Should Respond to Health
* Check (Ping)
* Requests](https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-inference-code.html#your-algorithms-inference-algo-ping-requests)
* .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentstartupparameters.html#cfn-sagemaker-inferencecomponent-inferencecomponentstartupparameters-containerstartuphealthchecktimeoutinseconds)
*/
override fun containerStartupHealthCheckTimeoutInSeconds(): Number? =
unwrap(this).getContainerStartupHealthCheckTimeoutInSeconds()
/**
* The timeout value, in seconds, to download and extract the model that you want to host from
* Amazon S3 to the individual inference instance associated with this inference component.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentstartupparameters.html#cfn-sagemaker-inferencecomponent-inferencecomponentstartupparameters-modeldatadownloadtimeoutinseconds)
*/
override fun modelDataDownloadTimeoutInSeconds(): Number? =
unwrap(this).getModelDataDownloadTimeoutInSeconds()
}
public companion object {
public operator fun invoke(block: Builder.() -> Unit = {}):
InferenceComponentStartupParametersProperty {
val builderImpl = BuilderImpl()
return Wrapper(builderImpl.apply(block).build())
}
internal
fun wrap(cdkObject: software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.InferenceComponentStartupParametersProperty):
InferenceComponentStartupParametersProperty = CdkObjectWrappers.wrap(cdkObject) as?
InferenceComponentStartupParametersProperty ?: Wrapper(cdkObject)
internal fun unwrap(wrapped: InferenceComponentStartupParametersProperty):
software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.InferenceComponentStartupParametersProperty
= (wrapped as CdkObject).cdkObject as
software.amazon.awscdk.services.sagemaker.CfnInferenceComponent.InferenceComponentStartupParametersProperty
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy