Class CfnEndpointConfig
A CloudFormation AWS::SageMaker::EndpointConfig
.
Inherited Members
Namespace: Amazon.CDK.AWS.Sagemaker
Assembly: Amazon.CDK.AWS.Sagemaker.dll
Syntax (csharp)
public class CfnEndpointConfig : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnEndpointConfig
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::SageMaker::EndpointConfig
resource creates a configuration for an Amazon SageMaker endpoint. For more information, see CreateEndpointConfig in the SageMaker Developer Guide .
CloudformationResource: AWS::SageMaker::EndpointConfig
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Sagemaker;
var cfnEndpointConfig = new CfnEndpointConfig(this, "MyCfnEndpointConfig", new CfnEndpointConfigProps {
ProductionVariants = new [] { new ProductionVariantProperty {
InitialVariantWeight = 123,
ModelName = "modelName",
VariantName = "variantName",
// the properties below are optional
AcceleratorType = "acceleratorType",
ContainerStartupHealthCheckTimeoutInSeconds = 123,
EnableSsmAccess = false,
InitialInstanceCount = 123,
InstanceType = "instanceType",
ModelDataDownloadTimeoutInSeconds = 123,
ServerlessConfig = new ServerlessConfigProperty {
MaxConcurrency = 123,
MemorySizeInMb = 123,
// the properties below are optional
ProvisionedConcurrency = 123
},
VolumeSizeInGb = 123
} },
// the properties below are optional
AsyncInferenceConfig = new AsyncInferenceConfigProperty {
OutputConfig = new AsyncInferenceOutputConfigProperty {
KmsKeyId = "kmsKeyId",
NotificationConfig = new AsyncInferenceNotificationConfigProperty {
ErrorTopic = "errorTopic",
IncludeInferenceResponseIn = new [] { "includeInferenceResponseIn" },
SuccessTopic = "successTopic"
},
S3FailurePath = "s3FailurePath",
S3OutputPath = "s3OutputPath"
},
// the properties below are optional
ClientConfig = new AsyncInferenceClientConfigProperty {
MaxConcurrentInvocationsPerInstance = 123
}
},
DataCaptureConfig = new DataCaptureConfigProperty {
CaptureOptions = new [] { new CaptureOptionProperty {
CaptureMode = "captureMode"
} },
DestinationS3Uri = "destinationS3Uri",
InitialSamplingPercentage = 123,
// the properties below are optional
CaptureContentTypeHeader = new CaptureContentTypeHeaderProperty {
CsvContentTypes = new [] { "csvContentTypes" },
JsonContentTypes = new [] { "jsonContentTypes" }
},
EnableCapture = false,
KmsKeyId = "kmsKeyId"
},
EndpointConfigName = "endpointConfigName",
ExplainerConfig = new ExplainerConfigProperty {
ClarifyExplainerConfig = new ClarifyExplainerConfigProperty {
ShapConfig = new ClarifyShapConfigProperty {
ShapBaselineConfig = new ClarifyShapBaselineConfigProperty {
MimeType = "mimeType",
ShapBaseline = "shapBaseline",
ShapBaselineUri = "shapBaselineUri"
},
// the properties below are optional
NumberOfSamples = 123,
Seed = 123,
TextConfig = new ClarifyTextConfigProperty {
Granularity = "granularity",
Language = "language"
},
UseLogit = false
},
// the properties below are optional
EnableExplanations = "enableExplanations",
InferenceConfig = new ClarifyInferenceConfigProperty {
ContentTemplate = "contentTemplate",
FeatureHeaders = new [] { "featureHeaders" },
FeaturesAttribute = "featuresAttribute",
FeatureTypes = new [] { "featureTypes" },
LabelAttribute = "labelAttribute",
LabelHeaders = new [] { "labelHeaders" },
LabelIndex = 123,
MaxPayloadInMb = 123,
MaxRecordCount = 123,
ProbabilityAttribute = "probabilityAttribute",
ProbabilityIndex = 123
}
}
},
KmsKeyId = "kmsKeyId",
ShadowProductionVariants = new [] { new ProductionVariantProperty {
InitialVariantWeight = 123,
ModelName = "modelName",
VariantName = "variantName",
// the properties below are optional
AcceleratorType = "acceleratorType",
ContainerStartupHealthCheckTimeoutInSeconds = 123,
EnableSsmAccess = false,
InitialInstanceCount = 123,
InstanceType = "instanceType",
ModelDataDownloadTimeoutInSeconds = 123,
ServerlessConfig = new ServerlessConfigProperty {
MaxConcurrency = 123,
MemorySizeInMb = 123,
// the properties below are optional
ProvisionedConcurrency = 123
},
VolumeSizeInGb = 123
} },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnEndpointConfig(Construct, String, ICfnEndpointConfigProps) | Create a new |
CfnEndpointConfig(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnEndpointConfig(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AsyncInferenceConfig | Specifies configuration for how an endpoint performs asynchronous inference. |
AttrEndpointConfigName | The name of the endpoint configuration, such as |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DataCaptureConfig | Specifies how to capture endpoint data for model monitor. |
EndpointConfigName | The name of the endpoint configuration. |
ExplainerConfig |
|
KmsKeyId | The Amazon Resource Name (ARN) of an AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. |
ProductionVariants | A list of |
ShadowProductionVariants | Array of |
Tags | A list of key-value pairs to apply to this resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnEndpointConfig(Construct, String, ICfnEndpointConfigProps)
Create a new AWS::SageMaker::EndpointConfig
.
public CfnEndpointConfig(Construct scope, string id, ICfnEndpointConfigProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnEndpointConfigProps
- resource properties.
CfnEndpointConfig(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnEndpointConfig(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnEndpointConfig(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnEndpointConfig(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AsyncInferenceConfig
Specifies configuration for how an endpoint performs asynchronous inference.
public virtual object AsyncInferenceConfig { get; set; }
Property Value
System.Object
Remarks
AttrEndpointConfigName
The name of the endpoint configuration, such as MyEndpointConfiguration
.
public virtual string AttrEndpointConfigName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: EndpointConfigName
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DataCaptureConfig
Specifies how to capture endpoint data for model monitor.
public virtual object DataCaptureConfig { get; set; }
Property Value
System.Object
Remarks
The data capture configuration applies to all production variants hosted at the endpoint.
EndpointConfigName
The name of the endpoint configuration.
public virtual string EndpointConfigName { get; set; }
Property Value
System.String
Remarks
ExplainerConfig
AWS::SageMaker::EndpointConfig.ExplainerConfig
.
public virtual object ExplainerConfig { get; set; }
Property Value
System.Object
Remarks
KmsKeyId
The Amazon Resource Name (ARN) of an AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.
public virtual string KmsKeyId { get; set; }
Property Value
System.String
Remarks
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 AWS Key Management Service section Using Key Policies in AWS KMS
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 <code>KmsKeyId</code> when using an instance type with local storage. If any of the models that you specify in the <code>ProductionVariants</code> parameter use nitro-based instances with local storage, do not specify a value for the <code>KmsKeyId</code> parameter. If you specify a value for <code>KmsKeyId</code> when using any nitro-based instances with local storage, the call to <code>CreateEndpointConfig</code> fails.
For a list of instance types that support local instance storage, see Instance Store Volumes .
For more information about local instance storage encryption, see SSD Instance Store Volumes .
ProductionVariants
A list of ProductionVariant
objects, one for each model that you want to host at this endpoint.
public virtual object ProductionVariants { get; set; }
Property Value
System.Object
Remarks
ShadowProductionVariants
Array of ProductionVariant
objects.
public virtual object ShadowProductionVariants { get; set; }
Property Value
System.Object
Remarks
There is one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants
. If you use this field, you can only specify one variant for ProductionVariants
and one variant for ShadowProductionVariants
.
Tags
A list of key-value pairs to apply to this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>