software.amazon.awscdk.services.sagemaker

Class CfnEndpoint

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.sagemaker.CfnEndpoint

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:07.803Z")
 @Stability(value=Stable)
public class CfnEndpoint
extends CfnResource
implements IInspectable

A CloudFormation `AWS::SageMaker::Endpoint`.

Example:

 // 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.*;
 CfnEndpoint cfnEndpoint = CfnEndpoint.Builder.create(this, "MyCfnEndpoint")
         .endpointConfigName("endpointConfigName")
         // the properties below are optional
         .deploymentConfig(DeploymentConfigProperty.builder()
                 .blueGreenUpdatePolicy(BlueGreenUpdatePolicyProperty.builder()
                         .trafficRoutingConfiguration(TrafficRoutingConfigProperty.builder()
                                 .type("type")
                                 // the properties below are optional
                                 .canarySize(CapacitySizeProperty.builder()
                                         .type("type")
                                         .value(123)
                                         .build())
                                 .linearStepSize(CapacitySizeProperty.builder()
                                         .type("type")
                                         .value(123)
                                         .build())
                                 .waitIntervalInSeconds(123)
                                 .build())
                         // the properties below are optional
                         .maximumExecutionTimeoutInSeconds(123)
                         .terminationWaitInSeconds(123)
                         .build())
                 // the properties below are optional
                 .autoRollbackConfiguration(AutoRollbackConfigProperty.builder()
                         .alarms(List.of(AlarmProperty.builder()
                                 .alarmName("alarmName")
                                 .build()))
                         .build())
                 .build())
         .endpointName("endpointName")
         .excludeRetainedVariantProperties(List.of(VariantPropertyProperty.builder()
                 .variantPropertyType("variantPropertyType")
                 .build()))
         .retainAllVariantProperties(false)
         .retainDeploymentConfig(false)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnEndpoint.AlarmProperty Example:
static interface	CfnEndpoint.AutoRollbackConfigProperty Example:
static interface	CfnEndpoint.BlueGreenUpdatePolicyProperty Example:
static class	CfnEndpoint.Builder A fluent builder for CfnEndpoint.
static interface	CfnEndpoint.CapacitySizeProperty Example:
static interface	CfnEndpoint.DeploymentConfigProperty Example:
static interface	CfnEndpoint.TrafficRoutingConfigProperty Example:
static interface	CfnEndpoint.VariantPropertyProperty Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnEndpoint(software.constructs.Construct scope, String id, CfnEndpointProps props) Create a new `AWS::SageMaker::Endpoint`.
protected	CfnEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnEndpoint(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrEndpointName()
protected Map<String,Object>	getCfnProperties()
Object	getDeploymentConfig() `AWS::SageMaker::Endpoint.DeploymentConfig`.
String	getEndpointConfigName() `AWS::SageMaker::Endpoint.EndpointConfigName`.
String	getEndpointName() `AWS::SageMaker::Endpoint.EndpointName`.
Object	getExcludeRetainedVariantProperties() `AWS::SageMaker::Endpoint.ExcludeRetainedVariantProperties`.
Object	getRetainAllVariantProperties() `AWS::SageMaker::Endpoint.RetainAllVariantProperties`.
Object	getRetainDeploymentConfig() `AWS::SageMaker::Endpoint.RetainDeploymentConfig`.
TagManager	getTags() `AWS::SageMaker::Endpoint.Tags`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDeploymentConfig(CfnEndpoint.DeploymentConfigProperty value) `AWS::SageMaker::Endpoint.DeploymentConfig`.
void	setDeploymentConfig(IResolvable value) `AWS::SageMaker::Endpoint.DeploymentConfig`.
void	setEndpointConfigName(String value) `AWS::SageMaker::Endpoint.EndpointConfigName`.
void	setEndpointName(String value) `AWS::SageMaker::Endpoint.EndpointName`.
void	setExcludeRetainedVariantProperties(IResolvable value) `AWS::SageMaker::Endpoint.ExcludeRetainedVariantProperties`.
void	setExcludeRetainedVariantProperties(List<Object> value) `AWS::SageMaker::Endpoint.ExcludeRetainedVariantProperties`.
void	setRetainAllVariantProperties(Boolean value) `AWS::SageMaker::Endpoint.RetainAllVariantProperties`.
void	setRetainAllVariantProperties(IResolvable value) `AWS::SageMaker::Endpoint.RetainAllVariantProperties`.
void	setRetainDeploymentConfig(Boolean value) `AWS::SageMaker::Endpoint.RetainDeploymentConfig`.
void	setRetainDeploymentConfig(IResolvable value) `AWS::SageMaker::Endpoint.RetainDeploymentConfig`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnEndpoint

protected CfnEndpoint(software.amazon.jsii.JsiiObjectRef objRef)

CfnEndpoint

protected CfnEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnEndpoint

@Stability(value=Stable)
public CfnEndpoint(@NotNull
                                            software.constructs.Construct scope,
                                            @NotNull
                                            String id,
                                            @NotNull
                                            CfnEndpointProps props)

Create a new `AWS::SageMaker::Endpoint`.

Parameters:

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

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

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrEndpointName

@Stability(value=Stable)
 @NotNull
public String getAttrEndpointName()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDeploymentConfig

@Stability(value=Stable)
 @Nullable
public Object getDeploymentConfig()

`AWS::SageMaker::Endpoint.DeploymentConfig`.

setDeploymentConfig

@Stability(value=Stable)
public void setDeploymentConfig(@Nullable
                                                         CfnEndpoint.DeploymentConfigProperty value)

`AWS::SageMaker::Endpoint.DeploymentConfig`.

setDeploymentConfig

@Stability(value=Stable)
public void setDeploymentConfig(@Nullable
                                                         IResolvable value)

`AWS::SageMaker::Endpoint.DeploymentConfig`.

getEndpointConfigName

@Stability(value=Stable)
 @NotNull
public String getEndpointConfigName()

`AWS::SageMaker::Endpoint.EndpointConfigName`.

setEndpointConfigName

@Stability(value=Stable)
public void setEndpointConfigName(@NotNull
                                                           String value)

`AWS::SageMaker::Endpoint.EndpointConfigName`.

getEndpointName

@Stability(value=Stable)
 @Nullable
public String getEndpointName()

`AWS::SageMaker::Endpoint.EndpointName`.

setEndpointName

@Stability(value=Stable)
public void setEndpointName(@Nullable
                                                     String value)

`AWS::SageMaker::Endpoint.EndpointName`.

getExcludeRetainedVariantProperties

@Stability(value=Stable)
 @Nullable
public Object getExcludeRetainedVariantProperties()

`AWS::SageMaker::Endpoint.ExcludeRetainedVariantProperties`.

setExcludeRetainedVariantProperties

@Stability(value=Stable)
public void setExcludeRetainedVariantProperties(@Nullable
                                                                         IResolvable value)

`AWS::SageMaker::Endpoint.ExcludeRetainedVariantProperties`.

setExcludeRetainedVariantProperties

@Stability(value=Stable)
public void setExcludeRetainedVariantProperties(@Nullable
                                                                         List<Object> value)

`AWS::SageMaker::Endpoint.ExcludeRetainedVariantProperties`.

getRetainAllVariantProperties

@Stability(value=Stable)
 @Nullable
public Object getRetainAllVariantProperties()

`AWS::SageMaker::Endpoint.RetainAllVariantProperties`.

setRetainAllVariantProperties

@Stability(value=Stable)
public void setRetainAllVariantProperties(@Nullable
                                                                   Boolean value)

`AWS::SageMaker::Endpoint.RetainAllVariantProperties`.

setRetainAllVariantProperties

@Stability(value=Stable)
public void setRetainAllVariantProperties(@Nullable
                                                                   IResolvable value)

`AWS::SageMaker::Endpoint.RetainAllVariantProperties`.

getRetainDeploymentConfig

@Stability(value=Stable)
 @Nullable
public Object getRetainDeploymentConfig()

`AWS::SageMaker::Endpoint.RetainDeploymentConfig`.

setRetainDeploymentConfig

@Stability(value=Stable)
public void setRetainDeploymentConfig(@Nullable
                                                               Boolean value)

`AWS::SageMaker::Endpoint.RetainDeploymentConfig`.

setRetainDeploymentConfig

@Stability(value=Stable)
public void setRetainDeploymentConfig(@Nullable
                                                               IResolvable value)

`AWS::SageMaker::Endpoint.RetainDeploymentConfig`.

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::SageMaker::Endpoint.Tags`.