Class CfnEndpointProps
Properties for defining a CfnEndpoint
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Sagemaker
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnEndpointProps : Object, ICfnEndpointProps
Syntax (vb)
Public Class CfnEndpointProps
Inherits Object
Implements ICfnEndpointProps
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpoint.html
ExampleMetadata: fixture=_generated
Examples
// 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 cfnEndpointProps = new CfnEndpointProps {
EndpointConfigName = "endpointConfigName",
// the properties below are optional
DeploymentConfig = new DeploymentConfigProperty {
AutoRollbackConfiguration = new AutoRollbackConfigProperty {
Alarms = new [] { new AlarmProperty {
AlarmName = "alarmName"
} }
},
BlueGreenUpdatePolicy = new BlueGreenUpdatePolicyProperty {
TrafficRoutingConfiguration = new TrafficRoutingConfigProperty {
Type = "type",
// the properties below are optional
CanarySize = new CapacitySizeProperty {
Type = "type",
Value = 123
},
LinearStepSize = new CapacitySizeProperty {
Type = "type",
Value = 123
},
WaitIntervalInSeconds = 123
},
// the properties below are optional
MaximumExecutionTimeoutInSeconds = 123,
TerminationWaitInSeconds = 123
},
RollingUpdatePolicy = new RollingUpdatePolicyProperty {
MaximumBatchSize = new CapacitySizeProperty {
Type = "type",
Value = 123
},
WaitIntervalInSeconds = 123,
// the properties below are optional
MaximumExecutionTimeoutInSeconds = 123,
RollbackMaximumBatchSize = new CapacitySizeProperty {
Type = "type",
Value = 123
}
}
},
EndpointName = "endpointName",
ExcludeRetainedVariantProperties = new [] { new VariantPropertyProperty {
VariantPropertyType = "variantPropertyType"
} },
RetainAllVariantProperties = false,
RetainDeploymentConfig = false,
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};
Synopsis
Constructors
CfnEndpointProps() |
Properties
DeploymentConfig | The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations. |
EndpointConfigName | The name of the AWS::SageMaker::EndpointConfig resource that specifies the configuration for the endpoint. For more information, see CreateEndpointConfig . |
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 |
ExcludeRetainedVariantProperties | When you are updating endpoint resources with RetainAllVariantProperties whose value is set to |
RetainAllVariantProperties | When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight. |
RetainDeploymentConfig | Specifies whether to reuse the last deployment configuration. |
Tags | A list of key-value pairs to apply to this resource. |
Constructors
CfnEndpointProps()
public CfnEndpointProps()
Properties
DeploymentConfig
The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.
public object DeploymentConfig { get; set; }
Property Value
System.Object
Remarks
EndpointConfigName
The name of the AWS::SageMaker::EndpointConfig resource that specifies the configuration for the endpoint. For more information, see CreateEndpointConfig .
public string EndpointConfigName { get; set; }
Property Value
System.String
Remarks
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 .
public string EndpointName { get; set; }
Property Value
System.String
Remarks
ExcludeRetainedVariantProperties
When you are updating endpoint resources with RetainAllVariantProperties whose value is set to true
, ExcludeRetainedVariantProperties
specifies the list of type VariantProperty 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
.
public object ExcludeRetainedVariantProperties { get; set; }
Property Value
System.Object
Remarks
RetainAllVariantProperties
When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight.
public object RetainAllVariantProperties { get; set; }
Property Value
System.Object
Remarks
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.
RetainDeploymentConfig
Specifies whether to reuse the last deployment configuration.
public object RetainDeploymentConfig { get; set; }
Property Value
System.Object
Remarks
The default value is false (the configuration is not reused).
Tags
A list of key-value pairs to apply to this resource.
public ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
Remarks
For more information, see Resource Tag and Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide .