EndpointConfig

sagemaker.services.k8s.aws/v1alpha1

Type	Link
GoDoc	sagemaker-controller/apis/v1alpha1#EndpointConfig

Metadata

Property	Value
Scope	Namespaced
Kind	`EndpointConfig`
ListKind	`EndpointConfigList`
Plural	`endpointconfigs`
Singular	`endpointconfig`

Spec

asyncInferenceConfig: 
  clientConfig: 
    maxConcurrentInvocationsPerInstance: integer
  outputConfig: 
    kmsKeyID: string
    notificationConfig: 
      errorTopic: string
      includeInferenceResponseIn:
      - string
      successTopic: string
    s3FailurePath: string
    s3OutputPath: string
dataCaptureConfig: 
  captureContentTypeHeader: 
    csvContentTypes:
    - string
    jsonContentTypes:
    - string
  captureOptions:
  - captureMode: string
  destinationS3URI: string
  enableCapture: boolean
  initialSamplingPercentage: integer
  kmsKeyID: string
enableNetworkIsolation: boolean
endpointConfigName: string
executionRoleARN: string
kmsKeyID: string
productionVariants:
- acceleratorType: string
  containerStartupHealthCheckTimeoutInSeconds: integer
  coreDumpConfig: 
    destinationS3URI: string
    kmsKeyID: string
  enableSSMAccess: boolean
  initialInstanceCount: integer
  initialVariantWeight: number
  instanceType: string
  managedInstanceScaling: 
    maxInstanceCount: integer
    minInstanceCount: integer
    status: string
  modelDataDownloadTimeoutInSeconds: integer
  modelName: string
  routingConfig: 
    routingStrategy: string
  serverlessConfig: 
    maxConcurrency: integer
    memorySizeInMB: integer
    provisionedConcurrency: integer
  variantName: string
  volumeSizeInGB: integer
tags:
- key: string
  value: string
vpcConfig: 
  securityGroupIDs:
  - string
  subnets:
  - string

Field	Description
asyncInferenceConfig Optional	object Specifies configuration for how an endpoint performs asynchronous inference. This is a required field in order for your Endpoint to be invoked using InvokeEndpointAsync (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpointAsync.html).
asyncInferenceConfig.clientConfig Optional	object Configures the behavior of the client used by SageMaker to interact with the model container during asynchronous inference.
asyncInferenceConfig.clientConfig.maxConcurrentInvocationsPerInstance Optional	integer
asyncInferenceConfig.outputConfig Optional	object Specifies the configuration for asynchronous inference invocation outputs.
asyncInferenceConfig.outputConfig.kmsKeyID Optional	string
asyncInferenceConfig.outputConfig.notificationConfig Optional	object Specifies the configuration for notifications of inference results for asynchronous inference.
asyncInferenceConfig.outputConfig.notificationConfig.errorTopic Optional	string
asyncInferenceConfig.outputConfig.notificationConfig.includeInferenceResponseIn Optional	array
asyncInferenceConfig.outputConfig.notificationConfig.includeInferenceResponseIn.[] Required	string
asyncInferenceConfig.outputConfig.s3FailurePath Optional	string
asyncInferenceConfig.outputConfig.s3OutputPath Optional	string
dataCaptureConfig Optional	object Configuration to control how SageMaker captures inference data.
dataCaptureConfig.captureContentTypeHeader Optional	object Configuration specifying how to treat different headers. If no headers are specified Amazon SageMaker will by default base64 encode when capturing the data.
dataCaptureConfig.captureContentTypeHeader.csvContentTypes Optional	array
dataCaptureConfig.captureContentTypeHeader.csvContentTypes.[] Required	string
dataCaptureConfig.captureContentTypeHeader.jsonContentTypes.[] Required	string
dataCaptureConfig.captureOptions.[] Required	object Specifies data Model Monitor will capture.
dataCaptureConfig.destinationS3URI Optional	string
dataCaptureConfig.enableCapture Optional	boolean
dataCaptureConfig.initialSamplingPercentage Optional	integer
dataCaptureConfig.kmsKeyID Optional	string
enableNetworkIsolation Optional	boolean Sets whether all model containers deployed to the endpoint are isolated. If they are, no inbound or outbound network calls can be made to or from the model containers.
endpointConfigName Required	string The name of the endpoint configuration. You specify this name in a CreateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html) request.
executionRoleARN Optional	string The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform actions on your behalf. For more information, see SageMaker Roles (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html). To be able to pass this role to Amazon SageMaker, the caller of this action must have the iam:PassRole permission.
kmsKeyID Optional	string The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. The KmsKeyId can be any of the following formats: * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab * Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab * Alias name: alias/ExampleAlias * Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint, UpdateEndpoint requests. For more information, refer to the Amazon Web Services Key Management Service section Using Key Policies in Amazon Web Services KMS (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can’t request a KmsKeyId when using an instance type with local storage. If any of the models that you specify in the ProductionVariants parameter use nitro-based instances with local storage, do not specify a value for the KmsKeyId parameter. If you specify a value for KmsKeyId when using any nitro-based instances with local storage, the call to CreateEndpointConfig fails. For a list of instance types that support local instance storage, see Instance Store Volumes (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes). For more information about local instance storage encryption, see SSD Instance Store Volumes (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html).
productionVariants Required	array An array of ProductionVariant objects, one for each model that you want to host at this endpoint.
productionVariants.[] Required	object Identifies a model that you want to host and the resources chosen to deploy
for hosting it. If you are deploying multiple models, tell SageMaker how
to distribute traffic among the models by specifying variant weights. For
more information on production variants, check Production variants (https://docs.aws.amazon.com/sagemaker/latest/dg/model-ab-testing.html).
productionVariants.[].containerStartupHealthCheckTimeoutInSeconds Optional	integer
productionVariants.[].coreDumpConfig Optional	object Specifies configuration for a core dump from the model container when the process crashes.
productionVariants.[].coreDumpConfig.destinationS3URI Optional	string
productionVariants.[].coreDumpConfig.kmsKeyID Optional	string
productionVariants.[].enableSSMAccess Optional	boolean
productionVariants.[].initialInstanceCount Optional	integer
productionVariants.[].initialVariantWeight Optional	number
productionVariants.[].instanceType Optional	string
productionVariants.[].managedInstanceScaling Optional	object Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.
productionVariants.[].managedInstanceScaling.maxInstanceCount Optional	integer
productionVariants.[].managedInstanceScaling.minInstanceCount Optional	integer
productionVariants.[].managedInstanceScaling.status Optional	string
productionVariants.[].modelDataDownloadTimeoutInSeconds Optional	integer
productionVariants.[].modelName Optional	string
productionVariants.[].routingConfig Optional	object Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.
productionVariants.[].routingConfig.routingStrategy Optional	string
productionVariants.[].serverlessConfig Optional	object Specifies the serverless configuration for an endpoint variant.
productionVariants.[].serverlessConfig.maxConcurrency Optional	integer
productionVariants.[].serverlessConfig.memorySizeInMB Optional	integer
productionVariants.[].serverlessConfig.provisionedConcurrency Optional	integer
productionVariants.[].variantName Optional	string
productionVariants.[].volumeSizeInGB Optional	integer
tags Optional	array An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).
tags.[] Required	object A tag object that consists of a key and an optional value, used to manage
metadata for SageMaker Amazon Web Services resources.

You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).

For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || tags.[].key
Optional | string
| | tags.[].value
Optional | string
| | vpcConfig
Optional | object
Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs,
hosted models, and compute resources have access to. You can control access
to and from your resources by configuring a VPC. For more information, see
Give SageMaker Access to Resources in your Amazon VPC (https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html). | | vpcConfig.securityGroupIDs
Optional | array
| | vpcConfig.securityGroupIDs.[]
Required | string
|| vpcConfig.subnets
Optional | array
| | vpcConfig.subnets.[]
Required | string
|

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string

Field	Description
ackResourceMetadata Optional	object All CRs managed by ACK have a common `Status.ACKResourceMetadata` member that is used to contain resource sync state, account ownership, constructed ARN for the resource
ackResourceMetadata.arn Optional	string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270
ackResourceMetadata.ownerAccountID Required	string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.
ackResourceMetadata.region Required	string Region is the AWS region in which the resource exists or will exist.
conditions Optional	array All CRS managed by ACK have a common `Status.Conditions` member that contains a collection of `ackv1alpha1.Condition` objects that describe the various terminal states of the CR and its backend AWS service API resource
conditions.[] Required	object Condition is the common struct used by all CRDs managed by ACK service
controllers to indicate terminal states of the CR and its backend AWS
service API resource
conditions.[].message Optional	string A human readable message indicating details about the transition.
conditions.[].reason Optional	string The reason for the condition’s last transition.
conditions.[].status Optional	string Status of the condition, one of True, False, Unknown.
conditions.[].type Optional	string Type is the type of the Condition

EndpointConfig

Metadata#

Spec#

Status#

Metadata

Spec

Status