This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.
AWS::SageMaker::EndpointConfig DataCaptureConfig
Specifies the configuration of your endpoint for model monitor data capture.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "CaptureContentTypeHeader" :CaptureContentTypeHeader, "CaptureOptions" :[ CaptureOption, ... ], "DestinationS3Uri" :String, "EnableCapture" :Boolean, "InitialSamplingPercentage" :Integer, "KmsKeyId" :String}
YAML
CaptureContentTypeHeader:CaptureContentTypeHeaderCaptureOptions:- CaptureOptionDestinationS3Uri:StringEnableCapture:BooleanInitialSamplingPercentage:IntegerKmsKeyId:String
Properties
CaptureContentTypeHeader-
A list of the JSON and CSV content type that the endpoint captures.
Required: No
Type: CaptureContentTypeHeader
Update requires: Replacement
CaptureOptions-
Specifies whether the endpoint captures input data to your model, output data from your model, or both.
Required: Yes
Type: Array of CaptureOption
Minimum:
1Maximum:
32Update requires: Replacement
DestinationS3Uri-
The S3 bucket where model monitor stores captured data.
Required: Yes
Type: String
Pattern:
(https|s3)://([^/])/?(.*)Minimum:
0Maximum:
512Update requires: Replacement
EnableCapture-
Set to
Trueto enable data capture.Required: No
Type: Boolean
Update requires: Replacement
InitialSamplingPercentage-
The percentage of data to capture.
Required: Yes
Type: Integer
Minimum:
0Maximum:
100Update requires: Replacement
KmsKeyId-
The Amazon Key Management Service (Amazon 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 Amazon KMS (http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) in the Amazon Key Management Service Developer Guide.
Required: No
Type: String
Pattern:
[a-zA-Z0-9:/_-]*Minimum:
0Maximum:
2048Update requires: Replacement