aws-cdk-lib.aws_sagemaker.CfnEndpointConfig.DataCaptureConfigProperty

DataCaptureConfigProperty Struct

Specifies the configuration of your endpoint for model monitor data capture.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from 'aws-cdk-lib';
const dataCaptureConfigProperty: sagemaker.CfnEndpointConfig.DataCaptureConfigProperty = {
  captureOptions: [{
    captureMode: 'captureMode',
  }],
  destinationS3Uri: 'destinationS3Uri',
  initialSamplingPercentage: 123,

  // the properties below are optional
  captureContentTypeHeader: {
    csvContentTypes: ['csvContentTypes'],
    jsonContentTypes: ['jsonContentTypes'],
  },
  enableCapture: false,
  kmsKeyId: 'kmsKeyId',
};

Properties

captureContentTypeHeader?optionalIResolvable | CfnEndpointConfig.CaptureContentTypeHeaderPropertycapture_content_type_header?optionaltyping.Union[IResolvable, CaptureContentTypeHeaderProperty]captureContentTypeHeader?optionalIResolvableCaptureContentTypeHeader?optionalIResolvableCaptureContentTypeHeader?optionalinterface{}#

A list of the JSON and CSV content type that the endpoint captures.

captureOptionsIResolvable | IResolvable | CfnEndpointConfig.CaptureOptionProperty[]capture_optionstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, CaptureOptionProperty]]]captureOptionsIResolvableCaptureOptionsIResolvableCaptureOptionsinterface{}required#

Specifies whether the endpoint captures input data to your model, output data from your model, or both.

destinationS3Uristringdestination_s3_uristrdestinationS3UriStringDestinationS3UristringDestinationS3Uri*stringrequired#

The S3 bucket where model monitor stores captured data.

enableCapture?optionalboolean | IResolvableenable_capture?optionaltyping.Union[bool, IResolvable]enableCapture?optionalBooleanEnableCapture?optionalboolEnableCapture?optionalinterface{}#

Set to `True` to enable data capture.

initialSamplingPercentagenumberinitial_sampling_percentageint | floatinitialSamplingPercentageNumberInitialSamplingPercentagedoubleInitialSamplingPercentage*float64required#

The percentage of data to capture.

kmsKeyId?optionalstringkms_key_id?optionalstrkmsKeyId?optionalStringKmsKeyId?optionalstringKmsKeyId?optional*string#

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.

notes

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.