Package software.amazon.awscdk.services.sagemaker

Interface CfnContextProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnContextProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)",
           date="2026-08-10T14:51:11.211Z")
@Stability(Stable)
public interface CfnContextProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnContext.

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.*;
 CfnContextProps cfnContextProps = CfnContextProps.builder()
         .contextName("contextName")
         .contextType("contextType")
         .source(SourceProperty.builder()
                 .sourceUri("sourceUri")
                 // the properties below are optional
                 .sourceId("sourceId")
                 .sourceType("sourceType")
                 .build())
         // the properties below are optional
         .description("description")
         .properties(Map.of(
                 "propertiesKey", "properties"))
         .tags(List.of(TagsItemsProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-context.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnContextProps.Builder	A builder for CfnContextProps
static final class	CfnContextProps.Jsii$Proxy	An implementation for CfnContextProps

Method Summary

Modifier and Type	Method	Description
static CfnContextProps.Builder	builder()
String	getContextName()	The name of the context.
String	getContextType()	The context type.
default String	getDescription()	The description of the context.
default Object	getProperties()	A list of properties to add to the context.
Object	getSource()	The source type, ID, and URI.
default List<CfnContext.TagsItemsProperty>	getTags()	A list of tags to apply to the context.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getContextName

@Stability(Stable)
@NotNull
String getContextName()

The name of the context.

Must be unique to your account in an AWS Region.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-context.html#cfn-sagemaker-context-contextname

getContextType

@Stability(Stable)
@NotNull
String getContextType()

The context type.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-context.html#cfn-sagemaker-context-contexttype

getSource

@Stability(Stable)
@NotNull
Object getSource()

The source type, ID, and URI.

Returns union: either IResolvable or CfnContext.SourceProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-context.html#cfn-sagemaker-context-source

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the context.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-context.html#cfn-sagemaker-context-description

getProperties

@Stability(Stable)
@Nullable
default Object getProperties()

A list of properties to add to the context.

Returns union: either IResolvable or Mapinvalid input: '<'String, String>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-context.html#cfn-sagemaker-context-properties

getTags

@Stability(Stable)
@Nullable
default List<CfnContext.TagsItemsProperty> getTags()

A list of tags to apply to the context.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-context.html#cfn-sagemaker-context-tags

builder

@Stability(Stable)
static CfnContextProps.Builder builder()

Returns:

a CfnContextProps.Builder of CfnContextProps