Interface CfnEndpointConfig.IDataCaptureConfigProperty
Specifies the configuration of your endpoint for model monitor data capture.
Namespace: Amazon.CDK.AWS.Sagemaker
Assembly: Amazon.CDK.AWS.Sagemaker.dll
Syntax (csharp)
public interface IDataCaptureConfigProperty
Syntax (vb)
Public Interface IDataCaptureConfigProperty
Remarks
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 dataCaptureConfigProperty = 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"
};
Synopsis
Properties
CaptureContentTypeHeader | A list of the JSON and CSV content type that the endpoint captures. |
CaptureOptions | Specifies whether the endpoint captures input data to your model, output data from your model, or both. |
DestinationS3Uri | The S3 bucket where model monitor stores captured data. |
EnableCapture | Set to |
InitialSamplingPercentage | The percentage of data to capture. |
KmsKeyId | The AWS Key Management Service ( AWS KMS) key that Amazon SageMaker uses to encrypt the captured data at rest using Amazon S3 server-side encryption. |
Properties
CaptureContentTypeHeader
A list of the JSON and CSV content type that the endpoint captures.
virtual object CaptureContentTypeHeader { get; }
Property Value
System.Object
Remarks
CaptureOptions
Specifies whether the endpoint captures input data to your model, output data from your model, or both.
object CaptureOptions { get; }
Property Value
System.Object
Remarks
DestinationS3Uri
The S3 bucket where model monitor stores captured data.
string DestinationS3Uri { get; }
Property Value
System.String
Remarks
EnableCapture
Set to True
to enable data capture.
virtual object EnableCapture { get; }
Property Value
System.Object
Remarks
InitialSamplingPercentage
The percentage of data to capture.
double InitialSamplingPercentage { get; }
Property Value
System.Double
Remarks
KmsKeyId
The AWS Key Management Service ( AWS KMS) key that Amazon SageMaker uses to encrypt the captured data at rest using Amazon S3 server-side encryption.
virtual string KmsKeyId { get; }
Property Value
System.String
Remarks
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 If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html) in the Amazon Simple Storage Service Developer Guide. The KMS key policy must grant permission to the IAM role that you specify in your CreateModel (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateModel.html) request. For more information, see Using Key Policies in AWS KMS (http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) in the AWS Key Management Service Developer Guide.