Skip to content
v2.277.0

EndpointInputProperty Struct ​

Input object for the endpoint.

Example ​

ts
// 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 endpointInputProperty: sagemaker.CfnDataQualityJobDefinition.EndpointInputProperty = {
  endpointName: 'endpointName',
  localPath: 'localPath',

  // the properties below are optional
  excludeFeaturesAttribute: 'excludeFeaturesAttribute',
  s3DataDistributionType: 's3DataDistributionType',
  s3InputMode: 's3InputMode',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sagemaker as sagemaker

endpoint_input_property = sagemaker.CfnDataQualityJobDefinition.EndpointInputProperty(
    endpoint_name="endpointName",
    local_path="localPath",

    # the properties below are optional
    exclude_features_attribute="excludeFeaturesAttribute",
    s3_data_distribution_type="s3DataDistributionType",
    s3_input_mode="s3InputMode"
)
java
// 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.*;

EndpointInputProperty endpointInputProperty = EndpointInputProperty.builder()
        .endpointName("endpointName")
        .localPath("localPath")

        // the properties below are optional
        .excludeFeaturesAttribute("excludeFeaturesAttribute")
        .s3DataDistributionType("s3DataDistributionType")
        .s3InputMode("s3InputMode")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// 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 endpointInputProperty = new EndpointInputProperty {
    EndpointName = "endpointName",
    LocalPath = "localPath",

    // the properties below are optional
    ExcludeFeaturesAttribute = "excludeFeaturesAttribute",
    S3DataDistributionType = "s3DataDistributionType",
    S3InputMode = "s3InputMode"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

endpointInputProperty := &EndpointInputProperty{
	EndpointName: jsii.String("endpointName"),
	LocalPath: jsii.String("localPath"),

	// the properties below are optional
	ExcludeFeaturesAttribute: jsii.String("excludeFeaturesAttribute"),
	S3DataDistributionType: jsii.String("s3DataDistributionType"),
	S3InputMode: jsii.String("s3InputMode"),
}

Properties ​

endpointNamestringendpoint_namestrendpointNameStringEndpointNamestringEndpointName*stringrequired#
An endpoint in customer's account which has enabled `DataCaptureConfig` enabled.
excludeFeaturesAttributeoptionalstringexclude_features_attributeoptionalstrexcludeFeaturesAttributeoptionalStringExcludeFeaturesAttributeoptionalstringExcludeFeaturesAttributeoptional*string#
The attributes of the input data to exclude from the analysis.
localPathstringlocal_pathstrlocalPathStringLocalPathstringLocalPath*stringrequired#
Path to the filesystem where the endpoint data is available to the container.
s3DataDistributionTypeoptionalstrings3_data_distribution_typeoptionalstrs3DataDistributionTypeoptionalStringS3DataDistributionTypeoptionalstringS3DataDistributionTypeoptional*string#
Whether input data distributed in Amazon S3 is fully replicated or sharded by an Amazon S3 key.

Defaults to FullyReplicated

s3InputModeoptionalstrings3_input_modeoptionalstrs3InputModeoptionalStringS3InputModeoptionalstringS3InputModeoptional*string#
Whether the `Pipe` or `File` is used as the input mode for transferring data for the monitoring job.

Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File .