Class CfnEndpoint
A CloudFormation AWS::SageMaker::Endpoint
.
Inherited Members
Namespace: Amazon.CDK.AWS.Sagemaker
Assembly: Amazon.CDK.AWS.Sagemaker.dll
Syntax (csharp)
public class CfnEndpoint : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnEndpoint
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Use the AWS::SageMaker::Endpoint
resource to create an endpoint using the specified configuration in the request. Amazon SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the AWS::SageMaker::EndpointConfig resource. For more information, see Deploy a Model on Amazon SageMaker Hosting Services in the Amazon SageMaker Developer Guide .
CloudformationResource: AWS::SageMaker::Endpoint
Link: 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 cfnEndpoint = new CfnEndpoint(this, "MyCfnEndpoint", new CfnEndpointProps {
EndpointConfigName = "endpointConfigName",
// the properties below are optional
DeploymentConfig = new DeploymentConfigProperty {
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
},
// the properties below are optional
AutoRollbackConfiguration = new AutoRollbackConfigProperty {
Alarms = new [] { new AlarmProperty {
AlarmName = "alarmName"
} }
}
},
EndpointName = "endpointName",
ExcludeRetainedVariantProperties = new [] { new VariantPropertyProperty {
VariantPropertyType = "variantPropertyType"
} },
RetainAllVariantProperties = false,
RetainDeploymentConfig = false,
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnEndpoint(Construct, String, ICfnEndpointProps) | Create a new |
CfnEndpoint(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnEndpoint(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrEndpointName | The name of the endpoint, such as |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnEndpoint(Construct, String, ICfnEndpointProps)
Create a new AWS::SageMaker::Endpoint
.
public CfnEndpoint(Construct scope, string id, ICfnEndpointProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnEndpointProps
- resource properties.
CfnEndpoint(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnEndpoint(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnEndpoint(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnEndpoint(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrEndpointName
The name of the endpoint, such as MyEndpoint
.
public virtual string AttrEndpointName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: EndpointName
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DeploymentConfig
The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.
public virtual 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 virtual 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 virtual 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 virtual 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 virtual 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 virtual 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 virtual TagManager Tags { get; }
Property Value
Remarks
For more information, see Resource Tag and Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide .
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>