Interface CfnEndpointConfig.DataCaptureConfigProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnEndpointConfig.DataCaptureConfigProperty.Jsii$Proxy
Enclosing class:
CfnEndpointConfig

@Stability(Stable) public static interface CfnEndpointConfig.DataCaptureConfigProperty extends software.amazon.jsii.JsiiSerializable
Specifies the configuration of your endpoint for model monitor data capture.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sagemaker.*;
 DataCaptureConfigProperty dataCaptureConfigProperty = DataCaptureConfigProperty.builder()
         .captureOptions(List.of(CaptureOptionProperty.builder()
                 .captureMode("captureMode")
                 .build()))
         .destinationS3Uri("destinationS3Uri")
         .initialSamplingPercentage(123)
         // the properties below are optional
         .captureContentTypeHeader(CaptureContentTypeHeaderProperty.builder()
                 .csvContentTypes(List.of("csvContentTypes"))
                 .jsonContentTypes(List.of("jsonContentTypes"))
                 .build())
         .enableCapture(false)
         .kmsKeyId("kmsKeyId")
         .build();
 
  • Method Details

    • getCaptureOptions

      @Stability(Stable) @NotNull Object getCaptureOptions()
      Specifies whether the endpoint captures input data to your model, output data from your model, or both.
    • getDestinationS3Uri

      @Stability(Stable) @NotNull String getDestinationS3Uri()
      The S3 bucket where model monitor stores captured data.
    • getInitialSamplingPercentage

      @Stability(Stable) @NotNull Number getInitialSamplingPercentage()
      The percentage of data to capture.
    • getCaptureContentTypeHeader

      @Stability(Stable) @Nullable default Object getCaptureContentTypeHeader()
      A list of the JSON and CSV content type that the endpoint captures.
    • getEnableCapture

      @Stability(Stable) @Nullable default Object getEnableCapture()
      Set to True to enable data capture.
    • getKmsKeyId

      @Stability(Stable) @Nullable default String getKmsKeyId()
      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.

      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.

    • builder

      @Stability(Stable) static CfnEndpointConfig.DataCaptureConfigProperty.Builder builder()
      Returns:
      a CfnEndpointConfig.DataCaptureConfigProperty.Builder of CfnEndpointConfig.DataCaptureConfigProperty