aws-cdk-lib.aws_sagemaker.CfnEndpointProps

CfnEndpointProps Struct

Properties for defining a CfnEndpoint.

Source

Generated code

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 cfnEndpointProps: sagemaker.CfnEndpointProps = {
  endpointConfigName: 'endpointConfigName',

  // the properties below are optional
  deploymentConfig: {
    autoRollbackConfiguration: {
      alarms: [{
        alarmName: 'alarmName',
      }],
    },
    blueGreenUpdatePolicy: {
      trafficRoutingConfiguration: {
        type: 'type',

        // the properties below are optional
        canarySize: {
          type: 'type',
          value: 123,
        },
        linearStepSize: {
          type: 'type',
          value: 123,
        },
        waitIntervalInSeconds: 123,
      },

      // the properties below are optional
      maximumExecutionTimeoutInSeconds: 123,
      terminationWaitInSeconds: 123,
    },
    rollingUpdatePolicy: {
      maximumBatchSize: {
        type: 'type',
        value: 123,
      },
      waitIntervalInSeconds: 123,

      // the properties below are optional
      maximumExecutionTimeoutInSeconds: 123,
      rollbackMaximumBatchSize: {
        type: 'type',
        value: 123,
      },
    },
  },
  endpointName: 'endpointName',
  excludeRetainedVariantProperties: [{
    variantPropertyType: 'variantPropertyType',
  }],
  retainAllVariantProperties: false,
  retainDeploymentConfig: false,
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

deploymentConfigIResolvable | CfnEndpoint.DeploymentConfigPropertydeployment_configtyping.Union[IResolvable, DeploymentConfigProperty]deploymentConfigIResolvableDeploymentConfigIResolvableDeploymentConfiginterface{}#

The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.

endpointConfigNamestringendpoint_config_namestrendpointConfigNameStringEndpointConfigNamestringEndpointConfigName*stringrequired#

The name of the [AWS::SageMaker::EndpointConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html) resource that specifies the configuration for the endpoint. For more information, see [CreateEndpointConfig](https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpointConfig.html) .

endpointNamestringendpoint_namestrendpointNameStringEndpointNamestringEndpointName*string#

The name of the endpoint.

notes

The name must be unique within an AWS Region in your AWS account. The name is case-insensitive in CreateEndpoint , but the case is preserved and must be matched in .

excludeRetainedVariantPropertiesIResolvable | IResolvable | CfnEndpoint.VariantPropertyProperty[]exclude_retained_variant_propertiestyping.Union[IResolvable, typing.List[typing.Union[IResolvable, VariantPropertyProperty]]]excludeRetainedVariantPropertiesIResolvableExcludeRetainedVariantPropertiesIResolvableExcludeRetainedVariantPropertiesinterface{}#

When you are updating endpoint resources with [RetainAllVariantProperties](https://docs.aws.amazon.com/sagemaker/latest/dg/API_UpdateEndpoint.html#SageMaker-UpdateEndpoint-request-RetainAllVariantProperties) whose value is set to `true` , `ExcludeRetainedVariantProperties` specifies the list of type [VariantProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-variantproperty.html) to override with the values provided by `EndpointConfig` . If you don't specify a value for `ExcludeAllVariantProperties` , no variant properties are overridden. Don't use this property when creating new endpoint resources or when `RetainAllVariantProperties` is set to `false` .

retainAllVariantPropertiesboolean | IResolvableretain_all_variant_propertiestyping.Union[bool, IResolvable]retainAllVariantPropertiesBooleanRetainAllVariantPropertiesboolRetainAllVariantPropertiesinterface{}#

When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight.

notes

To retain the variant properties of an endpoint when updating it, set RetainAllVariantProperties to true . To use the variant properties specified in a new EndpointConfig call when updating an endpoint, set RetainAllVariantProperties to false . Use this property only when updating endpoint resources, not when creating new endpoint resources.

retainDeploymentConfigboolean | IResolvableretain_deployment_configtyping.Union[bool, IResolvable]retainDeploymentConfigBooleanRetainDeploymentConfigboolRetainDeploymentConfiginterface{}#

Specifies whether to reuse the last deployment configuration.

The default value is false (the configuration is not reused).

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#

A list of key-value pairs to apply to this resource.

notes

For more information, see Resource Tag and Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide .

Used as props by

• CfnEndpoint