Package software.amazon.awscdk.cfnpropertymixins.services.sagemaker

Interface CfnEndpointConfigPropsMixin.DataCaptureConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEndpointConfigPropsMixin.DataCaptureConfigProperty.Jsii$Proxy

Enclosing class:

CfnEndpointConfigPropsMixin

@Stability(Stable)
public static interface CfnEndpointConfigPropsMixin.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.cfnpropertymixins.services.sagemaker.*;
 DataCaptureConfigProperty dataCaptureConfigProperty = DataCaptureConfigProperty.builder()
         .captureContentTypeHeader(CaptureContentTypeHeaderProperty.builder()
                 .csvContentTypes(List.of("csvContentTypes"))
                 .jsonContentTypes(List.of("jsonContentTypes"))
                 .build())
         .captureOptions(List.of(CaptureOptionProperty.builder()
                 .captureMode("captureMode")
                 .build()))
         .destinationS3Uri("destinationS3Uri")
         .enableCapture(false)
         .initialSamplingPercentage(123)
         .kmsKeyId("kmsKeyId")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-datacaptureconfig.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEndpointConfigPropsMixin.DataCaptureConfigProperty.Builder	A builder for CfnEndpointConfigPropsMixin.DataCaptureConfigProperty
static final class	CfnEndpointConfigPropsMixin.DataCaptureConfigProperty.Jsii$Proxy	An implementation for CfnEndpointConfigPropsMixin.DataCaptureConfigProperty

Method Summary

Modifier and Type	Method	Description
static CfnEndpointConfigPropsMixin.DataCaptureConfigProperty.Builder	builder()
default Object	getCaptureContentTypeHeader()	A list of the JSON and CSV content type that the endpoint captures.
default Object	getCaptureOptions()	Specifies whether the endpoint captures input data to your model, output data from your model, or both.
default String	getDestinationS3Uri()	The S3 bucket where model monitor stores captured data.
default Object	getEnableCapture()	Set to True to enable data capture.
default Number	getInitialSamplingPercentage()	The percentage of data to capture.
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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCaptureContentTypeHeader

@Stability(Stable)
@Nullable
default Object getCaptureContentTypeHeader()

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

Returns union: either IResolvable or CfnEndpointConfigPropsMixin.CaptureContentTypeHeaderProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-datacaptureconfig.html#cfn-sagemaker-endpointconfig-datacaptureconfig-capturecontenttypeheader

getCaptureOptions

@Stability(Stable)
@Nullable
default Object getCaptureOptions()

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnEndpointConfigPropsMixin.CaptureOptionProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-datacaptureconfig.html#cfn-sagemaker-endpointconfig-datacaptureconfig-captureoptions

getDestinationS3Uri

@Stability(Stable)
@Nullable
default String getDestinationS3Uri()

The S3 bucket where model monitor stores captured data.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-datacaptureconfig.html#cfn-sagemaker-endpointconfig-datacaptureconfig-destinations3uri

getEnableCapture

@Stability(Stable)
@Nullable
default Object getEnableCapture()

Set to True to enable data capture.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-datacaptureconfig.html#cfn-sagemaker-endpointconfig-datacaptureconfig-enablecapture

getInitialSamplingPercentage

@Stability(Stable)
@Nullable
default Number getInitialSamplingPercentage()

The percentage of data to capture.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-datacaptureconfig.html#cfn-sagemaker-endpointconfig-datacaptureconfig-initialsamplingpercentage

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-datacaptureconfig.html#cfn-sagemaker-endpointconfig-datacaptureconfig-kmskeyid

builder

@Stability(Stable)
static CfnEndpointConfigPropsMixin.DataCaptureConfigProperty.Builder builder()

Returns:

a CfnEndpointConfigPropsMixin.DataCaptureConfigProperty.Builder of CfnEndpointConfigPropsMixin.DataCaptureConfigProperty