software.amazon.awscdk.services.sagemaker

Class CfnModel

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

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.810Z")
 @Stability(value=Stable)
public class CfnModel
extends CfnResource
implements IInspectable

A CloudFormation `AWS::SageMaker::Model`.

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.*;
 Object environment;
 CfnModel cfnModel = CfnModel.Builder.create(this, "MyCfnModel")
         .executionRoleArn("executionRoleArn")
         // the properties below are optional
         .containers(List.of(ContainerDefinitionProperty.builder()
                 .containerHostname("containerHostname")
                 .environment(environment)
                 .image("image")
                 .imageConfig(ImageConfigProperty.builder()
                         .repositoryAccessMode("repositoryAccessMode")
                         // the properties below are optional
                         .repositoryAuthConfig(RepositoryAuthConfigProperty.builder()
                                 .repositoryCredentialsProviderArn("repositoryCredentialsProviderArn")
                                 .build())
                         .build())
                 .mode("mode")
                 .modelDataUrl("modelDataUrl")
                 .modelPackageName("modelPackageName")
                 .multiModelConfig(MultiModelConfigProperty.builder()
                         .modelCacheSetting("modelCacheSetting")
                         .build())
                 .build()))
         .enableNetworkIsolation(false)
         .inferenceExecutionConfig(InferenceExecutionConfigProperty.builder()
                 .mode("mode")
                 .build())
         .modelName("modelName")
         .primaryContainer(ContainerDefinitionProperty.builder()
                 .containerHostname("containerHostname")
                 .environment(environment)
                 .image("image")
                 .imageConfig(ImageConfigProperty.builder()
                         .repositoryAccessMode("repositoryAccessMode")
                         // the properties below are optional
                         .repositoryAuthConfig(RepositoryAuthConfigProperty.builder()
                                 .repositoryCredentialsProviderArn("repositoryCredentialsProviderArn")
                                 .build())
                         .build())
                 .mode("mode")
                 .modelDataUrl("modelDataUrl")
                 .modelPackageName("modelPackageName")
                 .multiModelConfig(MultiModelConfigProperty.builder()
                         .modelCacheSetting("modelCacheSetting")
                         .build())
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vpcConfig(VpcConfigProperty.builder()
                 .securityGroupIds(List.of("securityGroupIds"))
                 .subnets(List.of("subnets"))
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnModel.Builder A fluent builder for CfnModel.
static interface	CfnModel.ContainerDefinitionProperty Example:
static interface	CfnModel.ImageConfigProperty Example:
static interface	CfnModel.InferenceExecutionConfigProperty Example:
static interface	CfnModel.MultiModelConfigProperty Example:
static interface	CfnModel.RepositoryAuthConfigProperty Example:
static interface	CfnModel.VpcConfigProperty 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
	CfnModel(software.constructs.Construct scope, String id, CfnModelProps props) Create a new `AWS::SageMaker::Model`.
protected	CfnModel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnModel(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrModelName()
protected Map<String,Object>	getCfnProperties()
Object	getContainers() `AWS::SageMaker::Model.Containers`.
Object	getEnableNetworkIsolation() `AWS::SageMaker::Model.EnableNetworkIsolation`.
String	getExecutionRoleArn() `AWS::SageMaker::Model.ExecutionRoleArn`.
Object	getInferenceExecutionConfig() `AWS::SageMaker::Model.InferenceExecutionConfig`.
String	getModelName() `AWS::SageMaker::Model.ModelName`.
Object	getPrimaryContainer() `AWS::SageMaker::Model.PrimaryContainer`.
TagManager	getTags() `AWS::SageMaker::Model.Tags`.
Object	getVpcConfig() `AWS::SageMaker::Model.VpcConfig`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setContainers(IResolvable value) `AWS::SageMaker::Model.Containers`.
void	setContainers(List<Object> value) `AWS::SageMaker::Model.Containers`.
void	setEnableNetworkIsolation(Boolean value) `AWS::SageMaker::Model.EnableNetworkIsolation`.
void	setEnableNetworkIsolation(IResolvable value) `AWS::SageMaker::Model.EnableNetworkIsolation`.
void	setExecutionRoleArn(String value) `AWS::SageMaker::Model.ExecutionRoleArn`.
void	setInferenceExecutionConfig(CfnModel.InferenceExecutionConfigProperty value) `AWS::SageMaker::Model.InferenceExecutionConfig`.
void	setInferenceExecutionConfig(IResolvable value) `AWS::SageMaker::Model.InferenceExecutionConfig`.
void	setModelName(String value) `AWS::SageMaker::Model.ModelName`.
void	setPrimaryContainer(CfnModel.ContainerDefinitionProperty value) `AWS::SageMaker::Model.PrimaryContainer`.
void	setPrimaryContainer(IResolvable value) `AWS::SageMaker::Model.PrimaryContainer`.
void	setVpcConfig(CfnModel.VpcConfigProperty value) `AWS::SageMaker::Model.VpcConfig`.
void	setVpcConfig(IResolvable value) `AWS::SageMaker::Model.VpcConfig`.

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

CfnModel

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

CfnModel

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

CfnModel

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

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

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.

getAttrModelName

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getContainers

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

`AWS::SageMaker::Model.Containers`.

setContainers

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

`AWS::SageMaker::Model.Containers`.

setContainers

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

`AWS::SageMaker::Model.Containers`.

getEnableNetworkIsolation

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

`AWS::SageMaker::Model.EnableNetworkIsolation`.

setEnableNetworkIsolation

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

`AWS::SageMaker::Model.EnableNetworkIsolation`.

setEnableNetworkIsolation

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

`AWS::SageMaker::Model.EnableNetworkIsolation`.

getExecutionRoleArn

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

`AWS::SageMaker::Model.ExecutionRoleArn`.

setExecutionRoleArn

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

`AWS::SageMaker::Model.ExecutionRoleArn`.

getInferenceExecutionConfig

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

`AWS::SageMaker::Model.InferenceExecutionConfig`.

setInferenceExecutionConfig

@Stability(value=Stable)
public void setInferenceExecutionConfig(@Nullable
                                                                 CfnModel.InferenceExecutionConfigProperty value)

`AWS::SageMaker::Model.InferenceExecutionConfig`.

setInferenceExecutionConfig

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

`AWS::SageMaker::Model.InferenceExecutionConfig`.

getModelName

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

`AWS::SageMaker::Model.ModelName`.

setModelName

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

`AWS::SageMaker::Model.ModelName`.

getPrimaryContainer

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

`AWS::SageMaker::Model.PrimaryContainer`.

setPrimaryContainer

@Stability(value=Stable)
public void setPrimaryContainer(@Nullable
                                                         CfnModel.ContainerDefinitionProperty value)

`AWS::SageMaker::Model.PrimaryContainer`.

setPrimaryContainer

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

`AWS::SageMaker::Model.PrimaryContainer`.

getTags

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

`AWS::SageMaker::Model.Tags`.

getVpcConfig

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

`AWS::SageMaker::Model.VpcConfig`.

setVpcConfig

@Stability(value=Stable)
public void setVpcConfig(@Nullable
                                                  CfnModel.VpcConfigProperty value)

`AWS::SageMaker::Model.VpcConfig`.

setVpcConfig

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

`AWS::SageMaker::Model.VpcConfig`.