awssagemaker

package
v2.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 9, 2022 License: Apache-2.0 Imports: 6 Imported by: 6

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnAppImageConfig_CFN_RESOURCE_TYPE_NAME

func CfnAppImageConfig_CFN_RESOURCE_TYPE_NAME() *string

func CfnAppImageConfig_IsCfnElement

func CfnAppImageConfig_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnAppImageConfig_IsCfnResource

func CfnAppImageConfig_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnAppImageConfig_IsConstruct

func CfnAppImageConfig_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnApp_CFN_RESOURCE_TYPE_NAME

func CfnApp_CFN_RESOURCE_TYPE_NAME() *string

func CfnApp_IsCfnElement

func CfnApp_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnApp_IsCfnResource

func CfnApp_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnApp_IsConstruct

func CfnApp_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnCodeRepository_CFN_RESOURCE_TYPE_NAME

func CfnCodeRepository_CFN_RESOURCE_TYPE_NAME() *string

func CfnCodeRepository_IsCfnElement

func CfnCodeRepository_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnCodeRepository_IsCfnResource

func CfnCodeRepository_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnCodeRepository_IsConstruct

func CfnCodeRepository_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnDataQualityJobDefinition_CFN_RESOURCE_TYPE_NAME

func CfnDataQualityJobDefinition_CFN_RESOURCE_TYPE_NAME() *string

func CfnDataQualityJobDefinition_IsCfnElement

func CfnDataQualityJobDefinition_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnDataQualityJobDefinition_IsCfnResource

func CfnDataQualityJobDefinition_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnDataQualityJobDefinition_IsConstruct

func CfnDataQualityJobDefinition_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnDeviceFleet_CFN_RESOURCE_TYPE_NAME

func CfnDeviceFleet_CFN_RESOURCE_TYPE_NAME() *string

func CfnDeviceFleet_IsCfnElement

func CfnDeviceFleet_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnDeviceFleet_IsCfnResource

func CfnDeviceFleet_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnDeviceFleet_IsConstruct

func CfnDeviceFleet_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnDevice_CFN_RESOURCE_TYPE_NAME

func CfnDevice_CFN_RESOURCE_TYPE_NAME() *string

func CfnDevice_IsCfnElement

func CfnDevice_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnDevice_IsCfnResource

func CfnDevice_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnDevice_IsConstruct

func CfnDevice_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnDomain_CFN_RESOURCE_TYPE_NAME

func CfnDomain_CFN_RESOURCE_TYPE_NAME() *string

func CfnDomain_IsCfnElement

func CfnDomain_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnDomain_IsCfnResource

func CfnDomain_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnDomain_IsConstruct

func CfnDomain_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnEndpointConfig_CFN_RESOURCE_TYPE_NAME

func CfnEndpointConfig_CFN_RESOURCE_TYPE_NAME() *string

func CfnEndpointConfig_IsCfnElement

func CfnEndpointConfig_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnEndpointConfig_IsCfnResource

func CfnEndpointConfig_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnEndpointConfig_IsConstruct

func CfnEndpointConfig_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnEndpoint_CFN_RESOURCE_TYPE_NAME

func CfnEndpoint_CFN_RESOURCE_TYPE_NAME() *string

func CfnEndpoint_IsCfnElement

func CfnEndpoint_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnEndpoint_IsCfnResource

func CfnEndpoint_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnEndpoint_IsConstruct

func CfnEndpoint_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnFeatureGroup_CFN_RESOURCE_TYPE_NAME

func CfnFeatureGroup_CFN_RESOURCE_TYPE_NAME() *string

func CfnFeatureGroup_IsCfnElement

func CfnFeatureGroup_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnFeatureGroup_IsCfnResource

func CfnFeatureGroup_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnFeatureGroup_IsConstruct

func CfnFeatureGroup_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnImageVersion_CFN_RESOURCE_TYPE_NAME

func CfnImageVersion_CFN_RESOURCE_TYPE_NAME() *string

func CfnImageVersion_IsCfnElement

func CfnImageVersion_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnImageVersion_IsCfnResource

func CfnImageVersion_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnImageVersion_IsConstruct

func CfnImageVersion_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnImage_CFN_RESOURCE_TYPE_NAME

func CfnImage_CFN_RESOURCE_TYPE_NAME() *string

func CfnImage_IsCfnElement

func CfnImage_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnImage_IsCfnResource

func CfnImage_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnImage_IsConstruct

func CfnImage_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnModelBiasJobDefinition_CFN_RESOURCE_TYPE_NAME

func CfnModelBiasJobDefinition_CFN_RESOURCE_TYPE_NAME() *string

func CfnModelBiasJobDefinition_IsCfnElement

func CfnModelBiasJobDefinition_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnModelBiasJobDefinition_IsCfnResource

func CfnModelBiasJobDefinition_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnModelBiasJobDefinition_IsConstruct

func CfnModelBiasJobDefinition_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnModelExplainabilityJobDefinition_CFN_RESOURCE_TYPE_NAME

func CfnModelExplainabilityJobDefinition_CFN_RESOURCE_TYPE_NAME() *string

func CfnModelExplainabilityJobDefinition_IsCfnElement

func CfnModelExplainabilityJobDefinition_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnModelExplainabilityJobDefinition_IsCfnResource

func CfnModelExplainabilityJobDefinition_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnModelExplainabilityJobDefinition_IsConstruct

func CfnModelExplainabilityJobDefinition_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnModelPackageGroup_CFN_RESOURCE_TYPE_NAME

func CfnModelPackageGroup_CFN_RESOURCE_TYPE_NAME() *string

func CfnModelPackageGroup_IsCfnElement

func CfnModelPackageGroup_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnModelPackageGroup_IsCfnResource

func CfnModelPackageGroup_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnModelPackageGroup_IsConstruct

func CfnModelPackageGroup_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnModelQualityJobDefinition_CFN_RESOURCE_TYPE_NAME

func CfnModelQualityJobDefinition_CFN_RESOURCE_TYPE_NAME() *string

func CfnModelQualityJobDefinition_IsCfnElement

func CfnModelQualityJobDefinition_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnModelQualityJobDefinition_IsCfnResource

func CfnModelQualityJobDefinition_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnModelQualityJobDefinition_IsConstruct

func CfnModelQualityJobDefinition_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnModel_CFN_RESOURCE_TYPE_NAME

func CfnModel_CFN_RESOURCE_TYPE_NAME() *string

func CfnModel_IsCfnElement

func CfnModel_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnModel_IsCfnResource

func CfnModel_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnModel_IsConstruct

func CfnModel_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnMonitoringSchedule_CFN_RESOURCE_TYPE_NAME

func CfnMonitoringSchedule_CFN_RESOURCE_TYPE_NAME() *string

func CfnMonitoringSchedule_IsCfnElement

func CfnMonitoringSchedule_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnMonitoringSchedule_IsCfnResource

func CfnMonitoringSchedule_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnMonitoringSchedule_IsConstruct

func CfnMonitoringSchedule_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnNotebookInstanceLifecycleConfig_CFN_RESOURCE_TYPE_NAME

func CfnNotebookInstanceLifecycleConfig_CFN_RESOURCE_TYPE_NAME() *string

func CfnNotebookInstanceLifecycleConfig_IsCfnElement

func CfnNotebookInstanceLifecycleConfig_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnNotebookInstanceLifecycleConfig_IsCfnResource

func CfnNotebookInstanceLifecycleConfig_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnNotebookInstanceLifecycleConfig_IsConstruct

func CfnNotebookInstanceLifecycleConfig_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnNotebookInstance_CFN_RESOURCE_TYPE_NAME

func CfnNotebookInstance_CFN_RESOURCE_TYPE_NAME() *string

func CfnNotebookInstance_IsCfnElement

func CfnNotebookInstance_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnNotebookInstance_IsCfnResource

func CfnNotebookInstance_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnNotebookInstance_IsConstruct

func CfnNotebookInstance_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnPipeline_CFN_RESOURCE_TYPE_NAME

func CfnPipeline_CFN_RESOURCE_TYPE_NAME() *string

func CfnPipeline_IsCfnElement

func CfnPipeline_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnPipeline_IsCfnResource

func CfnPipeline_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnPipeline_IsConstruct

func CfnPipeline_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnProject_CFN_RESOURCE_TYPE_NAME

func CfnProject_CFN_RESOURCE_TYPE_NAME() *string

func CfnProject_IsCfnElement

func CfnProject_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnProject_IsCfnResource

func CfnProject_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnProject_IsConstruct

func CfnProject_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnUserProfile_CFN_RESOURCE_TYPE_NAME

func CfnUserProfile_CFN_RESOURCE_TYPE_NAME() *string

func CfnUserProfile_IsCfnElement

func CfnUserProfile_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnUserProfile_IsCfnResource

func CfnUserProfile_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnUserProfile_IsConstruct

func CfnUserProfile_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnWorkteam_CFN_RESOURCE_TYPE_NAME

func CfnWorkteam_CFN_RESOURCE_TYPE_NAME() *string

func CfnWorkteam_IsCfnElement

func CfnWorkteam_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnWorkteam_IsCfnResource

func CfnWorkteam_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnWorkteam_IsConstruct

func CfnWorkteam_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewCfnAppImageConfig_Override

func NewCfnAppImageConfig_Override(c CfnAppImageConfig, scope constructs.Construct, id *string, props *CfnAppImageConfigProps)

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

func NewCfnApp_Override

func NewCfnApp_Override(c CfnApp, scope constructs.Construct, id *string, props *CfnAppProps)

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

func NewCfnCodeRepository_Override

func NewCfnCodeRepository_Override(c CfnCodeRepository, scope constructs.Construct, id *string, props *CfnCodeRepositoryProps)

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

func NewCfnDataQualityJobDefinition_Override

func NewCfnDataQualityJobDefinition_Override(c CfnDataQualityJobDefinition, scope constructs.Construct, id *string, props *CfnDataQualityJobDefinitionProps)

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

func NewCfnDeviceFleet_Override

func NewCfnDeviceFleet_Override(c CfnDeviceFleet, scope constructs.Construct, id *string, props *CfnDeviceFleetProps)

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

func NewCfnDevice_Override

func NewCfnDevice_Override(c CfnDevice, scope constructs.Construct, id *string, props *CfnDeviceProps)

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

func NewCfnDomain_Override

func NewCfnDomain_Override(c CfnDomain, scope constructs.Construct, id *string, props *CfnDomainProps)

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

func NewCfnEndpointConfig_Override

func NewCfnEndpointConfig_Override(c CfnEndpointConfig, scope constructs.Construct, id *string, props *CfnEndpointConfigProps)

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

func NewCfnEndpoint_Override

func NewCfnEndpoint_Override(c CfnEndpoint, scope constructs.Construct, id *string, props *CfnEndpointProps)

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

func NewCfnFeatureGroup_Override

func NewCfnFeatureGroup_Override(c CfnFeatureGroup, scope constructs.Construct, id *string, props *CfnFeatureGroupProps)

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

func NewCfnImageVersion_Override

func NewCfnImageVersion_Override(c CfnImageVersion, scope constructs.Construct, id *string, props *CfnImageVersionProps)

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

func NewCfnImage_Override

func NewCfnImage_Override(c CfnImage, scope constructs.Construct, id *string, props *CfnImageProps)

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

func NewCfnModelBiasJobDefinition_Override

func NewCfnModelBiasJobDefinition_Override(c CfnModelBiasJobDefinition, scope constructs.Construct, id *string, props *CfnModelBiasJobDefinitionProps)

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

func NewCfnModelExplainabilityJobDefinition_Override

func NewCfnModelExplainabilityJobDefinition_Override(c CfnModelExplainabilityJobDefinition, scope constructs.Construct, id *string, props *CfnModelExplainabilityJobDefinitionProps)

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

func NewCfnModelPackageGroup_Override

func NewCfnModelPackageGroup_Override(c CfnModelPackageGroup, scope constructs.Construct, id *string, props *CfnModelPackageGroupProps)

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

func NewCfnModelQualityJobDefinition_Override

func NewCfnModelQualityJobDefinition_Override(c CfnModelQualityJobDefinition, scope constructs.Construct, id *string, props *CfnModelQualityJobDefinitionProps)

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

func NewCfnModel_Override

func NewCfnModel_Override(c CfnModel, scope constructs.Construct, id *string, props *CfnModelProps)

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

func NewCfnMonitoringSchedule_Override

func NewCfnMonitoringSchedule_Override(c CfnMonitoringSchedule, scope constructs.Construct, id *string, props *CfnMonitoringScheduleProps)

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

func NewCfnNotebookInstanceLifecycleConfig_Override

func NewCfnNotebookInstanceLifecycleConfig_Override(c CfnNotebookInstanceLifecycleConfig, scope constructs.Construct, id *string, props *CfnNotebookInstanceLifecycleConfigProps)

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

func NewCfnNotebookInstance_Override

func NewCfnNotebookInstance_Override(c CfnNotebookInstance, scope constructs.Construct, id *string, props *CfnNotebookInstanceProps)

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

func NewCfnPipeline_Override

func NewCfnPipeline_Override(c CfnPipeline, scope constructs.Construct, id *string, props *CfnPipelineProps)

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

func NewCfnProject_Override

func NewCfnProject_Override(c CfnProject, scope constructs.Construct, id *string, props *CfnProjectProps)

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

func NewCfnUserProfile_Override

func NewCfnUserProfile_Override(c CfnUserProfile, scope constructs.Construct, id *string, props *CfnUserProfileProps)

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

func NewCfnWorkteam_Override

func NewCfnWorkteam_Override(c CfnWorkteam, scope constructs.Construct, id *string, props *CfnWorkteamProps)

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

Types

type CfnApp

type CfnApp interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AppName() *string
	SetAppName(val *string)
	AppType() *string
	SetAppType(val *string)
	AttrAppArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DomainId() *string
	SetDomainId(val *string)
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	ResourceSpec() interface{}
	SetResourceSpec(val interface{})
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	UserProfileName() *string
	SetUserProfileName(val *string)
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::SageMaker::App`.

Creates a running app for the specified UserProfile. Supported apps are `JupyterServer` and `KernelGateway` . This operation is automatically invoked by Amazon SageMaker Studio upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously.

TODO: EXAMPLE

func NewCfnApp

func NewCfnApp(scope constructs.Construct, id *string, props *CfnAppProps) CfnApp

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

type CfnAppImageConfig

type CfnAppImageConfig interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AppImageConfigName() *string
	SetAppImageConfigName(val *string)
	AttrAppImageConfigArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	KernelGatewayImageConfig() interface{}
	SetKernelGatewayImageConfig(val interface{})
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::SageMaker::AppImageConfig`.

Creates a configuration for running a SageMaker image as a KernelGateway app. The configuration specifies the Amazon Elastic File System (EFS) storage volume on the image, and a list of the kernels in the image.

TODO: EXAMPLE

func NewCfnAppImageConfig

func NewCfnAppImageConfig(scope constructs.Construct, id *string, props *CfnAppImageConfigProps) CfnAppImageConfig

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

type CfnAppImageConfigProps

type CfnAppImageConfigProps struct {
	// The name of the AppImageConfig.
	//
	// Must be unique to your account.
	AppImageConfigName *string `json:"appImageConfigName"`
	// The configuration for the file system and kernels in the SageMaker image.
	KernelGatewayImageConfig interface{} `json:"kernelGatewayImageConfig"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `CfnAppImageConfig`.

TODO: EXAMPLE

type CfnAppImageConfig_FileSystemConfigProperty

type CfnAppImageConfig_FileSystemConfigProperty struct {
	// The default POSIX group ID (GID).
	//
	// If not specified, defaults to `100` .
	DefaultGid *float64 `json:"defaultGid"`
	// The default POSIX user ID (UID).
	//
	// If not specified, defaults to `1000` .
	DefaultUid *float64 `json:"defaultUid"`
	// The path within the image to mount the user's EFS home directory.
	//
	// The directory should be empty. If not specified, defaults to * /home/sagemaker-user* .
	MountPath *string `json:"mountPath"`
}

The Amazon Elastic File System (EFS) storage configuration for a SageMaker image.

TODO: EXAMPLE

type CfnAppImageConfig_KernelGatewayImageConfigProperty

type CfnAppImageConfig_KernelGatewayImageConfigProperty struct {
	// The specification of the Jupyter kernels in the image.
	KernelSpecs interface{} `json:"kernelSpecs"`
	// The Amazon Elastic File System (EFS) storage configuration for a SageMaker image.
	FileSystemConfig interface{} `json:"fileSystemConfig"`
}

The configuration for the file system and kernels in a SageMaker image running as a KernelGateway app.

TODO: EXAMPLE

type CfnAppImageConfig_KernelSpecProperty

type CfnAppImageConfig_KernelSpecProperty struct {
	// The name of the Jupyter kernel in the image.
	//
	// This value is case sensitive.
	Name *string `json:"name"`
	// The display name of the kernel.
	DisplayName *string `json:"displayName"`
}

The specification of a Jupyter kernel.

TODO: EXAMPLE

type CfnAppProps

type CfnAppProps struct {
	// The name of the app.
	AppName *string `json:"appName"`
	// The type of app.
	AppType *string `json:"appType"`
	// The domain ID.
	DomainId *string `json:"domainId"`
	// The user profile name.
	UserProfileName *string `json:"userProfileName"`
	// Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that the version runs on.
	ResourceSpec interface{} `json:"resourceSpec"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `CfnApp`.

TODO: EXAMPLE

type CfnApp_ResourceSpecProperty

type CfnApp_ResourceSpecProperty struct {
	// The instance type that the image version runs on.
	InstanceType *string `json:"instanceType"`
	// The ARN of the SageMaker image that the image version belongs to.
	SageMakerImageArn *string `json:"sageMakerImageArn"`
	// The ARN of the image version created on the instance.
	SageMakerImageVersionArn *string `json:"sageMakerImageVersionArn"`
}

Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that the version runs on.

TODO: EXAMPLE

type CfnCodeRepository

type CfnCodeRepository interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrCodeRepositoryName() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CodeRepositoryName() *string
	SetCodeRepositoryName(val *string)
	CreationStack() *[]*string
	GitConfig() interface{}
	SetGitConfig(val interface{})
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::SageMaker::CodeRepository`.

Creates a Git repository as a resource in your Amazon SageMaker account. You can associate the repository with notebook instances so that you can use Git source control for the notebooks you create. The Git repository is a resource in your Amazon SageMaker account, so it can be associated with more than one notebook instance, and it persists independently from the lifecycle of any notebook instances it is associated with.

The repository can be hosted either in [AWS CodeCommit](https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) or in any other Git repository.

TODO: EXAMPLE

func NewCfnCodeRepository

func NewCfnCodeRepository(scope constructs.Construct, id *string, props *CfnCodeRepositoryProps) CfnCodeRepository

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

type CfnCodeRepositoryProps

type CfnCodeRepositoryProps struct {
	// Configuration details for the Git repository, including the URL where it is located and the ARN of the AWS Secrets Manager secret that contains the credentials used to access the repository.
	GitConfig interface{} `json:"gitConfig"`
	// The name of the Git repository.
	CodeRepositoryName *string `json:"codeRepositoryName"`
	// List of tags for Code Repository.
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `CfnCodeRepository`.

TODO: EXAMPLE

type CfnCodeRepository_GitConfigProperty

type CfnCodeRepository_GitConfigProperty struct {
	// The URL where the Git repository is located.
	RepositoryUrl *string `json:"repositoryUrl"`
	// The default branch for the Git repository.
	Branch *string `json:"branch"`
	// The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the credentials used to access the git repository.
	//
	// The secret must have a staging label of `AWSCURRENT` and must be in the following format:
	//
	// `{"username": *UserName* , "password": *Password* }`
	SecretArn *string `json:"secretArn"`
}

Specifies configuration details for a Git repository in your AWS account.

TODO: EXAMPLE

type CfnDataQualityJobDefinition

type CfnDataQualityJobDefinition interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrCreationTime() *string
	AttrJobDefinitionArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DataQualityAppSpecification() interface{}
	SetDataQualityAppSpecification(val interface{})
	DataQualityBaselineConfig() interface{}
	SetDataQualityBaselineConfig(val interface{})
	DataQualityJobInput() interface{}
	SetDataQualityJobInput(val interface{})
	DataQualityJobOutputConfig() interface{}
	SetDataQualityJobOutputConfig(val interface{})
	JobDefinitionName() *string
	SetJobDefinitionName(val *string)
	JobResources() interface{}
	SetJobResources(val interface{})
	LogicalId() *string
	NetworkConfig() interface{}
	SetNetworkConfig(val interface{})
	Node() constructs.Node
	Ref() *string
	RoleArn() *string
	SetRoleArn(val *string)
	Stack() awscdk.Stack
	StoppingCondition() interface{}
	SetStoppingCondition(val interface{})
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::SageMaker::DataQualityJobDefinition`.

Creates a definition for a job that monitors data quality and drift. For information about model monitor, see [Amazon SageMaker Model Monitor](https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor.html) .

TODO: EXAMPLE

func NewCfnDataQualityJobDefinition

func NewCfnDataQualityJobDefinition(scope constructs.Construct, id *string, props *CfnDataQualityJobDefinitionProps) CfnDataQualityJobDefinition

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

type CfnDataQualityJobDefinitionProps

type CfnDataQualityJobDefinitionProps struct {
	// Specifies the container that runs the monitoring job.
	DataQualityAppSpecification interface{} `json:"dataQualityAppSpecification"`
	// A list of inputs for the monitoring job.
	//
	// Currently endpoints are supported as monitoring inputs.
	DataQualityJobInput interface{} `json:"dataQualityJobInput"`
	// The output configuration for monitoring jobs.
	DataQualityJobOutputConfig interface{} `json:"dataQualityJobOutputConfig"`
	// Identifies the resources to deploy for a monitoring job.
	JobResources interface{} `json:"jobResources"`
	// The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
	RoleArn *string `json:"roleArn"`
	// Configures the constraints and baselines for the monitoring job.
	DataQualityBaselineConfig interface{} `json:"dataQualityBaselineConfig"`
	// The name for the monitoring job definition.
	JobDefinitionName *string `json:"jobDefinitionName"`
	// Specifies networking configuration for the monitoring job.
	NetworkConfig interface{} `json:"networkConfig"`
	// A time limit for how long the monitoring job is allowed to run before stopping.
	StoppingCondition interface{} `json:"stoppingCondition"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `CfnDataQualityJobDefinition`.

TODO: EXAMPLE

type CfnDataQualityJobDefinition_ClusterConfigProperty

type CfnDataQualityJobDefinition_ClusterConfigProperty struct {
	// The number of ML compute instances to use in the model monitoring job.
	//
	// For distributed processing jobs, specify a value greater than 1. The default value is 1.
	InstanceCount *float64 `json:"instanceCount"`
	// `CfnDataQualityJobDefinition.ClusterConfigProperty.InstanceType`.
	InstanceType *string `json:"instanceType"`
	// The size of the ML storage volume, in gigabytes, that you want to provision.
	//
	// You must specify sufficient ML storage for your scenario.
	VolumeSizeInGb *float64 `json:"volumeSizeInGb"`
	// The AWS Key Management Service ( AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the model monitoring job.
	VolumeKmsKeyId *string `json:"volumeKmsKeyId"`
}

The configuration for the cluster of resources used to run the processing job.

TODO: EXAMPLE

type CfnDataQualityJobDefinition_ConstraintsResourceProperty

type CfnDataQualityJobDefinition_ConstraintsResourceProperty struct {
	// The Amazon S3 URI for the constraints resource.
	S3Uri *string `json:"s3Uri"`
}

The constraints resource for a monitoring job.

TODO: EXAMPLE

type CfnDataQualityJobDefinition_DataQualityAppSpecificationProperty

type CfnDataQualityJobDefinition_DataQualityAppSpecificationProperty struct {
	// The container image that the data quality monitoring job runs.
	ImageUri *string `json:"imageUri"`
	// The arguments to send to the container that the monitoring job runs.
	ContainerArguments *[]*string `json:"containerArguments"`
	// The entrypoint for a container used to run a monitoring job.
	ContainerEntrypoint *[]*string `json:"containerEntrypoint"`
	// Sets the environment variables in the container that the monitoring job runs.
	Environment interface{} `json:"environment"`
	// An Amazon S3 URI to a script that is called after analysis has been performed.
	//
	// Applicable only for the built-in (first party) containers.
	PostAnalyticsProcessorSourceUri *string `json:"postAnalyticsProcessorSourceUri"`
	// An Amazon S3 URI to a script that is called per row prior to running analysis.
	//
	// It can base64 decode the payload and convert it into a flatted json so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.
	RecordPreprocessorSourceUri *string `json:"recordPreprocessorSourceUri"`
}

Information about the container that a data quality monitoring job runs.

TODO: EXAMPLE

type CfnDataQualityJobDefinition_DataQualityBaselineConfigProperty

type CfnDataQualityJobDefinition_DataQualityBaselineConfigProperty struct {
	// The name of the job that performs baselining for the data quality monitoring job.
	BaseliningJobName *string `json:"baseliningJobName"`
	// The constraints resource for a monitoring job.
	ConstraintsResource interface{} `json:"constraintsResource"`
	// Configuration for monitoring constraints and monitoring statistics.
	//
	// These baseline resources are compared against the results of the current job from the series of jobs scheduled to collect data periodically.
	StatisticsResource interface{} `json:"statisticsResource"`
}

Configuration for monitoring constraints and monitoring statistics.

These baseline resources are compared against the results of the current job from the series of jobs scheduled to collect data periodically.

TODO: EXAMPLE

type CfnDataQualityJobDefinition_DataQualityJobInputProperty

type CfnDataQualityJobDefinition_DataQualityJobInputProperty struct {
	// `CfnDataQualityJobDefinition.DataQualityJobInputProperty.EndpointInput`.
	EndpointInput interface{} `json:"endpointInput"`
}

The input for the data quality monitoring job.

Currently endpoints are supported for input.

TODO: EXAMPLE

type CfnDataQualityJobDefinition_EndpointInputProperty

type CfnDataQualityJobDefinition_EndpointInputProperty struct {
	// An endpoint in customer's account which has enabled `DataCaptureConfig` enabled.
	EndpointName *string `json:"endpointName"`
	// Path to the filesystem where the endpoint data is available to the container.
	LocalPath *string `json:"localPath"`
	// Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key.
	//
	// Defaults to `FullyReplicated`
	S3DataDistributionType *string `json:"s3DataDistributionType"`
	// Whether the `Pipe` or `File` is used as the input mode for transferring data for the monitoring job.
	//
	// `Pipe` mode is recommended for large datasets. `File` mode is useful for small files that fit in memory. Defaults to `File` .
	S3InputMode *string `json:"s3InputMode"`
}

Input object for the endpoint.

TODO: EXAMPLE

type CfnDataQualityJobDefinition_MonitoringOutputConfigProperty

type CfnDataQualityJobDefinition_MonitoringOutputConfigProperty struct {
	// Monitoring outputs for monitoring jobs.
	//
	// This is where the output of the periodic monitoring jobs is uploaded.
	MonitoringOutputs interface{} `json:"monitoringOutputs"`
	// The AWS Key Management Service ( AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.
	KmsKeyId *string `json:"kmsKeyId"`
}

The output configuration for monitoring jobs.

TODO: EXAMPLE

type CfnDataQualityJobDefinition_MonitoringOutputProperty

type CfnDataQualityJobDefinition_MonitoringOutputProperty struct {
	// The Amazon S3 storage location where the results of a monitoring job are saved.
	S3Output interface{} `json:"s3Output"`
}

The output object for a monitoring job.

TODO: EXAMPLE

type CfnDataQualityJobDefinition_MonitoringResourcesProperty

type CfnDataQualityJobDefinition_MonitoringResourcesProperty struct {
	// The configuration for the cluster resources used to run the processing job.
	ClusterConfig interface{} `json:"clusterConfig"`
}

Identifies the resources to deploy for a monitoring job.

TODO: EXAMPLE

type CfnDataQualityJobDefinition_NetworkConfigProperty

type CfnDataQualityJobDefinition_NetworkConfigProperty struct {
	// Whether to encrypt all communications between distributed processing jobs.
	//
	// Choose `True` to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer.
	EnableInterContainerTrafficEncryption interface{} `json:"enableInterContainerTrafficEncryption"`
	// Whether to allow inbound and outbound network calls to and from the containers used for the processing job.
	EnableNetworkIsolation interface{} `json:"enableNetworkIsolation"`
	// Specifies a VPC that your training jobs and hosted models have access to.
	//
	// Control access to and from your training and model containers by configuring the VPC.
	VpcConfig interface{} `json:"vpcConfig"`
}

Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.

TODO: EXAMPLE

type CfnDataQualityJobDefinition_S3OutputProperty

type CfnDataQualityJobDefinition_S3OutputProperty struct {
	// The local path to the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job.
	//
	// LocalPath is an absolute path for the output data.
	LocalPath *string `json:"localPath"`
	// A URI that identifies the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job.
	S3Uri *string `json:"s3Uri"`
	// Whether to upload the results of the monitoring job continuously or after the job completes.
	S3UploadMode *string `json:"s3UploadMode"`
}

The Amazon S3 storage location where the results of a monitoring job are saved.

TODO: EXAMPLE

type CfnDataQualityJobDefinition_StatisticsResourceProperty

type CfnDataQualityJobDefinition_StatisticsResourceProperty struct {
	// The Amazon S3 URI for the statistics resource.
	S3Uri *string `json:"s3Uri"`
}

The statistics resource for a monitoring job.

TODO: EXAMPLE

type CfnDataQualityJobDefinition_StoppingConditionProperty

type CfnDataQualityJobDefinition_StoppingConditionProperty struct {
	// The maximum length of time, in seconds, that a training or compilation job can run.
	//
	// For compilation jobs, if the job does not complete during this time, you will receive a `TimeOut` error. We recommend starting with 900 seconds and increase as necessary based on your model.
	//
	// For all other jobs, if the job does not complete during this time, Amazon SageMaker ends the job. When `RetryStrategy` is specified in the job request, `MaxRuntimeInSeconds` specifies the maximum time for all of the attempts in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.
	MaxRuntimeInSeconds *float64 `json:"maxRuntimeInSeconds"`
}

Specifies a limit to how long a model training job or model compilation job can run.

It also specifies how long a managed spot training job has to complete. When the job reaches the time limit, Amazon SageMaker ends the training or compilation job. Use this API to cap model training costs.

To stop a training job, Amazon SageMaker sends the algorithm the `SIGTERM` signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

The training algorithms provided by Amazon SageMaker automatically save the intermediate results of a model training job when possible. This attempt to save artifacts is only a best effort case as model might not be in a state from which it can be saved. For example, if training has just started, the model might not be ready to save. When saved, this intermediate data is a valid model artifact. You can use it to create a model with `CreateModel` .

> The Neural Topic Model (NTM) currently does not support saving intermediate model artifacts. When training NTMs, make sure that the maximum runtime is sufficient for the training job to complete.

TODO: EXAMPLE

type CfnDataQualityJobDefinition_VpcConfigProperty

type CfnDataQualityJobDefinition_VpcConfigProperty struct {
	// The VPC security group IDs, in the form sg-xxxxxxxx.
	//
	// Specify the security groups for the VPC that is specified in the `Subnets` field.
	SecurityGroupIds *[]*string `json:"securityGroupIds"`
	// The ID of the subnets in the VPC to which you want to connect your training job or model.
	//
	// For information about the availability of specific instance types, see [Supported Instance Types and Availability Zones](https://docs.aws.amazon.com/sagemaker/latest/dg/instance-types-az.html) .
	Subnets *[]*string `json:"subnets"`
}

Specifies a VPC that your training jobs and hosted models have access to.

Control access to and from your training and model containers by configuring the VPC. For more information, see [Protect Endpoints by Using an Amazon Virtual Private Cloud](https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html) and [Protect Training Jobs by Using an Amazon Virtual Private Cloud](https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html) .

TODO: EXAMPLE

type CfnDevice

type CfnDevice interface {
	awscdk.CfnResource
	awscdk.IInspectable
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Device() interface{}
	SetDevice(val interface{})
	DeviceFleetName() *string
	SetDeviceFleetName(val *string)
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::SageMaker::Device`.

The `AWS::SageMaker::Device` resource is an Amazon SageMaker resource type that allows you to register your Devices against an existing SageMaker Edge Manager DeviceFleet. Each device must be listed individually in the CFN specification.

TODO: EXAMPLE

func NewCfnDevice

func NewCfnDevice(scope constructs.Construct, id *string, props *CfnDeviceProps) CfnDevice

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

type CfnDeviceFleet

type CfnDeviceFleet interface {
	awscdk.CfnResource
	awscdk.IInspectable
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	DeviceFleetName() *string
	SetDeviceFleetName(val *string)
	LogicalId() *string
	Node() constructs.Node
	OutputConfig() interface{}
	SetOutputConfig(val interface{})
	Ref() *string
	RoleArn() *string
	SetRoleArn(val *string)
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::SageMaker::DeviceFleet`.

The `AWS::SageMaker::DeviceFleet` resource is an Amazon SageMaker resource type that allows you to create a DeviceFleet that manages your SageMaker Edge Manager Devices. You must register your devices against the `DeviceFleet` separately.

TODO: EXAMPLE

func NewCfnDeviceFleet

func NewCfnDeviceFleet(scope constructs.Construct, id *string, props *CfnDeviceFleetProps) CfnDeviceFleet

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

type CfnDeviceFleetProps

type CfnDeviceFleetProps struct {
	// Name of the device fleet.
	DeviceFleetName *string `json:"deviceFleetName"`
	// The output configuration for storing sample data collected by the fleet.
	OutputConfig interface{} `json:"outputConfig"`
	// The Amazon Resource Name (ARN) that has access to AWS Internet of Things (IoT).
	RoleArn *string `json:"roleArn"`
	// A description of the fleet.
	Description *string `json:"description"`
	// An array of key-value pairs that contain metadata to help you categorize and organize your device fleets.
	//
	// Each tag consists of a key and a value, both of which you define.
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `CfnDeviceFleet`.

TODO: EXAMPLE

type CfnDeviceFleet_EdgeOutputConfigProperty

type CfnDeviceFleet_EdgeOutputConfigProperty struct {
	// The Amazon Simple Storage (S3) bucket URI.
	S3OutputLocation *string `json:"s3OutputLocation"`
	// The AWS Key Management Service ( AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job.
	//
	// If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account.
	KmsKeyId *string `json:"kmsKeyId"`
}

The output configuration for storing sample data collected by the fleet.

TODO: EXAMPLE

type CfnDeviceProps

type CfnDeviceProps struct {
	// The name of the fleet the device belongs to.
	DeviceFleetName *string `json:"deviceFleetName"`
	// Edge device you want to create.
	Device interface{} `json:"device"`
	// An array of key-value pairs that contain metadata to help you categorize and organize your devices.
	//
	// Each tag consists of a key and a value, both of which you define.
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `CfnDevice`.

TODO: EXAMPLE

type CfnDevice_DeviceProperty

type CfnDevice_DeviceProperty struct {
	// The name of the device.
	DeviceName *string `json:"deviceName"`
	// Description of the device.
	Description *string `json:"description"`
	// AWS Internet of Things (IoT) object name.
	IotThingName *string `json:"iotThingName"`
}

Information of a particular device.

TODO: EXAMPLE

type CfnDomain

type CfnDomain interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AppNetworkAccessType() *string
	SetAppNetworkAccessType(val *string)
	AttrDomainArn() *string
	AttrDomainId() *string
	AttrHomeEfsFileSystemId() *string
	AttrSingleSignOnManagedApplicationInstanceId() *string
	AttrUrl() *string
	AuthMode() *string
	SetAuthMode(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DefaultUserSettings() interface{}
	SetDefaultUserSettings(val interface{})
	DomainName() *string
	SetDomainName(val *string)
	KmsKeyId() *string
	SetKmsKeyId(val *string)
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	SubnetIds() *[]*string
	SetSubnetIds(val *[]*string)
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	VpcId() *string
	SetVpcId(val *string)
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::SageMaker::Domain`.

Creates a `Domain` used by Amazon SageMaker Studio. A domain consists of an associated Amazon Elastic File System (EFS) volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. An AWS account is limited to one domain per region. Users within a domain can share notebook files and other artifacts with each other.

*EFS storage*

When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files.

SageMaker uses the AWS Key Management Service ( AWS KMS) to encrypt the EFS volume attached to the domain with an AWS managed key by default. For more control, you can specify a customer managed key. For more information, see [Protect Data at Rest Using Encryption](https://docs.aws.amazon.com/sagemaker/latest/dg/encryption-at-rest.html) .

*VPC configuration*

All SageMaker Studio traffic between the domain and the EFS volume is through the specified VPC and subnets. For other Studio traffic, you can specify the `AppNetworkAccessType` parameter. `AppNetworkAccessType` corresponds to the network access type that you choose when you onboard to Studio. The following options are available:

- `PublicInternetOnly` - Non-EFS traffic goes through a VPC managed by Amazon SageMaker, which allows internet access. This is the default value. - `VpcOnly` - All Studio traffic is through the specified VPC and subnets. Internet access is disabled by default. To allow internet access, you must specify a NAT gateway.

When internet access is disabled, you won't be able to run a Studio notebook or to train or host models unless your VPC has an interface endpoint to the SageMaker API and runtime or a NAT gateway and your security groups allow outbound connections.

> NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules in order to launch a SageMaker Studio app successfully.

For more information, see [Connect SageMaker Studio Notebooks to Resources in a VPC](https://docs.aws.amazon.com/sagemaker/latest/dg/studio-notebooks-and-internet-access.html) .

TODO: EXAMPLE

func NewCfnDomain

func NewCfnDomain(scope constructs.Construct, id *string, props *CfnDomainProps) CfnDomain

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

type CfnDomainProps

type CfnDomainProps struct {
	// The mode of authentication that members use to access the domain.
	//
	// *Valid Values* : `SSO | IAM`
	AuthMode *string `json:"authMode"`
	// The default user settings.
	DefaultUserSettings interface{} `json:"defaultUserSettings"`
	// The domain name.
	DomainName *string `json:"domainName"`
	// The VPC subnets that Studio uses for communication.
	//
	// *Length Constraints* : Maximum length of 32.
	//
	// *Array members* : Minimum number of 1 item. Maximum number of 16 items.
	//
	// *Pattern* : `[-0-9a-zA-Z]+`
	SubnetIds *[]*string `json:"subnetIds"`
	// The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
	//
	// *Length Constraints* : Maximum length of 32.
	//
	// *Pattern* : `[-0-9a-zA-Z]+`
	VpcId *string `json:"vpcId"`
	// Specifies the VPC used for non-EFS traffic. The default value is `PublicInternetOnly` .
	//
	// - `PublicInternetOnly` - Non-EFS traffic is through a VPC managed by Amazon SageMaker , which allows direct internet access
	// - `VpcOnly` - All Studio traffic is through the specified VPC and subnets
	//
	// *Valid Values* : `PublicInternetOnly | VpcOnly`
	AppNetworkAccessType *string `json:"appNetworkAccessType"`
	// SageMaker uses AWS KMS to encrypt the EFS volume attached to the domain with an AWS managed customer master key (CMK) by default.
	//
	// For more control, specify a customer managed CMK.
	//
	// *Length Constraints* : Maximum length of 2048.
	//
	// *Pattern* : `.*`
	KmsKeyId *string `json:"kmsKeyId"`
	// Tags to associated with the Domain.
	//
	// Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.
	//
	// Tags that you specify for the Domain are also added to all Apps that are launched in the Domain.
	//
	// *Array members* : Minimum number of 0 items. Maximum number of 50 items.
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `CfnDomain`.

TODO: EXAMPLE

type CfnDomain_CustomImageProperty

type CfnDomain_CustomImageProperty struct {
	// The name of the AppImageConfig.
	AppImageConfigName *string `json:"appImageConfigName"`
	// The name of the CustomImage.
	//
	// Must be unique to your account.
	ImageName *string `json:"imageName"`
	// The version number of the CustomImage.
	ImageVersionNumber *float64 `json:"imageVersionNumber"`
}

A custom SageMaker image.

For more information, see [Bring your own SageMaker image](https://docs.aws.amazon.com/sagemaker/latest/dg/studio-byoi.html) .

TODO: EXAMPLE

type CfnDomain_JupyterServerAppSettingsProperty

type CfnDomain_JupyterServerAppSettingsProperty struct {
	// The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterServer app.
	DefaultResourceSpec interface{} `json:"defaultResourceSpec"`
}

The JupyterServer app settings.

TODO: EXAMPLE

type CfnDomain_KernelGatewayAppSettingsProperty

type CfnDomain_KernelGatewayAppSettingsProperty struct {
	// A list of custom SageMaker images that are configured to run as a KernelGateway app.
	CustomImages interface{} `json:"customImages"`
	// The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.
	DefaultResourceSpec interface{} `json:"defaultResourceSpec"`
}

The KernelGateway app settings.

TODO: EXAMPLE

type CfnDomain_ResourceSpecProperty

type CfnDomain_ResourceSpecProperty struct {
	// The instance type that the image version runs on.
	InstanceType *string `json:"instanceType"`
	// The ARN of the SageMaker image that the image version belongs to.
	SageMakerImageArn *string `json:"sageMakerImageArn"`
	// The ARN of the image version created on the instance.
	SageMakerImageVersionArn *string `json:"sageMakerImageVersionArn"`
}

Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that the version runs on.

TODO: EXAMPLE

type CfnDomain_SharingSettingsProperty

type CfnDomain_SharingSettingsProperty struct {
	// Whether to include the notebook cell output when sharing the notebook.
	//
	// The default is `Disabled` .
	NotebookOutputOption *string `json:"notebookOutputOption"`
	// When `NotebookOutputOption` is `Allowed` , the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.
	S3KmsKeyId *string `json:"s3KmsKeyId"`
	// When `NotebookOutputOption` is `Allowed` , the Amazon S3 bucket used to store the shared notebook snapshots.
	S3OutputPath *string `json:"s3OutputPath"`
}

Specifies options when sharing an Amazon SageMaker Studio notebook.

These settings are specified as part of `DefaultUserSettings` when the [CreateDomain](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateDomain.html) API is called, and as part of `UserSettings` when the [CreateUserProfile](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateUserProfile.html) API is called.

TODO: EXAMPLE

type CfnDomain_UserSettingsProperty

type CfnDomain_UserSettingsProperty struct {
	// The execution role for the user.
	ExecutionRole *string `json:"executionRole"`
	// The Jupyter server's app settings.
	JupyterServerAppSettings interface{} `json:"jupyterServerAppSettings"`
	// The kernel gateway app settings.
	KernelGatewayAppSettings interface{} `json:"kernelGatewayAppSettings"`
	// The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
	//
	// Optional when the `CreateDomain.AppNetworkAccessType` parameter is set to `PublicInternetOnly` .
	//
	// Required when the `CreateDomain.AppNetworkAccessType` parameter is set to `VpcOnly` .
	//
	// Amazon SageMaker adds a security group to allow NFS traffic from SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.
	SecurityGroups *[]*string `json:"securityGroups"`
	// Specifies options for sharing SageMaker Studio notebooks.
	SharingSettings interface{} `json:"sharingSettings"`
}

A collection of settings that apply to users of Amazon SageMaker Studio.

These settings are specified when the [CreateUserProfile](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateUserProfile.html) API is called, and as `DefaultUserSettings` when the [CreateDomain](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateDomain.html) API is called.

`SecurityGroups` is aggregated when specified in both calls. For all other settings in `UserSettings` , the values specified in `CreateUserProfile` take precedence over those specified in `CreateDomain` .

TODO: EXAMPLE

type CfnEndpoint

type CfnEndpoint interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrEndpointName() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DeploymentConfig() interface{}
	SetDeploymentConfig(val interface{})
	EndpointConfigName() *string
	SetEndpointConfigName(val *string)
	EndpointName() *string
	SetEndpointName(val *string)
	ExcludeRetainedVariantProperties() interface{}
	SetExcludeRetainedVariantProperties(val interface{})
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	RetainAllVariantProperties() interface{}
	SetRetainAllVariantProperties(val interface{})
	RetainDeploymentConfig() interface{}
	SetRetainDeploymentConfig(val interface{})
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

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

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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html) resource. For more information, see [Deploy a Model on Amazon SageMaker Hosting Services](https://docs.aws.amazon.com/sagemaker/latest/dg/how-it-works-hosting.html) in the *Amazon SageMaker Developer Guide* .

TODO: EXAMPLE

func NewCfnEndpoint

func NewCfnEndpoint(scope constructs.Construct, id *string, props *CfnEndpointProps) CfnEndpoint

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

type CfnEndpointConfig

type CfnEndpointConfig interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AsyncInferenceConfig() interface{}
	SetAsyncInferenceConfig(val interface{})
	AttrEndpointConfigName() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DataCaptureConfig() interface{}
	SetDataCaptureConfig(val interface{})
	EndpointConfigName() *string
	SetEndpointConfigName(val *string)
	KmsKeyId() *string
	SetKmsKeyId(val *string)
	LogicalId() *string
	Node() constructs.Node
	ProductionVariants() interface{}
	SetProductionVariants(val interface{})
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::SageMaker::EndpointConfig`.

The `AWS::SageMaker::EndpointConfig` resource creates a configuration for an Amazon SageMaker endpoint. For more information, see [CreateEndpointConfig](https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpointConfig.html) in the *SageMaker Developer Guide* .

TODO: EXAMPLE

func NewCfnEndpointConfig

func NewCfnEndpointConfig(scope constructs.Construct, id *string, props *CfnEndpointConfigProps) CfnEndpointConfig

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

type CfnEndpointConfigProps

type CfnEndpointConfigProps struct {
	// A list of `ProductionVariant` objects, one for each model that you want to host at this endpoint.
	ProductionVariants interface{} `json:"productionVariants"`
	// Specifies configuration for how an endpoint performs asynchronous inference.
	AsyncInferenceConfig interface{} `json:"asyncInferenceConfig"`
	// Specifies how to capture endpoint data for model monitor.
	//
	// The data capture configuration applies to all production variants hosted at the endpoint.
	DataCaptureConfig interface{} `json:"dataCaptureConfig"`
	// The name of the endpoint configuration.
	EndpointConfigName *string `json:"endpointConfigName"`
	// The Amazon Resource Name (ARN) of an AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.
	//
	// - Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
	// - Key ARN: `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
	// - Alias name: `alias/ExampleAlias`
	// - Alias name ARN: `arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias`
	//
	// The KMS key policy must grant permission to the IAM role that you specify in your `CreateEndpoint` , `UpdateEndpoint` requests. For more information, refer to the AWS Key Management Service section [Using Key Policies in AWS KMS](https://docs.aws.amazon.com//kms/latest/developerguide/key-policies.html)
	//
	// > Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a `KmsKeyId` when using an instance type with local storage. If any of the models that you specify in the `ProductionVariants` parameter use nitro-based instances with local storage, do not specify a value for the `KmsKeyId` parameter. If you specify a value for `KmsKeyId` when using any nitro-based instances with local storage, the call to `CreateEndpointConfig` fails.
	// >
	// > For a list of instance types that support local instance storage, see [Instance Store Volumes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes) .
	// >
	// > For more information about local instance storage encryption, see [SSD Instance Store Volumes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html) .
	KmsKeyId *string `json:"kmsKeyId"`
	// A list of key-value pairs to apply to this resource.
	//
	// For more information, see [Resource Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) and [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what) .
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `CfnEndpointConfig`.

TODO: EXAMPLE

type CfnEndpointConfig_AsyncInferenceClientConfigProperty

type CfnEndpointConfig_AsyncInferenceClientConfigProperty struct {
	// The maximum number of concurrent requests sent by the SageMaker client to the model container.
	//
	// If no value is provided, SageMaker will choose an optimal value for you.
	MaxConcurrentInvocationsPerInstance *float64 `json:"maxConcurrentInvocationsPerInstance"`
}

Configures the behavior of the client used by SageMaker to interact with the model container during asynchronous inference.

TODO: EXAMPLE

type CfnEndpointConfig_AsyncInferenceConfigProperty

type CfnEndpointConfig_AsyncInferenceConfigProperty struct {
	// Specifies the configuration for asynchronous inference invocation outputs.
	OutputConfig interface{} `json:"outputConfig"`
	// Configures the behavior of the client used by SageMaker to interact with the model container during asynchronous inference.
	ClientConfig interface{} `json:"clientConfig"`
}

Specifies configuration for how an endpoint performs asynchronous inference.

TODO: EXAMPLE

type CfnEndpointConfig_AsyncInferenceNotificationConfigProperty

type CfnEndpointConfig_AsyncInferenceNotificationConfigProperty struct {
	// Amazon SNS topic to post a notification to when an inference fails.
	//
	// If no topic is provided, no notification is sent on failure.
	ErrorTopic *string `json:"errorTopic"`
	// Amazon SNS topic to post a notification to when an inference completes successfully.
	//
	// If no topic is provided, no notification is sent on success.
	SuccessTopic *string `json:"successTopic"`
}

Specifies the configuration for notifications of inference results for asynchronous inference.

TODO: EXAMPLE

type CfnEndpointConfig_AsyncInferenceOutputConfigProperty

type CfnEndpointConfig_AsyncInferenceOutputConfigProperty struct {
	// The Amazon S3 location to upload inference responses to.
	S3OutputPath *string `json:"s3OutputPath"`
	// The AWS Key Management Service ( AWS KMS) key that Amazon SageMaker uses to encrypt the asynchronous inference output in Amazon S3.
	KmsKeyId *string `json:"kmsKeyId"`
	// Specifies the configuration for notifications of inference results for asynchronous inference.
	NotificationConfig interface{} `json:"notificationConfig"`
}

Specifies the configuration for asynchronous inference invocation outputs.

TODO: EXAMPLE

type CfnEndpointConfig_CaptureContentTypeHeaderProperty

type CfnEndpointConfig_CaptureContentTypeHeaderProperty struct {
	// A list of the CSV content types of the data that the endpoint captures.
	//
	// For the endpoint to capture the data, you must also specify the content type when you invoke the endpoint.
	CsvContentTypes *[]*string `json:"csvContentTypes"`
	// A list of the JSON content types of the data that the endpoint captures.
	//
	// For the endpoint to capture the data, you must also specify the content type when you invoke the endpoint.
	JsonContentTypes *[]*string `json:"jsonContentTypes"`
}

Specifies the JSON and CSV content types of the data that the endpoint captures.

TODO: EXAMPLE

type CfnEndpointConfig_CaptureOptionProperty

type CfnEndpointConfig_CaptureOptionProperty struct {
	// Specifies whether the endpoint captures input data or output data.
	CaptureMode *string `json:"captureMode"`
}

Specifies whether the endpoint captures input data or output data.

TODO: EXAMPLE

type CfnEndpointConfig_DataCaptureConfigProperty

type CfnEndpointConfig_DataCaptureConfigProperty struct {
	// Specifies whether the endpoint captures input data to your model, output data from your model, or both.
	CaptureOptions interface{} `json:"captureOptions"`
	// The S3 bucket where model monitor stores captured data.
	DestinationS3Uri *string `json:"destinationS3Uri"`
	// The percentage of data to capture.
	InitialSamplingPercentage *float64 `json:"initialSamplingPercentage"`
	// A list of the JSON and CSV content type that the endpoint captures.
	CaptureContentTypeHeader interface{} `json:"captureContentTypeHeader"`
	// Set to `True` to enable data capture.
	EnableCapture interface{} `json:"enableCapture"`
	// The AWS Key Management Service ( AWS KMS) key that Amazon SageMaker uses to encrypt the captured data at rest using Amazon S3 server-side encryption.
	//
	// The KmsKeyId can be any of the following formats: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias name: alias/ExampleAlias Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html) in the Amazon Simple Storage Service Developer Guide. The KMS key policy must grant permission to the IAM role that you specify in your CreateModel (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateModel.html) request. For more information, see Using Key Policies in AWS KMS (http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) in the AWS Key Management Service Developer Guide.
	KmsKeyId *string `json:"kmsKeyId"`
}

Specifies the configuration of your endpoint for model monitor data capture.

TODO: EXAMPLE

type CfnEndpointConfig_ProductionVariantProperty

type CfnEndpointConfig_ProductionVariantProperty struct {
	// Determines initial traffic distribution among all of the models that you specify in the endpoint configuration.
	//
	// The traffic to a production variant is determined by the ratio of the `VariantWeight` to the sum of all `VariantWeight` values across all ProductionVariants. If unspecified, it defaults to 1.0.
	InitialVariantWeight *float64 `json:"initialVariantWeight"`
	// The name of the model that you want to host.
	//
	// This is the name that you specified when creating the model.
	ModelName *string `json:"modelName"`
	// The name of the production variant.
	VariantName *string `json:"variantName"`
	// The size of the Elastic Inference (EI) instance to use for the production variant.
	//
	// EI instances provide on-demand GPU computing for inference. For more information, see [Using Elastic Inference in Amazon SageMaker](https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html) . For more information, see [Using Elastic Inference in Amazon SageMaker](https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html) .
	AcceleratorType *string `json:"acceleratorType"`
	// Number of instances to launch initially.
	InitialInstanceCount *float64 `json:"initialInstanceCount"`
	// The ML compute instance type.
	InstanceType *string `json:"instanceType"`
	// The serverless configuration for an endpoint. Specifies a serverless endpoint configuration instead of an instance-based endpoint configuration.
	//
	// > Serverless Inference is in preview release for Amazon SageMaker and is subject to change. We do not recommend using this feature in production environments.
	ServerlessConfig interface{} `json:"serverlessConfig"`
}

Specifies a model that you want to host and the resources to deploy for hosting it.

If you are deploying multiple models, tell Amazon SageMaker how to distribute traffic among the models by specifying the `InitialVariantWeight` objects.

TODO: EXAMPLE

type CfnEndpointConfig_ServerlessConfigProperty added in v2.2.0

type CfnEndpointConfig_ServerlessConfigProperty struct {
	// The maximum number of concurrent invocations your serverless endpoint can process.
	MaxConcurrency *float64 `json:"maxConcurrency"`
	// The memory size of your serverless endpoint.
	//
	// Valid values are in 1 GB increments: 1024 MB, 2048 MB, 3072 MB, 4096 MB, 5120 MB, or 6144 MB.
	MemorySizeInMb *float64 `json:"memorySizeInMb"`
}

> Serverless Inference is in preview release for Amazon SageMaker and is subject to change.

We do not recommend using this feature in production environments.

Specifies the serverless configuration for an endpoint variant.

TODO: EXAMPLE

type CfnEndpointProps

type CfnEndpointProps struct {
	// The name of the [AWS::SageMaker::EndpointConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html) resource that specifies the configuration for the endpoint. For more information, see [CreateEndpointConfig](https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpointConfig.html) .
	EndpointConfigName *string `json:"endpointConfigName"`
	// The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.
	DeploymentConfig interface{} `json:"deploymentConfig"`
	// 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 [](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html) .
	EndpointName *string `json:"endpointName"`
	// When you are updating endpoint resources with [RetainAllVariantProperties](https://docs.aws.amazon.com/sagemaker/latest/dg/API_UpdateEndpoint.html#SageMaker-UpdateEndpoint-request-RetainAllVariantProperties) whose value is set to `true` , `ExcludeRetainedVariantProperties` specifies the list of type [VariantProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-variantproperty.html) 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` .
	ExcludeRetainedVariantProperties interface{} `json:"excludeRetainedVariantProperties"`
	// When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight.
	//
	// 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.
	RetainAllVariantProperties interface{} `json:"retainAllVariantProperties"`
	// Specifies whether to reuse the last deployment configuration.
	//
	// The default value is false (the configuration is not reused).
	RetainDeploymentConfig interface{} `json:"retainDeploymentConfig"`
	// A list of key-value pairs to apply to this resource.
	//
	// For more information, see [Resource Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) and [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what) in the *AWS Billing and Cost Management User Guide* .
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `CfnEndpoint`.

TODO: EXAMPLE

type CfnEndpoint_AlarmProperty

type CfnEndpoint_AlarmProperty struct {
	// The name of a CloudWatch alarm in your account.
	AlarmName *string `json:"alarmName"`
}

An Amazon CloudWatch alarm configured to monitor metrics on an endpoint.

TODO: EXAMPLE

type CfnEndpoint_AutoRollbackConfigProperty

type CfnEndpoint_AutoRollbackConfigProperty struct {
	// List of CloudWatch alarms in your account that are configured to monitor metrics on an endpoint.
	//
	// If any alarms are tripped during a deployment, SageMaker rolls back the deployment.
	Alarms interface{} `json:"alarms"`
}

Automatic rollback configuration for handling endpoint deployment failures and recovery.

TODO: EXAMPLE

type CfnEndpoint_BlueGreenUpdatePolicyProperty

type CfnEndpoint_BlueGreenUpdatePolicyProperty struct {
	// Defines the traffic routing strategy to shift traffic from the old fleet to the new fleet during an endpoint deployment.
	TrafficRoutingConfiguration interface{} `json:"trafficRoutingConfiguration"`
	// Maximum execution timeout for the deployment.
	//
	// Note that the timeout value should be larger than the total waiting time specified in `TerminationWaitInSeconds` and `WaitIntervalInSeconds` .
	MaximumExecutionTimeoutInSeconds *float64 `json:"maximumExecutionTimeoutInSeconds"`
	// Additional waiting time in seconds after the completion of an endpoint deployment before terminating the old endpoint fleet.
	//
	// Default is 0.
	TerminationWaitInSeconds *float64 `json:"terminationWaitInSeconds"`
}

Update policy for a blue/green deployment.

If this update policy is specified, SageMaker creates a new fleet during the deployment while maintaining the old fleet. SageMaker flips traffic to the new fleet according to the specified traffic routing configuration. Only one update policy should be used in the deployment configuration. If no update policy is specified, SageMaker uses a blue/green deployment strategy with all at once traffic shifting by default.

TODO: EXAMPLE

type CfnEndpoint_CapacitySizeProperty

type CfnEndpoint_CapacitySizeProperty struct {
	// Specifies the endpoint capacity type.
	//
	// - `INSTANCE_COUNT` : The endpoint activates based on the number of instances.
	// - `CAPACITY_PERCENT` : The endpoint activates based on the specified percentage of capacity.
	Type *string `json:"type"`
	// Defines the capacity size, either as a number of instances or a capacity percentage.
	Value *float64 `json:"value"`
}

Specifies the endpoint capacity to activate for production.

TODO: EXAMPLE

type CfnEndpoint_DeploymentConfigProperty

type CfnEndpoint_DeploymentConfigProperty struct {
	// Update policy for a blue/green deployment.
	//
	// If this update policy is specified, SageMaker creates a new fleet during the deployment while maintaining the old fleet. SageMaker flips traffic to the new fleet according to the specified traffic routing configuration. Only one update policy should be used in the deployment configuration. If no update policy is specified, SageMaker uses a blue/green deployment strategy with all at once traffic shifting by default.
	BlueGreenUpdatePolicy interface{} `json:"blueGreenUpdatePolicy"`
	// Automatic rollback configuration for handling endpoint deployment failures and recovery.
	AutoRollbackConfiguration interface{} `json:"autoRollbackConfiguration"`
}

The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.

TODO: EXAMPLE

type CfnEndpoint_TrafficRoutingConfigProperty

type CfnEndpoint_TrafficRoutingConfigProperty struct {
	// Traffic routing strategy type.
	//
	// - `ALL_AT_ONCE` : Endpoint traffic shifts to the new fleet in a single step.
	// - `CANARY` : Endpoint traffic shifts to the new fleet in two steps. The first step is the canary, which is a small portion of the traffic. The second step is the remainder of the traffic.
	// - `LINEAR` : Endpoint traffic shifts to the new fleet in n steps of a configurable size.
	Type *string `json:"type"`
	// Batch size for the first step to turn on traffic on the new endpoint fleet.
	//
	// `Value` must be less than or equal to 50% of the variant's total instance count.
	CanarySize interface{} `json:"canarySize"`
	// Batch size for each step to turn on traffic on the new endpoint fleet.
	//
	// `Value` must be 10-50% of the variant's total instance count.
	LinearStepSize interface{} `json:"linearStepSize"`
	// The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet.
	WaitIntervalInSeconds *float64 `json:"waitIntervalInSeconds"`
}

Defines the traffic routing strategy during an endpoint deployment to shift traffic from the old fleet to the new fleet.

TODO: EXAMPLE

type CfnEndpoint_VariantPropertyProperty

type CfnEndpoint_VariantPropertyProperty struct {
	// The type of variant property. The supported values are:.
	//
	// - `DesiredInstanceCount` : Overrides the existing variant instance counts using the [InitialInstanceCount](https://docs.aws.amazon.com/sagemaker/latest/dg/API_ProductionVariant.html#SageMaker-Type-ProductionVariant-InitialInstanceCount) values in the [ProductionVariants](https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpointConfig.html#SageMaker-CreateEndpointConfig-request-ProductionVariants) .
	// - `DesiredWeight` : Overrides the existing variant weights using the [InitialVariantWeight](https://docs.aws.amazon.com/sagemaker/latest/dg/API_ProductionVariant.html#SageMaker-Type-ProductionVariant-InitialVariantWeight) values in the [ProductionVariants](https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpointConfig.html#SageMaker-CreateEndpointConfig-request-ProductionVariants) .
	// - `DataCaptureConfig` : (Not currently supported.)
	VariantPropertyType *string `json:"variantPropertyType"`
}

Specifies a production variant property type for an Endpoint.

If you are updating an Endpoint with the [RetainAllVariantProperties](https://docs.aws.amazon.com/sagemaker/latest/dg/API_UpdateEndpoint.html#SageMaker-UpdateEndpoint-request-RetainAllVariantProperties) option set to `true` , the `VarientProperty` objects listed in [ExcludeRetainedVariantProperties](https://docs.aws.amazon.com/sagemaker/latest/dg/API_UpdateEndpoint.html#SageMaker-UpdateEndpoint-request-ExcludeRetainedVariantProperties) override the existing variant properties of the Endpoint.

TODO: EXAMPLE

type CfnFeatureGroup

type CfnFeatureGroup interface {
	awscdk.CfnResource
	awscdk.IInspectable
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	EventTimeFeatureName() *string
	SetEventTimeFeatureName(val *string)
	FeatureDefinitions() interface{}
	SetFeatureDefinitions(val interface{})
	FeatureGroupName() *string
	SetFeatureGroupName(val *string)
	LogicalId() *string
	Node() constructs.Node
	OfflineStoreConfig() interface{}
	SetOfflineStoreConfig(val interface{})
	OnlineStoreConfig() interface{}
	SetOnlineStoreConfig(val interface{})
	RecordIdentifierFeatureName() *string
	SetRecordIdentifierFeatureName(val *string)
	Ref() *string
	RoleArn() *string
	SetRoleArn(val *string)
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::SageMaker::FeatureGroup`.

Create a new `FeatureGroup` . A `FeatureGroup` is a group of `Features` defined in the `FeatureStore` to describe a `Record` .

The `FeatureGroup` defines the schema and features contained in the FeatureGroup. A `FeatureGroup` definition is composed of a list of `Features` , a `RecordIdentifierFeatureName` , an `EventTimeFeatureName` and configurations for its `OnlineStore` and `OfflineStore` . Check [AWS service quotas](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) to see the `FeatureGroup` s quota for your AWS account.

> You must include at least one of `OnlineStoreConfig` and `OfflineStoreConfig` to create a `FeatureGroup` .

TODO: EXAMPLE

func NewCfnFeatureGroup

func NewCfnFeatureGroup(scope constructs.Construct, id *string, props *CfnFeatureGroupProps) CfnFeatureGroup

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

type CfnFeatureGroupProps

type CfnFeatureGroupProps struct {
	// The name of the feature that stores the `EventTime` of a Record in a `FeatureGroup` .
	//
	// A `EventTime` is point in time when a new event occurs that corresponds to the creation or update of a `Record` in `FeatureGroup` . All `Records` in the `FeatureGroup` must have a corresponding `EventTime` .
	EventTimeFeatureName *string `json:"eventTimeFeatureName"`
	// A list of `Feature` s. Each `Feature` must include a `FeatureName` and a `FeatureType` .
	//
	// Valid `FeatureType` s are `Integral` , `Fractional` and `String` .
	//
	// `FeatureName` s cannot be any of the following: `is_deleted` , `write_time` , `api_invocation_time` .
	//
	// You can create up to 2,500 `FeatureDefinition` s per `FeatureGroup` .
	FeatureDefinitions interface{} `json:"featureDefinitions"`
	// The name of the `FeatureGroup` .
	FeatureGroupName *string `json:"featureGroupName"`
	// The name of the `Feature` whose value uniquely identifies a `Record` defined in the `FeatureGroup` `FeatureDefinitions` .
	RecordIdentifierFeatureName *string `json:"recordIdentifierFeatureName"`
	// A free form description of a `FeatureGroup` .
	Description *string `json:"description"`
	// The configuration of an `OfflineStore` .
	OfflineStoreConfig interface{} `json:"offlineStoreConfig"`
	// The configuration of an `OnlineStore` .
	OnlineStoreConfig interface{} `json:"onlineStoreConfig"`
	// The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.
	RoleArn *string `json:"roleArn"`
	// Tags used to define a `FeatureGroup` .
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `CfnFeatureGroup`.

TODO: EXAMPLE

type CfnFeatureGroup_FeatureDefinitionProperty

type CfnFeatureGroup_FeatureDefinitionProperty struct {
	// The name of a feature.
	//
	// The type must be a string. `FeatureName` cannot be any of the following: `is_deleted` , `write_time` , `api_invocation_time` .
	FeatureName *string `json:"featureName"`
	// The value type of a feature.
	//
	// Valid values are Integral, Fractional, or String.
	FeatureType *string `json:"featureType"`
}

A list of features.

You must include `FeatureName` and `FeatureType` . Valid feature `FeatureType` s are `Integral` , `Fractional` and `String` .

TODO: EXAMPLE

type CfnImage

type CfnImage interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrImageArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	ImageDescription() *string
	SetImageDescription(val *string)
	ImageDisplayName() *string
	SetImageDisplayName(val *string)
	ImageName() *string
	SetImageName(val *string)
	ImageRoleArn() *string
	SetImageRoleArn(val *string)
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::SageMaker::Image`.

Creates a custom SageMaker image. A SageMaker image is a set of image versions. Each image version represents a container image stored in Amazon Container Registry (ECR). For more information, see [Bring your own SageMaker image](https://docs.aws.amazon.com/sagemaker/latest/dg/studio-byoi.html) .

TODO: EXAMPLE

func NewCfnImage

func NewCfnImage(scope constructs.Construct, id *string, props *CfnImageProps) CfnImage

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

type CfnImageProps

type CfnImageProps struct {
	// The name of the Image. Must be unique by region in your account.
	//
	// *Length Constraints* : Minimum length of 1. Maximum length of 63.
	//
	// *Pattern* : `^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$`
	ImageName *string `json:"imageName"`
	// The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
	//
	// *Length Constraints* : Minimum length of 20. Maximum length of 2048.
	//
	// *Pattern* : `^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$`
	ImageRoleArn *string `json:"imageRoleArn"`
	// The description of the image.
	//
	// *Length Constraints* : Minimum length of 1. Maximum length of 512.
	//
	// *Pattern* : `.*`
	ImageDescription *string `json:"imageDescription"`
	// The display name of the image.
	//
	// *Length Constraints* : Minimum length of 1. Maximum length of 128.
	//
	// *Pattern* : `^\S(.*\S)?$`
	ImageDisplayName *string `json:"imageDisplayName"`
	// A list of key-value pairs to apply to this resource.
	//
	// *Array Members* : Minimum number of 0 items. Maximum number of 50 items.
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `CfnImage`.

TODO: EXAMPLE

type CfnImageVersion

type CfnImageVersion interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrContainerImage() *string
	AttrImageArn() *string
	AttrImageVersionArn() *string
	AttrVersion() *float64
	BaseImage() *string
	SetBaseImage(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	ImageName() *string
	SetImageName(val *string)
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::SageMaker::ImageVersion`.

Creates a version of the SageMaker image specified by `ImageName` . The version represents the Amazon Container Registry (ECR) container image specified by `BaseImage` .

> You can use the `DependsOn` attribute to specify that the creation of a specific resource follows another. You can use it for the following use cases. For more information, see [`DependsOn` attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) . > > 1. `DependsOn` can be used to establish a parent/child relationship between `ImageVersion` and `Image` where the `ImageVersion` `DependsOn` the `Image` . > > 2. `DependsOn` can be used to establish order among `ImageVersion` s within the same `Image` namespace. For example, if ImageVersionB `DependsOn` ImageVersionA and both share the same parent `Image` , then ImageVersionA is version N and ImageVersionB is N+1.

TODO: EXAMPLE

func NewCfnImageVersion

func NewCfnImageVersion(scope constructs.Construct, id *string, props *CfnImageVersionProps) CfnImageVersion

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

type CfnImageVersionProps

type CfnImageVersionProps struct {
	// The container image that the SageMaker image version is based on.
	//
	// *Length Constraints* : Minimum length of 1. Maximum length of 255.
	//
	// *Pattern* : `.*`
	BaseImage *string `json:"baseImage"`
	// The name of the parent image.
	//
	// *Length Constraints* : Minimum length of 1. Maximum length of 63.
	//
	// *Pattern* : `^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$`
	ImageName *string `json:"imageName"`
}

Properties for defining a `CfnImageVersion`.

TODO: EXAMPLE

type CfnModel

type CfnModel interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrModelName() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	Containers() interface{}
	SetContainers(val interface{})
	CreationStack() *[]*string
	EnableNetworkIsolation() interface{}
	SetEnableNetworkIsolation(val interface{})
	ExecutionRoleArn() *string
	SetExecutionRoleArn(val *string)
	InferenceExecutionConfig() interface{}
	SetInferenceExecutionConfig(val interface{})
	LogicalId() *string
	ModelName() *string
	SetModelName(val *string)
	Node() constructs.Node
	PrimaryContainer() interface{}
	SetPrimaryContainer(val interface{})
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	VpcConfig() interface{}
	SetVpcConfig(val interface{})
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

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

The `AWS::SageMaker::Model` resource to create a model to host at an Amazon SageMaker endpoint. For more information, see [Deploying a Model on Amazon SageMaker Hosting Services](https://docs.aws.amazon.com/sagemaker/latest/dg/how-it-works-hosting.html) in the *Amazon SageMaker Developer Guide* .

TODO: EXAMPLE

func NewCfnModel

func NewCfnModel(scope constructs.Construct, id *string, props *CfnModelProps) CfnModel

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

type CfnModelBiasJobDefinition

type CfnModelBiasJobDefinition interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrCreationTime() *string
	AttrJobDefinitionArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	JobDefinitionName() *string
	SetJobDefinitionName(val *string)
	JobResources() interface{}
	SetJobResources(val interface{})
	LogicalId() *string
	ModelBiasAppSpecification() interface{}
	SetModelBiasAppSpecification(val interface{})
	ModelBiasBaselineConfig() interface{}
	SetModelBiasBaselineConfig(val interface{})
	ModelBiasJobInput() interface{}
	SetModelBiasJobInput(val interface{})
	ModelBiasJobOutputConfig() interface{}
	SetModelBiasJobOutputConfig(val interface{})
	NetworkConfig() interface{}
	SetNetworkConfig(val interface{})
	Node() constructs.Node
	Ref() *string
	RoleArn() *string
	SetRoleArn(val *string)
	Stack() awscdk.Stack
	StoppingCondition() interface{}
	SetStoppingCondition(val interface{})
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::SageMaker::ModelBiasJobDefinition`.

Creates the definition for a model bias job.

TODO: EXAMPLE

func NewCfnModelBiasJobDefinition

func NewCfnModelBiasJobDefinition(scope constructs.Construct, id *string, props *CfnModelBiasJobDefinitionProps) CfnModelBiasJobDefinition

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

type CfnModelBiasJobDefinitionProps

type CfnModelBiasJobDefinitionProps struct {
	// Identifies the resources to deploy for a monitoring job.
	JobResources interface{} `json:"jobResources"`
	// Configures the model bias job to run a specified Docker container image.
	ModelBiasAppSpecification interface{} `json:"modelBiasAppSpecification"`
	// Inputs for the model bias job.
	ModelBiasJobInput interface{} `json:"modelBiasJobInput"`
	// The output configuration for monitoring jobs.
	ModelBiasJobOutputConfig interface{} `json:"modelBiasJobOutputConfig"`
	// The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
	RoleArn *string `json:"roleArn"`
	// The name of the bias job definition.
	//
	// The name must be unique within an AWS Region in the AWS account.
	JobDefinitionName *string `json:"jobDefinitionName"`
	// The baseline configuration for a model bias job.
	ModelBiasBaselineConfig interface{} `json:"modelBiasBaselineConfig"`
	// Networking options for a model bias job.
	NetworkConfig interface{} `json:"networkConfig"`
	// A time limit for how long the monitoring job is allowed to run before stopping.
	StoppingCondition interface{} `json:"stoppingCondition"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `CfnModelBiasJobDefinition`.

TODO: EXAMPLE

type CfnModelBiasJobDefinition_ClusterConfigProperty

type CfnModelBiasJobDefinition_ClusterConfigProperty struct {
	// `CfnModelBiasJobDefinition.ClusterConfigProperty.InstanceCount`.
	InstanceCount *float64 `json:"instanceCount"`
	// `CfnModelBiasJobDefinition.ClusterConfigProperty.InstanceType`.
	InstanceType *string `json:"instanceType"`
	// `CfnModelBiasJobDefinition.ClusterConfigProperty.VolumeSizeInGB`.
	VolumeSizeInGb *float64 `json:"volumeSizeInGb"`
	// `CfnModelBiasJobDefinition.ClusterConfigProperty.VolumeKmsKeyId`.
	VolumeKmsKeyId *string `json:"volumeKmsKeyId"`
}

TODO: EXAMPLE

type CfnModelBiasJobDefinition_ConstraintsResourceProperty

type CfnModelBiasJobDefinition_ConstraintsResourceProperty struct {
	// The Amazon S3 URI for the constraints resource.
	S3Uri *string `json:"s3Uri"`
}

The constraints resource for a monitoring job.

TODO: EXAMPLE

type CfnModelBiasJobDefinition_EndpointInputProperty

type CfnModelBiasJobDefinition_EndpointInputProperty struct {
	// An endpoint in customer's account which has enabled `DataCaptureConfig` enabled.
	EndpointName *string `json:"endpointName"`
	// Path to the filesystem where the endpoint data is available to the container.
	LocalPath *string `json:"localPath"`
	// If specified, monitoring jobs substract this time from the end time.
	//
	// For information about using offsets for scheduling monitoring jobs, see [Schedule Model Quality Monitoring Jobs](https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-model-quality-schedule.html) .
	EndTimeOffset *string `json:"endTimeOffset"`
	// The attributes of the input data that are the input features.
	FeaturesAttribute *string `json:"featuresAttribute"`
	// The attribute of the input data that represents the ground truth label.
	InferenceAttribute *string `json:"inferenceAttribute"`
	// In a classification problem, the attribute that represents the class probability.
	ProbabilityAttribute *string `json:"probabilityAttribute"`
	// The threshold for the class probability to be evaluated as a positive result.
	ProbabilityThresholdAttribute *float64 `json:"probabilityThresholdAttribute"`
	// Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key.
	//
	// Defaults to `FullyReplicated`
	S3DataDistributionType *string `json:"s3DataDistributionType"`
	// Whether the `Pipe` or `File` is used as the input mode for transferring data for the monitoring job.
	//
	// `Pipe` mode is recommended for large datasets. `File` mode is useful for small files that fit in memory. Defaults to `File` .
	S3InputMode *string `json:"s3InputMode"`
	// If specified, monitoring jobs substract this time from the start time.
	//
	// For information about using offsets for scheduling monitoring jobs, see [Schedule Model Quality Monitoring Jobs](https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-model-quality-schedule.html) .
	StartTimeOffset *string `json:"startTimeOffset"`
}

Input object for the endpoint.

TODO: EXAMPLE

type CfnModelBiasJobDefinition_ModelBiasAppSpecificationProperty

type CfnModelBiasJobDefinition_ModelBiasAppSpecificationProperty struct {
	// JSON formatted S3 file that defines bias parameters.
	//
	// For more information on this JSON configuration file, see [Configure bias parameters](https://docs.aws.amazon.com/sagemaker/latest/json-bias-parameter-config.html) .
	ConfigUri *string `json:"configUri"`
	// The container image to be run by the model bias job.
	ImageUri *string `json:"imageUri"`
	// Sets the environment variables in the Docker container.
	Environment interface{} `json:"environment"`
}

Docker container image configuration object for the model bias job.

TODO: EXAMPLE

type CfnModelBiasJobDefinition_ModelBiasBaselineConfigProperty

type CfnModelBiasJobDefinition_ModelBiasBaselineConfigProperty struct {
	// The name of the baseline model bias job.
	BaseliningJobName *string `json:"baseliningJobName"`
	// The constraints resource for a monitoring job.
	ConstraintsResource interface{} `json:"constraintsResource"`
}

The configuration for a baseline model bias job.

TODO: EXAMPLE

type CfnModelBiasJobDefinition_ModelBiasJobInputProperty

type CfnModelBiasJobDefinition_ModelBiasJobInputProperty struct {
	// Input object for the endpoint.
	EndpointInput interface{} `json:"endpointInput"`
	// Location of ground truth labels to use in model bias job.
	GroundTruthS3Input interface{} `json:"groundTruthS3Input"`
}

Inputs for the model bias job.

TODO: EXAMPLE

type CfnModelBiasJobDefinition_MonitoringGroundTruthS3InputProperty

type CfnModelBiasJobDefinition_MonitoringGroundTruthS3InputProperty struct {
	// The address of the Amazon S3 location of the ground truth labels.
	S3Uri *string `json:"s3Uri"`
}

The ground truth labels for the dataset used for the monitoring job.

TODO: EXAMPLE

type CfnModelBiasJobDefinition_MonitoringOutputConfigProperty

type CfnModelBiasJobDefinition_MonitoringOutputConfigProperty struct {
	// Monitoring outputs for monitoring jobs.
	//
	// This is where the output of the periodic monitoring jobs is uploaded.
	MonitoringOutputs interface{} `json:"monitoringOutputs"`
	// The AWS Key Management Service ( AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.
	KmsKeyId *string `json:"kmsKeyId"`
}

The output configuration for monitoring jobs.

TODO: EXAMPLE

type CfnModelBiasJobDefinition_MonitoringOutputProperty

type CfnModelBiasJobDefinition_MonitoringOutputProperty struct {
	// The Amazon S3 storage location where the results of a monitoring job are saved.
	S3Output interface{} `json:"s3Output"`
}

The output object for a monitoring job.

TODO: EXAMPLE

type CfnModelBiasJobDefinition_MonitoringResourcesProperty

type CfnModelBiasJobDefinition_MonitoringResourcesProperty struct {
	// The configuration for the cluster resources used to run the processing job.
	ClusterConfig interface{} `json:"clusterConfig"`
}

Identifies the resources to deploy for a monitoring job.

TODO: EXAMPLE

type CfnModelBiasJobDefinition_NetworkConfigProperty

type CfnModelBiasJobDefinition_NetworkConfigProperty struct {
	// Whether to encrypt all communications between distributed processing jobs.
	//
	// Choose `True` to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer.
	EnableInterContainerTrafficEncryption interface{} `json:"enableInterContainerTrafficEncryption"`
	// Whether to allow inbound and outbound network calls to and from the containers used for the processing job.
	EnableNetworkIsolation interface{} `json:"enableNetworkIsolation"`
	// Specifies a VPC that your training jobs and hosted models have access to.
	//
	// Control access to and from your training and model containers by configuring the VPC.
	VpcConfig interface{} `json:"vpcConfig"`
}

Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.

TODO: EXAMPLE

type CfnModelBiasJobDefinition_S3OutputProperty

type CfnModelBiasJobDefinition_S3OutputProperty struct {
	// The local path to the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job.
	//
	// `LocalPath` is an absolute path for the output data.
	LocalPath *string `json:"localPath"`
	// A URI that identifies the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job.
	S3Uri *string `json:"s3Uri"`
	// Whether to upload the results of the monitoring job continuously or after the job completes.
	S3UploadMode *string `json:"s3UploadMode"`
}

The Amazon S3 storage location where the results of a monitoring job are saved.

TODO: EXAMPLE

type CfnModelBiasJobDefinition_StoppingConditionProperty

type CfnModelBiasJobDefinition_StoppingConditionProperty struct {
	// The maximum length of time, in seconds, that a training or compilation job can run.
	//
	// For compilation jobs, if the job does not complete during this time, you will receive a `TimeOut` error. We recommend starting with 900 seconds and increase as necessary based on your model.
	//
	// For all other jobs, if the job does not complete during this time, Amazon SageMaker ends the job. When `RetryStrategy` is specified in the job request, `MaxRuntimeInSeconds` specifies the maximum time for all of the attempts in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.
	MaxRuntimeInSeconds *float64 `json:"maxRuntimeInSeconds"`
}

Specifies a limit to how long a model training job or model compilation job can run.

It also specifies how long a managed spot training job has to complete. When the job reaches the time limit, Amazon SageMaker ends the training or compilation job. Use this API to cap model training costs.

To stop a training job, Amazon SageMaker sends the algorithm the `SIGTERM` signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

The training algorithms provided by Amazon SageMaker automatically save the intermediate results of a model training job when possible. This attempt to save artifacts is only a best effort case as model might not be in a state from which it can be saved. For example, if training has just started, the model might not be ready to save. When saved, this intermediate data is a valid model artifact. You can use it to create a model with `CreateModel` .

> The Neural Topic Model (NTM) currently does not support saving intermediate model artifacts. When training NTMs, make sure that the maximum runtime is sufficient for the training job to complete.

TODO: EXAMPLE

type CfnModelBiasJobDefinition_VpcConfigProperty

type CfnModelBiasJobDefinition_VpcConfigProperty struct {
	// The VPC security group IDs, in the form sg-xxxxxxxx.
	//
	// Specify the security groups for the VPC that is specified in the `Subnets` field.
	SecurityGroupIds *[]*string `json:"securityGroupIds"`
	// The ID of the subnets in the VPC to which you want to connect your training job or model.
	//
	// For information about the availability of specific instance types, see [Supported Instance Types and Availability Zones](https://docs.aws.amazon.com/sagemaker/latest/dg/instance-types-az.html) .
	Subnets *[]*string `json:"subnets"`
}

Specifies a VPC that your training jobs and hosted models have access to.

Control access to and from your training and model containers by configuring the VPC. For more information, see [Protect Endpoints by Using an Amazon Virtual Private Cloud](https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html) and [Protect Training Jobs by Using an Amazon Virtual Private Cloud](https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html) .

TODO: EXAMPLE

type CfnModelExplainabilityJobDefinition

type CfnModelExplainabilityJobDefinition interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrCreationTime() *string
	AttrJobDefinitionArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	JobDefinitionName() *string
	SetJobDefinitionName(val *string)
	JobResources() interface{}
	SetJobResources(val interface{})
	LogicalId() *string
	ModelExplainabilityAppSpecification() interface{}
	SetModelExplainabilityAppSpecification(val interface{})
	ModelExplainabilityBaselineConfig() interface{}
	SetModelExplainabilityBaselineConfig(val interface{})
	ModelExplainabilityJobInput() interface{}
	SetModelExplainabilityJobInput(val interface{})
	ModelExplainabilityJobOutputConfig() interface{}
	SetModelExplainabilityJobOutputConfig(val interface{})
	NetworkConfig() interface{}
	SetNetworkConfig(val interface{})
	Node() constructs.Node
	Ref() *string
	RoleArn() *string
	SetRoleArn(val *string)
	Stack() awscdk.Stack
	StoppingCondition() interface{}
	SetStoppingCondition(val interface{})
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::SageMaker::ModelExplainabilityJobDefinition`.

Creates the definition for a model explainability job.

TODO: EXAMPLE

func NewCfnModelExplainabilityJobDefinition

func NewCfnModelExplainabilityJobDefinition(scope constructs.Construct, id *string, props *CfnModelExplainabilityJobDefinitionProps) CfnModelExplainabilityJobDefinition

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

type CfnModelExplainabilityJobDefinitionProps

type CfnModelExplainabilityJobDefinitionProps struct {
	// Identifies the resources to deploy for a monitoring job.
	JobResources interface{} `json:"jobResources"`
	// Configures the model explainability job to run a specified Docker container image.
	ModelExplainabilityAppSpecification interface{} `json:"modelExplainabilityAppSpecification"`
	// Inputs for the model explainability job.
	ModelExplainabilityJobInput interface{} `json:"modelExplainabilityJobInput"`
	// The output configuration for monitoring jobs.
	ModelExplainabilityJobOutputConfig interface{} `json:"modelExplainabilityJobOutputConfig"`
	// The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
	RoleArn *string `json:"roleArn"`
	// The name of the model explainability job definition.
	//
	// The name must be unique within an AWS Region in the AWS account.
	JobDefinitionName *string `json:"jobDefinitionName"`
	// The baseline configuration for a model explainability job.
	ModelExplainabilityBaselineConfig interface{} `json:"modelExplainabilityBaselineConfig"`
	// Networking options for a model explainability job.
	NetworkConfig interface{} `json:"networkConfig"`
	// `AWS::SageMaker::ModelExplainabilityJobDefinition.StoppingCondition`.
	StoppingCondition interface{} `json:"stoppingCondition"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `CfnModelExplainabilityJobDefinition`.

TODO: EXAMPLE

type CfnModelExplainabilityJobDefinition_ClusterConfigProperty

type CfnModelExplainabilityJobDefinition_ClusterConfigProperty struct {
	// The number of ML compute instances to use in the model monitoring job.
	//
	// For distributed processing jobs, specify a value greater than 1. The default value is 1.
	InstanceCount *float64 `json:"instanceCount"`
	// The ML compute instance type for the processing job.
	InstanceType *string `json:"instanceType"`
	// The size of the ML storage volume, in gigabytes, that you want to provision.
	//
	// You must specify sufficient ML storage for your scenario.
	VolumeSizeInGb *float64 `json:"volumeSizeInGb"`
	// The AWS Key Management Service ( AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the model monitoring job.
	VolumeKmsKeyId *string `json:"volumeKmsKeyId"`
}

The configuration for the cluster resources used to run the processing job.

TODO: EXAMPLE

type CfnModelExplainabilityJobDefinition_ConstraintsResourceProperty

type CfnModelExplainabilityJobDefinition_ConstraintsResourceProperty struct {
	// The Amazon S3 URI for the constraints resource.
	S3Uri *string `json:"s3Uri"`
}

The constraints resource for a monitoring job.

TODO: EXAMPLE

type CfnModelExplainabilityJobDefinition_EndpointInputProperty

type CfnModelExplainabilityJobDefinition_EndpointInputProperty struct {
	// An endpoint in customer's account which has enabled `DataCaptureConfig` enabled.
	EndpointName *string `json:"endpointName"`
	// Path to the filesystem where the endpoint data is available to the container.
	LocalPath *string `json:"localPath"`
	// The attributes of the input data that are the input features.
	FeaturesAttribute *string `json:"featuresAttribute"`
	// The attribute of the input data that represents the ground truth label.
	InferenceAttribute *string `json:"inferenceAttribute"`
	// In a classification problem, the attribute that represents the class probability.
	ProbabilityAttribute *string `json:"probabilityAttribute"`
	// Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key.
	//
	// Defaults to `FullyReplicated`
	S3DataDistributionType *string `json:"s3DataDistributionType"`
	// Whether the `Pipe` or `File` is used as the input mode for transferring data for the monitoring job.
	//
	// `Pipe` mode is recommended for large datasets. `File` mode is useful for small files that fit in memory. Defaults to `File` .
	S3InputMode *string `json:"s3InputMode"`
}

Input object for the endpoint.

TODO: EXAMPLE

type CfnModelExplainabilityJobDefinition_ModelExplainabilityAppSpecificationProperty

type CfnModelExplainabilityJobDefinition_ModelExplainabilityAppSpecificationProperty struct {
	// JSON formatted S3 file that defines explainability parameters.
	//
	// For more information on this JSON configuration file, see [Configure model explainability parameters](https://docs.aws.amazon.com/sagemaker/latest/json-model-explainability-parameter-config.html) .
	ConfigUri *string `json:"configUri"`
	// The container image to be run by the model explainability job.
	ImageUri *string `json:"imageUri"`
	// Sets the environment variables in the Docker container.
	Environment interface{} `json:"environment"`
}

Docker container image configuration object for the model explainability job.

TODO: EXAMPLE

type CfnModelExplainabilityJobDefinition_ModelExplainabilityBaselineConfigProperty

type CfnModelExplainabilityJobDefinition_ModelExplainabilityBaselineConfigProperty struct {
	// The name of the baseline model explainability job.
	BaseliningJobName *string `json:"baseliningJobName"`
	// `CfnModelExplainabilityJobDefinition.ModelExplainabilityBaselineConfigProperty.ConstraintsResource`.
	ConstraintsResource interface{} `json:"constraintsResource"`
}

The configuration for a baseline model explainability job.

TODO: EXAMPLE

type CfnModelExplainabilityJobDefinition_ModelExplainabilityJobInputProperty

type CfnModelExplainabilityJobDefinition_ModelExplainabilityJobInputProperty struct {
	// `CfnModelExplainabilityJobDefinition.ModelExplainabilityJobInputProperty.EndpointInput`.
	EndpointInput interface{} `json:"endpointInput"`
}

Inputs for the model explainability job.

TODO: EXAMPLE

type CfnModelExplainabilityJobDefinition_MonitoringOutputConfigProperty

type CfnModelExplainabilityJobDefinition_MonitoringOutputConfigProperty struct {
	// Monitoring outputs for monitoring jobs.
	//
	// This is where the output of the periodic monitoring jobs is uploaded.
	MonitoringOutputs interface{} `json:"monitoringOutputs"`
	// The AWS Key Management Service ( AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.
	KmsKeyId *string `json:"kmsKeyId"`
}

The output configuration for monitoring jobs.

TODO: EXAMPLE

type CfnModelExplainabilityJobDefinition_MonitoringOutputProperty

type CfnModelExplainabilityJobDefinition_MonitoringOutputProperty struct {
	// The Amazon S3 storage location where the results of a monitoring job are saved.
	S3Output interface{} `json:"s3Output"`
}

The output object for a monitoring job.

TODO: EXAMPLE

type CfnModelExplainabilityJobDefinition_MonitoringResourcesProperty

type CfnModelExplainabilityJobDefinition_MonitoringResourcesProperty struct {
	// The configuration for the cluster resources used to run the processing job.
	ClusterConfig interface{} `json:"clusterConfig"`
}

Identifies the resources to deploy for a monitoring job.

TODO: EXAMPLE

type CfnModelExplainabilityJobDefinition_NetworkConfigProperty

type CfnModelExplainabilityJobDefinition_NetworkConfigProperty struct {
	// Whether to encrypt all communications between distributed processing jobs.
	//
	// Choose `True` to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer.
	EnableInterContainerTrafficEncryption interface{} `json:"enableInterContainerTrafficEncryption"`
	// Whether to allow inbound and outbound network calls to and from the containers used for the processing job.
	EnableNetworkIsolation interface{} `json:"enableNetworkIsolation"`
	// `CfnModelExplainabilityJobDefinition.NetworkConfigProperty.VpcConfig`.
	VpcConfig interface{} `json:"vpcConfig"`
}

Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.

TODO: EXAMPLE

type CfnModelExplainabilityJobDefinition_S3OutputProperty

type CfnModelExplainabilityJobDefinition_S3OutputProperty struct {
	// The local path to the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job.
	//
	// LocalPath is an absolute path for the output data.
	LocalPath *string `json:"localPath"`
	// A URI that identifies the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job.
	S3Uri *string `json:"s3Uri"`
	// Whether to upload the results of the monitoring job continuously or after the job completes.
	S3UploadMode *string `json:"s3UploadMode"`
}

The Amazon S3 storage location where the results of a monitoring job are saved.

TODO: EXAMPLE

type CfnModelExplainabilityJobDefinition_StoppingConditionProperty

type CfnModelExplainabilityJobDefinition_StoppingConditionProperty struct {
	// The maximum length of time, in seconds, that a training or compilation job can run.
	//
	// For compilation jobs, if the job does not complete during this time, you will receive a `TimeOut` error. We recommend starting with 900 seconds and increase as necessary based on your model.
	//
	// For all other jobs, if the job does not complete during this time, Amazon SageMaker ends the job. When `RetryStrategy` is specified in the job request, `MaxRuntimeInSeconds` specifies the maximum time for all of the attempts in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.
	MaxRuntimeInSeconds *float64 `json:"maxRuntimeInSeconds"`
}

Specifies a limit to how long a model training job or model compilation job can run.

It also specifies how long a managed spot training job has to complete. When the job reaches the time limit, Amazon SageMaker ends the training or compilation job. Use this API to cap model training costs.

To stop a training job, Amazon SageMaker sends the algorithm the `SIGTERM` signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

The training algorithms provided by Amazon SageMaker automatically save the intermediate results of a model training job when possible. This attempt to save artifacts is only a best effort case as model might not be in a state from which it can be saved. For example, if training has just started, the model might not be ready to save. When saved, this intermediate data is a valid model artifact. You can use it to create a model with `CreateModel` .

> The Neural Topic Model (NTM) currently does not support saving intermediate model artifacts. When training NTMs, make sure that the maximum runtime is sufficient for the training job to complete.

TODO: EXAMPLE

type CfnModelExplainabilityJobDefinition_VpcConfigProperty

type CfnModelExplainabilityJobDefinition_VpcConfigProperty struct {
	// The VPC security group IDs, in the form sg-xxxxxxxx.
	//
	// Specify the security groups for the VPC that is specified in the `Subnets` field.
	SecurityGroupIds *[]*string `json:"securityGroupIds"`
	// The ID of the subnets in the VPC to which you want to connect your training job or model.
	//
	// For information about the availability of specific instance types, see [Supported Instance Types and Availability Zones](https://docs.aws.amazon.com/sagemaker/latest/dg/instance-types-az.html) .
	Subnets *[]*string `json:"subnets"`
}

Specifies a VPC that your training jobs and hosted models have access to.

Control access to and from your training and model containers by configuring the VPC. For more information, see [Protect Endpoints by Using an Amazon Virtual Private Cloud](https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html) and [Protect Training Jobs by Using an Amazon Virtual Private Cloud](https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html) .

TODO: EXAMPLE

type CfnModelPackageGroup

type CfnModelPackageGroup interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrCreationTime() *string
	AttrModelPackageGroupArn() *string
	AttrModelPackageGroupStatus() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	ModelPackageGroupDescription() *string
	SetModelPackageGroupDescription(val *string)
	ModelPackageGroupName() *string
	SetModelPackageGroupName(val *string)
	ModelPackageGroupPolicy() interface{}
	SetModelPackageGroupPolicy(val interface{})
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::SageMaker::ModelPackageGroup`.

A group of versioned models in the model registry.

TODO: EXAMPLE

func NewCfnModelPackageGroup

func NewCfnModelPackageGroup(scope constructs.Construct, id *string, props *CfnModelPackageGroupProps) CfnModelPackageGroup

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

type CfnModelPackageGroupProps

type CfnModelPackageGroupProps struct {
	// The name of the model group.
	ModelPackageGroupName *string `json:"modelPackageGroupName"`
	// The description for the model group.
	ModelPackageGroupDescription *string `json:"modelPackageGroupDescription"`
	// A resouce policy to control access to a model group.
	//
	// For information about resoure policies, see [Identity-based policies and resource-based policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_identity-vs-resource.html) in the *AWS Identity and Access Management User Guide.* .
	ModelPackageGroupPolicy interface{} `json:"modelPackageGroupPolicy"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `CfnModelPackageGroup`.

TODO: EXAMPLE

type CfnModelProps

type CfnModelProps struct {
	// The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker can assume to access model artifacts and docker image for deployment on ML compute instances or for batch transform jobs.
	//
	// Deploying on ML compute instances is part of model hosting. For more information, see [Amazon SageMaker Roles](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html) .
	//
	// > To be able to pass this role to Amazon SageMaker, the caller of this API must have the `iam:PassRole` permission.
	ExecutionRoleArn *string `json:"executionRoleArn"`
	// Specifies the containers in the inference pipeline.
	Containers interface{} `json:"containers"`
	// Isolates the model container.
	//
	// No inbound or outbound network calls can be made to or from the model container.
	EnableNetworkIsolation interface{} `json:"enableNetworkIsolation"`
	// Specifies details of how containers in a multi-container endpoint are called.
	InferenceExecutionConfig interface{} `json:"inferenceExecutionConfig"`
	// The name of the new model.
	ModelName *string `json:"modelName"`
	// The location of the primary docker image containing inference code, associated artifacts, and custom environment map that the inference code uses when the model is deployed for predictions.
	PrimaryContainer interface{} `json:"primaryContainer"`
	// A list of key-value pairs to apply to this resource.
	//
	// For more information, see [Resource Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) and [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what) in the *AWS Billing and Cost Management User Guide* .
	Tags *[]*awscdk.CfnTag `json:"tags"`
	// A [VpcConfig](https://docs.aws.amazon.com/sagemaker/latest/dg/API_VpcConfig.html) object that specifies the VPC that you want your model to connect to. Control access to and from your model container by configuring the VPC. `VpcConfig` is used in hosting services and in batch transform. For more information, see [Protect Endpoints by Using an Amazon Virtual Private Cloud](https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html) and [Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private Cloud](https://docs.aws.amazon.com/sagemaker/latest/dg/batch-vpc.html) .
	VpcConfig interface{} `json:"vpcConfig"`
}

Properties for defining a `CfnModel`.

TODO: EXAMPLE

type CfnModelQualityJobDefinition

type CfnModelQualityJobDefinition interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrCreationTime() *string
	AttrJobDefinitionArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	JobDefinitionName() *string
	SetJobDefinitionName(val *string)
	JobResources() interface{}
	SetJobResources(val interface{})
	LogicalId() *string
	ModelQualityAppSpecification() interface{}
	SetModelQualityAppSpecification(val interface{})
	ModelQualityBaselineConfig() interface{}
	SetModelQualityBaselineConfig(val interface{})
	ModelQualityJobInput() interface{}
	SetModelQualityJobInput(val interface{})
	ModelQualityJobOutputConfig() interface{}
	SetModelQualityJobOutputConfig(val interface{})
	NetworkConfig() interface{}
	SetNetworkConfig(val interface{})
	Node() constructs.Node
	Ref() *string
	RoleArn() *string
	SetRoleArn(val *string)
	Stack() awscdk.Stack
	StoppingCondition() interface{}
	SetStoppingCondition(val interface{})
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::SageMaker::ModelQualityJobDefinition`.

TODO: EXAMPLE

func NewCfnModelQualityJobDefinition

func NewCfnModelQualityJobDefinition(scope constructs.Construct, id *string, props *CfnModelQualityJobDefinitionProps) CfnModelQualityJobDefinition

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

type CfnModelQualityJobDefinitionProps

type CfnModelQualityJobDefinitionProps struct {
	// Identifies the resources to deploy for a monitoring job.
	JobResources interface{} `json:"jobResources"`
	// `AWS::SageMaker::ModelQualityJobDefinition.ModelQualityAppSpecification`.
	ModelQualityAppSpecification interface{} `json:"modelQualityAppSpecification"`
	// A list of the inputs that are monitored.
	//
	// Currently endpoints are supported.
	ModelQualityJobInput interface{} `json:"modelQualityJobInput"`
	// The output configuration for monitoring jobs.
	ModelQualityJobOutputConfig interface{} `json:"modelQualityJobOutputConfig"`
	// The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
	RoleArn *string `json:"roleArn"`
	// The name of the monitoring job definition.
	JobDefinitionName *string `json:"jobDefinitionName"`
	// Specifies the constraints and baselines for the monitoring job.
	ModelQualityBaselineConfig interface{} `json:"modelQualityBaselineConfig"`
	// Specifies the network configuration for the monitoring job.
	NetworkConfig interface{} `json:"networkConfig"`
	// A time limit for how long the monitoring job is allowed to run before stopping.
	StoppingCondition interface{} `json:"stoppingCondition"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `CfnModelQualityJobDefinition`.

TODO: EXAMPLE

type CfnModelQualityJobDefinition_ClusterConfigProperty

type CfnModelQualityJobDefinition_ClusterConfigProperty struct {
	// The number of ML compute instances to use in the model monitoring job.
	//
	// For distributed processing jobs, specify a value greater than 1. The default value is 1.
	InstanceCount *float64 `json:"instanceCount"`
	// The ML compute instance type for the processing job.
	InstanceType *string `json:"instanceType"`
	// The size of the ML storage volume, in gigabytes, that you want to provision.
	//
	// You must specify sufficient ML storage for your scenario.
	VolumeSizeInGb *float64 `json:"volumeSizeInGb"`
	// The AWS Key Management Service ( AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the model monitoring job.
	VolumeKmsKeyId *string `json:"volumeKmsKeyId"`
}

The configuration for the cluster of resources used to run the processing job.

TODO: EXAMPLE

type CfnModelQualityJobDefinition_ConstraintsResourceProperty

type CfnModelQualityJobDefinition_ConstraintsResourceProperty struct {
	// The Amazon S3 URI for the constraints resource.
	S3Uri *string `json:"s3Uri"`
}

The constraints resource for a monitoring job.

TODO: EXAMPLE

type CfnModelQualityJobDefinition_EndpointInputProperty

type CfnModelQualityJobDefinition_EndpointInputProperty struct {
	// An endpoint in customer's account which has enabled `DataCaptureConfig` enabled.
	EndpointName *string `json:"endpointName"`
	// Path to the filesystem where the endpoint data is available to the container.
	LocalPath *string `json:"localPath"`
	// If specified, monitoring jobs substract this time from the end time.
	//
	// For information about using offsets for scheduling monitoring jobs, see [Schedule Model Quality Monitoring Jobs](https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-model-quality-schedule.html) .
	EndTimeOffset *string `json:"endTimeOffset"`
	// The attribute of the input data that represents the ground truth label.
	InferenceAttribute *string `json:"inferenceAttribute"`
	// In a classification problem, the attribute that represents the class probability.
	ProbabilityAttribute *string `json:"probabilityAttribute"`
	// The threshold for the class probability to be evaluated as a positive result.
	ProbabilityThresholdAttribute *float64 `json:"probabilityThresholdAttribute"`
	// Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key.
	//
	// Defaults to `FullyReplicated`
	S3DataDistributionType *string `json:"s3DataDistributionType"`
	// Whether the `Pipe` or `File` is used as the input mode for transferring data for the monitoring job.
	//
	// `Pipe` mode is recommended for large datasets. `File` mode is useful for small files that fit in memory. Defaults to `File` .
	S3InputMode *string `json:"s3InputMode"`
	// If specified, monitoring jobs substract this time from the start time.
	//
	// For information about using offsets for scheduling monitoring jobs, see [Schedule Model Quality Monitoring Jobs](https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-model-quality-schedule.html) .
	StartTimeOffset *string `json:"startTimeOffset"`
}

Input object for the endpoint.

TODO: EXAMPLE

type CfnModelQualityJobDefinition_ModelQualityAppSpecificationProperty

type CfnModelQualityJobDefinition_ModelQualityAppSpecificationProperty struct {
	// The address of the container image that the monitoring job runs.
	ImageUri *string `json:"imageUri"`
	// The machine learning problem type of the model that the monitoring job monitors.
	ProblemType *string `json:"problemType"`
	// An array of arguments for the container used to run the monitoring job.
	ContainerArguments *[]*string `json:"containerArguments"`
	// Specifies the entrypoint for a container that the monitoring job runs.
	ContainerEntrypoint *[]*string `json:"containerEntrypoint"`
	// Sets the environment variables in the container that the monitoring job runs.
	Environment interface{} `json:"environment"`
	// An Amazon S3 URI to a script that is called after analysis has been performed.
	//
	// Applicable only for the built-in (first party) containers.
	PostAnalyticsProcessorSourceUri *string `json:"postAnalyticsProcessorSourceUri"`
	// An Amazon S3 URI to a script that is called per row prior to running analysis.
	//
	// It can base64 decode the payload and convert it into a flatted json so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.
	RecordPreprocessorSourceUri *string `json:"recordPreprocessorSourceUri"`
}

Container image configuration object for the monitoring job.

TODO: EXAMPLE

type CfnModelQualityJobDefinition_ModelQualityBaselineConfigProperty

type CfnModelQualityJobDefinition_ModelQualityBaselineConfigProperty struct {
	// The name of the job that performs baselining for the monitoring job.
	BaseliningJobName *string `json:"baseliningJobName"`
	// `CfnModelQualityJobDefinition.ModelQualityBaselineConfigProperty.ConstraintsResource`.
	ConstraintsResource interface{} `json:"constraintsResource"`
}

Configuration for monitoring constraints and monitoring statistics.

These baseline resources are compared against the results of the current job from the series of jobs scheduled to collect data periodically.

TODO: EXAMPLE

type CfnModelQualityJobDefinition_ModelQualityJobInputProperty

type CfnModelQualityJobDefinition_ModelQualityJobInputProperty struct {
	// Input object for the endpoint.
	EndpointInput interface{} `json:"endpointInput"`
	// The ground truth label provided for the model.
	GroundTruthS3Input interface{} `json:"groundTruthS3Input"`
}

The input for the model quality monitoring job.

Currently endponts are supported for input for model quality monitoring jobs.

TODO: EXAMPLE

type CfnModelQualityJobDefinition_MonitoringGroundTruthS3InputProperty

type CfnModelQualityJobDefinition_MonitoringGroundTruthS3InputProperty struct {
	// The address of the Amazon S3 location of the ground truth labels.
	S3Uri *string `json:"s3Uri"`
}

The ground truth labels for the dataset used for the monitoring job.

TODO: EXAMPLE

type CfnModelQualityJobDefinition_MonitoringOutputConfigProperty

type CfnModelQualityJobDefinition_MonitoringOutputConfigProperty struct {
	// Monitoring outputs for monitoring jobs.
	//
	// This is where the output of the periodic monitoring jobs is uploaded.
	MonitoringOutputs interface{} `json:"monitoringOutputs"`
	// The AWS Key Management Service ( AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.
	KmsKeyId *string `json:"kmsKeyId"`
}

The output configuration for monitoring jobs.

TODO: EXAMPLE

type CfnModelQualityJobDefinition_MonitoringOutputProperty

type CfnModelQualityJobDefinition_MonitoringOutputProperty struct {
	// The Amazon S3 storage location where the results of a monitoring job are saved.
	S3Output interface{} `json:"s3Output"`
}

The output object for a monitoring job.

TODO: EXAMPLE

type CfnModelQualityJobDefinition_MonitoringResourcesProperty

type CfnModelQualityJobDefinition_MonitoringResourcesProperty struct {
	// The configuration for the cluster resources used to run the processing job.
	ClusterConfig interface{} `json:"clusterConfig"`
}

Identifies the resources to deploy for a monitoring job.

TODO: EXAMPLE

type CfnModelQualityJobDefinition_NetworkConfigProperty

type CfnModelQualityJobDefinition_NetworkConfigProperty struct {
	// Whether to encrypt all communications between distributed processing jobs.
	//
	// Choose `True` to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer.
	EnableInterContainerTrafficEncryption interface{} `json:"enableInterContainerTrafficEncryption"`
	// Whether to allow inbound and outbound network calls to and from the containers used for the processing job.
	EnableNetworkIsolation interface{} `json:"enableNetworkIsolation"`
	// Specifies a VPC that your training jobs and hosted models have access to.
	//
	// Control access to and from your training and model containers by configuring the VPC.
	VpcConfig interface{} `json:"vpcConfig"`
}

Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.

TODO: EXAMPLE

type CfnModelQualityJobDefinition_S3OutputProperty

type CfnModelQualityJobDefinition_S3OutputProperty struct {
	// The local path to the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job.
	//
	// LocalPath is an absolute path for the output data.
	LocalPath *string `json:"localPath"`
	// A URI that identifies the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job.
	S3Uri *string `json:"s3Uri"`
	// Whether to upload the results of the monitoring job continuously or after the job completes.
	S3UploadMode *string `json:"s3UploadMode"`
}

The Amazon S3 storage location where the results of a monitoring job are saved.

TODO: EXAMPLE

type CfnModelQualityJobDefinition_StoppingConditionProperty

type CfnModelQualityJobDefinition_StoppingConditionProperty struct {
	// The maximum length of time, in seconds, that a training or compilation job can run.
	//
	// For compilation jobs, if the job does not complete during this time, you will receive a `TimeOut` error. We recommend starting with 900 seconds and increase as necessary based on your model.
	//
	// For all other jobs, if the job does not complete during this time, Amazon SageMaker ends the job. When `RetryStrategy` is specified in the job request, `MaxRuntimeInSeconds` specifies the maximum time for all of the attempts in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.
	MaxRuntimeInSeconds *float64 `json:"maxRuntimeInSeconds"`
}

Specifies a limit to how long a model training job or model compilation job can run.

It also specifies how long a managed spot training job has to complete. When the job reaches the time limit, Amazon SageMaker ends the training or compilation job. Use this API to cap model training costs.

To stop a training job, Amazon SageMaker sends the algorithm the `SIGTERM` signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

The training algorithms provided by Amazon SageMaker automatically save the intermediate results of a model training job when possible. This attempt to save artifacts is only a best effort case as model might not be in a state from which it can be saved. For example, if training has just started, the model might not be ready to save. When saved, this intermediate data is a valid model artifact. You can use it to create a model with `CreateModel` .

> The Neural Topic Model (NTM) currently does not support saving intermediate model artifacts. When training NTMs, make sure that the maximum runtime is sufficient for the training job to complete.

TODO: EXAMPLE

type CfnModelQualityJobDefinition_VpcConfigProperty

type CfnModelQualityJobDefinition_VpcConfigProperty struct {
	// The VPC security group IDs, in the form sg-xxxxxxxx.
	//
	// Specify the security groups for the VPC that is specified in the `Subnets` field.
	SecurityGroupIds *[]*string `json:"securityGroupIds"`
	// The ID of the subnets in the VPC to which you want to connect your training job or model.
	//
	// For information about the availability of specific instance types, see [Supported Instance Types and Availability Zones](https://docs.aws.amazon.com/sagemaker/latest/dg/instance-types-az.html) .
	Subnets *[]*string `json:"subnets"`
}

Specifies a VPC that your training jobs and hosted models have access to.

Control access to and from your training and model containers by configuring the VPC. For more information, see [Protect Endpoints by Using an Amazon Virtual Private Cloud](https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html) and [Protect Training Jobs by Using an Amazon Virtual Private Cloud](https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html) .

TODO: EXAMPLE

type CfnModel_ContainerDefinitionProperty

type CfnModel_ContainerDefinitionProperty struct {
	// This parameter is ignored for models that contain only a `PrimaryContainer` .
	//
	// When a `ContainerDefinition` is part of an inference pipeline, the value of the parameter uniquely identifies the container for the purposes of logging and metrics. For information, see [Use Logs and Metrics to Monitor an Inference Pipeline](https://docs.aws.amazon.com/sagemaker/latest/dg/inference-pipeline-logs-metrics.html) . If you don't specify a value for this parameter for a `ContainerDefinition` that is part of an inference pipeline, a unique name is automatically assigned based on the position of the `ContainerDefinition` in the pipeline. If you specify a value for the `ContainerHostName` for any `ContainerDefinition` that is part of an inference pipeline, you must specify a value for the `ContainerHostName` parameter of every `ContainerDefinition` in that pipeline.
	ContainerHostname *string `json:"containerHostname"`
	// The environment variables to set in the Docker container.
	//
	// Each key and value in the `Environment` string to string map can have length of up to 1024. We support up to 16 entries in the map.
	Environment interface{} `json:"environment"`
	// The path where inference code is stored.
	//
	// This can be either in Amazon EC2 Container Registry or in a Docker registry that is accessible from the same VPC that you configure for your endpoint. If you are using your own custom algorithm instead of an algorithm provided by Amazon SageMaker, the inference code must meet Amazon SageMaker requirements. Amazon SageMaker supports both `registry/repository[:tag]` and `registry/repository[@digest]` image path formats. For more information, see [Using Your Own Algorithms with Amazon SageMaker](https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html)
	Image *string `json:"image"`
	// Specifies whether the model container is in Amazon ECR or a private Docker registry accessible from your Amazon Virtual Private Cloud (VPC).
	//
	// For information about storing containers in a private Docker registry, see [Use a Private Docker Registry for Real-Time Inference Containers](https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-containers-inference-private.html)
	ImageConfig interface{} `json:"imageConfig"`
	// The inference specification name in the model package version.
	InferenceSpecificationName *string `json:"inferenceSpecificationName"`
	// Whether the container hosts a single model or multiple models.
	Mode *string `json:"mode"`
	// The S3 path where the model artifacts, which result from model training, are stored.
	//
	// This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3 path is required for Amazon SageMaker built-in algorithms, but not if you use your own algorithms. For more information on built-in algorithms, see [Common Parameters](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html) .
	//
	// > The model artifacts must be in an S3 bucket that is in the same region as the model or endpoint you are creating.
	//
	// If you provide a value for this parameter, Amazon SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provide. AWS STS is activated in your IAM user account by default. If you previously deactivated AWS STS for a region, you need to reactivate AWS STS for that region. For more information, see [Activating and Deactivating AWS STS in an AWS Region](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) in the *AWS Identity and Access Management User Guide* .
	//
	// > If you use a built-in algorithm to create a model, Amazon SageMaker requires that you provide a S3 path to the model artifacts in `ModelDataUrl` .
	ModelDataUrl *string `json:"modelDataUrl"`
	// The name or Amazon Resource Name (ARN) of the model package to use to create the model.
	ModelPackageName *string `json:"modelPackageName"`
	// `CfnModel.ContainerDefinitionProperty.MultiModelConfig`.
	MultiModelConfig interface{} `json:"multiModelConfig"`
}

Describes the container, as part of model definition.

TODO: EXAMPLE

type CfnModel_ImageConfigProperty

type CfnModel_ImageConfigProperty struct {
	// Set this to one of the following values:.
	//
	// - `Platform` - The model image is hosted in Amazon ECR.
	// - `Vpc` - The model image is hosted in a private Docker registry in your VPC.
	RepositoryAccessMode *string `json:"repositoryAccessMode"`
	// (Optional) Specifies an authentication configuration for the private docker registry where your model image is hosted.
	//
	// Specify a value for this property only if you specified `Vpc` as the value for the `RepositoryAccessMode` field, and the private Docker registry where the model image is hosted requires authentication.
	RepositoryAuthConfig interface{} `json:"repositoryAuthConfig"`
}

Specifies whether the model container is in Amazon ECR or a private Docker registry accessible from your Amazon Virtual Private Cloud (VPC).

TODO: EXAMPLE

type CfnModel_InferenceExecutionConfigProperty

type CfnModel_InferenceExecutionConfigProperty struct {
	// How containers in a multi-container are run. The following values are valid.
	//
	// - `Serial` - Containers run as a serial pipeline.
	// - `Direct` - Only the individual container that you specify is run.
	Mode *string `json:"mode"`
}

TODO: EXAMPLE

type CfnModel_MultiModelConfigProperty

type CfnModel_MultiModelConfigProperty struct {
	// Whether to cache models for a multi-model endpoint.
	//
	// By default, multi-model endpoints cache models so that a model does not have to be loaded into memory each time it is invoked. Some use cases do not benefit from model caching. For example, if an endpoint hosts a large number of models that are each invoked infrequently, the endpoint might perform better if you disable model caching. To disable model caching, set the value of this parameter to Disabled.
	ModelCacheSetting *string `json:"modelCacheSetting"`
}

Specifies additional configuration for hosting multi-model endpoints.

TODO: EXAMPLE

type CfnModel_RepositoryAuthConfigProperty

type CfnModel_RepositoryAuthConfigProperty struct {
	// The Amazon Resource Name (ARN) of an AWS Lambda function that provides credentials to authenticate to the private Docker registry where your model image is hosted.
	//
	// For information about how to create an AWS Lambda function, see [Create a Lambda function with the console](https://docs.aws.amazon.com/lambda/latest/dg/getting-started-create-function.html) in the *AWS Lambda Developer Guide* .
	RepositoryCredentialsProviderArn *string `json:"repositoryCredentialsProviderArn"`
}

Specifies an authentication configuration for the private docker registry where your model image is hosted.

Specify a value for this property only if you specified `Vpc` as the value for the `RepositoryAccessMode` field of the `ImageConfig` object that you passed to a call to `CreateModel` and the private Docker registry where the model image is hosted requires authentication.

TODO: EXAMPLE

type CfnModel_VpcConfigProperty

type CfnModel_VpcConfigProperty struct {
	// The VPC security group IDs, in the form sg-xxxxxxxx.
	//
	// Specify the security groups for the VPC that is specified in the `Subnets` field.
	SecurityGroupIds *[]*string `json:"securityGroupIds"`
	// The ID of the subnets in the VPC to which you want to connect your training job or model.
	//
	// For information about the availability of specific instance types, see [Supported Instance Types and Availability Zones](https://docs.aws.amazon.com/sagemaker/latest/dg/instance-types-az.html) .
	Subnets *[]*string `json:"subnets"`
}

Specifies a VPC that your training jobs and hosted models have access to.

Control access to and from your training and model containers by configuring the VPC. For more information, see [Protect Endpoints by Using an Amazon Virtual Private Cloud](https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html) and [Protect Training Jobs by Using an Amazon Virtual Private Cloud](https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html) .

TODO: EXAMPLE

type CfnMonitoringSchedule

type CfnMonitoringSchedule interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrCreationTime() *string
	AttrLastModifiedTime() *string
	AttrMonitoringScheduleArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	EndpointName() *string
	SetEndpointName(val *string)
	FailureReason() *string
	SetFailureReason(val *string)
	LastMonitoringExecutionSummary() interface{}
	SetLastMonitoringExecutionSummary(val interface{})
	LogicalId() *string
	MonitoringScheduleConfig() interface{}
	SetMonitoringScheduleConfig(val interface{})
	MonitoringScheduleName() *string
	SetMonitoringScheduleName(val *string)
	MonitoringScheduleStatus() *string
	SetMonitoringScheduleStatus(val *string)
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::SageMaker::MonitoringSchedule`.

The `AWS::SageMaker::MonitoringSchedule` resource is an Amazon SageMaker resource type that regularly starts SageMaker processing Jobs to monitor the data captured for a SageMaker endpoint.

TODO: EXAMPLE

func NewCfnMonitoringSchedule

func NewCfnMonitoringSchedule(scope constructs.Construct, id *string, props *CfnMonitoringScheduleProps) CfnMonitoringSchedule

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

type CfnMonitoringScheduleProps

type CfnMonitoringScheduleProps struct {
	// The configuration object that specifies the monitoring schedule and defines the monitoring job.
	MonitoringScheduleConfig interface{} `json:"monitoringScheduleConfig"`
	// The name of the monitoring schedule.
	MonitoringScheduleName *string `json:"monitoringScheduleName"`
	// The name of the endpoint using the monitoring schedule.
	EndpointName *string `json:"endpointName"`
	// Contains the reason a monitoring job failed, if it failed.
	FailureReason *string `json:"failureReason"`
	// Describes metadata on the last execution to run, if there was one.
	LastMonitoringExecutionSummary interface{} `json:"lastMonitoringExecutionSummary"`
	// The status of the monitoring schedule.
	MonitoringScheduleStatus *string `json:"monitoringScheduleStatus"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `CfnMonitoringSchedule`.

TODO: EXAMPLE

type CfnMonitoringSchedule_BaselineConfigProperty

type CfnMonitoringSchedule_BaselineConfigProperty struct {
	// The Amazon S3 URI for the constraints resource.
	ConstraintsResource interface{} `json:"constraintsResource"`
	// The baseline statistics file in Amazon S3 that the current monitoring job should be validated against.
	StatisticsResource interface{} `json:"statisticsResource"`
}

Baseline configuration used to validate that the data conforms to the specified constraints and statistics.

TODO: EXAMPLE

type CfnMonitoringSchedule_ClusterConfigProperty

type CfnMonitoringSchedule_ClusterConfigProperty struct {
	// The number of ML compute instances to use in the model monitoring job.
	//
	// For distributed processing jobs, specify a value greater than 1. The default value is 1.
	InstanceCount *float64 `json:"instanceCount"`
	// The ML compute instance type for the processing job.
	InstanceType *string `json:"instanceType"`
	// The size of the ML storage volume, in gigabytes, that you want to provision.
	//
	// You must specify sufficient ML storage for your scenario.
	VolumeSizeInGb *float64 `json:"volumeSizeInGb"`
	// The AWS Key Management Service ( AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the model monitoring job.
	VolumeKmsKeyId *string `json:"volumeKmsKeyId"`
}

Configuration for the cluster used to run model monitoring jobs.

TODO: EXAMPLE

type CfnMonitoringSchedule_ConstraintsResourceProperty

type CfnMonitoringSchedule_ConstraintsResourceProperty struct {
	// The Amazon S3 URI for the constraints resource.
	S3Uri *string `json:"s3Uri"`
}

The Amazon S3 URI for the constraints resource.

TODO: EXAMPLE

type CfnMonitoringSchedule_EndpointInputProperty

type CfnMonitoringSchedule_EndpointInputProperty struct {
	// An endpoint in customer's account which has enabled `DataCaptureConfig` enabled.
	EndpointName *string `json:"endpointName"`
	// Path to the filesystem where the endpoint data is available to the container.
	LocalPath *string `json:"localPath"`
	// Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key.
	//
	// Defaults to `FullyReplicated`
	S3DataDistributionType *string `json:"s3DataDistributionType"`
	// Whether the `Pipe` or `File` is used as the input mode for transferring data for the monitoring job.
	//
	// `Pipe` mode is recommended for large datasets. `File` mode is useful for small files that fit in memory. Defaults to `File` .
	S3InputMode *string `json:"s3InputMode"`
}

Input object for the endpoint.

TODO: EXAMPLE

type CfnMonitoringSchedule_MonitoringAppSpecificationProperty

type CfnMonitoringSchedule_MonitoringAppSpecificationProperty struct {
	// The container image to be run by the monitoring job.
	ImageUri *string `json:"imageUri"`
	// An array of arguments for the container used to run the monitoring job.
	ContainerArguments *[]*string `json:"containerArguments"`
	// Specifies the entrypoint for a container used to run the monitoring job.
	ContainerEntrypoint *[]*string `json:"containerEntrypoint"`
	// An Amazon S3 URI to a script that is called after analysis has been performed.
	//
	// Applicable only for the built-in (first party) containers.
	PostAnalyticsProcessorSourceUri *string `json:"postAnalyticsProcessorSourceUri"`
	// An Amazon S3 URI to a script that is called per row prior to running analysis.
	//
	// It can base64 decode the payload and convert it into a flatted json so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.
	RecordPreprocessorSourceUri *string `json:"recordPreprocessorSourceUri"`
}

Container image configuration object for the monitoring job.

TODO: EXAMPLE

type CfnMonitoringSchedule_MonitoringExecutionSummaryProperty

type CfnMonitoringSchedule_MonitoringExecutionSummaryProperty struct {
	// The time at which the monitoring job was created.
	CreationTime *string `json:"creationTime"`
	// A timestamp that indicates the last time the monitoring job was modified.
	LastModifiedTime *string `json:"lastModifiedTime"`
	// The status of the monitoring job.
	MonitoringExecutionStatus *string `json:"monitoringExecutionStatus"`
	// The name of the monitoring schedule.
	MonitoringScheduleName *string `json:"monitoringScheduleName"`
	// The time the monitoring job was scheduled.
	ScheduledTime *string `json:"scheduledTime"`
	// The name of the endpoint used to run the monitoring job.
	EndpointName *string `json:"endpointName"`
	// Contains the reason a monitoring job failed, if it failed.
	FailureReason *string `json:"failureReason"`
	// The Amazon Resource Name (ARN) of the monitoring job.
	ProcessingJobArn *string `json:"processingJobArn"`
}

Summary of information about the last monitoring job to run.

TODO: EXAMPLE

type CfnMonitoringSchedule_MonitoringInputProperty

type CfnMonitoringSchedule_MonitoringInputProperty struct {
	// The endpoint for a monitoring job.
	EndpointInput interface{} `json:"endpointInput"`
}

The inputs for a monitoring job.

TODO: EXAMPLE

type CfnMonitoringSchedule_MonitoringJobDefinitionProperty

type CfnMonitoringSchedule_MonitoringJobDefinitionProperty struct {
	// Configures the monitoring job to run a specified Docker container image.
	MonitoringAppSpecification interface{} `json:"monitoringAppSpecification"`
	// The array of inputs for the monitoring job.
	//
	// Currently we support monitoring an Amazon SageMaker Endpoint.
	MonitoringInputs interface{} `json:"monitoringInputs"`
	// The array of outputs from the monitoring job to be uploaded to Amazon Simple Storage Service (Amazon S3).
	MonitoringOutputConfig interface{} `json:"monitoringOutputConfig"`
	// Identifies the resources, ML compute instances, and ML storage volumes to deploy for a monitoring job.
	//
	// In distributed processing, you specify more than one instance.
	MonitoringResources interface{} `json:"monitoringResources"`
	// The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
	RoleArn *string `json:"roleArn"`
	// Baseline configuration used to validate that the data conforms to the specified constraints and statistics.
	BaselineConfig interface{} `json:"baselineConfig"`
	// Sets the environment variables in the Docker container.
	Environment interface{} `json:"environment"`
	// Specifies networking options for an monitoring job.
	NetworkConfig interface{} `json:"networkConfig"`
	// Specifies a time limit for how long the monitoring job is allowed to run.
	StoppingCondition interface{} `json:"stoppingCondition"`
}

Defines the monitoring job.

TODO: EXAMPLE

type CfnMonitoringSchedule_MonitoringOutputConfigProperty

type CfnMonitoringSchedule_MonitoringOutputConfigProperty struct {
	// Monitoring outputs for monitoring jobs.
	//
	// This is where the output of the periodic monitoring jobs is uploaded.
	MonitoringOutputs interface{} `json:"monitoringOutputs"`
	// The AWS Key Management Service ( AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.
	KmsKeyId *string `json:"kmsKeyId"`
}

The output configuration for monitoring jobs.

TODO: EXAMPLE

type CfnMonitoringSchedule_MonitoringOutputProperty

type CfnMonitoringSchedule_MonitoringOutputProperty struct {
	// The Amazon S3 storage location where the results of a monitoring job are saved.
	S3Output interface{} `json:"s3Output"`
}

The output object for a monitoring job.

TODO: EXAMPLE

type CfnMonitoringSchedule_MonitoringResourcesProperty

type CfnMonitoringSchedule_MonitoringResourcesProperty struct {
	// The configuration for the cluster resources used to run the processing job.
	ClusterConfig interface{} `json:"clusterConfig"`
}

Identifies the resources to deploy for a monitoring job.

TODO: EXAMPLE

type CfnMonitoringSchedule_MonitoringScheduleConfigProperty

type CfnMonitoringSchedule_MonitoringScheduleConfigProperty struct {
	// Defines the monitoring job.
	MonitoringJobDefinition interface{} `json:"monitoringJobDefinition"`
	// The name of the monitoring job definition to schedule.
	MonitoringJobDefinitionName *string `json:"monitoringJobDefinitionName"`
	// The type of the monitoring job definition to schedule.
	MonitoringType *string `json:"monitoringType"`
	// Configures the monitoring schedule.
	ScheduleConfig interface{} `json:"scheduleConfig"`
}

Configures the monitoring schedule and defines the monitoring job.

TODO: EXAMPLE

type CfnMonitoringSchedule_NetworkConfigProperty

type CfnMonitoringSchedule_NetworkConfigProperty struct {
	// Whether to encrypt all communications between distributed processing jobs.
	//
	// Choose `True` to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer.
	EnableInterContainerTrafficEncryption interface{} `json:"enableInterContainerTrafficEncryption"`
	// Whether to allow inbound and outbound network calls to and from the containers used for the processing job.
	EnableNetworkIsolation interface{} `json:"enableNetworkIsolation"`
	// Specifies a VPC that your training jobs and hosted models have access to.
	//
	// Control access to and from your training and model containers by configuring the VPC. For more information, see [Protect Endpoints by Using an Amazon Virtual Private Cloud](https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html) and [Protect Training Jobs by Using an Amazon Virtual Private Cloud](https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html) .
	VpcConfig interface{} `json:"vpcConfig"`
}

Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.

TODO: EXAMPLE

type CfnMonitoringSchedule_S3OutputProperty

type CfnMonitoringSchedule_S3OutputProperty struct {
	// The local path to the S3 storage location where SageMaker saves the results of a monitoring job.
	//
	// LocalPath is an absolute path for the output data.
	LocalPath *string `json:"localPath"`
	// A URI that identifies the S3 storage location where SageMaker saves the results of a monitoring job.
	S3Uri *string `json:"s3Uri"`
	// Whether to upload the results of the monitoring job continuously or after the job completes.
	S3UploadMode *string `json:"s3UploadMode"`
}

Information about where and how you want to store the results of a monitoring job.

TODO: EXAMPLE

type CfnMonitoringSchedule_ScheduleConfigProperty

type CfnMonitoringSchedule_ScheduleConfigProperty struct {
	// A cron expression that describes details about the monitoring schedule.
	//
	// Currently the only supported cron expressions are:
	//
	// - If you want to set the job to start every hour, please use the following:
	//
	// `Hourly: cron(0 * ? * * *)`
	// - If you want to start the job daily:
	//
	// `cron(0 [00-23] ? * * *)`
	//
	// For example, the following are valid cron expressions:
	//
	// - Daily at noon UTC: `cron(0 12 ? * * *)`
	// - Daily at midnight UTC: `cron(0 0 ? * * *)`
	//
	// To support running every 6, 12 hours, the following are also supported:
	//
	// `cron(0 [00-23]/[01-24] ? * * *)`
	//
	// For example, the following are valid cron expressions:
	//
	// - Every 12 hours, starting at 5pm UTC: `cron(0 17/12 ? * * *)`
	// - Every two hours starting at midnight: `cron(0 0/2 ? * * *)`
	//
	// > - Even though the cron expression is set to start at 5PM UTC, note that there could be a delay of 0-20 minutes from the actual requested time to run the execution.
	// > - We recommend that if you would like a daily schedule, you do not provide this parameter. Amazon SageMaker will pick a time for running every day.
	ScheduleExpression *string `json:"scheduleExpression"`
}

Configuration details about the monitoring schedule.

TODO: EXAMPLE

type CfnMonitoringSchedule_StatisticsResourceProperty

type CfnMonitoringSchedule_StatisticsResourceProperty struct {
	// The S3 URI for the statistics resource.
	S3Uri *string `json:"s3Uri"`
}

The baseline statistics file in Amazon S3 that the current monitoring job should be validated against.

TODO: EXAMPLE

type CfnMonitoringSchedule_StoppingConditionProperty

type CfnMonitoringSchedule_StoppingConditionProperty struct {
	// The maximum length of time, in seconds, that a training or compilation job can run.
	//
	// For compilation jobs, if the job does not complete during this time, you will receive a `TimeOut` error. We recommend starting with 900 seconds and increase as necessary based on your model.
	//
	// For all other jobs, if the job does not complete during this time, Amazon SageMaker ends the job. When `RetryStrategy` is specified in the job request, `MaxRuntimeInSeconds` specifies the maximum time for all of the attempts in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.
	MaxRuntimeInSeconds *float64 `json:"maxRuntimeInSeconds"`
}

Specifies a limit to how long a model training job or model compilation job can run.

It also specifies how long a managed spot training job has to complete. When the job reaches the time limit, Amazon SageMaker ends the training or compilation job. Use this API to cap model training costs.

To stop a training job, Amazon SageMaker sends the algorithm the `SIGTERM` signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

The training algorithms provided by Amazon SageMaker automatically save the intermediate results of a model training job when possible. This attempt to save artifacts is only a best effort case as model might not be in a state from which it can be saved. For example, if training has just started, the model might not be ready to save. When saved, this intermediate data is a valid model artifact. You can use it to create a model with `CreateModel` .

> The Neural Topic Model (NTM) currently does not support saving intermediate model artifacts. When training NTMs, make sure that the maximum runtime is sufficient for the training job to complete.

TODO: EXAMPLE

type CfnMonitoringSchedule_VpcConfigProperty

type CfnMonitoringSchedule_VpcConfigProperty struct {
	// The VPC security group IDs, in the form sg-xxxxxxxx.
	//
	// Specify the security groups for the VPC that is specified in the `Subnets` field.
	SecurityGroupIds *[]*string `json:"securityGroupIds"`
	// The ID of the subnets in the VPC to which you want to connect your training job or model.
	//
	// For information about the availability of specific instance types, see [Supported Instance Types and Availability Zones](https://docs.aws.amazon.com/sagemaker/latest/dg/instance-types-az.html) .
	Subnets *[]*string `json:"subnets"`
}

Specifies a VPC that your training jobs and hosted models have access to.

Control access to and from your training and model containers by configuring the VPC. For more information, see [Protect Endpoints by Using an Amazon Virtual Private Cloud](https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html) and [Protect Training Jobs by Using an Amazon Virtual Private Cloud](https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html) .

TODO: EXAMPLE

type CfnNotebookInstance

type CfnNotebookInstance interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AcceleratorTypes() *[]*string
	SetAcceleratorTypes(val *[]*string)
	AdditionalCodeRepositories() *[]*string
	SetAdditionalCodeRepositories(val *[]*string)
	AttrNotebookInstanceName() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DefaultCodeRepository() *string
	SetDefaultCodeRepository(val *string)
	DirectInternetAccess() *string
	SetDirectInternetAccess(val *string)
	InstanceType() *string
	SetInstanceType(val *string)
	KmsKeyId() *string
	SetKmsKeyId(val *string)
	LifecycleConfigName() *string
	SetLifecycleConfigName(val *string)
	LogicalId() *string
	Node() constructs.Node
	NotebookInstanceName() *string
	SetNotebookInstanceName(val *string)
	PlatformIdentifier() *string
	SetPlatformIdentifier(val *string)
	Ref() *string
	RoleArn() *string
	SetRoleArn(val *string)
	RootAccess() *string
	SetRootAccess(val *string)
	SecurityGroupIds() *[]*string
	SetSecurityGroupIds(val *[]*string)
	Stack() awscdk.Stack
	SubnetId() *string
	SetSubnetId(val *string)
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	VolumeSizeInGb() *float64
	SetVolumeSizeInGb(val *float64)
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::SageMaker::NotebookInstance`.

The `AWS::SageMaker::NotebookInstance` resource creates an Amazon SageMaker notebook instance. A notebook instance is a machine learning (ML) compute instance running on a Jupyter notebook. For more information, see [Use Notebook Instances](https://docs.aws.amazon.com/sagemaker/latest/dg/nbi.html) .

TODO: EXAMPLE

func NewCfnNotebookInstance

func NewCfnNotebookInstance(scope constructs.Construct, id *string, props *CfnNotebookInstanceProps) CfnNotebookInstance

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

type CfnNotebookInstanceLifecycleConfig

type CfnNotebookInstanceLifecycleConfig interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrNotebookInstanceLifecycleConfigName() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Node() constructs.Node
	NotebookInstanceLifecycleConfigName() *string
	SetNotebookInstanceLifecycleConfigName(val *string)
	OnCreate() interface{}
	SetOnCreate(val interface{})
	OnStart() interface{}
	SetOnStart(val interface{})
	Ref() *string
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::SageMaker::NotebookInstanceLifecycleConfig`.

The `AWS::SageMaker::NotebookInstanceLifecycleConfig` resource creates shell scripts that run when you create and/or start a notebook instance. For information about notebook instance lifecycle configurations, see [Customize a Notebook Instance](https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html) in the *Amazon SageMaker Developer Guide* .

TODO: EXAMPLE

func NewCfnNotebookInstanceLifecycleConfig

func NewCfnNotebookInstanceLifecycleConfig(scope constructs.Construct, id *string, props *CfnNotebookInstanceLifecycleConfigProps) CfnNotebookInstanceLifecycleConfig

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

type CfnNotebookInstanceLifecycleConfigProps

type CfnNotebookInstanceLifecycleConfigProps struct {
	// The name of the lifecycle configuration.
	NotebookInstanceLifecycleConfigName *string `json:"notebookInstanceLifecycleConfigName"`
	// A shell script that runs only once, when you create a notebook instance.
	//
	// The shell script must be a base64-encoded string.
	OnCreate interface{} `json:"onCreate"`
	// A shell script that runs every time you start a notebook instance, including when you create the notebook instance.
	//
	// The shell script must be a base64-encoded string.
	OnStart interface{} `json:"onStart"`
}

Properties for defining a `CfnNotebookInstanceLifecycleConfig`.

TODO: EXAMPLE

type CfnNotebookInstanceLifecycleConfig_NotebookInstanceLifecycleHookProperty

type CfnNotebookInstanceLifecycleConfig_NotebookInstanceLifecycleHookProperty struct {
	// A base64-encoded string that contains a shell script for a notebook instance lifecycle configuration.
	Content *string `json:"content"`
}

Specifies the notebook instance lifecycle configuration script.

Each lifecycle configuration script has a limit of 16384 characters.

TODO: EXAMPLE

type CfnNotebookInstanceProps

type CfnNotebookInstanceProps struct {
	// The type of ML compute instance to launch for the notebook instance.
	//
	// > Expect some interruption of service if this parameter is changed as CloudFormation stops a notebook instance and starts it up again to update it.
	InstanceType *string `json:"instanceType"`
	// When you send any requests to AWS resources from the notebook instance, Amazon SageMaker assumes this role to perform tasks on your behalf.
	//
	// You must grant this role necessary permissions so Amazon SageMaker can perform these tasks. The policy must allow the Amazon SageMaker service principal (sagemaker.amazonaws.com) permissions to assume this role. For more information, see [Amazon SageMaker Roles](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html) .
	//
	// > To be able to pass this role to Amazon SageMaker, the caller of this API must have the `iam:PassRole` permission.
	RoleArn *string `json:"roleArn"`
	// A list of Amazon Elastic Inference (EI) instance types to associate with the notebook instance.
	//
	// Currently, only one instance type can be associated with a notebook instance. For more information, see [Using Elastic Inference in Amazon SageMaker](https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html) .
	//
	// *Valid Values:* `ml.eia1.medium | ml.eia1.large | ml.eia1.xlarge | ml.eia2.medium | ml.eia2.large | ml.eia2.xlarge` .
	AcceleratorTypes *[]*string `json:"acceleratorTypes"`
	// An array of up to three Git repositories associated with the notebook instance.
	//
	// These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in [AWS CodeCommit](https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see [Associating Git Repositories with Amazon SageMaker Notebook Instances](https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html) .
	AdditionalCodeRepositories *[]*string `json:"additionalCodeRepositories"`
	// The Git repository associated with the notebook instance as its default code repository.
	//
	// This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in [AWS CodeCommit](https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see [Associating Git Repositories with Amazon SageMaker Notebook Instances](https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html) .
	DefaultCodeRepository *string `json:"defaultCodeRepository"`
	// Sets whether Amazon SageMaker provides internet access to the notebook instance.
	//
	// If you set this to `Disabled` this notebook instance is able to access resources only in your VPC, and is not be able to connect to Amazon SageMaker training and endpoint services unless you configure a NAT Gateway in your VPC.
	//
	// For more information, see [Notebook Instances Are Internet-Enabled by Default](https://docs.aws.amazon.com/sagemaker/latest/dg/appendix-additional-considerations.html#appendix-notebook-and-internet-access) . You can set the value of this parameter to `Disabled` only if you set a value for the `SubnetId` parameter.
	DirectInternetAccess *string `json:"directInternetAccess"`
	// The Amazon Resource Name (ARN) of a AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to your notebook instance.
	//
	// The KMS key you provide must be enabled. For information, see [Enabling and Disabling Keys](https://docs.aws.amazon.com/kms/latest/developerguide/enabling-keys.html) in the *AWS Key Management Service Developer Guide* .
	KmsKeyId *string `json:"kmsKeyId"`
	// The name of a lifecycle configuration to associate with the notebook instance.
	//
	// For information about lifecycle configurations, see [Customize a Notebook Instance](https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html) in the *Amazon SageMaker Developer Guide* .
	LifecycleConfigName *string `json:"lifecycleConfigName"`
	// The name of the new notebook instance.
	NotebookInstanceName *string `json:"notebookInstanceName"`
	// The platform identifier of the notebook instance runtime environment.
	PlatformIdentifier *string `json:"platformIdentifier"`
	// Whether root access is enabled or disabled for users of the notebook instance. The default value is `Enabled` .
	//
	// > Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.
	RootAccess *string `json:"rootAccess"`
	// The VPC security group IDs, in the form sg-xxxxxxxx.
	//
	// The security groups must be for the same VPC as specified in the subnet.
	SecurityGroupIds *[]*string `json:"securityGroupIds"`
	// The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.
	SubnetId *string `json:"subnetId"`
	// A list of key-value pairs to apply to this resource.
	//
	// For more information, see [Resource Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) and [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what) .
	//
	// You can add tags later by using the `CreateTags` API.
	Tags *[]*awscdk.CfnTag `json:"tags"`
	// The size, in GB, of the ML storage volume to attach to the notebook instance.
	//
	// The default value is 5 GB.
	//
	// > Expect some interruption of service if this parameter is changed as CloudFormation stops a notebook instance and starts it up again to update it.
	VolumeSizeInGb *float64 `json:"volumeSizeInGb"`
}

Properties for defining a `CfnNotebookInstance`.

TODO: EXAMPLE

type CfnPipeline

type CfnPipeline interface {
	awscdk.CfnResource
	awscdk.IInspectable
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Node() constructs.Node
	PipelineDefinition() interface{}
	SetPipelineDefinition(val interface{})
	PipelineDescription() *string
	SetPipelineDescription(val *string)
	PipelineDisplayName() *string
	SetPipelineDisplayName(val *string)
	PipelineName() *string
	SetPipelineName(val *string)
	Ref() *string
	RoleArn() *string
	SetRoleArn(val *string)
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::SageMaker::Pipeline`.

The `AWS::SageMaker::Pipeline` resource creates shell scripts that run when you create and/or start a SageMaker Pipeline. For information about SageMaker Pipelines, see [SageMaker Pipelines](https://docs.aws.amazon.com/sagemaker/latest/dg/pipelines.html) in the *Amazon SageMaker Developer Guide* .

TODO: EXAMPLE

func NewCfnPipeline

func NewCfnPipeline(scope constructs.Construct, id *string, props *CfnPipelineProps) CfnPipeline

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

type CfnPipelineProps

type CfnPipelineProps struct {
	// The definition of the pipeline.
	//
	// This can be either a JSON string or an Amazon S3 location.
	PipelineDefinition interface{} `json:"pipelineDefinition"`
	// The name of the pipeline.
	PipelineName *string `json:"pipelineName"`
	// The Amazon Resource Name (ARN) of the IAM role used to execute the pipeline.
	RoleArn *string `json:"roleArn"`
	// The description of the pipeline.
	PipelineDescription *string `json:"pipelineDescription"`
	// The display name of the pipeline.
	PipelineDisplayName *string `json:"pipelineDisplayName"`
	// The tags of the pipeline.
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `CfnPipeline`.

TODO: EXAMPLE

type CfnProject

type CfnProject interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrCreationTime() *string
	AttrProjectArn() *string
	AttrProjectId() *string
	AttrProjectStatus() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Node() constructs.Node
	ProjectDescription() *string
	SetProjectDescription(val *string)
	ProjectName() *string
	SetProjectName(val *string)
	Ref() *string
	ServiceCatalogProvisioningDetails() interface{}
	SetServiceCatalogProvisioningDetails(val interface{})
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::SageMaker::Project`.

Creates a machine learning (ML) project that can contain one or more templates that set up an ML pipeline from training to deploying an approved model.

TODO: EXAMPLE

func NewCfnProject

func NewCfnProject(scope constructs.Construct, id *string, props *CfnProjectProps) CfnProject

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

type CfnProjectProps

type CfnProjectProps struct {
	// The name of the project.
	ProjectName *string `json:"projectName"`
	// The product ID and provisioning artifact ID to provision a service catalog.
	//
	// For information, see [What is AWS Service Catalog](https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html) .
	ServiceCatalogProvisioningDetails interface{} `json:"serviceCatalogProvisioningDetails"`
	// The description of the project.
	ProjectDescription *string `json:"projectDescription"`
	// A list of key-value pairs to apply to this resource.
	//
	// For more information, see [Resource Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) and [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what) in the *AWS Billing and Cost Management User Guide* .
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `CfnProject`.

TODO: EXAMPLE

type CfnUserProfile

type CfnUserProfile interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrUserProfileArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DomainId() *string
	SetDomainId(val *string)
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	SingleSignOnUserIdentifier() *string
	SetSingleSignOnUserIdentifier(val *string)
	SingleSignOnUserValue() *string
	SetSingleSignOnUserValue(val *string)
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	UserProfileName() *string
	SetUserProfileName(val *string)
	UserSettings() interface{}
	SetUserSettings(val interface{})
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::SageMaker::UserProfile`.

Creates a user profile. A user profile represents a single user within a domain, and is the main way to reference a "person" for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to Amazon SageMaker Studio. If an administrator invites a person by email or imports them from SSO, a user profile is automatically created. A user profile is the primary holder of settings for an individual user and has a reference to the user's private Amazon Elastic File System (EFS) home directory.

TODO: EXAMPLE

func NewCfnUserProfile

func NewCfnUserProfile(scope constructs.Construct, id *string, props *CfnUserProfileProps) CfnUserProfile

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

type CfnUserProfileProps

type CfnUserProfileProps struct {
	// The domain ID.
	DomainId *string `json:"domainId"`
	// The user profile name.
	UserProfileName *string `json:"userProfileName"`
	// A specifier for the type of value specified in SingleSignOnUserValue.
	//
	// Currently, the only supported value is "UserName". If the Domain's AuthMode is SSO, this field is required. If the Domain's AuthMode is not SSO, this field cannot be specified.
	SingleSignOnUserIdentifier *string `json:"singleSignOnUserIdentifier"`
	// The username of the associated AWS Single Sign-On User for this UserProfile.
	//
	// If the Domain's AuthMode is SSO, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not SSO, this field cannot be specified.
	SingleSignOnUserValue *string `json:"singleSignOnUserValue"`
	// An array of key-value pairs to apply to this resource.
	//
	// Tags that you specify for the User Profile are also added to all Apps that the User Profile launches.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags *[]*awscdk.CfnTag `json:"tags"`
	// A collection of settings that apply to users of Amazon SageMaker Studio.
	UserSettings interface{} `json:"userSettings"`
}

Properties for defining a `CfnUserProfile`.

TODO: EXAMPLE

type CfnUserProfile_CustomImageProperty

type CfnUserProfile_CustomImageProperty struct {
	// The name of the AppImageConfig.
	AppImageConfigName *string `json:"appImageConfigName"`
	// The name of the CustomImage.
	//
	// Must be unique to your account.
	ImageName *string `json:"imageName"`
	// The version number of the CustomImage.
	ImageVersionNumber *float64 `json:"imageVersionNumber"`
}

A custom SageMaker image.

For more information, see [Bring your own SageMaker image](https://docs.aws.amazon.com/sagemaker/latest/dg/studio-byoi.html) .

TODO: EXAMPLE

type CfnUserProfile_JupyterServerAppSettingsProperty

type CfnUserProfile_JupyterServerAppSettingsProperty struct {
	// The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterServer app.
	DefaultResourceSpec interface{} `json:"defaultResourceSpec"`
}

The JupyterServer app settings.

TODO: EXAMPLE

type CfnUserProfile_KernelGatewayAppSettingsProperty

type CfnUserProfile_KernelGatewayAppSettingsProperty struct {
	// A list of custom SageMaker images that are configured to run as a KernelGateway app.
	CustomImages interface{} `json:"customImages"`
	// The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.
	DefaultResourceSpec interface{} `json:"defaultResourceSpec"`
}

The KernelGateway app settings.

TODO: EXAMPLE

type CfnUserProfile_ResourceSpecProperty

type CfnUserProfile_ResourceSpecProperty struct {
	// The instance type that the image version runs on.
	InstanceType *string `json:"instanceType"`
	// The ARN of the SageMaker image that the image version belongs to.
	SageMakerImageArn *string `json:"sageMakerImageArn"`
	// The ARN of the image version created on the instance.
	SageMakerImageVersionArn *string `json:"sageMakerImageVersionArn"`
}

Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that the version runs on.

TODO: EXAMPLE

type CfnUserProfile_SharingSettingsProperty

type CfnUserProfile_SharingSettingsProperty struct {
	// Whether to include the notebook cell output when sharing the notebook.
	//
	// The default is `Disabled` .
	NotebookOutputOption *string `json:"notebookOutputOption"`
	// When `NotebookOutputOption` is `Allowed` , the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.
	S3KmsKeyId *string `json:"s3KmsKeyId"`
	// When `NotebookOutputOption` is `Allowed` , the Amazon S3 bucket used to store the shared notebook snapshots.
	S3OutputPath *string `json:"s3OutputPath"`
}

Specifies options when sharing an Amazon SageMaker Studio notebook.

These settings are specified as part of `DefaultUserSettings` when the [CreateDomain](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateDomain.html) API is called, and as part of `UserSettings` when the [CreateUserProfile](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateUserProfile.html) API is called.

TODO: EXAMPLE

type CfnUserProfile_UserSettingsProperty

type CfnUserProfile_UserSettingsProperty struct {
	// The execution role for the user.
	ExecutionRole *string `json:"executionRole"`
	// The Jupyter server's app settings.
	JupyterServerAppSettings interface{} `json:"jupyterServerAppSettings"`
	// The kernel gateway app settings.
	KernelGatewayAppSettings interface{} `json:"kernelGatewayAppSettings"`
	// The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
	//
	// Optional when the `CreateDomain.AppNetworkAccessType` parameter is set to `PublicInternetOnly` .
	//
	// Required when the `CreateDomain.AppNetworkAccessType` parameter is set to `VpcOnly` .
	//
	// Amazon SageMaker adds a security group to allow NFS traffic from SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.
	SecurityGroups *[]*string `json:"securityGroups"`
	// Specifies options for sharing SageMaker Studio notebooks.
	SharingSettings interface{} `json:"sharingSettings"`
}

A collection of settings that apply to users of Amazon SageMaker Studio.

These settings are specified when the [CreateUserProfile](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateUserProfile.html) API is called, and as `DefaultUserSettings` when the [CreateDomain](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateDomain.html) API is called.

`SecurityGroups` is aggregated when specified in both calls. For all other settings in `UserSettings` , the values specified in `CreateUserProfile` take precedence over those specified in `CreateDomain` .

TODO: EXAMPLE

type CfnWorkteam

type CfnWorkteam interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrWorkteamName() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	LogicalId() *string
	MemberDefinitions() interface{}
	SetMemberDefinitions(val interface{})
	Node() constructs.Node
	NotificationConfiguration() interface{}
	SetNotificationConfiguration(val interface{})
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	WorkteamName() *string
	SetWorkteamName(val *string)
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::SageMaker::Workteam`.

Creates a new work team for labeling your data. A work team is defined by one or more Amazon Cognito user pools. You must first create the user pools before you can create a work team.

You cannot create more than 25 work teams in an account and region.

TODO: EXAMPLE

func NewCfnWorkteam

func NewCfnWorkteam(scope constructs.Construct, id *string, props *CfnWorkteamProps) CfnWorkteam

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

type CfnWorkteamProps

type CfnWorkteamProps struct {
	// A description of the work team.
	Description *string `json:"description"`
	// A list of `MemberDefinition` objects that contains objects that identify the workers that make up the work team.
	//
	// Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use `CognitoMemberDefinition` . For workforces created using your own OIDC identity provider (IdP) use `OidcMemberDefinition` .
	MemberDefinitions interface{} `json:"memberDefinitions"`
	// Configures SNS notifications of available or expiring work items for work teams.
	NotificationConfiguration interface{} `json:"notificationConfiguration"`
	// `AWS::SageMaker::Workteam.Tags`.
	Tags *[]*awscdk.CfnTag `json:"tags"`
	// The name of the work team.
	WorkteamName *string `json:"workteamName"`
}

Properties for defining a `CfnWorkteam`.

TODO: EXAMPLE

type CfnWorkteam_CognitoMemberDefinitionProperty

type CfnWorkteam_CognitoMemberDefinitionProperty struct {
	// `CfnWorkteam.CognitoMemberDefinitionProperty.CognitoClientId`.
	CognitoClientId *string `json:"cognitoClientId"`
	// `CfnWorkteam.CognitoMemberDefinitionProperty.CognitoUserGroup`.
	CognitoUserGroup *string `json:"cognitoUserGroup"`
	// `CfnWorkteam.CognitoMemberDefinitionProperty.CognitoUserPool`.
	CognitoUserPool *string `json:"cognitoUserPool"`
}

Identifies a Amazon Cognito user group.

A user group can be used in on or more work teams.

TODO: EXAMPLE

type CfnWorkteam_MemberDefinitionProperty

type CfnWorkteam_MemberDefinitionProperty struct {
	// The Amazon Cognito user group that is part of the work team.
	CognitoMemberDefinition interface{} `json:"cognitoMemberDefinition"`
}

Defines an Amazon Cognito or your own OIDC IdP user group that is part of a work team.

TODO: EXAMPLE

type CfnWorkteam_NotificationConfigurationProperty

type CfnWorkteam_NotificationConfigurationProperty struct {
	// The ARN for the Amazon SNS topic to which notifications should be published.
	NotificationTopicArn *string `json:"notificationTopicArn"`
}

Configures Amazon SNS notifications of available or expiring work items for work teams.

TODO: EXAMPLE

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL