Class CfnEndpointConfig
The AWS::SageMaker::EndpointConfig
resource creates a configuration for an Amazon SageMaker endpoint.
Inherited Members
Namespace: Amazon.CDK.AWS.Sagemaker
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnEndpointConfig : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnEndpointConfig
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
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 {
VariantName = "variantName",
// the properties below are optional
AcceleratorType = "acceleratorType",
ContainerStartupHealthCheckTimeoutInSeconds = 123,
EnableSsmAccess = false,
InitialInstanceCount = 123,
InitialVariantWeight = 123,
InstanceType = "instanceType",
ManagedInstanceScaling = new ManagedInstanceScalingProperty {
MaxInstanceCount = 123,
MinInstanceCount = 123,
Status = "status"
},
ModelDataDownloadTimeoutInSeconds = 123,
ModelName = "modelName",
RoutingConfig = new RoutingConfigProperty {
RoutingStrategy = "routingStrategy"
},
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"
},
EnableNetworkIsolation = false,
EndpointConfigName = "endpointConfigName",
ExecutionRoleArn = "executionRoleArn",
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 {
VariantName = "variantName",
// the properties below are optional
AcceleratorType = "acceleratorType",
ContainerStartupHealthCheckTimeoutInSeconds = 123,
EnableSsmAccess = false,
InitialInstanceCount = 123,
InitialVariantWeight = 123,
InstanceType = "instanceType",
ManagedInstanceScaling = new ManagedInstanceScalingProperty {
MaxInstanceCount = 123,
MinInstanceCount = 123,
Status = "status"
},
ModelDataDownloadTimeoutInSeconds = 123,
ModelName = "modelName",
RoutingConfig = new RoutingConfigProperty {
RoutingStrategy = "routingStrategy"
},
ServerlessConfig = new ServerlessConfigProperty {
MaxConcurrency = 123,
MemorySizeInMb = 123,
// the properties below are optional
ProvisionedConcurrency = 123
},
VolumeSizeInGb = 123
} },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
VpcConfig = new VpcConfigProperty {
SecurityGroupIds = new [] { "securityGroupIds" },
Subnets = new [] { "subnets" }
}
});
Synopsis
Constructors
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 |
CfnEndpointConfig(Construct, String, ICfnEndpointConfigProps) |
Properties
AsyncInferenceConfig | Specifies configuration for how an endpoint performs asynchronous inference. |
AttrEndpointConfigName | The name of the endpoint configuration, such as |
AttrId | |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DataCaptureConfig | Specifies how to capture endpoint data for model monitor. |
EnableNetworkIsolation | |
EndpointConfigName | The name of the endpoint configuration. |
ExecutionRoleArn | |
ExplainerConfig | A parameter to activate explainers. |
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 | Tag Manager which manages the tags for this resource. |
TagsRaw | A list of key-value pairs to apply to this resource. |
VpcConfig |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
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
CfnEndpointConfig(Construct, String, ICfnEndpointConfigProps)
public CfnEndpointConfig(Construct scope, string id, ICfnEndpointConfigProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnEndpointConfigProps
Resource properties.
Properties
AsyncInferenceConfig
Specifies configuration for how an endpoint performs asynchronous inference.
public virtual object AsyncInferenceConfig { get; set; }
Property Value
System.Object
AttrEndpointConfigName
The name of the endpoint configuration, such as MyEndpointConfiguration
.
public virtual string AttrEndpointConfigName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: EndpointConfigName
AttrId
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
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
EnableNetworkIsolation
public virtual object EnableNetworkIsolation { get; set; }
Property Value
System.Object
EndpointConfigName
The name of the endpoint configuration.
public virtual string EndpointConfigName { get; set; }
Property Value
System.String
ExecutionRoleArn
public virtual string ExecutionRoleArn { get; set; }
Property Value
System.String
ExplainerConfig
A parameter to activate explainers.
public virtual object ExplainerConfig { get; set; }
Property Value
System.Object
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
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
ShadowProductionVariants
Array of ProductionVariant
objects.
public virtual object ShadowProductionVariants { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
A list of key-value pairs to apply to this resource.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
VpcConfig
public virtual object VpcConfig { get; set; }
Property Value
System.Object
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>