software.amazon.awscdk.services.sagemaker

Class CfnEndpoint.Builder

java.lang.Object

software.amazon.awscdk.services.sagemaker.CfnEndpoint.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnEndpoint>

Enclosing class:

CfnEndpoint

@Stability(value=Stable)
public static final class CfnEndpoint.Builder
extends Object
implements software.amazon.jsii.Builder<CfnEndpoint>

A fluent builder for CfnEndpoint.

Method Summary

Modifier and Type	Method and Description
CfnEndpoint	build()
static CfnEndpoint.Builder	create(software.constructs.Construct scope, String id)
CfnEndpoint.Builder	deploymentConfig(CfnEndpoint.DeploymentConfigProperty deploymentConfig) The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.
CfnEndpoint.Builder	deploymentConfig(IResolvable deploymentConfig) The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.
CfnEndpoint.Builder	endpointConfigName(String endpointConfigName) 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.
CfnEndpoint.Builder	endpointName(String endpointName) The name of the endpoint.The name must be unique within an AWS Region in your AWS account.
CfnEndpoint.Builder	excludeRetainedVariantProperties(IResolvable excludeRetainedVariantProperties) 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` .
CfnEndpoint.Builder	excludeRetainedVariantProperties(List<? extends Object> excludeRetainedVariantProperties) 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` .
CfnEndpoint.Builder	retainAllVariantProperties(Boolean retainAllVariantProperties) When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight.
CfnEndpoint.Builder	retainAllVariantProperties(IResolvable retainAllVariantProperties) When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight.
CfnEndpoint.Builder	retainDeploymentConfig(Boolean retainDeploymentConfig) Specifies whether to reuse the last deployment configuration.
CfnEndpoint.Builder	retainDeploymentConfig(IResolvable retainDeploymentConfig) Specifies whether to reuse the last deployment configuration.
CfnEndpoint.Builder	tags(List<? extends CfnTag> tags) A list of key-value pairs to apply to this resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static CfnEndpoint.Builder create(software.constructs.Construct scope,
                                                                  String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnEndpoint.AlarmProperty.Builder.

endpointConfigName

@Stability(value=Stable)
public CfnEndpoint.Builder endpointConfigName(String endpointConfigName)

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) .

Parameters:

endpointConfigName - 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) . This parameter is required.

Returns:

this

deploymentConfig

@Stability(value=Stable)
public CfnEndpoint.Builder deploymentConfig(CfnEndpoint.DeploymentConfigProperty deploymentConfig)

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

Parameters:

deploymentConfig - The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations. This parameter is required.

Returns:

this

deploymentConfig

@Stability(value=Stable)
public CfnEndpoint.Builder deploymentConfig(IResolvable deploymentConfig)

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

Parameters:

deploymentConfig - The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations. This parameter is required.

Returns:

this

endpointName

@Stability(value=Stable)
public CfnEndpoint.Builder endpointName(String endpointName)

The name of the endpoint.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 [](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html) .

Parameters:

endpointName - The name of the endpoint.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 [](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html) . This parameter is required.

Returns:

this

excludeRetainedVariantProperties

@Stability(value=Stable)
public CfnEndpoint.Builder excludeRetainedVariantProperties(IResolvable excludeRetainedVariantProperties)

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` .

Parameters:

excludeRetainedVariantProperties - 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` . This parameter is required.

Returns:

this

excludeRetainedVariantProperties

@Stability(value=Stable)
public CfnEndpoint.Builder excludeRetainedVariantProperties(List<? extends Object> excludeRetainedVariantProperties)

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` .

Parameters:

excludeRetainedVariantProperties - 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` . This parameter is required.

Returns:

this

retainAllVariantProperties

@Stability(value=Stable)
public CfnEndpoint.Builder retainAllVariantProperties(Boolean retainAllVariantProperties)

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

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.

Parameters:

retainAllVariantProperties - When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight. This parameter is required.

Returns:

this

retainAllVariantProperties

@Stability(value=Stable)
public CfnEndpoint.Builder retainAllVariantProperties(IResolvable retainAllVariantProperties)

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

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.

Parameters:

retainAllVariantProperties - When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight. This parameter is required.

Returns:

this

retainDeploymentConfig

@Stability(value=Stable)
public CfnEndpoint.Builder retainDeploymentConfig(Boolean retainDeploymentConfig)

Specifies whether to reuse the last deployment configuration.

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

Parameters:

retainDeploymentConfig - Specifies whether to reuse the last deployment configuration. This parameter is required.

Returns:

this

retainDeploymentConfig

@Stability(value=Stable)
public CfnEndpoint.Builder retainDeploymentConfig(IResolvable retainDeploymentConfig)

Specifies whether to reuse the last deployment configuration.

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

Parameters:

retainDeploymentConfig - Specifies whether to reuse the last deployment configuration. This parameter is required.

Returns:

this

tags

@Stability(value=Stable)
public CfnEndpoint.Builder tags(List<? extends CfnTag> tags)

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

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

Parameters:

tags - A list of key-value pairs to apply to this resource. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnEndpoint build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnEndpoint>